Skip to content

Commit c70cc92

Browse files
authored
relrefs for versioned products should use version explicitly (#1336)
* relrefs for versioned products should use version
1 parent ae00dea commit c70cc92

File tree

356 files changed

+1563
-1539
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

356 files changed

+1563
-1539
lines changed

.github/workflows/main-staging.yml

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -87,8 +87,12 @@ jobs:
8787
rm -r "content/operate/kubernetes/${version_to_remove}"
8888
done
8989
90-
cp -r "content/operate/kubernetes/${version}"/* content/operate/kubernetes/
91-
rm -r "content/operate/kubernetes/${version}"
90+
# relrefs should not include version
91+
find "content/operate/kubernetes/${version}" -type f | while read file; do
92+
awk '{gsub(/\(\{\{< relref "\/operate\/kubernetes\/'${version}'/, "({{< relref \"/operate/kubernetes") }1' "$file" > tmpfile && mv tmpfile "$file"
93+
done
94+
95+
rsync -a --delete-after "content/operate/kubernetes/${version}"/ content/operate/kubernetes/
9296
sed -i 's/id="versionSelectorKubernetesValue" class="version-selector-control">latest/id="versionSelectorKubernetesValue" class="version-selector-control">v'"${version}"'/' layouts/partials/docs-nav.html
9397
sed -i 's/linkTitle: '"${version}"'/linkTitle: Redis for Kubernetes/' content/operate/kubernetes/_index.md
9498
@@ -110,8 +114,12 @@ jobs:
110114
rm -r "content/operate/rs/${version_to_remove}"
111115
done
112116
113-
cp -r "content/operate/rs/${version}"/* content/operate/rs/
114-
rm -r "content/operate/rs/${version}"
117+
# relrefs should not include version
118+
find "content/operate/rs/${version}" -type f | while read file; do
119+
awk '{gsub(/\(\{\{< relref "\/operate\/rs\/'${version}'/, "({{< relref \"/operate/rs") }1' "$file" > tmpfile && mv tmpfile "$file"
120+
done
121+
122+
rsync -a --delete-after "content/operate/rs/${version}"/ content/operate/rs/
115123
sed -i 's/id="versionSelectorRsValue" class="version-selector-control">latest/id="versionSelectorRsValue" class="version-selector-control">v'"${version}"'/' layouts/partials/docs-nav.html
116124
sed -i 's/linkTitle: '"${version}"'/linkTitle: Redis Software/' content/operate/rs/_index.md
117125
@@ -133,8 +141,12 @@ jobs:
133141
rm -r "content/integrate/redis-data-integration/${version_to_remove}"
134142
done
135143
136-
cp -r "content/integrate/redis-data-integration/${version}"/* content/integrate/redis-data-integration/
137-
rm -r "content/integrate/redis-data-integration/${version}"
144+
# relrefs should not include version
145+
find "content/operate/redis-data-integration/${version}" -type f | while read file; do
146+
awk '{gsub(/\(\{\{< relref "\/operate\/redis-data-integration\/'${version}'/, "({{< relref \"/operate/redis-data-integration") }1' "$file" > tmpfile && mv tmpfile "$file"
147+
done
148+
149+
rsync -a --delete-after "content/operate/redis-data-integration/${version}"/ content/operate/redis-data-integration/
138150
sed -i 's/id="versionSelectorRedis-Data-IntegrationValue" class="version-selector-control">latest/id="versionSelectorRedis-Data-IntegrationValue" class="version-selector-control">v'"${version}"'/' layouts/partials/docs-nav.html
139151
sed -i 's/linkTitle: '"${version}"'/linkTitle: Redis Data Integration/' content/integrate/redis-data-integration/_index.md
140152
@@ -181,9 +193,9 @@ jobs:
181193
for versioned_build in "${versioned_builds[@]}"; do
182194
product=$(awk 'BEGIN{FS=OFS="-"}{NF--; print}' <<< $versioned_build)
183195
if [[ "${product}" == "redis-data-integration" ]]; then
184-
gsutil -m rsync -r -c -j html -d "${{ github.workspace }}/${versioned_build}/integrate/${product}" "gs://${BUCKET}/${versioned_build}/integrate/${product}"
196+
gsutil -m rsync -r -c -j html -d "${{ github.workspace }}/${versioned_build}/integrate/${product}/" "gs://${BUCKET}/${bucket_path}/${versioned_build}/integrate/${product}"
185197
else
186-
gsutil -m rsync -r -c -j html -d "${{ github.workspace }}/${versioned_build}/operate/${product}" "gs://${BUCKET}/${versioned_build}/operate/${product}"
198+
gsutil -m rsync -r -c -j html -d "${{ github.workspace }}/${versioned_build}/operate/${product}/" "gs://${BUCKET}/${bucket_path}/${versioned_build}/operate/${product}"
187199
fi
188200
done
189201

.github/workflows/main.yml

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -87,8 +87,12 @@ jobs:
8787
rm -r "content/operate/kubernetes/${version_to_remove}"
8888
done
8989
90-
cp -r "content/operate/kubernetes/${version}"/* content/operate/kubernetes/
91-
rm -r "content/operate/kubernetes/${version}"
90+
# relrefs should not include version
91+
find "content/operate/kubernetes/${version}" -type f | while read file; do
92+
awk '{gsub(/\(\{\{< relref "\/operate\/kubernetes\/'${version}'/, "({{< relref \"/operate/kubernetes") }1' "$file" > tmpfile && mv tmpfile "$file"
93+
done
94+
95+
rsync -a --delete-after "content/operate/kubernetes/${version}"/ content/operate/kubernetes/
9296
sed -i 's/id="versionSelectorKubernetesValue" class="version-selector-control">latest/id="versionSelectorKubernetesValue" class="version-selector-control">v'"${version}"'/' layouts/partials/docs-nav.html
9397
sed -i 's/linkTitle: '"${version}"'/linkTitle: Redis for Kubernetes/' content/operate/kubernetes/_index.md
9498
@@ -110,8 +114,12 @@ jobs:
110114
rm -r "content/operate/rs/${version_to_remove}"
111115
done
112116
113-
cp -r "content/operate/rs/${version}"/* content/operate/rs/
114-
rm -r "content/operate/rs/${version}"
117+
# relrefs should not include version
118+
find "content/operate/rs/${version}" -type f | while read file; do
119+
awk '{gsub(/\(\{\{< relref "\/operate\/rs\/'${version}'/, "({{< relref \"/operate/rs") }1' "$file" > tmpfile && mv tmpfile "$file"
120+
done
121+
122+
rsync -a --delete-after "content/operate/rs/${version}"/ content/operate/rs/
115123
sed -i 's/id="versionSelectorRsValue" class="version-selector-control">latest/id="versionSelectorRsValue" class="version-selector-control">v'"${version}"'/' layouts/partials/docs-nav.html
116124
sed -i 's/linkTitle: '"${version}"'/linkTitle: Redis Software/' content/operate/rs/_index.md
117125
@@ -133,8 +141,12 @@ jobs:
133141
rm -r "content/integrate/redis-data-integration/${version_to_remove}"
134142
done
135143
136-
cp -r "content/integrate/redis-data-integration/${version}"/* content/integrate/redis-data-integration/
137-
rm -r "content/integrate/redis-data-integration/${version}"
144+
# relrefs should not include version
145+
find "content/operate/redis-data-integration/${version}" -type f | while read file; do
146+
awk '{gsub(/\(\{\{< relref "\/operate\/redis-data-integration\/'${version}'/, "({{< relref \"/operate/redis-data-integration") }1' "$file" > tmpfile && mv tmpfile "$file"
147+
done
148+
149+
rsync -a --delete-after "content/operate/redis-data-integration/${version}"/ content/operate/redis-data-integration/
138150
sed -i 's/id="versionSelectorRedis-Data-IntegrationValue" class="version-selector-control">latest/id="versionSelectorRedis-Data-IntegrationValue" class="version-selector-control">v'"${version}"'/' layouts/partials/docs-nav.html
139151
sed -i 's/linkTitle: '"${version}"'/linkTitle: Redis Data Integration/' content/integrate/redis-data-integration/_index.md
140152

content/operate/kubernetes/7.4.6/active-active/_index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@ Versions 6.4.2-6 or later fully support the Active-Active controller. Some of th
3030

3131
This setup method includes the following steps:
3232

33-
1. Gather REC credentials and [prepare participating clusters]({{< relref "/operate/kubernetes/active-active/prepare-clusters.md" >}}).
34-
2. Create [`RedisEnterpriseRemoteCluster` (RERC)]({{< relref "/operate/kubernetes/active-active/create-reaadb#create-rerc" >}}) resources.
35-
3. Create [`RedisEnterpriseActiveActiveDatabase` (REAADB)]({{< relref "/operate/kubernetes/active-active/create-reaadb#create-reaadb" >}}) resource.
33+
1. Gather REC credentials and [prepare participating clusters]({{< relref "/operate/kubernetes/7.4.6/active-active/prepare-clusters.md" >}}).
34+
2. Create [`RedisEnterpriseRemoteCluster` (RERC)]({{< relref "/operate/kubernetes/7.4.6/active-active/create-reaadb#create-rerc" >}}) resources.
35+
3. Create [`RedisEnterpriseActiveActiveDatabase` (REAADB)]({{< relref "/operate/kubernetes/7.4.6/active-active/create-reaadb#create-reaadb" >}}) resource.
3636

3737
### `crdb-cli` method
3838

@@ -49,7 +49,7 @@ For versions 6.4.2 or earlier, this Active-Active setup method includes the foll
4949

5050
[Active-Active]({{< relref "/operate/rs/databases/active-active/" >}}) databases give you read-and-write access to Redis Enterprise clusters (REC) in different Kubernetes clusters or namespaces. Active-Active deployments managed by the Redis Enterprise operator require two additional custom resources: Redis Enterprise Active-Active database (REAADB) and Redis Enterprise remote cluster (RERC).
5151

52-
To create an Active-Active Redis Enterprise deployment for Kubernetes with these new features, first [prepare participating clusters]({{< relref "/operate/kubernetes/active-active/prepare-clusters.md" >}}) then [create an Active-Active database]({{< relref "/operate/kubernetes/active-active/create-reaadb.md" >}}).
52+
To create an Active-Active Redis Enterprise deployment for Kubernetes with these new features, first [prepare participating clusters]({{< relref "/operate/kubernetes/7.4.6/active-active/prepare-clusters.md" >}}) then [create an Active-Active database]({{< relref "/operate/kubernetes/7.4.6/active-active/create-reaadb.md" >}}).
5353

5454
### Preview versions
5555

@@ -76,13 +76,13 @@ If you are using a preview version of these features (operator version 6.4.2-4 o
7676
7777
Redis Enterprise Active-Active database (REAADB) contains a link to the RERC for each participating cluster, and provides configuration and status to the management plane.
7878
79-
For a full list of fields and options, see the [REAADB API reference]({{<relref "/operate/kubernetes/reference/redis_enterprise_active_active_database_api">}}).
79+
For a full list of fields and options, see the [REAADB API reference]({{<relref "/operate/kubernetes/7.4.6/reference/redis_enterprise_active_active_database_api">}}).
8080
8181
### RERC custom resource
8282
8383
Redis Enterprise remote cluster (RERC) custom resource contains configuration details for all the participating clusters.
8484
85-
For a full list of fields and options, see the [RERC API reference]({{<relref "/operate/kubernetes/reference/redis_enterprise_remote_cluster_api">}}).
85+
For a full list of fields and options, see the [RERC API reference]({{<relref "/operate/kubernetes/7.4.6/reference/redis_enterprise_remote_cluster_api">}}).
8686
8787
### Limitations
8888

content/operate/kubernetes/7.4.6/active-active/create-aa-crdb-cli.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ linkTitle: Create Active-Active with crdb-cli
1111
weight: 99
1212
url: '/operate/kubernetes/7.4.6/active-active/create-aa-crdb-cli/'
1313
---
14-
{{<note>}} Versions 6.4.2 and later support the Active-Active database controller. This controller allows you to create Redis Enterprise Active-Active databases (REAADB) and Redis Enterprise remote clusters (RERC) with custom resources. We recommend using the [REAADB method for creating Active-Active databases]({{< relref "/operate/kubernetes/active-active/create-reaadb.md" >}}).{{</note>}}
14+
{{<note>}} Versions 6.4.2 and later support the Active-Active database controller. This controller allows you to create Redis Enterprise Active-Active databases (REAADB) and Redis Enterprise remote clusters (RERC) with custom resources. We recommend using the [REAADB method for creating Active-Active databases]({{< relref "/operate/kubernetes/7.4.6/active-active/create-reaadb.md" >}}).{{</note>}}
1515

1616
On Kubernetes, Redis Enterprise [Active-Active]({{< relref "/operate/rs/databases/active-active/" >}}) databases provide read-and-write access to the same dataset from different Kubernetes clusters. For more general information about Active-Active, see the [Redis Enterprise Software docs]({{< relref "/operate/rs/databases/active-active/" >}}).
1717

18-
Creating an Active-Active database requires routing [network access]({{< relref "/operate/kubernetes/networking/" >}}) between two Redis Enterprise clusters residing in different Kubernetes clusters. Without the proper access configured for each cluster, syncing between the databases instances will fail.
18+
Creating an Active-Active database requires routing [network access]({{< relref "/operate/kubernetes/7.4.6/networking/" >}}) between two Redis Enterprise clusters residing in different Kubernetes clusters. Without the proper access configured for each cluster, syncing between the databases instances will fail.
1919

2020
This process consists of:
2121

@@ -27,8 +27,8 @@ This process consists of:
2727

2828
Before creating Active-Active databases, you'll need admin access to two or more working Kubernetes clusters that each have:
2929

30-
- Routing for external access with an [ingress resources]({{< relref "/operate/kubernetes/networking/ingress.md" >}}) (or [route resources]({{< relref "/operate/kubernetes/networking/routes.md" >}}) on OpenShift).
31-
- A working [Redis Enterprise cluster (REC)]({{< relref "/operate/kubernetes/reference/redis_enterprise_cluster_api" >}}) with a unique name.
30+
- Routing for external access with an [ingress resources]({{< relref "/operate/kubernetes/7.4.6/networking/ingress.md" >}}) (or [route resources]({{< relref "/operate/kubernetes/7.4.6/networking/routes.md" >}}) on OpenShift).
31+
- A working [Redis Enterprise cluster (REC)]({{< relref "/operate/kubernetes/7.4.6/reference/redis_enterprise_cluster_api" >}}) with a unique name.
3232
- Enough memory resources available for the database (see [hardware requirements]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements.md" >}})).
3333

3434
{{<note>}} The `activeActive` field and the `ingressOrRouteSpec` field cannot coexist in the same REC. If you configured your ingress via the `ingressOrRouteSpec` field in the REC, create your Active-Active database with the RedisEnterpriseActiveActiveDatabase (REAADB) custom resource.{{</note>}}
@@ -70,7 +70,7 @@ You'll need to create DNS aliases to resolve your API hostname `<api-hostname>`,
7070
- Description: Combined with database name to create the Active-Active database hostname
7171
- Format: string
7272
- Example value: `-cluster.ijk.example.com`
73-
- [**REC admin credentials**]({{< relref "/operate/kubernetes/security/manage-rec-credentials.md" >}}) `<username> <password>`:
73+
- [**REC admin credentials**]({{< relref "/operate/kubernetes/7.4.6/security/manage-rec-credentials.md" >}}) `<username> <password>`:
7474
- Description: Admin username and password for the REC stored in a secret
7575
- Format: string
7676
- Example value: username: `user@example.com`, password: `something`
@@ -100,7 +100,7 @@ From inside your K8s cluster, edit your Redis Enterprise cluster (REC) resource
100100
101101
### Using ingress controller
102102
103-
1. If your cluster uses an [ingress controller]({{< relref "/operate/kubernetes/networking/ingress.md" >}}), add the following to the `spec` section of your REC resource file.
103+
1. If your cluster uses an [ingress controller]({{< relref "/operate/kubernetes/7.4.6/networking/ingress.md" >}}), add the following to the `spec` section of your REC resource file.
104104
105105
Nginx:
106106
@@ -147,7 +147,7 @@ HAproxy:
147147

148148
#### If using Istio Gateway and VirtualService
149149

150-
No changes are required to the REC spec if you are using [Istio]({{< relref "/operate/kubernetes/networking/istio-ingress.md" >}}) in place of an ingress controller. The `activeActive` section added above creates ingress resources. The two custom resources used to configure Istio (Gateway and VirtualService) replace the need for ingress resources.
150+
No changes are required to the REC spec if you are using [Istio]({{< relref "/operate/kubernetes/7.4.6/networking/istio-ingress.md" >}}) in place of an ingress controller. The `activeActive` section added above creates ingress resources. The two custom resources used to configure Istio (Gateway and VirtualService) replace the need for ingress resources.
151151

152152
{{<warning>}}
153153
These custom resources are not controlled by the operator and will need to be configured and maintained manually.
@@ -174,7 +174,7 @@ For each cluster, verify the VirtualService resource has two `- match:` blocks i
174174
175175
1. Make sure you have DNS aliases for each database that resolve your API hostname `<api-hostname>`,`<ingress-suffix>`, `<replication-hostname>` to the route IP address. To avoid entering multiple DNS records, you can use a wildcard in your alias (such as `*.ijk.example.com`).
176176
177-
1. If your cluster uses [OpenShift routes]({{< relref "/operate/kubernetes/networking/routes.md" >}}), add the following to the `spec` section of your Redis Enterprise cluster (REC) resource file.
177+
1. If your cluster uses [OpenShift routes]({{< relref "/operate/kubernetes/7.4.6/networking/routes.md" >}}), add the following to the `spec` section of your Redis Enterprise cluster (REC) resource file.
178178
179179
```sh
180180
activeActive:
@@ -195,7 +195,7 @@ For each cluster, verify the VirtualService resource has two `- match:` blocks i
195195
196196
## Create an Active-Active database with `crdb-cli`
197197
198-
The `crdb-cli` command can be run from any Redis Enterprise pod hosted on any participating K8s cluster. You'll need the values for the [required parameters]({{< relref "/operate/kubernetes/active-active/create-aa-crdb-cli#document-required-parameters" >}}) for each Redis Enterprise cluster.
198+
The `crdb-cli` command can be run from any Redis Enterprise pod hosted on any participating K8s cluster. You'll need the values for the [required parameters]({{< relref "/operate/kubernetes/7.4.6/active-active/create-aa-crdb-cli#document-required-parameters" >}}) for each Redis Enterprise cluster.
199199

200200
```sh
201201
crdb-cli crdb create \
@@ -214,4 +214,4 @@ See the [`crdb-cli` reference]({{< relref "/operate/rs/references/cli-utilities/
214214

215215
The easiest way to test your Active-Active database is to set a key-value pair in one database and retrieve it from the other.
216216

217-
You can connect to your databases with the instructions in [Manage databases]({{< relref "/operate/kubernetes/re-databases/db-controller#connect-to-a-database" >}}). Set a test key with `SET foo bar` in the first database. If your Active-Active deployment is working properly, when connected to your second database, `GET foo` should output `bar`.
217+
You can connect to your databases with the instructions in [Manage databases]({{< relref "/operate/kubernetes/7.4.6/re-databases/db-controller#connect-to-a-database" >}}). Set a test key with `SET foo bar` in the first database. If your Active-Active deployment is working properly, when connected to your second database, `GET foo` should output `bar`.

0 commit comments

Comments
 (0)