cli: add field docs to the state file #2453
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for constellation-docs canceled.
|
elchead
reviewed
Oct 16, 2023
| // description: | | ||
| // DO NOT EDIT. State of the Constellation Kubernetes cluster. | ||
| // These values are set during cluster initialization and should not be changed. | ||
| ClusterValues ClusterValues `yaml:"clusterValues"` |
There was a problem hiding this comment.
future idea: we could back up these values in the cluster and compare against the cluster state upon apply, similar to the attestationconfig
elchead
reviewed
Oct 16, 2023
daniel-weisse
approved these changes
Oct 16, 2023
There was a problem hiding this comment.
We should rethink custom marshaling of []byte for the state file.
Currently, MeasurementSalt and InitSecret get rendered as a list of byte values, e.g.
MeasurementSalt:
- 12
- 53
- 12
- 53
// ...Should probably be done in a separate PR however.
Otherwise looks good to me.
msanft
force-pushed
the
feat/cli/document-state-file
branch
from
0df5aa9
to
47300cf
Compare
elchead
approved these changes
Oct 16, 2023
msanft
force-pushed
the
feat/cli/document-state-file
branch
from
47300cf
to
2d421c6
Compare
msanft
force-pushed
the
feat/cli/document-state-file
branch
from
180e342
to
1d9b72c
Compare
daniel-weisse
approved these changes
Oct 16, 2023
Coverage report
|
elchead
pushed a commit
that referenced
this pull request
Oct 17, 2023
* add field docs to the state file * mark only optional fields * tidy * use talos encoder
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Context
The state file was missing in-line documentation, aligned with what the config file has.
Proposed change(s)
Additional info
Checklist