K8s: Add YAML examples #1872

kaitlynmichael · 2025-07-24T19:30:05Z

I've added a YAML examples section to the Reference section. These are pulled directly from the example files in the redis-enterprise-k8s-docs repo with each release, so they will always be up to date. Each YAML example can be copied or downloaded with the buttons in the top right corner. Longer files scroll to avoid taking up the entire page.

This PR includes a new shortcode: embed-yaml

DOC-3998
DOC-4725

…ocumentation - Created new YAML examples subsection in content/operate/kubernetes/reference/yaml-examples/ - Added 4 dedicated example pages for different deployment scenarios: * basic-deployment.md - Essential YAML files for simple Redis Enterprise deployment * rack-awareness.md - YAML examples for rack-aware deployments across availability zones * active-active.md - YAML examples for Active-Active databases across multiple clusters * multi-namespace.md - YAML examples for deploying across multiple namespaces - Added log-collector-rbac.md to logs section with RBAC configurations for restricted and all collection modes - Each YAML example is in its own linkable subsection for direct referencing - Updated reference index to include new YAML examples subsection - Updated logs index to include log collector RBAC documentation - All pages include complete YAML examples using existing embed files from content/embeds/k8s/ - Provides step-by-step instructions, configuration explanations, and troubleshooting guidance - Cross-referenced with relevant API documentation and guides

- Updated log collector RBAC page weight from 20 to 90 - Ensures 'Collect logs' (weight 89) appears before 'Log collector RBAC' (weight 90) in navigation

- Link 'restricted' mode to #restricted-mode-rbac section - Link 'all' mode to #all-mode-rbac section - Add RBAC requirements section with link to complete YAML configurations - Improves navigation between log collection guide and RBAC setup

- 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

- Removed log collector RBAC page from YAML examples section - Reverted logs section index to remove log collector RBAC reference - Reverted collect-logs.md to remove links to log collector RBAC page - DOC-4727 now focuses purely on YAML examples for deployment scenarios - Log collector documentation moved to DOC-5485 branch where it belongs thematically

github-actions · 2025-07-24T19:30:22Z

andy-stark-redis

I've made a few suggestions, but the main text is basically really good. However, there are quite a few broken links that you should fix and check.

Regarding the embed-yaml shortcode, Cameron added something very similar recently (scrollable-code which is used, for example here). It might be better to use scrollable-code or modify it, unless you have further yaml-specific ideas for your shortcode.

andy-stark-redis · 2025-07-25T08:26:36Z

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

