Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jira DOC-802: RS - Update "upgrade existing deployment" article... #1489

Merged
merged 18 commits into from
Aug 17, 2021
Merged
Show file tree
Hide file tree
Changes from 17 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 61 additions & 24 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
version: 2
jobs:
# The build job for staging branches that excludes Google Tag Manager
build-staging:
build-docs-staging:
docker:
# Hugo image
- image: cibuilds/hugo:0.72
Expand All @@ -24,7 +24,7 @@ jobs:
export LOCATION=staging/${CIRCLE_BRANCH} ;
fi
echo ${LOCATION}
hugo -v --baseURL //docs.redislabs.com/$LOCATION
hugo -v --baseURL //docs.redis.com/$LOCATION
- run:
name: Remove generated directories that are not needed
command: |
Expand All @@ -36,7 +36,7 @@ jobs:
- public

# The build job for production branches that includes Google Tag Manager
build-prod:
build-docs-prod:
docker:
- image: cibuilds/hugo:0.72
working_directory: ~/project
Expand All @@ -56,7 +56,7 @@ jobs:
name: Build site files (HTML, CSS, images) with the baseURL for the specified branch, including Google snippets (production)
command: |
export VERSION=${CIRCLE_BRANCH/-build/}
HUGO_ENV=production hugo -v --baseURL https://docs.redislabs.com/$VERSION
HUGO_ENV=production hugo -v --baseURL https://docs.redis.com/$VERSION
- run:
name: Remove generated directories that are not needed
command: |
Expand All @@ -70,7 +70,7 @@ jobs:
- public

# Deploy for branches other than -build to /staging/{branch}
deploy-staging:
deploy-docs-staging:
docker:
- image: xueshanf/awscli:latest
working_directory: ~/project
Expand All @@ -80,7 +80,10 @@ jobs:
# Set the signature version for the S3 auth
- run:
name: Setting Signature Version 4 for S3 Request Authentication
command: aws configure set default.s3.signature_version s3v4
command: |
export AWS_ACCESS_KEY_ID=${AWS_DOCS_ACCESS_KEY_ID}
export AWS_SECRET_ACCESS_KEY=${AWS_DOCS_SECRET_ACCESS_KEY}
aws configure set default.s3.signature_version s3v4
# Declare target location for baseURL and deployment location and deploy to the S3 bucket corresponding to the current branch
- run:
name: Replace existing site files on the AWS S3 bucket for the branch
Expand All @@ -90,10 +93,19 @@ jobs:
else
export LOCATION=staging/${CIRCLE_BRANCH} ;
fi
aws s3 sync public s3://docs.redislabs.com/$LOCATION --delete --acl public-read # --size-only
export AWS_ACCESS_KEY_ID=${AWS_DOCS_ACCESS_KEY_ID}
export AWS_SECRET_ACCESS_KEY=${AWS_DOCS_SECRET_ACCESS_KEY}
aws s3 sync public s3://docs.redis.com/$LOCATION --delete --acl public-read # --size-only
# Purge the site cache to force the deployed changes to display immediately
- run:
name: Purge site cache
command: |
export AWS_ACCESS_KEY_ID=${AWS_DOCS_ACCESS_KEY_ID}
export AWS_SECRET_ACCESS_KEY=${AWS_DOCS_SECRET_ACCESS_KEY}
aws cloudfront create-invalidation --distribution-id=${CLOUDFRONT_DISTRIBUTION_ID} --paths "/staging/*"

