Skip to content

docs(memcached): sync template standards updates#358

Open
mberlofa wants to merge 2 commits into
mainfrom
docs/memcached-template-standards-sync
Open

docs(memcached): sync template standards updates#358
mberlofa wants to merge 2 commits into
mainfrom
docs/memcached-template-standards-sync

Conversation

@mberlofa

@mberlofa mberlofa commented Jul 4, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Document networkPolicy.extraEgress for Memcached.
  • Add Memcached playground controls for custom egress CIDR and port.

Related

Validation

  • npm run lint
  • npm run format:check
  • npm run build
  • make site-sync-check CHART=memcached
  • make release-check REPO=site
  • make attribution-check REPO=site

Summary by CodeRabbit

  • New Features
    • Added new Network Policy options for the Memcached chart to configure additional outbound access using a custom CIDR and port.
    • Updated the Memcached chart documentation with an extraEgress example and a configuration reference entry describing how to append custom full egress rules.

@coderabbitai

coderabbitai Bot commented Jul 4, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: c583a85f-f9ed-420d-8e76-3e46c9b4c4ba

📥 Commits

Reviewing files that changed from the base of the PR and between ad54364 and 0f396e9.

📒 Files selected for processing (2)
  • src/data/playground-configs.ts
  • src/pages/docs/charts/memcached.mdx
✅ Files skipped from review due to trivial changes (1)
  • src/pages/docs/charts/memcached.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/data/playground-configs.ts

📝 Walkthrough

Walkthrough

Added two new configurable playground fields for the memcached chart's networkPolicy.egress.extraEgress[0] (CIDR and port), and updated the memcached chart documentation to include extraEgress in the deployment example and configuration reference table.

Changes

Memcached NetworkPolicy extraEgress

Layer / File(s) Summary
Playground config fields
src/data/playground-configs.ts
Added two field definitions under networkPolicy.egress.extraEgress[0]: an "Extra Egress CIDR" text field (default 10.80.0.0/16) and an "Extra Egress Port" numeric field (default 443).
Documentation update
src/pages/docs/charts/memcached.mdx
Added extraEgress: [] to the deployment example YAML and a new row in the Configuration Reference table documenting networkPolicy.egress.extraEgress.

Estimated code review effort: 1 (Trivial) | ~5 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title is related to the Memcached docs sync, but it is broader and less specific than the actual egress policy update.
Description check ✅ Passed The description includes a clear summary, related reference, and validation steps, with only minor template mismatches versus the repository format.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/memcached-template-standards-sync

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
src/pages/docs/charts/memcached.mdx (1)

236-243: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low value

Consider showing a populated extraEgress example.

extraEgress: [] just repeats the default and doesn't demonstrate the rule shape (to[].ipBlock.cidr, ports[].port) that the new playground fields populate.

✏️ Suggested example
   egress:
     enabled: true
     allowDNS: true
-  extraEgress: []
+  extraEgress:
+    - to:
+        - ipBlock:
+            cidr: 10.80.0.0/16
+      ports:
+        - port: 443
+          protocol: TCP
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@src/pages/docs/charts/memcached.mdx` around lines 236 - 243, The
NetworkPolicy example in the memcached docs only shows the default empty
extraEgress value, so update the example to demonstrate a populated extraEgress
rule using the fields exposed by the playground, such as a to[] ipBlock.cidr
target and ports[] entries with port values. Keep the surrounding networkPolicy
structure in the memcached.mdx example, but replace the placeholder empty array
with a concrete rule shape that readers can copy.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@src/pages/docs/charts/memcached.mdx`:
- Around line 236-243: The NetworkPolicy example in the memcached docs only
shows the default empty extraEgress value, so update the example to demonstrate
a populated extraEgress rule using the fields exposed by the playground, such as
a to[] ipBlock.cidr target and ports[] entries with port values. Keep the
surrounding networkPolicy structure in the memcached.mdx example, but replace
the placeholder empty array with a concrete rule shape that readers can copy.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 64bba44c-9902-45a7-8156-d034102734c7

📥 Commits

Reviewing files that changed from the base of the PR and between 365449a and ad54364.

📒 Files selected for processing (2)
  • src/data/playground-configs.ts
  • src/pages/docs/charts/memcached.mdx

@mberlofa

mberlofa commented Jul 5, 2026

Copy link
Copy Markdown
Contributor Author

Synced this site PR with the Memcached chart change in helmforgedev/charts#680.

What changed:

  • Updated the Memcached docs example and configuration reference from networkPolicy.extraEgress to networkPolicy.egress.extraEgress.
  • Updated the playground field keys to generate the nested value path.

Validation:

  • make site-sync-check CHART=memcached reports the required artifacts as OK.
  • npm run format:check passed.
  • npm run lint passed.
  • npm run build passed.
  • make release-check REPO=site passed.
  • make attribution-check REPO=site passed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant