From cb1c37b9929b5e94e80cd6b24d497023c5e5ff7f Mon Sep 17 00:00:00 2001 From: Stefan Reimer Date: Tue, 19 May 2020 16:54:07 +0100 Subject: [PATCH] Update README --- charts/kubezero-app/README.md | 3 ++- charts/kubezero-aws-ebs-csi-driver/README.md | 15 +++++++++++-- .../README.md.gotmpl | 21 +++++++++++++++++++ 3 files changed, 36 insertions(+), 3 deletions(-) create mode 100644 charts/kubezero-aws-ebs-csi-driver/README.md.gotmpl diff --git a/charts/kubezero-app/README.md b/charts/kubezero-app/README.md index b2b9bf61..479f387c 100644 --- a/charts/kubezero-app/README.md +++ b/charts/kubezero-app/README.md @@ -2,7 +2,7 @@ kubezero-app ============ KubeZero ArgoCD Application - Root chart of the KubeZero -Current chart version is `0.2.1` +Current chart version is `0.2.2` Source code can be found [here](https://kubezero.com) @@ -16,6 +16,7 @@ Source code can be found [here](https://kubezero.com) | Key | Type | Default | Description | |-----|------|---------|-------------| +| aws-ebs-csi-driver.enabled | bool | `false` | | | calico.enabled | bool | `false` | | | cert-manager.enabled | bool | `false` | | | global.defaultDestination.server | string | `"https://kubernetes.default.svc"` | | diff --git a/charts/kubezero-aws-ebs-csi-driver/README.md b/charts/kubezero-aws-ebs-csi-driver/README.md index 1e2f2a31..525ff1bf 100644 --- a/charts/kubezero-aws-ebs-csi-driver/README.md +++ b/charts/kubezero-aws-ebs-csi-driver/README.md @@ -1,5 +1,5 @@ -kubezero-aws-ebs -================ +kubezero-aws-ebs-csi-driver +=========================== KubeZero Umbrella Chart for aws-ebs-csi-driver Current chart version is `0.1.0` @@ -12,6 +12,17 @@ Source code can be found [here](https://kubezero.com) |------------|------|---------| | https://zero-down-time.github.io/kubezero/ | kubezero-lib | >= 0.1.1 | +## IAM Role +If you use kiam or kube2iam and restrict access on nodes running this controller please adjust: +``` +podAnnotations: + iam.amazonaws.com/role: +``` + +## Storage Classes +Provides the *ebs-sc-gp2-xfs* storage class for gp2, enrypted and XFS. +This class is also set as default. + ## Chart Values | Key | Type | Default | Description | diff --git a/charts/kubezero-aws-ebs-csi-driver/README.md.gotmpl b/charts/kubezero-aws-ebs-csi-driver/README.md.gotmpl new file mode 100644 index 00000000..787427e3 --- /dev/null +++ b/charts/kubezero-aws-ebs-csi-driver/README.md.gotmpl @@ -0,0 +1,21 @@ +{{ template "chart.header" . }} +{{ template "chart.description" . }} + +{{ template "chart.versionLine" . }} + +{{ template "chart.sourceLinkLine" . }} + +{{ template "chart.requirementsSection" . }} + +## IAM Role +If you use kiam or kube2iam and restrict access on nodes running this controller please adjust: +``` +podAnnotations: + iam.amazonaws.com/role: +``` + +## Storage Classes +Provides the *ebs-sc-gp2-xfs* storage class for gp2, enrypted and XFS. +This class is also set as default. + +{{ template "chart.valuesSection" . }}