# Deploy only RS site files to the AWS S3 bucket for the branch
deploy-prod:
deploy-docs-prod:
docker:
- image: xueshanf/awscli:latest
working_directory: ~/project
Expand All @@ -103,16 +115,29 @@ jobs:
# Set the signature version for the S3 auth
- run:
name: Setting Signature Version 4 for S3 Request Authentication
command: aws configure set default.s3.signature_version s3v4
command: |
export AWS_ACCESS_KEY_ID=${AWS_DOCS_ACCESS_KEY_ID}
export AWS_SECRET_ACCESS_KEY=${AWS_DOCS_SECRET_ACCESS_KEY}
aws configure set default.s3.signature_version s3v4
# Deploy to the S3 bucket corresponding to the current branch
- run:
name: Replace existing site files on the AWS S3 bucket for the branch
command: |
export AWS_ACCESS_KEY_ID=${AWS_DOCS_ACCESS_KEY_ID}
export AWS_SECRET_ACCESS_KEY=${AWS_DOCS_SECRET_ACCESS_KEY}
export VERSION=${CIRCLE_BRANCH/-build/}
aws s3 sync public s3://docs.redis.com/$VERSION --delete --acl public-read --exclude "*rv/*" --exclude "*rc/*" # --size-only
# Purge the site cache to force the deployed changes to display immediately
- run:
name: Purge site cache
command: |
export AWS_ACCESS_KEY_ID=${AWS_DOCS_ACCESS_KEY_ID}
export AWS_SECRET_ACCESS_KEY=${AWS_DOCS_SECRET_ACCESS_KEY}
export VERSION=${CIRCLE_BRANCH/-build/}
aws s3 sync public s3://docs.redislabs.com/$VERSION --delete --acl public-read --exclude "*rv/*" --exclude "*rc/*" # --size-only
aws cloudfront create-invalidation --distribution-id=${CLOUDFRONT_DISTRIBUTION_ID} --paths "/${VERSION}/*"

# Deploy for -build to push to /{version} without -build
deploy-latest:
deploy-docs-latest:
docker:
- image: xueshanf/awscli:latest
working_directory: ~/project
Expand All @@ -122,54 +147,66 @@ jobs:
# Set the signature version for the S3 auth
- run:
name: Setting Signature Version 4 for S3 Request Authentication
command: aws configure set default.s3.signature_version s3v4
command: |
export AWS_ACCESS_KEY_ID=${AWS_DOCS_ACCESS_KEY_ID}
export AWS_SECRET_ACCESS_KEY=${AWS_DOCS_SECRET_ACCESS_KEY}
aws configure set default.s3.signature_version s3v4
# Declare target location for baseURL and deployment location and deploy to the S3 bucket corresponding to the current branch
- run:
name: Deploy site files to the AWS S3 bucket and set HTML, CSS, and JS files to expire for immediate client update
command: |
export AWS_ACCESS_KEY_ID=${AWS_DOCS_ACCESS_KEY_ID}
export AWS_SECRET_ACCESS_KEY=${AWS_DOCS_SECRET_ACCESS_KEY}
# Set aws S3 target location to branch_name
export LOCATION=${CIRCLE_BRANCH}
# Deploy HTML and CSS files to the S3 bucket corresponding to the current branch
aws s3 sync public s3://docs.redislabs.com/$LOCATION --delete --acl public-read --metadata-directive REPLACE --exclude "*" --include "*.html" --include "*.css" --include "*.js" --cache-control max-age=0 # --size-only
aws s3 sync public s3://docs.redis.com/$LOCATION --delete --acl public-read --metadata-directive REPLACE --exclude "*" --include "*.html" --include "*.css" --include "*.js" --cache-control max-age=0 # --size-only
# Deploy all other files to the S3 bucket corresponding to the current branch
aws s3 sync public s3://docs.redislabs.com/$LOCATION --delete --acl public-read --exclude "*.html" --exclude "*.css" --exclude "*.js" # --size-only
aws s3 sync public s3://docs.redis.com/$LOCATION --delete --acl public-read --exclude "*.html" --exclude "*.css" --exclude "*.js" # --size-only
# Deploy the robots.txt file
aws s3 cp robots.txt s3://docs.redislabs.com/robots.txt
aws s3 cp robots.txt s3://docs.redis.com/robots.txt
# Deploy the S3 site configuration
aws s3api put-bucket-website --bucket docs.redislabs.com --website-configuration file://website.json
aws s3api put-bucket-website --bucket docs.redis.com --website-configuration file://website.json
# Purge the site cache to force the deployed changes to display immediately
- run:
name: Purge site cache
command: |
export AWS_ACCESS_KEY_ID=${AWS_DOCS_ACCESS_KEY_ID}
export AWS_SECRET_ACCESS_KEY=${AWS_DOCS_SECRET_ACCESS_KEY}
aws cloudfront create-invalidation --distribution-id=${CLOUDFRONT_DISTRIBUTION_ID} --paths "/latest/*" "/robots.txt"
workflows:
version: 2
build-deploy:
jobs:
- build-staging:
- build-docs-staging:
filters:
branches:
ignore:
- /.*-build/
- latest
- build-prod:
- build-docs-prod:
filters:
branches:
only:
- /.*-build/
- latest
- deploy-staging:
- deploy-docs-staging:
requires:
- build-staging
- build-docs-staging
filters:
branches:
ignore:
- /.*-build/
- latest
- deploy-prod:
- deploy-docs-prod:
requires:
- build-prod
- build-docs-prod
filters:
branches:
only: /.*-build/
- deploy-latest:
- deploy-docs-latest:
requires:
- build-prod
- build-docs-prod
filters:
branches:
only: latest
4 changes: 2 additions & 2 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The Redis Labs Website and Documentation Portal by Redis Labs, Ltd.
The Redis Website and Documentation Portal by Redis, Inc.

