Skip to content

Commit 793f6d4

Browse files
active voice edits
1 parent a538390 commit 793f6d4

File tree

8 files changed

+27
-27
lines changed

8 files changed

+27
-27
lines changed

content/operate/kubernetes/reference/_index.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@ linkTitle: Reference
1111
weight: 89
1212
---
1313

14-
Reference documentation for Redis Enterprise custom resources, including API specifications and practical guides for creating, configuring, and managing Redis Enterprise deployments on Kubernetes.
14+
This reference documentation covers Redis Enterprise custom resources, API specifications, and practical instructions for creating, configuring, and managing Redis Enterprise deployments on Kubernetes.
1515

1616
## Work with custom resources
1717

18-
Redis Enterprise for Kubernetes uses custom resources to manage clusters and databases. You can create, modify, and delete these resources using standard Kubernetes tools.
18+
Redis Enterprise for Kubernetes uses custom resources to manage clusters and databases. Use standard Kubernetes tools to create, modify, and delete these resources.
1919

2020
### Create custom resources
2121

22-
Create custom resources using `kubectl apply` with YAML manifests:
22+
Use `kubectl apply` with YAML manifests to create custom resources:
2323

2424
```bash
2525
kubectl apply -f my-redis-cluster.yaml
@@ -28,7 +28,7 @@ kubectl apply -f my-redis-database.yaml
2828

2929
### View custom resources
3030

31-
List and inspect existing custom resources:
31+
Use these commands to list and inspect existing custom resources:
3232

3333
```bash
3434
# List Redis Enterprise clusters
@@ -50,7 +50,7 @@ kubectl describe redb my-database
5050

5151
### Modify custom resources
5252

53-
Update custom resources by editing the YAML manifest and reapplying:
53+
Edit the YAML manifest and reapply to update custom resources:
5454

5555
```bash
5656
# Edit and apply updated manifest
@@ -63,7 +63,7 @@ kubectl edit redb my-database
6363

6464
## YAML examples
6565

66-
Complete YAML examples for common deployment scenarios:
66+
Find complete YAML examples for common deployment scenarios:
6767

6868
- [YAML examples]({{< relref "/operate/kubernetes/reference/yaml-examples" >}}) - Ready-to-use YAML configurations for different deployment types
6969

@@ -76,30 +76,30 @@ Complete YAML examples for common deployment scenarios:
7676

7777
## API reference
7878

79-
Complete API specifications for all Redis Enterprise custom resources:
79+
Review complete API specifications for all Redis Enterprise custom resources:
8080

81-
Core resources:
81+
### Core resources
8282

8383
- [Redis Enterprise cluster API (REC)]({{< relref "/operate/kubernetes/reference/redis_enterprise_cluster_api" >}}) - Manage Redis Enterprise clusters
8484
- [Redis Enterprise database API (REDB)]({{< relref "/operate/kubernetes/reference/redis_enterprise_database_api" >}}) - Manage Redis databases
8585

86-
Active-Active resources:
86+
### Active-Active resources
8787

8888
- [Active-Active database API (REAADB)]({{< relref "/operate/kubernetes/reference/redis_enterprise_active_active_database_api" >}}) - Manage Active-Active databases
8989
- [Remote cluster API (RERC)]({{< relref "/operate/kubernetes/reference/redis_enterprise_remote_cluster_api" >}}) - Configure remote cluster connections
9090

9191
## Compatibility
9292

93-
Information about supported Kubernetes distributions and versions:
93+
Check supported Kubernetes distributions and versions:
9494

9595
- [Supported Kubernetes distributions]({{< relref "/operate/kubernetes/reference/supported_k8s_distributions" >}}) - Compatible Kubernetes platforms and versions
9696

9797
## Best practices
9898

99-
When working with custom resources:
99+
Follow these best practices when working with custom resources:
100100

101101
- **Use version control**: Store your YAML manifests in version control systems
102102
- **Validate before applying**: Use `kubectl apply --dry-run=client` to validate changes
103-
- **Monitor resource status**: Check resource status after applying changes
103+
- **Monitor resource status**: Check resource status after you apply changes
104104
- **Follow naming conventions**: Use consistent naming for easier management
105105
- **Document configurations**: Add annotations and labels to describe resource purpose

content/operate/kubernetes/reference/api/_index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ hideListLinks: true
1212
aliases:
1313
---
1414

15-
The Redis Enterprise operator provides Kubernetes custom resource definitions (CRDs) that allow you to manage Redis Enterprise clusters and databases declaratively. This section contains the complete API reference for all operator resources.
15+
The Redis Enterprise operator provides Kubernetes custom resource definitions (CRDs) that let you manage Redis Enterprise clusters and databases declaratively. This section contains the complete API reference for all operator resources.
1616

1717
## API versions and stability
1818

@@ -34,7 +34,7 @@ The operator uses different API versions to indicate stability and feature matur
3434

3535
### Using kubectl
3636

37-
All resources can be managed using standard `kubectl` commands:
37+
Manage all resources using standard `kubectl` commands:
3838

3939
```bash
4040
# List all Redis Enterprise clusters
@@ -49,8 +49,8 @@ kubectl apply -f my-redis-config.yaml
4949

5050
### Resource relationships
5151

