From 35a6a01ddf51284cd95f0416215aaa7235daf460 Mon Sep 17 00:00:00 2001 From: Anish Ramasekar Date: Thu, 19 Aug 2021 09:57:21 -0700 Subject: [PATCH] helm: update chart repo to `https://kuberentes-sigs.github.io/secrets-store-csi-driver/charts` Signed-off-by: Anish Ramasekar --- charts/secrets-store-csi-driver/README.md | 34 +++++++++++++----- docs/book/src/getting-started/installation.md | 17 ++++++--- docs/book/src/getting-started/upgrades.md | 15 ++++++++ docs/book/theme/favicon.png | Bin 2522 -> 0 bytes .../charts/secrets-store-csi-driver/README.md | 25 ++++++++++--- 5 files changed, 74 insertions(+), 17 deletions(-) delete mode 100644 docs/book/theme/favicon.png diff --git a/charts/secrets-store-csi-driver/README.md b/charts/secrets-store-csi-driver/README.md index 10d71893d..23db0f95e 100644 --- a/charts/secrets-store-csi-driver/README.md +++ b/charts/secrets-store-csi-driver/README.md @@ -10,14 +10,31 @@ Quick start instructions for the setup and configuration of secrets-store-csi-dr ### Installing the chart -Add the chart repo +> Note: The helm chart repository URL has changed from `https://raw.githubusercontent.com/kuberentes-sigs/secrets-store-csi-driver/master/charts` to `https://kuberentes-sigs.github.io/secrets-store-csi-driver/charts`. + +
+Update helm chart repositories if using the old URL + +Run the following commands to update your Helm chart repositories if using the old URL: + ```bash -$ helm repo add secrets-store-csi-driver https://raw.githubusercontent.com/kubernetes-sigs/secrets-store-csi-driver/master/charts +helm repo rm secrets-store-csi-driver +helm repo add secrets-store-csi-driver https://kuberentes-sigs.github.io/secrets-store-csi-driver/charts +helm repo update ``` -Helm v3.0+ +
+ +#### Add the chart repo + +```bash +helm repo add secrets-store-csi-driver https://kuberentes-sigs.github.io/secrets-store-csi-driver/charts +``` + +#### Install chart using Helm v3.0+ + ```bash -$ helm install csi-secrets-store secrets-store-csi-driver/secrets-store-csi-driver +helm install csi-secrets-store secrets-store-csi-driver/secrets-store-csi-driver ``` ### Configuration @@ -30,7 +47,7 @@ The following table lists the configurable parameters of the csi-secrets-store-p | `fullnameOverride` | String to fully override secrets-store-csi-driver.fullname template with a string | `""` | | `linux.image.repository` | Linux image repository | `k8s.gcr.io/csi-secrets-store/driver` | | `linux.image.pullPolicy` | Linux image pull policy | `IfNotPresent` | -| `linux.image.tag` | Linux image tag | `v0.2.0` | +| `linux.image.tag` | Linux image tag | `v0.2.0` | | `linux.affinity` | Linux affinity | `key: type; operator: NotIn; values: [virtual-kubelet]` | | `linux.driver.resources` | The resource request/limits for the linux secrets-store container image | `limits: 200m CPU, 200Mi; requests: 50m CPU, 100Mi` | | `linux.enabled` | Install secrets store csi driver on linux nodes | true | @@ -41,7 +58,7 @@ The following table lists the configurable parameters of the csi-secrets-store-p | `linux.metricsAddr` | The address the metric endpoint binds to | `:8095` | | `linux.registrarImage.repository` | Linux node-driver-registrar image repository | `k8s.gcr.io/sig-storage/csi-node-driver-registrar` | | `linux.registrarImage.pullPolicy` | Linux node-driver-registrar image pull policy | `IfNotPresent` | -| `linux.registrarImage.tag` | Linux node-driver-registrar image tag | `v2.2.0` | +| `linux.registrarImage.tag` | Linux node-driver-registrar image tag | `v2.3.0` | | `linux.registrar.resources` | The resource request/limits for the linux node-driver-registrar container image | `limits: 100m CPU, 100Mi; requests: 10m CPU, 20Mi` | | `linux.registrar.logVerbosity` | Log level for node-driver-registrar. Uses V logs (klog) | `5` | | `linux.livenessProbeImage.repository` | Linux liveness-probe image repository | `k8s.gcr.io/sig-storage/livenessprobe` | @@ -50,6 +67,7 @@ The following table lists the configurable parameters of the csi-secrets-store-p | `linux.livenessProbe.resources` | The resource request/limits for the linux liveness-probe container image | `limits: 100m CPU, 100Mi; requests: 10m CPU, 20Mi` | | `linux.env` | Environment variables to be passed for the daemonset on linux nodes | `[]` | | `linux.priorityClassName` | Indicates the importance of a Pod relative to other Pods. | `""` | +| `linux.crds.annotations` | Linux *helm hook* annotations | `{}` | | `linux.daemonsetAnnotations` | Linux *DaemonSet* annotations | `{}` | | `linux.podAnnotations` | Linux *Pod* annotations | `{}` | | `linux.podLabels` | Linux *Pod* labels | `{}` | @@ -58,7 +76,7 @@ The following table lists the configurable parameters of the csi-secrets-store-p | `linux.updateStrategy` | Configure a custom update strategy for the daemonset on linux nodes | `RollingUpdate with 1 maxUnavailable` | | `windows.image.repository` | Windows image repository | `k8s.gcr.io/csi-secrets-store/driver` | | `windows.image.pullPolicy` | Windows image pull policy | `IfNotPresent` | -| `windows.image.tag` | Windows image tag | `v0.2.0` | +| `windows.image.tag` | Windows image tag | `v0.2.0` | | `windows.affinity` | Windows affinity | `key: type; operator: NotIn; values: [virtual-kubelet]` | | `windows.driver.resources` | The resource request/limits for the windows secrets-store container image | `limits: 400m CPU, 400Mi; requests: 50m CPU, 100Mi` | | `windows.enabled` | Install secrets store csi driver on windows nodes | false | @@ -69,7 +87,7 @@ The following table lists the configurable parameters of the csi-secrets-store-p | `windows.metricsAddr` | The address the metric endpoint binds to | `:8095` | | `windows.registrarImage.repository` | Windows node-driver-registrar image repository | `k8s.gcr.io/sig-storage/csi-node-driver-registrar` | | `windows.registrarImage.pullPolicy` | Windows node-driver-registrar image pull policy | `IfNotPresent` | -| `windows.registrarImage.tag` | Windows node-driver-registrar image tag | `v2.2.0` | +| `windows.registrarImage.tag` | Windows node-driver-registrar image tag | `v2.3.0` | | `windows.registrar.resources` | The resource request/limits for the windows node-driver-registrar container image | `limits: 200m CPU, 200Mi; requests: 10m CPU, 20Mi` | | `windows.registrar.logVerbosity` | Log level for node-driver-registrar. Uses V logs (klog) | `5` | | `windows.livenessProbeImage.repository` | Windows liveness-probe image repository | `k8s.gcr.io/sig-storage/livenessprobe` | diff --git a/docs/book/src/getting-started/installation.md b/docs/book/src/getting-started/installation.md index 6e14999c9..e3c379252 100644 --- a/docs/book/src/getting-started/installation.md +++ b/docs/book/src/getting-started/installation.md @@ -1,5 +1,12 @@ # Installation + + ## Install the Secrets Store CSI Driver ### Prerequisites @@ -18,7 +25,7 @@ Secrets Store CSI Driver allows users to customize their installation via Helm. > Recommended to use Helm3 ```bash -helm repo add secrets-store-csi-driver https://raw.githubusercontent.com/kubernetes-sigs/secrets-store-csi-driver/master/charts +helm repo add secrets-store-csi-driver https://kubernetes-sigs.github.io/secrets-store-csi-driver/charts helm install csi-secrets-store secrets-store-csi-driver/secrets-store-csi-driver --namespace kube-system ``` @@ -29,10 +36,10 @@ namespace. Notably the following feature must be explicitly enabled: -| Feature | Helm Parameter | -|-----|-----| -| [Sync as Kubernetes secret](../topics/sync-as-kubernetes-secret.md) | `syncSecret.enabled=true`| -| [Secret Auto rotation](../topics/secret-auto-rotation.md) | `enableSecretRotation=true`| +| Feature | Helm Parameter | +| ------------------------------------------------------------------- | --------------------------- | +| [Sync as Kubernetes secret](../topics/sync-as-kubernetes-secret.md) | `syncSecret.enabled=true` | +| [Secret Auto rotation](../topics/secret-auto-rotation.md) | `enableSecretRotation=true` | For a list of customizable values that can be injected when invoking helm install, please see the [Helm chart configurations](https://github.com/kubernetes-sigs/secrets-store-csi-driver/tree/master/charts/secrets-store-csi-driver#configuration). diff --git a/docs/book/src/getting-started/upgrades.md b/docs/book/src/getting-started/upgrades.md index 892369dd1..7a2af9e78 100644 --- a/docs/book/src/getting-started/upgrades.md +++ b/docs/book/src/getting-started/upgrades.md @@ -1,5 +1,20 @@ # Upgrades + + This page includes instructions for upgrading the driver to the latest version. ```bash diff --git a/docs/book/theme/favicon.png b/docs/book/theme/favicon.png deleted file mode 100644 index 9f0139ba8f6573093f25362bb7c279fddd5a74c0..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 2522 zcmZ`*c|4oh8vaOYXPDSZjYviBTf_(%maX>4Tnh}(nxGr zC@Gvuw}LOXw8LT4Fe`X~sTazN=|G}TT@zwRM-%Y=!~_}<8wR(rma^pFK!PX|n*ifP zMbcR~jurfGUL3gI3nSsMzf0IOD|n!n56poPLxPzanHZtq)>1Ibm@qQV&(ZlS81$^* z6gHcQLn7njfz!D?CyQVt>w93M4avB>57y35>|PIokOLc69M+*Nz1!^&}-OvxMjRZzj$K8(}8TpBG7$yCB21t#U6=zDs@P z@{{t=AD^zS_aln zkjAi)(H%u&F1xLl=jPt5=Wgx(K)cyE2MrDlYAHKN9=ak)Nr#+Odl(~QaS_?nQvcvo zD~|DF#zMfs!UN_!)3MYso%=PGLVnI@hV}<~|MSJ%sV}uU{rCeYbI;VH zJ5}wSSVr~2W}Nq}f%$+CPXKuFEvM~FRr55Lvr;J02vw@y!Nvxj?Z6`(-CUH9A@c5{w&tI~% z;nAGwhgtV%pF9w95&`nRSG@SJfT5#DTBcPsdn*7w^r;7QG5Z1qq-+1Zp_SS@t#j$#_;ohkWH-k7P9r+DGQVE^x0(k~~NKOEA^{cTc_5HSW< z;`jHRa9q+~?a)%$w2wO&chupQ9Yy}U;FlH6Bkh&zeCHp}5l^6w_u;dXySKB*5o0g& z$|QPP&L(V{zHb%zAu?Uzszj>0nnJRHeu|Fm0d*3*+sr%tN8mV0bwBZ1w>T{Kh=aZSnS+3oI#%L2)`d7J8j)SrBLU-fjkj6|5I}*Nw`>F zsa%DPpHep1Zx(pPQ$E=^%gasK+?hhH#ZGB3-y~CoVQAuX?^-Aa?Q&kEmfSYijmO zK-uRP;-uhdzgfzq!3i5Vbh(f`!1p^CxvtwRHYdI0fe1&7KFaS76pODM_oEmZF1LsC zoOZ2eE0jG&--xQha&sO`9e-2P72Q`uCRYzY*R>yille-}nc}GK!;2jfg&Z#;l^$ki zNsf^0uKVszsnpyNcoySnu3g%r#*b60ovfE+^KYo%-S8f$-I!`|n!qPcnv6QrAfijw z(u-35zNy*xa=3jh^5mtT%i+tV({A_HZTi*_QbDhGMIocPemPF*au}Ln+q%ycM^E|G z)CvSjtnEy^>0-p==h7l;Wfq0a^2O3pG{K|6eJ5org_S!i>;Asg7GKiG@skP5<43SU zeab_@^#*%DLj^KzGZ!;kHMriM6Y73)W!je?(4=&t9^I8@RJ8e6`6gfVthc3FA=3w+$51^M=PG~BF^|7Nx%qxJK`a{U)7+fQUqc={C!b_d9}Q1Ty3xYrHO0mT z8Z>mE=XFEuF_n7;H;QDfZ_g)4 zqI6H!DLkxY2?;YEmnfSnONTVZ2T}?%**NjTvB7h<%E|x2u+IHf>K(QNt+|AbQS%u| z1Mf<0wo@QGjKC)0h%qG40BDpk)(`~_j6WKK!(eeHriW2z912CQI}-dqfG9>7m3-#^ z15}oHFF`;+0{D{hBgDg)F$^*_k_2O)VUl3r3xo&&oWl848HwoQy1ISdPx{?n`vDMy zv=LDnihz3LDng(zN1jPX7z9!84}0>*NN;C<=fO_#Cp_0;cO&4fiUNDp-t-2z1>oj{ KcdW4wN&Yv1he~Sz diff --git a/manifest_staging/charts/secrets-store-csi-driver/README.md b/manifest_staging/charts/secrets-store-csi-driver/README.md index d2db2d50b..ebe361c76 100644 --- a/manifest_staging/charts/secrets-store-csi-driver/README.md +++ b/manifest_staging/charts/secrets-store-csi-driver/README.md @@ -10,14 +10,31 @@ Quick start instructions for the setup and configuration of secrets-store-csi-dr ### Installing the chart -Add the chart repo +> Note: The helm chart repository URL has changed from `https://raw.githubusercontent.com/kuberentes-sigs/secrets-store-csi-driver/master/charts` to `https://kuberentes-sigs.github.io/secrets-store-csi-driver/charts`. + +
+Update helm chart repository if using the old URL + +Run the following commands to update your Helm chart repositories if using the old URL: + ```bash -$ helm repo add secrets-store-csi-driver https://raw.githubusercontent.com/kubernetes-sigs/secrets-store-csi-driver/master/charts +helm repo rm secrets-store-csi-driver +helm repo add secrets-store-csi-driver https://kuberentes-sigs.github.io/secrets-store-csi-driver/charts +helm repo update ``` -Helm v3.0+ +
+ +#### Add the chart repo + +```bash +helm repo add secrets-store-csi-driver https://kuberentes-sigs.github.io/secrets-store-csi-driver/charts +``` + +#### Install chart using Helm v3.0+ + ```bash -$ helm install csi-secrets-store secrets-store-csi-driver/secrets-store-csi-driver +helm install csi-secrets-store secrets-store-csi-driver/secrets-store-csi-driver ``` ### Configuration