Skip to content

K8s: Add YAML examples #1872

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 64 commits into from
Jul 29, 2025
Merged

K8s: Add YAML examples #1872

merged 64 commits into from
Jul 29, 2025

Conversation

kaitlynmichael
Copy link
Contributor

@kaitlynmichael kaitlynmichael commented Jul 24, 2025 •
edited
Loading

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

Preview:
https://redis.io/docs/staging/DOC-4727/operate/kubernetes/reference/
https://redis.io/docs/staging/DOC-4727/operate/kubernetes/reference/yaml/

@kaitlynmichael
Add comprehensive YAML examples subsection for Kubernetes reference d…
f64f63f 
…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
@kaitlynmichael
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
@kaitlynmichael
Add links to YAML examples in log collector documentation
9b4d5e9 
- 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
@kaitlynmichael
Remove unnecessary 'File:' labels from YAML examples
0d8da15 
- 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
@kaitlynmichael
Move log collector changes to DOC-5485 branch
2443841 
- 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
@kaitlynmichael
edits
5c369ef
@kaitlynmichael
Add log-collector-rbac.md with RBAC configurations
6f9c84d
@kaitlynmichael kaitlynmichael self-assigned this Jul 24, 2025
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jul 24, 2025 •
edited
Loading

Staging links:
https://redis.io/docs/staging/DOC-4727/apis/
https://redis.io/docs/staging/DOC-4727/commands/cf.exists
https://redis.io/docs/staging/DOC-4727/commands/cms.info
https://redis.io/docs/staging/DOC-4727/commands/cms.query
https://redis.io/docs/staging/DOC-4727/commands/ft._list
https://redis.io/docs/staging/DOC-4727/commands/ft.aggregate
https://redis.io/docs/staging/DOC-4727/commands/ft.aliasadd
https://redis.io/docs/staging/DOC-4727/commands/ft.aliasdel
https://redis.io/docs/staging/DOC-4727/commands/ft.aliasupdate
https://redis.io/docs/staging/DOC-4727/commands/ft.alter
https://redis.io/docs/staging/DOC-4727/commands/ft.config-get
https://redis.io/docs/staging/DOC-4727/commands/ft.config-help
https://redis.io/docs/staging/DOC-4727/commands/ft.config-set
https://redis.io/docs/staging/DOC-4727/commands/ft.create
https://redis.io/docs/staging/DOC-4727/commands/ft.cursor-del
https://redis.io/docs/staging/DOC-4727/commands/ft.cursor-read
https://redis.io/docs/staging/DOC-4727/commands/ft.dictadd
https://redis.io/docs/staging/DOC-4727/commands/ft.dictdel
https://redis.io/docs/staging/DOC-4727/commands/ft.dictdump
https://redis.io/docs/staging/DOC-4727/commands/ft.drop
https://redis.io/docs/staging/DOC-4727/commands/ft.explain
https://redis.io/docs/staging/DOC-4727/commands/ft.explaincli
https://redis.io/docs/staging/DOC-4727/commands/ft.info
https://redis.io/docs/staging/DOC-4727/commands/ft.profile
https://redis.io/docs/staging/DOC-4727/commands/ft.search

@kaitlynmichael kaitlynmichael requested review from oshribr, yuvallevy2, a team and shreyaverma-git and removed request for oshribr July 24, 2025 21:17
@kaitlynmichael kaitlynmichael marked this pull request as ready for review July 24, 2025 21:29
andy-stark-redis
andy-stark-redis previously requested changes Jul 25, 2025
View reviewed changes
Copy link
Contributor

@andy-stark-redis andy-stark-redis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

