Skip to content

Commit 0d8da15

Browse files
Remove unnecessary 'File:' labels from YAML examples
- Removed 'File: filename.yaml' labels from all YAML examples across all pages - YAML examples are self-explanatory and don't need explicit file labels - Fixed duplicate 'Customization options' headings in basic-deployment.md - Renamed to 'Cluster customization options' and 'Database customization options' - Cleaner, more focused presentation of YAML configurations
1 parent 9b4d5e9 commit 0d8da15

File tree

5 files changed

+7
-53
lines changed

5 files changed

+7
-53
lines changed

content/operate/kubernetes/logs/log-collector-rbac.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,6 @@ The key differences between the two modes:
5555

5656
Use restricted mode for minimal security exposure while still collecting essential Redis Enterprise diagnostics.
5757

58-
**File: `log-collector-restricted-rbac.yaml`**
59-
6058
{{<embed-md "k8s/log_collector_role_restricted_mode.md">}}
6159

6260
### Restricted mode permissions
@@ -83,8 +81,6 @@ The restricted mode provides access to:
8381

8482
Use all mode when you need comprehensive cluster diagnostics or when specifically requested by Redis Support.
8583

86-
**File: `log-collector-all-rbac.yaml`**
87-
8884
{{<embed-md "k8s/log_collector_role_all_mode.md">}}
8985

9086
### All mode additional permissions
@@ -103,8 +99,6 @@ In addition to all restricted mode permissions, all mode provides:
10399

104100
Bind the Role to your service account in each namespace where you want to collect logs.
105101

106-
**File: `log-collector-role-binding.yaml`**
107-
108102
```yaml
109103
apiVersion: rbac.authorization.k8s.io/v1
110104
kind: RoleBinding
@@ -125,8 +119,6 @@ roleRef:
125119
126120
Bind the ClusterRole to your service account for cluster-wide permissions.
127121
128-
**File: `log-collector-cluster-role-binding.yaml`**
129-
130122
```yaml
131123
apiVersion: rbac.authorization.k8s.io/v1
132124
kind: ClusterRoleBinding

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

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,6 @@ This example shows a two-cluster Active-Active setup:
3939

4040
Each participating cluster needs a RedisEnterpriseRemoteCluster (RERC) resource pointing to the other clusters.
4141

42-
**File: `rerc-chicago.yaml`** (applied on Boston cluster)
43-
4442
{{<embed-md "k8s/rerc.md">}}
4543