+```
+### Namespace requirements
+
+The Role and RoleBinding must be created in every namespace where you need to collect logs:


"You must create" to avoid PV?

andy-stark-redis · 2025-07-25T08:36:47Z

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

+
+## All mode
+
+The all mode configuration provides comprehensive permissions for collecting detailed cluster information.


Nothing major, but I'm just wondering if there's an easy way to add italics or code style or something to "all" when it's used as the mode name (and I guess you would do the same for "restricted" for consistency)? For example, later in the page you say "Consider switching to all mode..." and it took me a second reading to get what it meant.

andy-stark-redis · 2025-07-25T08:43:36Z

content/operate/kubernetes/reference/_index.md


-**Important:** Always delete databases (REDB) before deleting the cluster (REC) to ensure proper cleanup.
+- [Basic deployment]({{< relref "/operate/kubernetes/reference/yaml-examples/basic-deployment" >}}) - Essential YAML files for simple Redis Enterprise deployment


These are all dead links. I think the /yaml-examples/ bit should be just /yaml/, unless you're planning to rename the folder in a future commit?

Suggested change

- [Basic deployment]({{< relref "/operate/kubernetes/reference/yaml-examples/basic-deployment" >}}) - Essential YAML files for simple Redis Enterprise deployment

- [Basic deployment]({{< relref "/operate/kubernetes/reference/yaml/basic-deployment" >}}) - Essential YAML files for simple Redis Enterprise deployment

andy-stark-redis · 2025-07-25T08:46:21Z

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

+- Create `RedisEnterpriseDatabase` (REDB) resources within a cluster to provision individual databases
+- Use `RedisEnterpriseActiveActiveDatabase` (REAADB) with `RedisEnterpriseRemoteCluster (RERC)` resources to define participating clusters
+
+For complete YAML configuration examples, see the [YAML examples](../yaml/) section.


Should be a relref.

Suggested change

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

For complete YAML configuration examples, see the [YAML examples]({{< relref "/operate/kubernetes/reference/yaml/" >}}) section.

andy-stark-redis · 2025-07-25T08:49:14Z

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

+weight: 85
+---
+
+This section provides complete YAML examples for common Redis Enterprise for Kubernetes deployment scenarios. Each example includes the necessary configuration files and step-by-step instructions for editing and applying them.


The first "for" reacts badly with the one in the product name.

Suggested change

This section provides complete YAML examples for common Redis Enterprise for Kubernetes deployment scenarios. Each example includes the necessary configuration files and step-by-step instructions for editing and applying them.

This section provides complete YAML examples that cover common Redis Enterprise for Kubernetes deployment scenarios. Each example includes the necessary configuration files and step-by-step instructions for editing and applying them.

andy-stark-redis · 2025-07-25T09:17:26Z

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

+weight: 20
+---
+
+This page provides YAML examples for deploying Redis Enterprise with [rack awareness]({{< relref "/operate/kubernetes/architecture/operator-architecture#rack-awareness" >}}). Rack awareness distributes Redis Enterprise nodes across different availability zones or failure domains to improve high availability and fault tolerance.


Dead link (presumably, this page is yet to be added, but I thought I'd check).

andy-stark-redis · 2025-07-25T09:18:27Z

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

+
+## Service account
+
+The service account for rack-aware deployments is the same as [basic deployments]({{< relref "/operate/kubernetes/reference/yaml-examples/basic-deployment#service-account" >}}).


Suggested change

The service account for rack-aware deployments is the same as [basic deployments]({{< relref "/operate/kubernetes/reference/yaml-examples/basic-deployment#service-account" >}}).

The service account for rack-aware deployments is the same as for [basic deployments]({{< relref "/operate/kubernetes/reference/yaml-examples/basic-deployment#service-account" >}}).

andy-stark-redis · 2025-07-25T09:25:43Z

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

+
+## Rack-aware Redis Enterprise cluster
+
+The rack-aware [REC configuration]({{< relref "/operate/kubernetes/reference/redis_enterprise_cluster_api" >}}) includes the `rackAwarenessNodeLabel` field.


Missing the new /api/ folder.

Suggested change

The rack-aware [REC configuration]({{< relref "/operate/kubernetes/reference/redis_enterprise_cluster_api" >}}) includes the `rackAwarenessNodeLabel` field.

The rack-aware [REC configuration]({{< relref "/operate/kubernetes/reference/api/redis_enterprise_cluster_api" >}}) includes the `rackAwarenessNodeLabel` field.

andy-stark-redis · 2025-07-25T09:27:04Z

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

+
+## Redis Enterprise database
+
+Database configuration for rack-aware clusters is the same as [basic deployments]({{< relref "/operate/kubernetes/reference/yaml-examples/basic-deployment#redis-enterprise-database" >}}).


Suggested change

Database configuration for rack-aware clusters is the same as [basic deployments]({{< relref "/operate/kubernetes/reference/yaml-examples/basic-deployment#redis-enterprise-database" >}}).

Database configuration for rack-aware clusters is the same as [basic deployments]({{< relref "/operate/kubernetes/reference/yaml/basic-deployment#redis-enterprise-database" >}}).

andy-stark-redis · 2025-07-25T09:28:49Z

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

+
+## Next steps
+
+- [Configure Active-Active databases]({{< relref "/operate/kubernetes/reference/yaml-examples/active-active" >}})


Several dodgy links below, either using yaml-examples instead of yaml or missing the api folder.

zcahana · 2025-07-27T07:16:41Z

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

+# Apply multiple files
+kubectl apply -f rbac/ -f cluster/ -f database/
+
+# Apply with validation


This comment might incorrectly imply that the previous apply forms don't employ validation, and this one does, in addition to persistently applying the configuration in the manifest. The reality is kinda the opposite: all of these commands employ validation (both client- and server-side), and the last one only does client-side validation and doesn't actually apply the objects.

Hence, consider a comment in the likes of:

# Validate files without actually applying

zcahana · 2025-07-27T07:19:55Z

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

+
+## Best practices
+
+- Validate syntax: Use `kubectl apply --dry-run=client` to check YAML syntax before applying


This indeed checks YAML syntax, but goes beyond that: it also validates the YAML objects with the schema for that object kind.

zcahana · 2025-07-27T07:24:35Z

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

+
+This example shows:
+- Operator namespace: `redis-enterprise-operator` (where the operator runs)
+- Consumer namespaces: `app-production`, `app-staging` (where REC/REDB resources are created)


Only REDBs are created in these separate namespaces; the REC lives in the operator's namespace.

zcahana · 2025-07-27T07:27:24Z

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

+weight: 20
+---
+
+This page provides YAML examples for deploying Redis Enterprise with [rack awareness]({{< relref "/operate/kubernetes/architecture/operator-architecture#rack-awareness" >}}). Rack awareness distributes Redis Enterprise nodes across different availability zones or failure domains to improve high availability and fault tolerance.


Suggested change

This page provides YAML examples for deploying Redis Enterprise with [rack awareness]({{< relref "/operate/kubernetes/architecture/operator-architecture#rack-awareness" >}}). Rack awareness distributes Redis Enterprise nodes across different availability zones or failure domains to improve high availability and fault tolerance.

This page provides YAML examples for deploying Redis Enterprise with [rack awareness]({{< relref "/operate/kubernetes/architecture/operator-architecture#rack-awareness" >}}). Rack awareness distributes Redis Enterprise nodes and database shards across different availability zones or failure domains to improve high availability and fault tolerance.

May want to mention the effect on databases too, which I guess is the more important aspect for most users.

zcahana · 2025-07-27T07:33:12Z

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

+
+### Database shards not distributed
+- Confirm the cluster has rack awareness enabled
+- Check that the database has multiple shards


The rack awareness feature in the cluster distributes primary/replica across zones, but not necessarily different (primary) shards. Perhaps the instruction here should be to check that the database has replication enabled.

zcahana · 2025-07-27T07:46:49Z

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

This file duplicates the one in logs/log-collect-rbac.md (though with minor diff's). I guess we should pick only one?

zcahana · 2025-07-27T07:49:22Z

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

+
+## Apply the configuration
+
+### Manual deployment


These instructions only mention the roles, but it could also be useful to clarify that these roles should be bound (via RoleBindings) to the user subject that will execute the log collector.

kaitlynmichael added 7 commits July 24, 2025 13:23

Fix navigation order in logs section

847ed14

- Updated log collector RBAC page weight from 20 to 90 - Ensures 'Collect logs' (weight 89) appears before 'Log collector RBAC' (weight 90) in navigation

edits

5c369ef

Add log-collector-rbac.md with RBAC configurations

6f9c84d

kaitlynmichael self-assigned this Jul 24, 2025

kaitlynmichael added do not merge yet k8s labels Jul 24, 2025

kaitlynmichael added 9 commits July 24, 2025 15:00

api section

9683c0e

copy edits

acbfaf1

download button

37caa05

deployment links

f7daf5c

copy edits

3d1f5c5

fix download button

ba19a2f

download button adjustments

7a262d6

formatting cleanup

a538390

active voice edits

793f6d4

kaitlynmichael requested review from oshribr, yuvallevy2, a team and shreyaverma-git and removed request for oshribr July 24, 2025 21:17

kaitlynmichael marked this pull request as ready for review July 24, 2025 21:29

andy-stark-redis requested changes Jul 25, 2025

View reviewed changes

zcahana reviewed Jul 27, 2025

View reviewed changes


		## All mode

		The all mode configuration provides comprehensive permissions for collecting detailed cluster information.


		Important: Always delete databases (REDB) before deleting the cluster (REC) to ensure proper cleanup.
		- [Basic deployment]({{< relref "/operate/kubernetes/reference/yaml-examples/basic-deployment" >}}) - Essential YAML files for simple Redis Enterprise deployment

	For complete YAML configuration examples, see the [YAML examples](../yaml/) section.
	For complete YAML configuration examples, see the [YAML examples]({{< relref "/operate/kubernetes/reference/yaml/" >}}) section.

	This section provides complete YAML examples for common Redis Enterprise for Kubernetes deployment scenarios. Each example includes the necessary configuration files and step-by-step instructions for editing and applying them.
	This section provides complete YAML examples that cover common Redis Enterprise for Kubernetes deployment scenarios. Each example includes the necessary configuration files and step-by-step instructions for editing and applying them.


		## Service account

		The service account for rack-aware deployments is the same as [basic deployments]({{< relref "/operate/kubernetes/reference/yaml-examples/basic-deployment#service-account" >}}).


		## Rack-aware Redis Enterprise cluster

		The rack-aware [REC configuration]({{< relref "/operate/kubernetes/reference/redis_enterprise_cluster_api" >}}) includes the `rackAwarenessNodeLabel` field.


		## Redis Enterprise database

		Database configuration for rack-aware clusters is the same as [basic deployments]({{< relref "/operate/kubernetes/reference/yaml-examples/basic-deployment#redis-enterprise-database" >}}).


		## Next steps

		- [Configure Active-Active databases]({{< relref "/operate/kubernetes/reference/yaml-examples/active-active" >}})


		## Best practices

		- Validate syntax: Use `kubectl apply --dry-run=client` to check YAML syntax before applying

	This page provides YAML examples for deploying Redis Enterprise with [rack awareness]({{< relref "/operate/kubernetes/architecture/operator-architecture#rack-awareness" >}}). Rack awareness distributes Redis Enterprise nodes across different availability zones or failure domains to improve high availability and fault tolerance.
	This page provides YAML examples for deploying Redis Enterprise with [rack awareness]({{< relref "/operate/kubernetes/architecture/operator-architecture#rack-awareness" >}}). Rack awareness distributes Redis Enterprise nodes and database shards across different availability zones or failure domains to improve high availability and fault tolerance.

K8s: Add YAML examples #1872

Are you sure you want to change the base?

K8s: Add YAML examples #1872

Conversation

kaitlynmichael commented Jul 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jul 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

andy-stark-redis left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

kaitlynmichael commented Jul 24, 2025 •

edited

Loading

github-actions bot commented Jul 24, 2025 •

edited

Loading