panxiao81/helm-charts-hardened
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update docs to simplify, clarify, and prioritize ease of install/upgrade (#62)

Browse Source 
* Update docs to simplify, clarify, and prioritize ease of install/upgrade

Signed-off-by: Kevin Fox <[email protected]>

* Apply suggestions from code review

Co-authored-by: Marco Franssen <[email protected]>
Signed-off-by: kfox1111 <[email protected]>

* Incorperate feedback

Signed-off-by: Kevin Fox <[email protected]>

* Incorperate feedback

Signed-off-by: Kevin Fox <[email protected]>

---------

Signed-off-by: Kevin Fox <[email protected]>
Signed-off-by: kfox1111 <[email protected]>
Co-authored-by: Marco Franssen <[email protected]>
This commit is contained in:
kfox1111
2023-10-26 22:13:54 +00:00
committed by GitHub
co-authored by Marco Franssen
parent 5ad35bd8d5
commit b813807f16
2 changed files with 52 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+7 -18
View File
@@ -1,4 +1,7 @@
> **Note**: All the helm charts in this repo are beta. We encourage you to try them out and contribute. The API may change as we move towards a production ready release.
> [!Note]
> Things to consider:
> 1. We do not support running out of the git main branch. This is where development happens. Please use released versions via the published repo or git tags.
> 2. All the helm charts in this repo are beta. We encourage you to try them out and contribute. The API may change as we move towards a production ready release.
# SPIFFE Helm Charts
@@ -8,24 +11,10 @@
A suite of [Helm Charts](https://helm.sh/docs) for standardized installations of SPIRE components in Kubernetes environments.
## Add Helm repository
## How to install or upgrade
```bash
helm repo add spiffe https://spiffe.github.io/helm-charts-hardened/
helm repo update
```
## Dependencies and Version Compatibility
Unless otherwise noted in an application chart README, the following dependencies will follow these prescribed version compatibility rules.
| Dependency | Supported Versions |
|:-----------|:-------------------|
| SPIRE | `1.8.2` |
| Helm | `3.x` |
| Kubernetes | `1.22+` |
> **Note**: For Kubernetes, we will officially support the last 3 versions as described in [k8s versioning](https://kubernetes.io/releases/version-skew-policy/#supported-versions). Any version before the last 3 we will try to support as long it doesn't bring security issues or any big maintenance burden. *The first version we tested this chart with is `1.22`.*
You most likely want to do an integrated setup based on the spire chart.
[Instructions](https://artifacthub.io/packages/helm/spiffe/spire)
## Contributing