52-
- A `RedisEnterpriseCluster` (REC) must be created first to provide the Redis Enterprise infrastructure
53-
- `RedisEnterpriseDatabase` (REDB) resources are created within a cluster to provision individual databases
54-
- `RedisEnterpriseActiveActiveDatabase` (REAADB) requires `RedisEnterpriseRemoteCluster (RERC)` resources to define participating clusters
52+
- Create a `RedisEnterpriseCluster` (REC) first to provide the Redis Enterprise infrastructure
53+
- Create `RedisEnterpriseDatabase` (REDB) resources within a cluster to provision individual databases
54+
- Use `RedisEnterpriseActiveActiveDatabase` (REAADB) with `RedisEnterpriseRemoteCluster (RERC)` resources to define participating clusters
5555

5656
For complete YAML configuration examples, see the [YAML examples](../yaml/) section.

content/operate/kubernetes/reference/supported_k8s_distributions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ linkTitle: Supported distributions
1010
weight: 10
1111
---
1212

13-
Each release of Redis Enterprise for Kubernetes is thoroughly tested against a set of Kubernetes distributions. The table below lists Redis Enterprise for Kubernetes versions and the Kubernetes distributions they support.
13+
We thoroughly test each release of Redis Enterprise for Kubernetes against a set of Kubernetes distributions. The table below lists Redis Enterprise for Kubernetes versions and the Kubernetes distributions they support.
1414

1515
{{<note>}}x86 is currently the only computer architecture supported by Redis Enterprise for Kubernetes. Support for ARM architecture is coming in future releases.{{</note>}}
1616

content/operate/kubernetes/reference/yaml/active-active.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ For complete deployment instructions, see [Active-Active databases]({{< relref "
2424

2525
## RERC for Chicago cluster
2626

27-
Each participating cluster needs a RedisEnterpriseRemoteCluster (RERC) resource pointing to the other clusters.
27+
Create a RedisEnterpriseRemoteCluster (RERC) resource on each participating cluster that points to the other clusters.
2828

2929
{{<embed-yaml "k8s/rerc.md" "redis-enterprise-remote-cluster.yaml">}}
3030

content/operate/kubernetes/reference/yaml/basic-deployment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ linkTitle: Basic deployment
1010
weight: 10
1111
---
1212

13-
This page provides complete YAML examples for a basic Redis Enterprise deployment on Kubernetes. These examples include all the essential components needed to deploy a Redis Enterprise cluster and create a database.
13+
This page provides complete YAML examples for a basic Redis Enterprise deployment on Kubernetes. These examples include all the essential components you need to deploy a Redis Enterprise cluster and create a database.
1414

1515
For complete deployment instructions, see [Deploy on Kubernetes]({{< relref "/operate/kubernetes/deployment/quick-start" >}}).
1616

content/operate/kubernetes/reference/yaml/log-collector-rbac.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ weight: 50
1212

1313
This page provides YAML examples for configuring RBAC permissions for the Redis Enterprise log collector tool. The log collector requires different permission levels depending on the collection mode you choose.
1414

15-
For complete log collection instructions, see [Collect logs guide]({{< relref "/operate/kubernetes/logs/collect-logs" >}}).
15+
For complete log collection instructions, see [Collect logs]({{< relref "/operate/kubernetes/logs/collect-logs" >}}).
1616

1717
## Prerequisites
1818

19-
- [Redis Enterprise operator]({{< relref "/operate/kubernetes/deployment" >}}) must be installed
19+
- Install the [Redis Enterprise operator]({{< relref "/operate/kubernetes/deployment" >}})
2020
- Appropriate permissions to create RBAC resources in target namespaces
2121
- Understanding of your deployment model (single namespace, multi-namespace, etc.)
2222

content/operate/kubernetes/reference/yaml/multi-namespace.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ linkTitle: Multi-namespace
1010
weight: 40
1111
---
1212

13-
Multi-namespace deployment allows a single Redis Enterprise operator to manage clusters and databases in different namespaces, providing better resource isolation and organization.
13+
Multi-namespace deployment lets a single Redis Enterprise operator manage clusters and databases in different namespaces, providing better resource isolation and organization.
1414

1515
Multi-namespace deployment enables:
1616
- Namespace isolation: Separate Redis Enterprise resources by team, environment, or application
@@ -26,13 +26,13 @@ For complete deployment instructions, see [Manage databases in multiple namespac
2626

2727
## Operator service account
2828

29-
These resources are deployed in the namespace where the Redis Enterprise operator runs.
29+
Deploy these resources in the namespace where the Redis Enterprise operator runs.
3030

3131
{{<embed-yaml "k8s/service_account.md" "operator-service-account.yaml">}}
3232

3333
## Operator cluster role
3434

35-
The operator needs cluster-wide permissions to manage resources across namespaces.
35+
Grant the operator cluster-wide permissions to manage resources across namespaces.
3636

3737
{{<embed-yaml "k8s/multi-ns_operator_cluster_role.md" "operator-cluster-role.yaml">}}
3838

content/operate/kubernetes/reference/yaml/rack-awareness.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ This page provides YAML examples for deploying Redis Enterprise with [rack aware
1414

1515
## Prerequisites
1616

17-
- [Kubernetes nodes](https://kubernetes.io/docs/concepts/architecture/nodes/) must be labeled with zone information
17+
- Label [Kubernetes nodes](https://kubernetes.io/docs/concepts/architecture/nodes/) with zone information
1818
- Typically uses the standard label `topology.kubernetes.io/zone`
1919
- Verify node labels: `kubectl get nodes --show-labels`
20-
- [Redis Enterprise operator]({{< relref "/operate/kubernetes/deployment" >}}) must be installed
20+
- Install the [Redis Enterprise operator]({{< relref "/operate/kubernetes/deployment" >}})
2121

2222
For complete deployment instructions, see [Deploy on Kubernetes]({{< relref "/operate/kubernetes/deployment" >}}).
2323

0 commit comments

Comments
 (0)