Skip to content

Commit

Permalink
docs: add project status to docs
Browse files Browse the repository at this point in the history
docs: update a remaining v1alpha1 -> v1 crd example
  • Loading branch information
tam7t committed Oct 14, 2021
1 parent 1409f23 commit 99aafa5
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 9 deletions.
1 change: 1 addition & 0 deletions docs/book/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,4 @@
- [Load tests](./load-tests.md)
- [Testing](./testing.md)
- [Known Limitations](./known-limitations.md)
- [Release Managment](./release-management.md)
32 changes: 26 additions & 6 deletions docs/book/src/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,35 @@ Join us to help define the direction and implementation of this project!
- Use [GitHub Issues](https://github.com/kubernetes-sigs/secrets-store-csi-driver/issues) to file bugs, request features, or ask questions asynchronously.
- Join [biweekly community meetings](https://docs.google.com/document/d/1q74nboAg0GSPcom3kLWCIoWg43Qg3mr306KNL58f2hg/edit?usp=sharing) to discuss development, issues, use cases, etc.

## Project Status

| Driver | Compatible Kubernetes | `secrets-store.csi.k8s.io` Versions |
|-------------------------------------------------------------------------------------------|-----------------------|-------------------------------------|
| [v1.0.0](https://github.com/kubernetes-sigs/secrets-store-csi-driver/releases/tag/v1.0.0) | 1.19+ | `v1`, `v1alpha1` |
| [v0.3.0](https://github.com/kubernetes-sigs/secrets-store-csi-driver/releases/tag/v0.3.0) | 1.19+ | `v1alpha1` |

See
[Release Management](./release-management.md)
for additional details on versioning. We aim to release a new minor version every month and intend to support the latest
2 minor versions of the driver.

## Features

### Driver Core Functionality (Stable)

- Multiple external [secrets store providers](./providers.md)
- Pod portability with the `SecretProviderClass` `CustomResourceDefinition`
- Mounts secrets/keys/certs to pod using a CSI volume
- Supports mounting multiple secrets store objects as a single volume
- Supports multiple secrets stores as providers. Multiple providers can run in the same cluster simultaneously
- Supports pod portability with the SecretProviderClass CRD
- Supports windows containers (Kubernetes version v1.18+)
- Supports sync with Kubernetes Secrets (Secrets Store CSI Driver v0.0.10+)
- Support auto rotation of mounted contents and synced Kubernetes secret (Secrets Store CSI Driver v0.0.15+)
- Mount multiple secrets store objects as a single volume
- Windows containers

### Alpha Functionality

These features are not stable. If you use these be sure to consult the
[upgrade instructions](./getting-started/upgrades.md) with each upgrade.

- [Auto rotation](./topics/secret-auto-rotation.md) of mounted contents and synced Kubernetes secret
- [Sync with Kubernetes Secrets](./topics/sync-as-kubernetes-secret.md)

## Supported Providers

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,6 @@ This project strictly follows [semantic versioning](https://semver.org/spec/v2.0

- Ideally we will avoid making multiple major releases to be always backward compatible, unless project evolves in important new directions and such release is necessary.

- Secrets Store CSI Driver is currently tracking towards first stable release(v1.0.0) with [this](https://github.com/kubernetes-sigs/secrets-store-csi-driver/milestone/5) milestone.

## Release Cadence and Branching

- Secrets Store CSI Driver follows `monthly` release schedule.
Expand Down
2 changes: 1 addition & 1 deletion docs/book/src/topics/sync-as-kubernetes-secret.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ In some cases, you may want to create a Kubernetes Secret to mirror the mounted
A `SecretProviderClass` custom resource should have the following components:

```yaml
apiVersion: secrets-store.csi.x-k8s.io/v1alpha1
apiVersion: secrets-store.csi.x-k8s.io/v1
kind: SecretProviderClass
metadata:
name: my-provider
Expand Down

0 comments on commit 99aafa5

Please sign in to comment.