From 0dac0dbd95d6fdc47c3352fc550ee431e6ed449e Mon Sep 17 00:00:00 2001 From: Marco Franssen Date: Sat, 25 Mar 2023 00:37:34 +0100 Subject: [PATCH] Improve Spire Chart documentation Signed-off-by: Marco Franssen --- README.md | 2 +- charts/spire/README.md | 16 ++++++++++++++-- charts/spire/README.md.gotmpl | 16 ++++++++++++++-- 3 files changed, 29 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index ed62ef9..e46dd58 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ Unless otherwise noted in an application chart README, the following dependencie | Dependency | Supported Versions | |:-----------|:-------------------| -| SPIRE | `1.5.x`, `1.6.x` | +| SPIRE | `1.5.3`+, `1.6.x` | | Helm | `3.x` | For Kubernetes we will officially try to support the last 3 versions as described in [k8s versioning](https://kubernetes.io/releases/version-skew-policy/#supported-versions). diff --git a/charts/spire/README.md b/charts/spire/README.md index 4ca34ba..81cb23b 100644 --- a/charts/spire/README.md +++ b/charts/spire/README.md @@ -3,14 +3,26 @@ ![Version: 0.5.0](https://img.shields.io/badge/Version-0.5.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.6.1](https://img.shields.io/badge/AppVersion-1.6.1-informational?style=flat-square) +[![Development Phase](https://github.com/spiffe/spiffe/blob/main/.img/maturity/dev.svg)](https://github.com/spiffe/spiffe/blob/main/MATURITY.md#development) A Helm chart for deploying the complete Spire stack including: spire-server, spire-agent, spiffe-csi-driver, spiffe-oidc-discovery-provider and spire-controller-manager. **Homepage:** -> **Warning**: Please note this chart requires Projected Service Account Tokens which has to be enabled on your k8s api server. +## Version support -> **Note**: Minimum Spire version is `v1.5.3`. +> **Note**: This Chart is still in development and still subject to change the API (`values.yaml`). +> Until we reach a `1.0.0` version of the chart we can't guarantee backwards compatibility although +> we do aim for as much stability as possible. + +| Dependency | Supported Versions | +|:-----------|:-------------------| +| SPIRE | `1.5.3+`, `1.6.x` | +| Helm | `3.x` | + +## Prerequisites + +Please note this chart requires `Projected Service Account Tokens` which has to be enabled on your k8s api server. To enable Projected Service Account Tokens on Docker for Mac/Windows run the following command to SSH into the Docker Desktop K8s VM. diff --git a/charts/spire/README.md.gotmpl b/charts/spire/README.md.gotmpl index 9c640b7..a5fdd06 100644 --- a/charts/spire/README.md.gotmpl +++ b/charts/spire/README.md.gotmpl @@ -5,14 +5,26 @@ {{ template "chart.deprecationWarning" . }} {{ template "chart.badgesSection" . }} +[![Development Phase](https://github.com/spiffe/spiffe/blob/main/.img/maturity/dev.svg)](https://github.com/spiffe/spiffe/blob/main/MATURITY.md#development) {{ template "chart.description" . }} {{ template "chart.homepageLine" . }} -> **Warning**: Please note this chart requires Projected Service Account Tokens which has to be enabled on your k8s api server. +## Version support -> **Note**: Minimum Spire version is `v1.5.3`. +> **Note**: This Chart is still in development and still subject to change the API (`values.yaml`). +> Until we reach a `1.0.0` version of the chart we can't guarantee backwards compatibility although +> we do aim for as much stability as possible. + +| Dependency | Supported Versions | +|:-----------|:-------------------| +| SPIRE | `1.5.3+`, `1.6.x` | +| Helm | `3.x` | + +## Prerequisites + +Please note this chart requires `Projected Service Account Tokens` which has to be enabled on your k8s api server. To enable Projected Service Account Tokens on Docker for Mac/Windows run the following command to SSH into the Docker Desktop K8s VM.