The Redis Labs Website and Documentation Portal is licensed under a
The Redis Website and Documentation Portal is licensed under a
Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

You should have received a copy of the license along with this
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
_The master branch_ => [![CircleCI](https://circleci.com/gh/RedisLabs/redislabs-docs/tree/master.svg?style=svg)](https://circleci.com/gh/RedisLabs/redislabs-docs/tree/master)

# Redis Labs Documentation Center
# Redis Documentation Center

The Redis Labs Documentation Center is built with [Hugo]( https://gohugo.io/ ) version 0.48 and is based on the [DocDock]( https://github.com/vjeantet/hugo-theme-docdock.git ) theme.
The Redis Documentation Center is built with [Hugo]( https://gohugo.io/ ) version 0.48 and is based on the [DocDock]( https://github.com/vjeantet/hugo-theme-docdock.git ) theme.

## Installing the Redis Labs Documentation Center
## Installing the Redis Documentation Center

To run the Redis Labs Documentation Center locally:
To run the Redis Documentation Center locally:

1. Install the latest Hugo:

Expand Down Expand Up @@ -39,11 +39,11 @@ To access the site, go to: http://localhost:1313

## Publishing

The latest branch is the latest stable version of documentation for the latest publicly available release at: https://docs.redislabs.com/latest
The latest branch is the latest stable version of documentation for the latest publicly available release at: https://docs.redis.com/latest

Documentation for previous versions is published through the version build branches (for example 5.2-build).

The master branch is published to https://docs.redislabs.com/staging/dev and represents the unstable version of documentation for the latest publicly available release. When stable, this branch is published to the latest branch.
The master branch is published to https://docs.redis.com/staging/dev and represents the unstable version of documentation for the latest publicly available release. When stable, this branch is published to the latest branch.

## Contributing to the documentation

Expand All @@ -64,4 +64,4 @@ To add a new section in the sidebar, you must add a directory and add an `_index

## Markdown

For more information about markdown syntax for our docs, see the [cheatsheet](https://docs.redislabs.com/latest/cheatsheet).
For more information about markdown syntax for our docs, see the [cheatsheet](https://docs.redis.com/latest/cheatsheet).
4 changes: 2 additions & 2 deletions config.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
baseURL = "/"
languageCode = "en-us"
DefaultContentLanguage = "en"
title = "Redis Labs Documentation Center"
title = "Redis Documentation Center"
theme = "docdock"
assetDir = "static"
# themesdir = "../.."
Expand Down Expand Up @@ -39,7 +39,7 @@ highlightClientSide = false # set true to use highlight.pack.js instead of the d
menushortcutsnewtab = false # set true to open shortcuts links to a new tab/window
enableGitInfo = true
googleAnalytics = "UA-92003007-1"
googleTagManager = "GTM-TKZ6J9R"
googleTagManager = "GTM-KNWQXKB"

mac_dl_link = "https://downloads.redisinsight.redislabs.com/latest/redisinsight-mac.dmg"
linux_dl_link = "https://downloads.redisinsight.redislabs.com/latest/redisinsight-linux64"
Expand Down
2 changes: 1 addition & 1 deletion content/_header.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
[![Redis Labs]( /images/icon_logo/logo-redis-2.svg )](https://redislabs.com)
[![Redis]( /images/icon_logo/logo-redis-3.svg )](https://redislabs.com)
2 changes: 1 addition & 1 deletion content/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Redis Labs Documentation
title: Redis Documentation
# description: Where documentation LIVES!
toc: false
---
Expand Down
8 changes: 4 additions & 4 deletions content/contribution-guide.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: Contribution Guide
description: How to contribute to the Redis Labs documentation
description: How to contribute to the Redis documentation
draft: false
---
Redis Labs documentation is an open source project and we welcome edits of all types.
Redis documentation is an open source project and we welcome edits of all types.

Just to get you started, here is a simple explanation of how to contribute content to the docs.

Expand All @@ -16,7 +16,7 @@ you can click on the **Edit on GitHub** link, [edit the page, and submit the cha
## Branches vs. forks

The redislabs-docs repository is public but only members of the repository can create new branches in the repo.
New branches in the repo are automatically built into staging sites at: `http://docs.redislabs.com/staging/<branch>`
New branches in the repo are automatically built into staging sites at: `http://docs.redis.com/staging/<branch>`
After every commit to a branch, the site is re-built within about 1 minute so you can see the live updates.

If you are not a member of the repository, you can fork the repository to a branch in your account
Expand All @@ -31,7 +31,7 @@ you can open a pull request to submit your changes for consideration.

After you clone the repository to your local machine, you can serve the site locally with Hugo and then browse to http://localhost:1313 to see how it looks.

The Redis Labs documentation site does not run on the latest version of [Hugo](http://gohugo.io).
The Redis documentation site does not run on the latest version of [Hugo](http://gohugo.io).
You can go to the readme page of the redislabs-docs repository to find the version of Hugo that is currently supported.

To run an older version of Hugo on your local machine:
Expand Down
6 changes: 3 additions & 3 deletions content/editing-guide.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: Editing Guide
description: How to edit the Redis Labs documentation
description: How to edit the Redis documentation
draft: false
---
Redis Labs documentation is an open source project and we welcome edits of all types.
Redis documentation is an open source project and we welcome edits of all types.

Just to get you started, here is a simple explanation of how to edit the docs.

Expand Down Expand Up @@ -74,7 +74,7 @@ Here's what this process looks like:
Here's what this process looks like:
{{< video "/images/site/review-and-create-PR.mp4" "review-and-create-PR" >}}

Your edits improve the quality of the documentation and help every Redis Labs customer get the most out of Redis products!
Your edits improve the quality of the documentation and help every Redis customer get the most out of Redis products!

## Related Info

Expand Down
6 changes: 3 additions & 3 deletions content/embeds/compatible-with-oss.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Yes we are. Not only are we are the home of Redis, but most of Redis’ core engineers also work for Redis Labs! We contribute extensively to the open source Redis project. As a rule, we adhere to the open source’s specifications and make every effort to update our service with its latest versions.
Yes we are. Not only are we are the home of Redis, but most of the core engineers on open source Redis also work here. We contribute extensively to the open source Redis project. As a rule, we adhere to the open source’s specifications and make every effort to update our service with its latest versions.

That said, the following Redis features are not applicable in the context of our service:

Expand All @@ -15,8 +15,8 @@ That said, the following Redis features are not applicable in the context of our
- [REPLCONF](http://redis.io/commands/REPLCONF)
- [SLAVEOF](http://redis.io/commands/SLAVEOF)
- [SYNC](http://redis.io/commands/SYNC)/[PSYNC](http://redis.io/commands/PSYNC)
- Redis Labs clustering technology is different than the open source Redis Cluster and supports clustering in a seamless manner that works with all standard Redis clients. As a result, [all Cluster related commands](http://redis.io/commands#cluster) are blocked and show an error when used.
- Redis Labs clustering technology allows [multiple active proxies](http://docs.redislabs.com/latest/rs/administering/designing-production/networking/multiple-active-proxy.md). As a result, the CLIENT ID command cannot guarantee incremental IDs between clients who connect to different nodes under multi proxy policies.
- Redis Enterprise clustering technology is different than the open source Redis Cluster and supports clustering in a seamless manner that works with all standard Redis clients. As a result, [all Cluster related commands](http://redis.io/commands#cluster) are blocked and show an error when used.
- Redis Enterprise clustering technology allows [multiple active proxies](http://docs.redislabs.com/latest/rs/administering/designing-production/networking/multiple-active-proxy.md). As a result, the CLIENT ID command cannot guarantee incremental IDs between clients who connect to different nodes under multi proxy policies.
- Commands that aren’t relevant for a hosted Redis service are blocked:
- [CONFIG RESETSTAT](http://redis.io/commands/CONFIG-RESETSTAT)
- [DEBUG OBJECT](http://redis.io/commands/DEBUG-OBJECT)/[SEGFAULT](http://redis.io/commands/DEBUG-SEGFAULT)
Expand Down
4 changes: 2 additions & 2 deletions content/embeds/new-cluster-embed.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
A Redis Enterprise Software (RS) cluster typically consists of several nodes.
For production deployments, Redis Labs recommends an uneven number of nodes, with a minimum of three.
A Redis Enterprise Software cluster typically consists of several nodes.
For production deployments, we recommend an uneven number of nodes, with a minimum of three.

{{< note >}}
In a cluster that consists of only one node, some features and capabilities are not enabled,
Expand Down
8 changes: 4 additions & 4 deletions content/embeds/tryout-redisearch-2.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,21 +28,21 @@ In this example, we have four fields: `title` (`TEXT`), `body` (`TEXT`), `url`

Now add some data to this index. Here we add a hash with the key "`doc:1`" and the fields:

- title: "Redis Labs"
- title: "Redis"
- body: "Primary and caching"
- url: <https://redislabs.com/primary-caching>
- visits: 108

```sh
127.0.0.1:12543> HSET doc:1 title "Redis Labs" body "Primary and caching" url "<https://redislabs.com/primary-caching>" visits 108
127.0.0.1:12543> HSET doc:1 title "Redis" body "Primary and caching" url "<https://redislabs.com/primary-caching>" visits 108
OK
```

To add a document specific score, that causes the document to appear higher or lower in results, set a value for the `doc_score` field.
We specified the `SCORE_FIELD` in the schema definition to hold the document weight value.

```sh
127.0.0.1:12543> HSET doc:2 title "Redis Labs" body "Modules" url "<https://redislabs.com/modules>" visits 102 doc_score 0.8
127.0.0.1:12543> HSET doc:2 title "Redis" body "Modules" url "<https://redislabs.com/modules>" visits 102 doc_score 0.8
OK
```

Expand All @@ -56,7 +56,7 @@ Do a search on this index for any documents with the word "primary":
1) (integer) 1
2) "doc:1"
3) 1) "title"
2) "Redis Labs"
2) "Redis"
3) "body"
4) "primary and caching"
5) "url"
Expand Down
Loading