4644
### RERC configuration
@@ -76,8 +74,6 @@ spec:
7674
7775
## RERC for Boston cluster
7876
79-
**File: `rerc-boston.yaml`** (applied on Chicago cluster)
80-
8177
```yaml
8278
apiVersion: app.redislabs.com/v1alpha1
8379
kind: RedisEnterpriseRemoteCluster
@@ -95,8 +91,6 @@ spec:
9591
9692
The RedisEnterpriseActiveActiveDatabase (REAADB) resource defines the Active-Active database.
9793
98-
**File: `active-active-database.yaml`**
99-
10094
{{<embed-md "k8s/reaadb.md">}}
10195
10296
### REAADB configuration

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

Lines changed: 7 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,6 @@ Apply the YAML files in this order:
2626

2727
The service account provides an identity for the Redis Enterprise operator.
2828

29-
**File: `service-account.yaml`**
30-
3129
{{<embed-md "k8s/service_account.md">}}
3230

3331
### Service account configuration
@@ -39,8 +37,6 @@ The service account provides an identity for the Redis Enterprise operator.
3937

4038
The Role defines the permissions needed by the Redis Enterprise operator within the namespace.
4139

42-
**File: `role.yaml`**
43-
4440
{{<embed-md "k8s/role.md">}}
4541

4642
### Role configuration
@@ -61,8 +57,6 @@ The Role defines the permissions needed by the Redis Enterprise operator within
6157

6258
The RoleBinding connects the service account to the role, granting the necessary permissions.
6359

64-
**File: `role-binding.yaml`**
65-
6660
{{<embed-md "k8s/role_binding.md">}}
6761

6862
### Role binding configuration
@@ -75,8 +69,6 @@ The RoleBinding connects the service account to the role, granting the necessary
7569

7670
The RedisEnterpriseCluster (REC) custom resource defines the cluster specification.
7771

78-
**File: `redis-cluster.yaml`**
79-
8072
{{<embed-md "k8s/rec.md">}}
8173

8274
### Cluster configuration
@@ -86,19 +78,19 @@ The RedisEnterpriseCluster (REC) custom resource defines the cluster specificati
8678
- **persistentSpec.volumeSize**: Storage size per node
8779
- **redisEnterpriseNodeResources**: CPU and memory allocation per node
8880

89-
### Customization options
81+
### Cluster customization options
9082

9183
Edit these values based on your requirements:
9284

9385
```yaml
9486
spec:
9587
# Increase nodes for larger clusters
9688
nodes: 5
97-
89+
9890
# Adjust storage size
9991
persistentSpec:
10092
volumeSize: 50Gi
101-
93+
10294
# Modify resource allocation
10395
redisEnterpriseNodeResources:
10496
requests:
@@ -113,8 +105,6 @@ spec:
113105
114106
The RedisEnterpriseDatabase (REDB) custom resource defines the database specification.
115107
116-
**File: `redis-database.yaml`**
117-
118108
{{<embed-md "k8s/redb.md">}}
119109
120110
### Database configuration
@@ -124,21 +114,21 @@ The RedisEnterpriseDatabase (REDB) custom resource defines the database specific
124114
- **spec.shardCount**: Number of shards (affects performance and scalability)
125115
- **spec.replication**: Enable/disable database replication
126116
127-
### Customization options
117+
### Database customization options
128118
129119
Edit these values based on your requirements:
130120
131121
```yaml
132122
spec:
133123
# Increase memory for larger datasets
134124
memorySize: 1GB
135-
125+
136126
# Add more shards for better performance
137127
shardCount: 3
138-
128+
139129
# Enable replication for high availability
140130
replication: true
141-
131+
142132
# Add database-specific configuration
143133
redisEnterpriseConfiguration:
144134
# Enable specific Redis modules

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

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -43,30 +43,22 @@ Apply the YAML files in this order:
4343

4444
These resources are deployed in the namespace where the Redis Enterprise operator runs.
4545

46-
**File: `operator-service-account.yaml`**
47-
4846
{{<embed-md "k8s/service_account.md">}}
4947

5048
## Operator cluster role
5149

5250
The operator needs cluster-wide permissions to manage resources across namespaces.
5351

54-
**File: `operator-cluster-role.yaml`**
55-
5652
{{<embed-md "k8s/multi-ns_operator_cluster_role.md">}}
5753

5854
## Operator cluster role binding
5955

60-
**File: `operator-cluster-role-binding.yaml`**
61-
6256
{{<embed-md "k8s/multi-ns_operator_cluster_role_binding.md">}}
6357

6458
## Consumer service account
6559

6660
These resources are deployed in each namespace where you want to create Redis Enterprise clusters or databases.
6761

68-
**File: `consumer-service-account.yaml`**
69-
7062
```yaml
7163
apiVersion: v1
7264
kind: ServiceAccount
@@ -78,14 +70,10 @@ metadata:
7870
7971
## Consumer role
8072
81-
**File: `consumer-role.yaml`**
82-
8373
{{<embed-md "k8s/multi-ns_role.md">}}
8474
8575
## Consumer role binding
8676
87-
**File: `consumer-role-binding.yaml`**
88-
8977
{{<embed-md "k8s/multi-ns_role_binding.md">}}
9078
9179
### Consumer namespace configuration

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

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -39,16 +39,12 @@ Apply the YAML files in this order:
3939

4040
The service account for rack-aware deployments is the same as basic deployments.
4141

42-
**File: `service-account.yaml`**
43-
4442
{{<embed-md "k8s/service_account.md">}}
4543

4644
## Cluster role
4745

4846
Rack awareness requires additional permissions to read node labels across the cluster.
4947

50-
**File: `cluster-role.yaml`**
51-
5248
{{<embed-md "k8s/rack_aware_cluster_role.md">}}
5349

5450
### Cluster role configuration
@@ -66,8 +62,6 @@ Rack awareness requires additional permissions to read node labels across the cl
6662

6763
The ClusterRoleBinding grants cluster-wide permissions to the service account.
6864

69-
**File: `cluster-role-binding.yaml`**
70-
7165
{{<embed-md "k8s/rack_aware_cluster_role_binding.md">}}
7266

7367
### Cluster role binding configuration
@@ -80,8 +74,6 @@ The ClusterRoleBinding grants cluster-wide permissions to the service account.
8074

8175
The rack-aware REC configuration includes the `rackAwarenessNodeLabel` field.
8276

83-
**File: `rack-aware-cluster.yaml`**
84-
8577
{{<embed-md "k8s/rack_aware_rec.md">}}
8678

8779
### Rack-aware cluster configuration
@@ -135,8 +127,6 @@ kubectl get nodes -o custom-columns=NAME:.metadata.name,ZONE:.metadata.labels.'t
135127

136128
Database configuration for rack-aware clusters is the same as basic deployments.
137129

138-
**File: `redis-database.yaml`**
139-
140130
{{<embed-md "k8s/redb.md">}}
141131

142132
### Rack awareness benefits

0 commit comments

Comments
 (0)