Improve Spire Chart documentation
Signed-off-by: Marco Franssen <[email protected]>
This commit is contained in:
@@ -21,7 +21,7 @@ Unless otherwise noted in an application chart README, the following dependencie
|
|||||||
|
|
||||||
| Dependency | Supported Versions |
|
| Dependency | Supported Versions |
|
||||||
|:-----------|:-------------------|
|
|:-----------|:-------------------|
|
||||||
| SPIRE | `1.5.x`, `1.6.x` |
|
| SPIRE | `1.5.3`+, `1.6.x` |
|
||||||
| Helm | `3.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).
|
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).
|
||||||
|
|||||||
+14
-2
@@ -3,14 +3,26 @@
|
|||||||
<!-- This README.md is generated. Please edit README.md.gotmpl -->
|
<!-- This README.md is generated. Please edit README.md.gotmpl -->
|
||||||
|
|
||||||
  
|
  
|
||||||
|
[](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.
|
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:** <https://github.com/spiffe/helm-charts/tree/main/charts/spire>
|
**Homepage:** <https://github.com/spiffe/helm-charts/tree/main/charts/spire>
|
||||||
|
|
||||||
> **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
|
To enable Projected Service Account Tokens on Docker for Mac/Windows run the following
|
||||||
command to SSH into the Docker Desktop K8s VM.
|
command to SSH into the Docker Desktop K8s VM.
|
||||||
|
|||||||
@@ -5,14 +5,26 @@
|
|||||||
{{ template "chart.deprecationWarning" . }}
|
{{ template "chart.deprecationWarning" . }}
|
||||||
|
|
||||||
{{ template "chart.badgesSection" . }}
|
{{ template "chart.badgesSection" . }}
|
||||||
|
[](https://github.com/spiffe/spiffe/blob/main/MATURITY.md#development)
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
{{ template "chart.description" . }}
|
||||||
|
|
||||||
{{ template "chart.homepageLine" . }}
|
{{ 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
|
To enable Projected Service Account Tokens on Docker for Mac/Windows run the following
|
||||||
command to SSH into the Docker Desktop K8s VM.
|
command to SSH into the Docker Desktop K8s VM.
|
||||||
|
|||||||
Reference in New Issue
Block a user