Skip to content

docs(vpc): generate README parameters from values.yaml - #4944

Merged
Aleksei Sviridkin (lexfrei) merged 2 commits into
cozystack:mainfrom
rawsun007:docs-vpc-readme-generate
Nov 13, 2026
Merged

docs(vpc): generate README parameters from values.yaml#4944
Aleksei Sviridkin (lexfrei) merged 2 commits into
cozystack:mainfrom
rawsun007:docs-vpc-readme-generate

Conversation

@rawsun007

@rawsun007 Roshan Ramani (rawsun007) commented Oct 18, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Contributor

What this PR does

packages/apps/vpc/Makefile is the only app Makefile that calls cozyvalues-gen without -r README.md, and it has been that way since the app was added, so the README's Parameters table was hand-written and never regenerated. It still documents subnets as map[string]object and omits peers and routes, and the README example uses the map form, which values.schema.json rejects since #2052 made subnets a list. That README is also the source of the website's VPC reference page, so the published example is the invalid one.

This adds -r README.md, regenerates the table with cozyvalues-gen v1.7.0 (the version CI uses), and rewrites the example as a list. make generate in packages/apps/vpc leaves the CRD and Go types unchanged, and the new example validates against the VPC openAPISchema. The draft #4813 edits this values.yaml, so once this lands its make generate will update the README as well.

Screenshots

Downstream repositories

The website's VPC page is regenerated from this README by the release bot, so it needs no separate change.

Release note

docs(vpc): document subnets, peers and routes in the VPC README as the list-based parameters the chart accepts.

Summary by CodeRabbit

  • Documentation
    • Updated the VPC configuration guide to describe subnet entries, including names, CIDR ranges, and optional allowed source ranges.
    • Added guidance for configuring VPC peers with a remote VPC name and tenant namespace, and routes with a destination range and next-hop IP.
    • Revised the subnet example to use a list of named entries.

@rawsun007
docs(vpc): generate README parameters from values.yaml
1779df2 
The vpc Makefile never passed -r README.md to cozyvalues-gen, unlike
every other app, so its Parameters table was never regenerated. It
still described subnets as a map after the switch to a list, and the
README example, which also feeds the website reference page, fails
values.schema.json.

Assisted-by: LLM
Signed-off-by: Roshan Ramani <[email protected]>
@github-actions github-actions Bot added size/S This PR changes 10-29 lines, ignoring generated files area/networking Issues or PRs related to networking (ingress, gateway, vpn, metallb, kube-ovn) kind/documentation Categorizes issue or PR as related to documentation labels Oct 18, 2026
@coderabbitai

coderabbitai Bot commented Oct 18, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Important

Review skipped

Review was skipped as selected files did not have any reviewable changes.

Run configuration

Commits

Reviewing files that changed from the base of the PR and between 1779df2 and 54cc97a.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • Trigger review

No actionable comments were generated in the recent review.

Walkthrough

The VPC README now documents subnet, peer, and route values. Its subnet example uses a list of named entries. The Makefile passes the README to cozyvalues-gen.

Changes: VPC values documentation

Layer / File(s) Summary
Document VPC values and provide README to generator
packages/apps/vpc/README.md, packages/apps/vpc/Makefile		 The README documents subnet objects with name, cidr, and optional allowSubnets, plus peer and route objects. The example uses a list of named subnets. The generate target passes README.md to cozyvalues-gen with -r.

Estimated code review effort: 2 (Simple) | ~5 minutes

Change: Other

Suggested reviewers: nbykov0

Merge Risk: Minimal · previous review 1779d

This documentation-only change makes the VPC README parameters table regenerate from values.yaml and corrects the subnet example. No merge-blocking risk was found.

Pre-merge checks: Passed 5

Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly and concisely describes the main change: generating VPC README parameters from values.yaml.
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (2 skipped: 2 unsupported.)

Finishing Touches

🧪 Generate unit tests (beta)

  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

ℹ️ Recent review info

⚙️ Run configuration

  • Configuration used: Repository: cozystack/cozystack/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 1663bc36-0cef-439d-9061-2050eada21c9
📥 Commits

Reviewing files that changed from the base of the PR and between aed7fa8 and 1779df2.

📒 Files selected for processing: 2

  • packages/apps/vpc/Makefile
  • packages/apps/vpc/README.md

Included review availability: This review used your included allowance. Your plan provides up to 8 included reviews per hour; 7 remain after this review.

@lexfrei
Merge branch 'main' into docs-vpc-readme-generate
54cc97a 
Assisted-by: LLM
Signed-off-by: Aleksei Sviridkin <[email protected]>
@lexfrei

Aleksei Sviridkin (lexfrei) commented Nov 13, 2026

Copy link
Copy Markdown
Contributor

Roshan Ramani (@rawsun007) I merged main into your branch (54cc97a) so CI runs against the current base. Your commits are unchanged.

lexfrei
Aleksei Sviridkin (lexfrei) approved these changes Nov 13, 2026
View reviewed changes

@lexfrei Aleksei Sviridkin (lexfrei) left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Roshan Ramani (@rawsun007) LGTM, CI and E2E are green on this head.

@lexfrei
Aleksei Sviridkin (lexfrei) merged commit 233dee7 into cozystack:main Nov 13, 2026
24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@lexfrei Aleksei Sviridkin (lexfrei) lexfrei approved these changes
@kvaps Andrei Kvapil (kvaps) Awaiting requested review from kvaps kvaps is a code owner
@lllamnyp Timofei Larkin (lllamnyp) Awaiting requested review from lllamnyp lllamnyp is a code owner
@myasnikovdaniil myasnikovdaniil Awaiting requested review from myasnikovdaniil myasnikovdaniil is a code owner
@IvanHunters IvanHunters Awaiting requested review from IvanHunters IvanHunters is a code owner
@matthieu-robin Matthieu ROBIN (matthieu-robin) Awaiting requested review from matthieu-robin matthieu-robin is a code owner
@scooby87 scooby87 Awaiting requested review from scooby87 scooby87 is a code owner

Assignees

No one assigned

Labels

area/networking Issues or PRs related to networking (ingress, gateway, vpn, metallb, kube-ovn) kind/documentation Categorizes issue or PR as related to documentation size/S This PR changes 10-29 lines, ignoring generated files

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@rawsun007 @lexfrei