Skip to content

Commit 445c679

Browse files
K8s: Add YAML examples (#1872)
* Add comprehensive YAML examples subsection for Kubernetes reference documentation - 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 * Fix navigation order in logs section - Updated log collector RBAC page weight from 20 to 90 - Ensures 'Collect logs' (weight 89) appears before 'Log collector RBAC' (weight 90) in navigation * Add links to YAML examples in log collector documentation - 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 * 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 * Move log collector changes to DOC-5485 branch - 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 * edits * Add log-collector-rbac.md with RBAC configurations * api section * copy edits * download button * deployment links * copy edits * fix download button * download button adjustments * formatting cleanup * active voice edits * Update content/operate/kubernetes/reference/_index.md
1 parent 0b0e0ee commit 445c679

Some content is hidden

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

46 files changed

+988
-102
lines changed

assets/css/index.css

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -521,6 +521,41 @@ select {
521521
@apply w-10 h-10;
522522
}
523523

524+
/* YAML embed download button styles */
525+
.download-yaml-btn {
526+
@apply transition-colors;
527+
}
528+
529+
.download-yaml-btn:disabled {
530+
@apply opacity-75 cursor-not-allowed;
531+
}
532+
533+
.download-yaml-btn svg {
534+
@apply w-4 h-4;
535+
}
536+
537+
/* Make long code blocks scrollable */
538+
.yaml-embed-container .highlight {
539+
max-height: 800px;
540+
overflow-y: auto;
541+
}
542+
543+
.yaml-embed-container .highlight::-webkit-scrollbar {
544+
width: 8px;
545+
}
546+
547+
.yaml-embed-container .highlight::-webkit-scrollbar-track {
548+
@apply bg-slate-700 rounded;
549+
}
550+
551+
.yaml-embed-container .highlight::-webkit-scrollbar-thumb {
552+
@apply bg-slate-500 rounded;
553+
}
554+
555+
.yaml-embed-container .highlight::-webkit-scrollbar-thumb:hover {
556+
@apply bg-slate-400;
557+
}
558+
524559
#download-redis > h3,
525560
#download-redis-stack > h3 {
526561
@apply mt-2;

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]({{<relref "/operate/kubernetes/reference/redis_enterprise_cluster_api">}})
64-
- [Redis Enterprise Database API]({{<relref "/operate/kubernetes/reference/redis_enterprise_database_api">}})
63+
- [Redis Enterprise Cluster API]({{<relref "/operate/kubernetes/reference/api/redis_enterprise_cluster_api">}})
64+
- [Redis Enterprise Database API]({{<relref "/operate/kubernetes/reference/api/redis_enterprise_database_api">}})

content/operate/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ hideListLinks: true
2727
| Redis Flex/Auto tiering | [Create a Redis Flex database]({{< relref "/operate/rc/databases/create-database/create-flex-database" >}}) | [Auto Tiering]({{<relref "/operate/rs/databases/auto-tiering">}}) | | [Auto Tiering]({{<relref "/operate/kubernetes/re-clusters/auto-tiering/">}}) |
2828
| Persistence | [Data persistence]({{< relref "/operate/rc/databases/configuration/data-persistence" >}}) | [Persistence]({{<relref "/operate/rs/databases/configure/database-persistence">}}) | [Persistence]({{< relref "/operate/oss_and_stack/management/replication" >}}) | [Persistence volumes]({{<relref "/operate/kubernetes/recommendations/persistent-volumes/">}})|
2929
| Recovery | Automatic | [Recover cluster]({{<relref "/operate/rs/clusters/cluster-recovery">}}) | [Manual failover]({{< relref "/operate/oss_and_stack/management/scaling#manual-failover" >}}) | [Cluster recovery]({{<relref "/operate/kubernetes/re-clusters/cluster-recovery/">}}) |
30-
| Backups | [Back up a database]({{< relref "/operate/rc/databases/back-up-data" >}}) | [Schedule backups]({{<relref "/operate/rs/databases/import-export/schedule-backups">}}) | [Persistence]({{< relref "/operate/oss_and_stack/management/replication" >}}) | [REDB spec.backup]({{<relref "/operate/kubernetes/reference/redis_enterprise_database_api/#specbackup">}}) |
30+
| Backups | [Back up a database]({{< relref "/operate/rc/databases/back-up-data" >}}) | [Schedule backups]({{<relref "/operate/rs/databases/import-export/schedule-backups">}}) | [Persistence]({{< relref "/operate/oss_and_stack/management/replication" >}}) | [REDB spec.backup]({{<relref "/operate/kubernetes/reference/api/redis_enterprise_database_api/#specbackup">}}) |
3131

3232
### Logging and monitoring
3333

@@ -36,15 +36,15 @@ hideListLinks: true
3636
|:-----------|:--------------|:-----------|:--------------|:--------------|
3737
| Monitoring | [Monitor performance]({{< relref "/operate/rc/databases/monitor-performance" >}}) | [Monitoring]({{<relref "/operate/rs/monitoring">}}) | [INFO]({{< relref "/commands/info" >}}), [MONITOR]({{< relref "/commands/monitor" >}}), and [LATENCY DOCTOR]({{< relref "/commands/latency-doctor" >}})<br/>[Analysis with Redis Insight]({{< relref "/develop/tools/insight#database-analysis" >}}) | [Export metrics to Prometheus]({{<relref "/operate/kubernetes/re-clusters/connect-prometheus-operator/">}}) |
3838
| Logging | [System logs]({{< relref "/operate/rc/logs-reports/system-logs" >}}) | [Logging]({{<relref "/operate/rs/clusters/logging">}}) | `/var/log/redis/redis.log`<br/>[SLOWLOG]({{< relref "/commands/slowlog" >}})<br/>[Keyspace notifications]({{< relref "/develop/pubsub/keyspace-notifications" >}}) | [Logs]({{<relref "/operate/kubernetes/logs/">}}) |
39-
| Alerts | [Alerts]({{< relref "/operate/rc/databases/view-edit-database#alerts-section" >}}) | [Alerts and events]({{<relref "/operate/rs/clusters/logging/alerts-events">}}) | [Pub/sub with Redis Sentinel]({{< relref "/operate/oss_and_stack/management/sentinel#pubsub-messages" >}}) | [REDB alertSettings]({{<relref "/operate/kubernetes/reference/redis_enterprise_database_api/#specalertsettings">}}) |
39+
| Alerts | [Alerts]({{< relref "/operate/rc/databases/view-edit-database#alerts-section" >}}) | [Alerts and events]({{<relref "/operate/rs/clusters/logging/alerts-events">}}) | [Pub/sub with Redis Sentinel]({{< relref "/operate/oss_and_stack/management/sentinel#pubsub-messages" >}}) | [REDB alertSettings]({{<relref "/operate/kubernetes/reference/api/redis_enterprise_database_api/#specalertsettings">}}) |
4040
| Support | [Contact support](https://redis.io/support/) | [Create support package]({{<relref "/operate/rs/installing-upgrading/creating-support-package">}}) | | [Contact support](https://redis.io/support/) |
4141

4242
### Security
4343

4444
<!-- | Feature | RC | RS | Open Source | K8s | -->
4545
| | <nobr>{{<color-bubble color="bg-blue-bubble" >}} Redis</nobr> Cloud | <nobr>{{<color-bubble color="bg-yellow-bubble">}} Redis</nobr> Software | <nobr>{{<color-bubble color="bg-purple-bubble">}} Redis</nobr> Open Source | <nobr><div class="h-3 w-3 rounded-md border border-redis-pen-600 inline-block mr-1" style="background-color: #8A99A0"></div> Redis for</nobr> Kubernetes |
4646
|:-----------|:--------------|:-----------|:--------------|:--------------|
47-
| Transport Layer Security (TLS) | [TLS]({{<relref "/operate/rc/security/database-security/tls-ssl">}}) | [TLS]({{<relref "/operate/rs/security/encryption/tls">}}) | [TLS]({{< relref "/operate/oss_and_stack/management/security/encryption" >}}) | [REDB tlsMode]({{<relref "/operate/kubernetes/reference/redis_enterprise_database_api/#spec">}}) |
47+
| Transport Layer Security (TLS) | [TLS]({{<relref "/operate/rc/security/database-security/tls-ssl">}}) | [TLS]({{<relref "/operate/rs/security/encryption/tls">}}) | [TLS]({{< relref "/operate/oss_and_stack/management/security/encryption" >}}) | [REDB tlsMode]({{<relref "/operate/kubernetes/reference/api/redis_enterprise_database_api/#spec">}}) |
4848
| Role-based access control (RBAC) | [Role-based access control]({{<relref "/operate/rc/security/access-control/data-access-control/role-based-access-control">}}) | [Access control]({{<relref "/operate/rs/security/access-control">}}) | [Access control list]({{< relref "/operate/oss_and_stack/management/security/acl" >}}) | [REC credentials]({{<relref "/operate/kubernetes/security/manage-rec-credentials/">}}) |
4949
| Lightweight Directory Access Protocol (LDAP) | | [LDAP authentication]({{<relref "/operate/rs/security/access-control/ldap">}}) | | [Enable LDAP]({{<relref "/operate/kubernetes/security/ldap/">}}) |
5050
| Single sign-on (SSO) | [SAML SSO]({{< relref "/operate/rc/security/access-control/saml-sso" >}}) | | | |

content/operate/kubernetes/7.8.4/re-databases/replica-redb.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ url: '/operate/kubernetes/7.8.4/re-databases/replica-redb/'
1212
---
1313

1414
You can configure a replica of a database by creating an item in
15-
the [`replicaSources`]({{< relref "/operate/kubernetes/reference/redis_enterprise_database_api#specreplicasources" >}}) section of the RedisEnterpriseDatabase (REDB) custom resource.
15+
the [`replicaSources`]({{< relref "/operate/kubernetes/reference/api/redis_enterprise_database_api#specreplicasources" >}}) section of the RedisEnterpriseDatabase (REDB) custom resource.
1616

1717
A secret must be created with the `stringData` section containing the replica source URI as follows:
1818

content/operate/kubernetes/7.8.6/re-databases/replica-redb.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ url: '/operate/kubernetes/7.8.6/re-databases/replica-redb/'
1212
---
1313

1414
You can configure a replica of a database by creating an item in
15-
the [`replicaSources`]({{< relref "/operate/kubernetes/reference/redis_enterprise_database_api#specreplicasources" >}}) section of the RedisEnterpriseDatabase (REDB)custom resource.
15+
the [`replicaSources`]({{< relref "/operate/kubernetes/reference/api/redis_enterprise_database_api#specreplicasources" >}}) section of the RedisEnterpriseDatabase (REDB)custom resource.
1616

1717
A secret must be created with the `stringData` section containing the replica source URI as follows:
1818

content/operate/kubernetes/_index.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -41,15 +41,15 @@ Create and manage [Redis Enterprise clusters]({{< relref "/operate/kubernetes/re
4141
- [Auto Tiering]({{< relref "/operate/kubernetes/re-clusters/auto-tiering" >}})
4242
- [Multi-namespace deployment]({{< relref "/operate/kubernetes/re-clusters/multi-namespace" >}})
4343
- [Cluster recovery]({{< relref "/operate/kubernetes/re-clusters/cluster-recovery" >}})
44-
- [REC API reference]({{< relref "/operate/kubernetes/reference/redis_enterprise_cluster_api" >}})
44+
- [REC API reference]({{< relref "/operate/kubernetes/reference/api/redis_enterprise_cluster_api" >}})
4545

4646
## Redis Enterprise databases (REDB)
4747

4848
Create and manage [Redis Enterprise databases]({{< relref "/operate/kubernetes/re-databases" >}}) using Kubernetes resources.
4949

5050
- [Database controller]({{< relref "/operate/kubernetes/re-databases/db-controller" >}})
5151
- [Create replica databases]({{< relref "/operate/kubernetes/re-databases/replica-redb" >}})
52-
- [REDB API reference]({{< relref "/operate/kubernetes/reference/redis_enterprise_database_api" >}})
52+
- [REDB API reference]({{< relref "/operate/kubernetes/reference/api/redis_enterprise_database_api" >}})
5353

5454
## Active-Active databases
5555

@@ -58,8 +58,8 @@ Set up globally distributed [Active-Active databases]({{< relref "/operate/kuber
5858
- [Prepare participating clusters]({{< relref "/operate/kubernetes/active-active/prepare-clusters" >}})
5959
- [Create Active-Active database]({{< relref "/operate/kubernetes/active-active/create-reaadb" >}})
6060
- [Global configuration]({{< relref "/operate/kubernetes/active-active/global-config" >}})
61-
- [REAADB API reference]({{< relref "/operate/kubernetes/reference/redis_enterprise_active_active_database_api" >}})
62-
- [Remote cluster API reference]({{< relref "/operate/kubernetes/reference/redis_enterprise_remote_cluster_api" >}})
61+
- [REAADB API reference]({{< relref "/operate/kubernetes/reference/api/redis_enterprise_active_active_database_api" >}})
62+
- [Remote cluster API reference]({{< relref "/operate/kubernetes/reference/api/redis_enterprise_remote_cluster_api" >}})
6363

6464
## Security
6565

@@ -74,10 +74,10 @@ Manage [secure connections]({{< relref "/operate/kubernetes/security" >}}) and a
7474

7575
Use the Kubernetes API and command-line tools to manage your Redis Enterprise deployment.
7676

77-
- [Redis Enterprise cluster API (REC)]({{< relref "/operate/kubernetes/reference/redis_enterprise_cluster_api" >}})
78-
- [Redis Enterprise database API (REDB)]({{< relref "/operate/kubernetes/reference/redis_enterprise_database_api" >}})
79-
- [Active-Active database API (REAADB)]({{< relref "/operate/kubernetes/reference/redis_enterprise_active_active_database_api" >}})
80-
- [Remote cluster API (RERC)]({{< relref "/operate/kubernetes/reference/redis_enterprise_remote_cluster_api" >}})
77+
- [Redis Enterprise cluster API (REC)]({{< relref "/operate/kubernetes/reference/api/redis_enterprise_cluster_api" >}})
78+
- [Redis Enterprise database API (REDB)]({{< relref "/operate/kubernetes/reference/api/redis_enterprise_database_api" >}})
79+
- [Active-Active database API (REAADB)]({{< relref "/operate/kubernetes/reference/api/redis_enterprise_active_active_database_api" >}})
80+
- [Remote cluster API (RERC)]({{< relref "/operate/kubernetes/reference/api/redis_enterprise_remote_cluster_api" >}})
8181

8282
## Logs & monitoring
8383

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,13 +77,13 @@ If you are using a preview version of these features (operator version 6.4.2-4 o
7777
7878
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.
7979
80-
For a full list of fields and options, see the [REAADB API reference]({{<relref "/operate/kubernetes/reference/redis_enterprise_active_active_database_api">}}).
80+
For a full list of fields and options, see the [REAADB API reference]({{<relref "/operate/kubernetes/reference/api/redis_enterprise_active_active_database_api">}}).
8181
8282
### RERC custom resource
8383
8484
Redis Enterprise remote cluster (RERC) custom resource contains configuration details for all the participating clusters.
8585
86-
For a full list of fields and options, see the [RERC API reference]({{<relref "/operate/kubernetes/reference/redis_enterprise_remote_cluster_api">}}).
86+
For a full list of fields and options, see the [RERC API reference]({{<relref "/operate/kubernetes/reference/api/redis_enterprise_remote_cluster_api">}}).
8787
8888
### Limitations
8989

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ This process consists of:
2727
Before creating Active-Active databases, you'll need admin access to two or more working Kubernetes clusters that each have:
2828

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

3333
{{<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>}}

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]({{<relref "/operate/kubernetes/reference/redis_enterprise_remote_cluster_api">}}).
72+
For more details on RERC fields, see the [RERC API reference]({{<relref "/operate/kubernetes/reference/api/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]({{<relref "/operate/kubernetes/reference/redis_enterprise_remote_cluster_api">}}).
126+
For more details on RERC fields, see the [RERC API reference]({{<relref "/operate/kubernetes/reference/api/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]({{<relref "/operate/kubernetes/reference/redis_enterprise_remote_cluster_api">}}).
19+
For more details, see the [RERC API reference]({{<relref "/operate/kubernetes/reference/api/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]({{<relref "/operate/kubernetes/reference/redis_enterprise_remote_cluster_api">}}).
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/api/redis_enterprise_remote_cluster_api">}}).
2424

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

0 commit comments

Comments
 (0)