Skip to content

Commit 14a8460

Browse files
redisdocsapp[bot]github-actions[bot]kaitlynmichaelpaoloredisandy-stark-redis
authored
k8s api docs 7.4.6-2 (#523)
* k8s api docs 7.4.6-2 * remove options articles * replace rec api links * replace REDB links * replace REAADB links * replace RERC links * quick index wording change * Rename redis_enterprise_remote_cluster.md to redis_enterprise_remote_cluster_api.md * Use api groups instead of packages * Use apiVersion * Update content/operate/kubernetes/active-active/global-config.md Co-authored-by: andy-stark-redis <164213578+andy-stark-redis@users.noreply.github.com> * Update content/operate/kubernetes/deployment/openshift/openshift-cli.md Co-authored-by: andy-stark-redis <164213578+andy-stark-redis@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: andy-stark-redis <164213578+andy-stark-redis@users.noreply.github.com> * Remove bold tags * Remove [index] usage --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: kaitlynmichael <kaitlyn.michael@redis.com> Co-authored-by: paoloredis <paolo.lazzari@redis.com> Co-authored-by: Kaitlyn Michael <76962844+kaitlynmichael@users.noreply.github.com> Co-authored-by: andy-stark-redis <164213578+andy-stark-redis@users.noreply.github.com>
1 parent 7b1a803 commit 14a8460

17 files changed

+30197
-279
lines changed

content/apis/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,5 +60,5 @@ If you have installed Redis Enterprise Software, you can automate operations wit
6060

6161
If you need to install Redis Enterprise on Kubernetes, then you can use the [Redis Enterprise for Kubernetes Operators]({{< relref "/operate/Kubernetes/" >}}). You can find the resource definitions here:
6262

63-
- [Redis Enterprise Cluster API](https://github.com/RedisLabs/redis-enterprise-k8s-docs/blob/master/redis_enterprise_cluster_api.md)
64-
- [Redis Enterprise Database API](https://github.com/RedisLabs/redis-enterprise-k8s-docs/blob/master/redis_enterprise_database_api.md)
63+
- [Redis Enterprise Cluster API]({{<relref "/operate/kubernetes/reference/redis_enterprise_cluster_api">}})
64+
- [Redis Enterprise Database API]({{<relref "/operate/kubernetes/reference/redis_enterprise_database_api">}})

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,13 +75,13 @@ If you are using a preview version of these features (operator version 6.4.2-4 o
7575
7676
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.
7777
78-
For a full list of fields and options, see the [REAADB API reference](https://github.com/RedisLabs/redis-enterprise-k8s-docs/blob/master/redis_enterprise_active_active_database_api.md).
78+
For a full list of fields and options, see the [REAADB API reference]({{<relref "/operate/kubernetes/reference/redis_enterprise_active_active_database_api">}}).
7979
8080
### RERC custom resource
8181
8282
Redis Enterprise remote cluster (RERC) custom resource contains configuration details for all the participating clusters.
8383
84-
For a full list of fields and options, see the [RERC API reference](https://github.com/RedisLabs/redis-enterprise-k8s-docs/blob/master/redis_enterprise_remote_cluster_api.md).
84+
For a full list of fields and options, see the [RERC API reference]({{<relref "/operate/kubernetes/reference/redis_enterprise_remote_cluster_api">}}).
8585
8686
### Limitations
8787

content/operate/kubernetes/active-active/create-reaadb.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ For a list of example values used throughout this article, see the [Example valu
6969
secretName: redis-enterprise-rerc-reagan
7070
```
7171

72-
For more details on RERC fields, see the [RERC API reference](https://github.com/RedisLabs/redis-enterprise-k8s-docs/blob/master/redis_enterprise_remote_cluster_api.md).
72+
For more details on RERC fields, see the [RERC API reference]({{<relref "/operate/kubernetes/reference/redis_enterprise_remote_cluster_api">}}).
7373

7474
1. Create a Redis Enterprise remote cluster from each RERC custom resource file.
7575

@@ -123,7 +123,7 @@ For a list of example values used throughout this article, see the [Example valu
123123

124124
{{<note>}}Sharding is disabled on Active-Active databases created with a `shardCount` of 1. Sharding cannot be enabled after database creation. {{</note>}}
125125

126-
For more details on RERC fields, see the [RERC API reference](https://github.com/RedisLabs/redis-enterprise-k8s-docs/blob/master/redis_enterprise_remote_cluster_api.md).
126+
For more details on RERC fields, see the [RERC API reference]({{<relref "/operate/kubernetes/reference/redis_enterprise_remote_cluster_api">}}).
127127

128128
1. Create a Redis Enterprise Active-Active database from the REAADB custom resource file.
129129

content/operate/kubernetes/active-active/edit-rerc.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ Before a RedisEnterpriseCluster (REC) can participate in an Active-Active databa
1616

1717
The RERC controller periodically connects to the local REC endpoint via its external address, to ensure it’s setup correctly. For this to work, the external load balancer must support [NAT hairpinning](https://en.wikipedia.org/wiki/Network_address_translation#NAT_loopback). In some cloud environments, this may involve disabling IP preservation for the load balancer target groups.
1818

19-
For more details, see the [RERC API reference](https://github.com/RedisLabs/redis-enterprise-k8s-docs/blob/master/redis_enterprise_remote_cluster_api.md).
19+
For more details, see the [RERC API reference]({{<relref "/operate/kubernetes/reference/redis_enterprise_remote_cluster_api">}}).
2020

2121
## Edit RERC
2222

23-
Use the `kubectl patch rerc <rerc-name> --type merge --patch` command to patch the local RERC custom resource with your changes. For a full list of available fields, see the [RERC API reference](https://github.com/RedisLabs/redis-enterprise-k8s-docs/blob/master/redis_enterprise_remote_cluster_api.md).
23+
Use the `kubectl patch rerc <rerc-name> --type merge --patch` command to patch the local RERC custom resource with your changes. For a full list of available fields, see the [RERC API reference]({{<relref "/operate/kubernetes/reference/redis_enterprise_remote_cluster_api">}}).
2424

2525
The following example edits the `dbFqdnSuffix` field for the RERC named `rerc-ohare`.
2626

content/operate/kubernetes/active-active/global-config.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ weight: 50
1414

1515
The Redis Enterprise Active-Active database (REAADB) custom resource contains the field `.spec.globalConfigurations`. This field sets configurations for the Active-Active database across all participating clusters, such as memory size, shard count, and the global database secrets.
1616

17-
The [REAADB API reference](https://github.com/RedisLabs/redis-enterprise-k8s-docs/blob/master/redis_enterprise_active_active_database_api.md) contains a full list of available fields.
17+
The [REAADB API reference]({{<relref "/operate/kubernetes/reference/redis_enterprise_active_active_database_api">}}) contains a full list of available fields.
1818

1919
## Edit global configurations
2020

@@ -46,7 +46,7 @@ The [REAADB API reference](https://github.com/RedisLabs/redis-enterprise-k8s-doc
4646

4747
## Edit global configuration secrets
4848

49-
This section edits the secrets under the REAADB '.spec.globalConfigurations' section. For more information and all available fields, see the [REAADB API reference](https://github.com/RedisLabs/redis-enterprise-k8s-docs/blob/master/redis_enterprise_active_active_database_api.md).
49+
This section edits the secrets under the REAADB `.spec.globalConfigurations` section. For more information and all available fields, see the [REAADB API reference]({{<relref "/operate/kubernetes/reference/redis_enterprise_active_active_database_api">}}).
5050

5151

5252
1. On an existing participating cluster, generate a YAML file containing the database secret with the relevant data.

content/operate/kubernetes/deployment/openshift/openshift-cli.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ The Redis Enterprise pods must run in OpenShift with privileges set in a [Securi
105105

106106
1. Apply the `RedisEnterpriseCluster` resource file ([rec_rhel.yaml](https://github.com/RedisLabs/redis-enterprise-k8s-docs/blob/master/openshift/rec_rhel.yaml)).
107107

108-
You can rename the file to `<your_cluster_name>.yaml`, but it is not required. Examples below use `<rec_rhel>.yaml`. [Options for Redis Enterprise clusters]({{< relref "/operate/kubernetes/reference/cluster-options.md" >}}) has more info about the Redis Enterprise cluster (REC) custom resource, or see the [Redis Enterprise cluster API](https://github.com/RedisLabs/redis-enterprise-k8s-docs/blob/master/redis_enterprise_cluster_api.md) for a full list of options.
108+
You can rename the file to `<your_cluster_name>.yaml`, but it is not required. Examples below use `<rec_rhel>.yaml`. [Options for Redis Enterprise clusters]({{< relref "/operate/kubernetes/reference/cluster-options" >}}) has more info about the Redis Enterprise cluster (REC) custom resource, or see the [Redis Enterprise cluster API]({{<relref "/operate/kubernetes/reference/redis_enterprise_cluster_api">}}) for a full list of options.
109109

110110
The REC name cannot be changed after cluster creation.
111111

@@ -212,7 +212,7 @@ The operator uses the instructions in the Redis Enterprise database (REDB) custo
212212
213213
1. Create a `RedisEnterpriseDatabase` custom resource.
214214
215-
This example creates a test database. For production databases, see [creating a database]({{< relref "/operate/kubernetes/re-databases/db-controller.md#create-a-database" >}}) and [database options]({{< relref "/operate/kubernetes/reference/db-options.md" >}}).
215+
This example creates a test database. For production databases, see [create a database]({{< relref "/operate/kubernetes/re-databases/db-controller.md#create-a-database" >}}) and [RedisEnterpriseDatabase API reference]({{< relref "/operate/kubernetes/reference/redis_enterprise_database_api" >}}).
216216
217217
```bash
218218
cat << EOF > /tmp/redis-enterprise-database.yml
@@ -233,8 +233,6 @@ The operator uses the instructions in the Redis Enterprise database (REDB) custo
233233
234234
## More info
235235
236-
- [Options for Redis Enterprise clusters (REC)]({{< relref "/operate/kubernetes/reference/cluster-options.md" >}})
237-
- [Redis Enterprise cluster API](https://github.com/RedisLabs/redis-enterprise-k8s-docs/blob/master/redis_enterprise_cluster_api.md)
238-
- [Options for Redis Enterprise databases (REDB)]({{< relref "/operate/kubernetes/reference/db-options.md" >}})
239-
- [Redis Enterprise database API](https://github.com/RedisLabs/redis-enterprise-k8s-docs/blob/master/redis_enterprise_database_api.md)
236+
- [Redis Enterprise cluster API]({{<relref "/operate/kubernetes/reference/redis_enterprise_cluster_api">}})
237+
- [Redis Enterprise database API]({{<relref "/operate/kubernetes/reference/redis_enterprise_database_api">}})
240238

content/operate/kubernetes/deployment/quick-start.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ redis-enterprise-operator 1/1 1 1 0m36s
112112
A Redis Enterprise cluster (REC) is created from a `RedisEnterpriseCluster` custom resource
113113
that contains cluster specifications.
114114

115-
The following example creates a minimal Redis Enterprise cluster. See the [RedisEnterpriseCluster API reference](https://github.com/RedisLabs/redis-enterprise-k8s-docs/blob/master/redis_enterprise_cluster_api.md) for more information on the various options available.
115+
The following example creates a minimal Redis Enterprise cluster. See the [RedisEnterpriseCluster API reference]({{<relref "/operate/kubernetes/reference/redis_enterprise_cluster_api">}}) for more information on the various options available.
116116

117117
1. Create a file that defines a Redis Enterprise cluster with three nodes.
118118
{{<note>}} The REC name (`my-rec` in this example) cannot be changed after cluster creation.{{</note>}}

content/operate/kubernetes/reference/_index.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,7 @@ linkTitle: Reference
1212
weight: 89
1313
---
1414

15-
This section contains the references to the operator, cluster, database deployment
16-
options for Kubernetes.
15+
This section contains the API reference for Redis custom resources and supported distributions.
1716

1817

1918

content/operate/kubernetes/reference/cluster-options.md

Lines changed: 0 additions & 138 deletions
This file was deleted.

0 commit comments

Comments
 (0)