Document SDK read-only mode (v1.19.0)#3928
Conversation
Document the new readOnlyMode Helm value that prevents the SDK from writing Kubernetes secrets at runtime, reduces RBAC to read-only permissions, and returns 422 on write API endpoints.
✅ Deploy Preview for replicated-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for replicated-docs-upgrade ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
replicated-ci
added
type::docs
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Rewrite sentences to use active voice in the read-only mode documentation section.
|
Thanks @alicenstar ! I'll defer to @paigecalvert on this one, but I think Read Only mode content should be up in the "Customize RBAC for the SDK" section as it is essentially a fourth method. The requesting vendor even called in "even more minimal rbac" when describing it For the behavior in read-only mode, I think we need to be clearer what impact that actually has on the product experience.
|
I had the same thought :) @alicenstar I think a single section named "Read-only mode" just after "Minimal RBAC" would work. |
…fy impact - Move read-only mode from standalone section to h3 under "Customize RBAC for the SDK", after Minimal RBAC - Rewrite behavior bullets to explain practical vendor impact - Clarify air gap vs online distinction for custom metrics - Explain that POST/PATCH custom-metrics still work, only DELETE is 422 - Drop vague "non-fatal sync failures" sentence
The read-only mode impact is documented comprehensively in the customizing page. These per-endpoint notes were redundant.
|
@paigecalvert Ready for re-review here! |
| ## Customize RBAC for the SDK | ||
|
|
||
| This section describes role-based access control (RBAC) for the Replicated SDK, including the default RBAC, minimal RBAC, and how to install the SDK with custom RBAC. | ||
| This section describes role-based access control (RBAC) for the Replicated SDK, including the default RBAC, minimal RBAC, read-only mode, and how to install the SDK with custom RBAC. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
4 participants
Summary
readOnlyModeHelm value, its effects on RBAC, secret writes, and API behavior:::notecallouts to the 5 affected write endpoints in the SDK API reference documenting the 422 response in read-only modereadOnlyModeto the SDK Helm values example partial