Remove isolated field from Tenant
#404
Conversation
✅ Deploy Preview for cozystack ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Summary of ChangesHello @sircthulhu, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on streamlining the Tenant configuration by eliminating the Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
|
Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. 📝 WalkthroughWalkthroughThree installation documentation files were updated to remove the "isolated": true configuration option from JSON patch payloads in their code examples, streamlining the tenant configuration specifications. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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. Comment |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request removes the isolated field from the Tenant documentation. The changes are consistent and correctly applied across the documentation files. I've also pointed out a recurring issue in the documentation where multi-line kubectl patch commands are not valid for copy-pasting and suggested formatting them as single-line commands to improve user experience. Overall, the main goal of the PR is achieved, and with the suggested improvements, the documentation quality will be enhanced.
| "monitoring": true, | ||
| "etcd": true, | ||
| "isolated": true | ||
| "etcd": true |
There was a problem hiding this comment.
While this line is correct, the overall kubectl patch command block (lines 549-554) is not a valid shell command if copy-pasted, because the single-quoted string is split across multiple lines without continuation characters. This could lead to errors for users. To improve the documentation, consider formatting the JSON payload as a single line. For example: kubectl patch ... -p '{"spec":{"ingress":true,"monitoring":true,"etcd":true}}'.
| "monitoring": true, | ||
| "etcd": true, | ||
| "isolated": true | ||
| "etcd": true |
There was a problem hiding this comment.
While this line is correct, the overall kubectl patch command block (lines 427-432) is not a valid shell command if copy-pasted, because the single-quoted string is split across multiple lines without continuation characters. This could lead to errors for users. To improve the documentation, consider formatting the JSON payload as a single line. For example: kubectl patch ... -p '{"spec":{"ingress":true,"monitoring":true,"etcd":true}}'.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
content/en/docs/install/cozystack/_index.md (1)
549-554: Documentation incomplete—deprecatedisolatedfield remains in multiple files.While the patch configuration in this file was correctly updated, verification found that the
isolatedfield has not been removed from all documentation references. The following files still contain"isolated": true:
content/en/docs/getting-started/install-cozystack.md(line 522)content/en/docs/getting-started/create-tenant.md(line 109)content/en/docs/operations/stretched/seaweedfs-multidc.md(lines 36, 80)These examples need to be updated for consistency to reflect the API changes and avoid misleading users with outdated configuration patterns.
|
Please also fix ./docs/getting-started/install-cozystack.md |
sircthulhu
force-pushed
the
remove-tenant-field-isolated
branch
from
680b2a1 to
a99fa00
Compare
See cozystack/cozystack#1896 Signed-off-by: Kirill Ilin <stitch14@yandex.ru>
sircthulhu
force-pushed
the
remove-tenant-field-isolated
branch
from
a99fa00 to
3ad5668
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@content/en/docs/getting-started/install-cozystack.md`:
- Around line 518-522: Update the create-tenant documentation to remove all
references to the removed tenant field "isolated": delete or reword the sentence
that explains "The `isolated` option determines whether sibling tenants can
communicate over the network" and remove the `isolated: true` entry from the
YAML example so the prose and example match the updated behavior shown in the
kubectl patch; search for the string "isolated" in
content/en/docs/getting-started/create-tenant.md and remove or replace mentions,
ensuring the YAML sample remains valid after deletion.
| kubectl patch -n tenant-root tenants.apps.cozystack.io root --type=merge -p ' | ||
| {"spec":{ | ||
| "monitoring": true, | ||
| "etcd": true, | ||
| "isolated": true | ||
| "etcd": true | ||
| }}' |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
# First, read the specific lines from the file to verify the snippet
cat -n content/en/docs/getting-started/install-cozystack.md | sed -n '510,530p'Repository: cozystack/website
Length of output: 603
🏁 Script executed:
# Search for all references to "isolated" in markdown documentation files
rg -n -C2 'isolated' --type=md content/Repository: cozystack/website
Length of output: 15157
🏁 Script executed:
# Also check if there are related changes in other documentation files
rg -n '"etcd":\s*true' --type=md content/Repository: cozystack/website
Length of output: 259
Update create-tenant.md as well—it still documents the isolated field that was removed.
While the kubectl patch command in lines 518-522 correctly excludes the isolated field, the documentation in content/en/docs/getting-started/create-tenant.md still references it as an active, configurable option:
- Line 74 explains: "The
isolatedoption determines whether sibling tenants can communicate over the network" - Line 109 includes it in a YAML example:
isolated: true
These references contradict the PR objective to remove isolated support. Update create-tenant.md to remove mentions of the isolated field from both the prose explanation and the YAML example to ensure consistency across all documentation.
🤖 Prompt for AI Agents
In `@content/en/docs/getting-started/install-cozystack.md` around lines 518 - 522,
Update the create-tenant documentation to remove all references to the removed
tenant field "isolated": delete or reword the sentence that explains "The
`isolated` option determines whether sibling tenants can communicate over the
network" and remove the `isolated: true` entry from the YAML example so the
prose and example match the updated behavior shown in the kubectl patch; search
for the string "isolated" in content/en/docs/getting-started/create-tenant.md
and remove or replace mentions, ensuring the YAML sample remains valid after
deletion.
See cozystack/cozystack#1896
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.