Skip to content

Commit 1cd45b6

Browse files
committed
docs(cryptosctl): say a switched-off block's settings change needs no reboot
The config get help and the ACME and EST warnings said every protocol change waits for a reboot. Changing only the settings of a block with enabled: false is live, so say so. Signed-off-by: Bugs5382 <12115015+Bugs5382@users.noreply.github.com>
1 parent db3d32d commit 1cd45b6

3 files changed

Lines changed: 7 additions & 6 deletions

File tree

‎cmd/cryptosctl/config.go‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,9 @@ func newConfigGetCmd(opts *globalOpts) *cobra.Command {
6060
"hmac_key_base64 and password_sha256 are write-only. Leave a blank secret " +
6161
"as it is and `config apply` keeps the one the node stores for that key_id " +
6262
"or username; set it to replace it. A new key_id or username needs its " +
63-
"secret. Switching a protocol on or off, or changing its settings, takes " +
64-
"effect at the next reboot.",
63+
"secret. Switching a protocol on or off, or changing the settings of one " +
64+
"that is on, takes effect at the next reboot. A block with enabled: false " +
65+
"keeps its settings; changing only those needs no reboot.",
6566
Args: cobra.NoArgs,
6667
RunE: func(cmd *cobra.Command, _ []string) error {
6768
client, closeConn, err := dial(opts)

‎docs/acme.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -173,8 +173,8 @@ Over the API the block is `Pki.acme` with an explicit `enabled` flag.
173173
of an `ApplyConfig` keeps what the node has, on or off.
174174

175175
> [!WARNING]
176-
> Every ACME change, switching it on or off included, takes effect at the
177-
> next reboot, not when you apply it. `config apply` stores the change and
176+
> Switching ACME on or off, or changing its settings while it is on, takes
177+
> effect at the next reboot, not when you apply it. `config apply` stores the change and
178178
> prints `requires_reboot=true`; the listener starts, stops or picks up the new
179179
> settings only when the node boots again. Plan the reboot for a maintenance
180180
> window, because the node stops issuing while it restarts, then use

‎docs/est.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -235,8 +235,8 @@ Over the API the block is `Pki.est` with an explicit `enabled` flag.
235235
of an `ApplyConfig` keeps what the node has, on or off.
236236

237237
> [!WARNING]
238-
> Every EST change, switching it on or off included, takes effect at the
239-
> next reboot, not when you apply it. `config apply` stores the change and
238+
> Switching EST on or off, or changing its settings while it is on, takes
239+
> effect at the next reboot, not when you apply it. `config apply` stores the change and
240240
> prints `requires_reboot=true`; the listener starts, stops or picks up the new
241241
> settings only when the node boots again. Plan the reboot for a maintenance
242242
> window, because the node stops issuing while it restarts, then use

0 commit comments

Comments
 (0)