Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
…-store-csi-driver/charts`

Signed-off-by: Anish Ramasekar <[email protected]>
  • Loading branch information
aramase committed Aug 19, 2021
1 parent 0609d63 commit 35a6a01
Show file tree
Hide file tree
Showing 5 changed files with 74 additions and 17 deletions.
34 changes: 26 additions & 8 deletions charts/secrets-store-csi-driver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
<details>
<summary>Update helm chart repositories if using the old URL</summary>

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+
</details>

#### 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
Expand All @@ -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 |
Expand All @@ -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` |
Expand All @@ -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 | `{}` |
Expand All @@ -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 |
Expand All @@ -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` |
Expand Down
17 changes: 12 additions & 5 deletions docs/book/src/getting-started/installation.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# Installation

<aside class="note">
<h1>Note</h1>

The helm chart repository URL has changed to `https://kuberentes-sigs.github.io/secrets-store-csi-driver/charts`

</aside>

## Install the Secrets Store CSI Driver

### Prerequisites
Expand All @@ -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
```

Expand All @@ -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).

Expand Down
15 changes: 15 additions & 0 deletions docs/book/src/getting-started/upgrades.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,20 @@
# Upgrades

<aside class="note warning">
<h1>Warning</h1>

The helm chart repository URL has changed to `https://kuberentes-sigs.github.io/secrets-store-csi-driver/charts`.

Run the following commands to update your Helm chart repositories:

```bash
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
```

</aside>

This page includes instructions for upgrading the driver to the latest version.

```bash
Expand Down
Binary file removed docs/book/theme/favicon.png
Binary file not shown.
25 changes: 21 additions & 4 deletions manifest_staging/charts/secrets-store-csi-driver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
<details>
<summary>Update helm chart repository if using the old URL</summary>

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+
</details>

#### 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
Expand Down

0 comments on commit 35a6a01

Please sign in to comment.