docs(install): add Build Your Own Platform (BYOP) guide#437
Conversation
Restructure install/cozystack/ into an overview page with two sub-pages: "As a Platform" (existing content) and "Build Your Own Platform" (new BYOP guide). Co-Authored-By: Claude <noreply@anthropic.com> Signed-off-by: Andrei Kvapil <kvapss@gmail.com>
Add documentation for using Cozystack as a Kubernetes distribution with the cozypkg CLI tool. Covers operator installation, cozypkg setup, package management workflow, networking variants, component value overrides, and package removal. Co-Authored-By: Claude <noreply@anthropic.com> Signed-off-by: Andrei Kvapil <kvapss@gmail.com>
Update use-cases, getting-started, and variants pages with links to the new BYOP guide. Rename "Kubernetes Distribution" use case to "Build Your Own Platform". Co-Authored-By: Claude <noreply@anthropic.com> Signed-off-by: Andrei Kvapil <kvapss@gmail.com>
✅ Deploy Preview for cozystack ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Caution Review failedThe pull request is closed. ℹ️ Recent review infoConfiguration used: defaults Review profile: CHILL Plan: Pro 📒 Files selected for processing (6)
📝 WalkthroughWalkthroughDocumentation restructuring introduced two distinct Cozystack deployment paths: "As a Platform" (ready-to-use) and "Build Your Own Platform (BYOP)" (selective component installation). The installation guide was consolidated and split into dedicated guides for each path, with supporting documentation updates across related topics. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
Summary of ChangesHello, 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 significantly refactors the Cozystack installation documentation to provide clearer guidance for users. It introduces a new 'Build Your Own Platform (BYOP)' approach, allowing users to selectively install Cozystack components on existing Kubernetes clusters using 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. Changelog
Activity
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
|
![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 introduces a comprehensive 'Build Your Own Platform (BYOP)' guide, which is a great addition for users who need more granular control over their Cozystack installation. The refactoring of the installation documentation into 'As a Platform' and 'BYOP' tracks improves clarity and user experience. The new guide is well-structured and detailed. I've added a few minor suggestions to improve the clarity and consistency of the documentation examples.
|
|
||
| ```console | ||
| NAME VARIANTS READY STATUS | ||
| cozystack.cozystack-platform default,isp-full,isp-full... True ... |
There was a problem hiding this comment.
The example output for VARIANTS is a bit confusing due to the repetition of isp-full and the ellipsis. To improve clarity and align with the variants documentation, consider listing the actual variants or a more representative subset.
This issue also appears in the console output example on lines 109 and 114. For consistency, you may want to update those as well.
| cozystack.cozystack-platform default,isp-full,isp-full... True ... | |
| cozystack.cozystack-platform default,isp-full,isp-full-generic,isp-hosted True ... |
|
|
||
| Each package consists of one or more components (Helm charts). You can override values for specific components by editing the Package resource directly. | ||
|
|
||
| The Package spec supports a `components` map where you can specify values for each component: |
There was a problem hiding this comment.
For consistency and clarity, it's helpful to provide a filename for the YAML manifest, similar to how cozystack-platform.yaml is named in other parts of the documentation. This makes it easier for users to follow the instructions.
| The Package spec supports a `components` map where you can specify values for each component: | |
| The Package spec supports a components map where you can specify values for each component: | |
| **metallb-package.yaml:** |
1 participant
Summary
install/cozystack/into two sub-pages: "As a Platform" (existing content) and "Build Your Own Platform" (new BYOP guide)cozypkgCLI to selectively install individual packagesDetails
The BYOP guide covers:
cozypkgCLI setup (Homebrew + GitHub releases)defaultvariantnoopfor existing clusters)Summary by CodeRabbit