docs: add serviceaccount-api-access and update faq#421
docs: add serviceaccount-api-access and update faq#421IvanStukov wants to merge 5 commits intocozystack:mainfrom
Conversation
Co-Authored-By: Claude <noreply@anthropic.com> Signed-off-by: Ivan Stukov <stukov.ivan.time@gmail.com>
✅ Deploy Preview for cozystack ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
No actionable comments were generated in the recent review. 🎉 📝 WalkthroughWalkthroughThis PR converts several FAQ section headings into collapsible Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 3 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
⚔️ Resolve merge conflicts (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 @IvanStukov, 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 enhances the documentation by introducing a comprehensive guide on ServiceAccount tokens for API access, which is crucial for secure and programmatic interaction with the Cozystack API. Additionally, it improves the user experience of the FAQ sections by making them collapsible, and refines navigation consistency across related documentation pages. 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
The pull request introduces a new documentation page for ServiceAccount tokens and improves the FAQ index readability by using collapsible <details>/<summary> sections. The documentation is clear, well-structured, and follows the existing versioning pattern. I have provided some feedback regarding the placement of generic aliases to ensure they point to the latest documentation version (v1) and identified some redundant alias entries.
Signed-off-by: Ivan Stukov <stukov.ivan.time@gmail.com>
| First, get the API server address: | ||
|
|
||
| ```bash | ||
| export API_SERVER=$(kubectl config view --minify -o jsonpath='{.clusters[0].cluster.server}') |
There was a problem hiding this comment.
In prerequisites we need either kubectl config or OIDC credentials. I think we should be able to get everything either from the dashboard or using kubectl. User might not have configured kubectl for this cluster
| Next, extract the CA certificate to a file: | ||
|
|
||
| ```bash | ||
| kubectl config view --minify --raw -o jsonpath='{.clusters[0].cluster.certificate-authority-data}' | base64 -d > ca.crt |
There was a problem hiding this comment.
It may lead to unexpected results if
- current kubeconfig does has multiple clusters and needed cluster isn't first
- current kubeconfig does not have configuration for needed cluster at all
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@content/en/docs/v0/operations/faq/serviceaccount-api-access.md`:
- Around line 22-23: Replace the ambiguous sentence "The Secret has the same
name as the tenant" with a clear description that the Secret and namespace use
the tenant- prefix (e.g., for tenant "team1" the namespace and Secret are named
"tenant-team1"); update the phrasing around the examples that show
"tenant-<name>" so the doc states explicitly that the secret name follows the
namespace pattern "tenant-<name>" rather than the bare tenant name.
🧹 Nitpick comments (1)
content/en/docs/v0/operations/faq/serviceaccount-api-access.md (1)
53-82: Consider documenting RBAC permissions scope.While the guide effectively covers token retrieval and usage, it might be helpful to briefly mention what permissions or RBAC roles the ServiceAccount has by default, especially since the security warning emphasizes treating these tokens as credentials.
This would help users understand the access level they're granting when sharing these tokens.
Signed-off-by: Ivan Stukov <stukov.ivan.time@gmail.com>
Signed-off-by: Ivan Stukov <stukov.ivan.time@gmail.com>
Co-Authored-By: Claude <noreply@anthropic.com> Signed-off-by: Ivan Stukov <stukov.ivan.time@gmail.com>
2 participants
Summary
operations/faq/serviceaccount-api-access.md) for both v0 and v1<details>/<summary>sections for betterreadability
weightandaliasestogenerate-kubeconfig.mdfor consistent navigationSummary by CodeRabbit
New Documentation
Documentation