Skip to content

Commit

Permalink
doc/reference: Add warning about volatile keys (#13990)
Browse files Browse the repository at this point in the history
Adds a short warning about volatile keys in the reference page. I wasn't
sure how explicit to be about this warning so recommendations welcome.

Edit: I've just seen that a similar warning exists for `raw.*` config
keys so I've copied that instead.
  • Loading branch information
tomponline authored Aug 27, 2024
2 parents 4ec02c3 + 4226d0a commit 2ae4559
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions doc/reference/instance_options.md
Original file line number Diff line number Diff line change
Expand Up @@ -369,6 +369,11 @@ The following instance options control the creation and expiry of {ref}`instance

The following volatile keys are currently used internally by LXD to store internal data specific to an instance:

```{important}
Setting these `volatile.*` keys might break LXD in non-obvious ways.
Therefore, you should avoid setting any of these keys.
```

% Include content from [../metadata.txt](../metadata.txt)
```{include} ../metadata.txt
:start-after: <!-- config group instance-volatile start -->
Expand Down

0 comments on commit 2ae4559

Please sign in to comment.