Skip to content

docs: move atomic manifest updates to other page #2302

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
davidweisse wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: move atomic manifest updates to other page #2302

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/docs/howto/manifest-update.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,3 +44,23 @@ for all your application resources.
As described above, a manifest update triggers rotation of the mesh CA certificate, the intermediate CA certificate and the workload certificates.
You can use this to force a certificate rotation or to constrain the certificate validity period.
Setting the current manifest once more causes a certificate rotation, without changing the reference values enforced by the Coordinator.

### Atomic manifest updates

Setting the manifest won't consider the previous state of the Coordinator.
This means that after a manifest update, you may have accidentally overwritten a previous Coordinator state set by another party.
To prevent this, use the `--atomic` flag:

```sh
contrast set -c "${coordinator}:1313" --atomic resources/
```

This will only update the manifest if the manifest history at the Coordinator matches the expected history.
When setting the manifest on an already initialized Coordinator, the latest transition hash has to be obtained by running `contrast verify`.
An atomic manifest update will then automatically read the hash from `verify/latest-transition`.
When setting the manifest for the first time, the expected transition hash is `00...00` (32 zero bytes, hex-encoded) and will be set automatically if the `verify/latest-transition` file doesn't exist.
Optionally, you can specify a transition hash using the `--latest-transition` flag:

```sh
contrast set -c "${coordinator}:1313" --atomic --latest-transition ab...cd resources/
```
20 changes: 0 additions & 20 deletions docs/docs/howto/workload-deployment/set-manifest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,23 +28,3 @@ contrast set -c "${coordinator}:1313" resources/
```

This will use the reference values from the manifest file to attest the Coordinator. After this step, the Coordinator will start issuing TLS certificates to the workloads. The init container will fetch a certificate for the workload and the workload is started.

### Atomic manifest updates

Setting the manifest won't consider the previous state of the Coordinator.
This means that after a manifest update, you may have accidentally overwritten a previous Coordinator state set by another party.
To prevent this, use the `--atomic` flag:

```sh
contrast set -c "${coordinator}:1313" --atomic resources/
```

This will only update the manifest if the manifest history at the Coordinator matches the expected history.
When setting the manifest on an already initialized Coordinator, the latest transition hash has to be obtained by running `contrast verify`.
An atomic manifest update will then automatically read the hash from `verify/latest-transition`.
When setting the manifest for the first time, the expected transition hash is `00...00` (32 zero bytes, hex-encoded) and will be set automatically if the `verify/latest-transition` file doesn't exist.
Optionally, you can specify a transition hash using the `--latest-transition` flag:

```sh
contrast set -c "${coordinator}:1313" --atomic --latest-transition ab...cd resources/
```
Loading