Skip to content

Commit

Permalink
docs: update "features and limitations" regarding BM and TDX
Browse files Browse the repository at this point in the history
  • Loading branch information
thomasten committed Oct 12, 2024
1 parent 93bce2f commit 363c7cc
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 17 deletions.
16 changes: 9 additions & 7 deletions dev-docs/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,33 +4,35 @@

1. Ensure all needed PRs were merged.

2. Export the release you want to make:
2. Update [Planned features and limitations](../docs/docs/features-limitations.md).

3. Export the release you want to make:

```sh
export REL_VER=v0.1.0
echo "Releasing $REL_VER"
```

3. Create a new temporary branch for the release:
4. Create a new temporary branch for the release:

```sh
git switch -c "tmp/$REL_VER"
git push
```

4. Trigger the release workflow
5. Trigger the release workflow

```sh
gh workflow run release.yml --ref $(git rev-parse --abbrev-ref HEAD) -f kind=minor -f version="$REL_VER"
```

5. Review the release notes, test the binary artifact.
6. Review the release notes, test the binary artifact.

6. Review and merge the auto generated update PR for main.
7. Review and merge the auto generated update PR for main.

7. Publish the GitHub release.
8. Publish the GitHub release.

8. Check that the release publish action succeeds.
9. Check that the release publish action succeeds.

## Patch

Expand Down
6 changes: 1 addition & 5 deletions docs/docs/features-limitations.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This section lists planned features and current limitations of Contrast.
## Availability

- **Platform support**: At present, Contrast is exclusively available on Azure AKS, supported by the [Confidential Container preview for AKS](https://learn.microsoft.com/en-us/azure/confidential-computing/confidential-containers-on-aks-preview). Expansion to other cloud platforms is planned, pending the availability of necessary infrastructure enhancements.
- **Bare metal support**: Support for running Contrast on bare metal Kubernetes will be available soon for AMD SEV and Intel TDX.
- **Bare-metal support**: Support for running [Contrast on bare-metal Kubernetes](getting-started/bare-metal.md) is available for AMD SEV-SNP and Intel TDX.

## Kubernetes features

Expand Down Expand Up @@ -33,7 +33,3 @@ The policy limitations, in particular the missing guarantee that our service mes
The Contrast Coordinator is a singleton and can't be scaled to more than one instance.
When this instance's pod is restarted, for example for node maintenance, it needs to be recovered manually.
In a future release, we plan to support distributed Coordinator instances that can recover automatically.

## Attestation

Attestation for TDX isn't completely implemented yet and shouldn't yet be relied upon for security. This will be fixed in a future release.
6 changes: 1 addition & 5 deletions docs/versioned_docs/version-1.1/features-limitations.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This section lists planned features and current limitations of Contrast.
## Availability

- **Platform support**: At present, Contrast is exclusively available on Azure AKS, supported by the [Confidential Container preview for AKS](https://learn.microsoft.com/en-us/azure/confidential-computing/confidential-containers-on-aks-preview). Expansion to other cloud platforms is planned, pending the availability of necessary infrastructure enhancements.
- **Bare metal support**: Support for running Contrast on bare metal Kubernetes will be available soon for AMD SEV and Intel TDX.
- **Bare-metal support**: Support for running [Contrast on bare-metal Kubernetes](getting-started/bare-metal.md) is available for AMD SEV-SNP and Intel TDX.

## Kubernetes features

Expand Down Expand Up @@ -33,7 +33,3 @@ The policy limitations, in particular the missing guarantee that our service mes
The Contrast Coordinator is a singleton and can't be scaled to more than one instance.
When this instance's pod is restarted, for example for node maintenance, it needs to be recovered manually.
In a future release, we plan to support distributed Coordinator instances that can recover automatically.

## Attestation

Attestation for TDX isn't completely implemented yet and shouldn't yet be relied upon for security. This will be fixed in a future release.

0 comments on commit 363c7cc

Please sign in to comment.