zcahana
zcahana reviewed Jul 27, 2025
View reviewed changes
kaitlynmichael and others added 2 commits July 28, 2025 12:42
@kaitlynmichael @andy-stark-redis
Update content/operate/kubernetes/reference/_index.md
e1e97fd 
Co-authored-by: andy-stark-redis <164213578+andy-stark-redis@users.noreply.github.com>
@kaitlynmichael @andy-stark-redis
Update content/operate/kubernetes/reference/yaml/_index.md
0bc65c4 
Co-authored-by: andy-stark-redis <164213578+andy-stark-redis@users.noreply.github.com>
dwdougherty and others added 21 commits July 29, 2025 13:37
@dwdougherty @kaitlynmichael
DEV: add RESP2/3 return information to the JSON commands (#1878)
e2251e8
@dwdougherty @kaitlynmichael
DEV: a better explanation for the XCLAIM RETRYCOUNT option (#1883)
a28321d
@paoloredis @kaitlynmichael
Upload versioned products to different paths for cloud connector (#1888)
ef14a9d 
* Upload versioned products to different paths for cloud connector

* Only upload version folder
@maayanagranat @kaitlynmichael
Update rs-prometheus-metrics-v2.md (#1890)
d2f00b5
@andy-stark-redis @kaitlynmichael
DOC-5503 David's local examples build
58d3507
@andy-stark-redis @kaitlynmichael
DOC-5503 New param to override default tab name
3c1d721
@andy-stark-redis @kaitlynmichael
DOC-5503 allow custom name and link for first tab
d4bfda2
@andy-stark-redis @kaitlynmichael
DOC-5503 hide GitHub icon when example is local
69900ec
@andy-stark-redis @kaitlynmichael
DOC-5503 deleted test files
c0141e9
@andy-stark-redis @kaitlynmichael
DOC-5510 added temporary data type examples
f9c4fe2
@andy-stark-redis @kaitlynmichael
DOC-5510 local C# client-specific examples
d16e8b2
@andy-stark-redis @kaitlynmichael
DOC-5510 Python and Jedis probabilistic examples
2518df3
@maayanagranat @rrelledge @kaitlynmichael
Update rs-prometheus-metrics-v2.md (#1887)
74c86c2 
* Update rs-prometheus-metrics-v2.md

Remove redundant metrics

* Marked redis_server_db0_avg_ttl and redis_server_db0_keys metrics as deprecated

---------

Co-authored-by: Rachel Elledge <rachel.elledge@redislabs.com>
@rrelledge @kaitlynmichael
DOC-3222 RS: Clarified formula and examples for disk sizing for heavy…
b5ff4b7 
… write scenarios (#1790)
@rrelledge @kaitlynmichael
RS 7.22.0 July maintenance release notes (#1844)
edab195 
* DOC-5468 RS 7.22.0 July maintenance release notes

* DOC-5481 Copied CVE-2025-32023 fix to the RS 7.22.0 July maintenance release notes

* DOC-5468 Added another resolved issue to RS 7.22 July maintenance release notes

* DOC-5468 Added build number to RS 7.22 July release notes

* DOC-5468 Added checksums to RS 7.22 July release notes
@mich-elle-luna @kaitlynmichael
remove link to downloads page
1f7674b
@mich-elle-luna @kaitlynmichael
Update apt.md
594e8b5
@mich-elle-luna @kaitlynmichael
Add 8 new notebook links to AI notebook collection
35be4c7 
- Added data type optimization notebook for vector indices
- Added RBAC policy implementation for RAG systems
- Added full-featured agent architecture notebook
- Added semantic cache optimization notebook
- Added semantic routing examples notebook
- Added router configuration optimization notebook
- Added two towers recommendation system notebook
- Added feature store implementation notebook

Organized notebooks by category and added new categories for Semantic Cache, Semantic Router, and Feature Store.
@mich-elle-luna @dwdougherty @kaitlynmichael
Update content/develop/ai/notebook-collection.md
b983e61 
Co-authored-by: David Dougherty <david.dougherty@redis.com>
@mich-elle-luna @dwdougherty @kaitlynmichael
Update content/develop/ai/notebook-collection.md
5c1c419 
Co-authored-by: David Dougherty <david.dougherty@redis.com>
@mich-elle-luna @dwdougherty @kaitlynmichael
Update content/develop/ai/notebook-collection.md
fd3b087 
Co-authored-by: David Dougherty <david.dougherty@redis.com>
@kaitlynmichael kaitlynmichael requested review from a team and zcahana and removed request for zcahana July 29, 2025 18:41
@kaitlynmichael kaitlynmichael added enhancement New feature or request and removed do not merge yet labels Jul 29, 2025
@kaitlynmichael kaitlynmichael merged commit 445c679 into main Jul 29, 2025
5 checks passed
@kaitlynmichael kaitlynmichael deleted the DOC-4727 branch July 29, 2025 20:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dwdougherty dwdougherty dwdougherty approved these changes

@yuvallevy2 yuvallevy2 Awaiting requested review from yuvallevy2

@shreyaverma-git shreyaverma-git Awaiting requested review from shreyaverma-git

@andy-stark-redis andy-stark-redis Awaiting requested review from andy-stark-redis

@zcahana zcahana Awaiting requested review from zcahana

Assignees

@kaitlynmichael kaitlynmichael

Labels
enhancement New feature or request k8s
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
9 participants
@kaitlynmichael @dwdougherty @zcahana @andy-stark-redis @cmilesb @paoloredis @maayanagranat @rrelledge @mich-elle-luna