docs: pause docs on repo #1518
docs: pause docs on repo #1518
Conversation
Signed-off-by: Alex Pana <8968914+acpana@users.noreply.github.com>
Signed-off-by: Alex Pana <8968914+acpana@users.noreply.github.com>
|
|
||
| To pause KCC across namespaces it is suffcient to set the ConfigConnector's `actuationMode: Paused`. This will work when KCC runs in `Cluster` and `Namesapced` mode. To eventually resume actuation just set the field back to `Reconciling`. | ||
|
|
||
| ### Pausing Per Namespace |
There was a problem hiding this comment.
It is worth mentioning that the Pause field on ConfigConnectorContext takes precedence of ConfigConnector.
docs/features/pause.md
Outdated
| @@ -0,0 +1,43 @@ | |||
| # Pause KCC | |||
|
|
|||
| > `Feature State`: KCC version v1.114+ (alpha) | |||
There was a problem hiding this comment.
I don't have a better suggestion, but this was a little hard to read. Maybe "alpha as of version v1.114" ? We could also ask taryn :-)
docs/features/pause.md
Outdated
| We extended the API definitions for the ConfigConnector and ConfigConnectorContext resources to | ||
| support a new field, `spec.actuationMode`. The field's current supported values are `Reconciling` | ||
| and `Paused` with `Reconciling` being the default for backwards compatiblity. | ||
| As such, KCC can be "paused" both globablly and on a per namespace level if running in namesapce mode |
There was a problem hiding this comment.
Typo in globally. And probably per-namespace (with a hyphen). Also typo in namespace :-)
docs/features/pause.md
Outdated
|
|
||
| ### Pausing Globally | ||
|
|
||
| To pause KCC across namespaces it is suffcient to set the ConfigConnector's `actuationMode: Paused`. This will work when KCC runs in `Cluster` and `Namesapced` mode. To eventually resume actuation just set the field back to `Reconciling`. |
There was a problem hiding this comment.
Maybe search for "amesap". You're not the only one to make this typo :-)
docs/features/pause.md
Outdated
| reconciling can be turned on for a namespace by changing the `actuationMode` | ||
| field for the`ConfigConnectorContext` to `Reconciling` for that namespace. | ||
| NOTE: you can avoid any pausing in actuation by first changing the | ||
| `ConfigConnectorContext` actuationMode first. |
There was a problem hiding this comment.
Nit: you say "first" twice
docs/features/pause.md
Outdated
|
|
||
| ### Eventual state transitions & Jitter | ||
|
|
||
| When changing actuation modes for a cluster or namespace, a KCC resource should eventually actuate |
There was a problem hiding this comment.
Maybe "When you un-pause actuation, reconciliation will not happen immediately, but will instead start happening on the normal re-reconciliation interval (with jitter). We may enhance this behaviour in future"
|
Looks pretty good to me, a few nits, and maybe we should get our professional writers to look at it? One way to do that is to make the equivalent change in our "cloud.google.com" docs. I suggest starting with copy-and-paste reuse this time, but thinking about how we can share content easily going forwards. |
|
|
||
| It can be handy to have KCC globally paused but reconciling on a per | ||
| namespace level. To do this make sure KCC is running in `Namespaced` mode | ||
| and the `actuationMode: Paused` on the `ConfigConnector` resource. Then |
There was a problem hiding this comment.
Nit: probably "is set on" instead of "on" (?)
|
LGTM ... one phrasing nit but not blocking /approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: justinsb The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
google-oss-prow
bot
merged commit a140bdf
into
GoogleCloudPlatform:master
* docs: add feature docs Signed-off-by: Alex Pana <8968914+acpana@users.noreply.github.com> * docs: also link from release notes Signed-off-by: Alex Pana <8968914+acpana@users.noreply.github.com> * Apply suggestions from code review --------- Signed-off-by: Alex Pana <8968914+acpana@users.noreply.github.com>
* docs: add feature docs Signed-off-by: Alex Pana <8968914+acpana@users.noreply.github.com> * docs: also link from release notes Signed-off-by: Alex Pana <8968914+acpana@users.noreply.github.com> * Apply suggestions from code review --------- Signed-off-by: Alex Pana <8968914+acpana@users.noreply.github.com>
Pause docs for the repo.
cc @ziyue-101