From cf1f49b032b79ca7f7b776ca3eca1dec2875472f Mon Sep 17 00:00:00 2001 From: Anish Ramasekar Date: Tue, 1 Feb 2022 11:29:55 -0800 Subject: [PATCH 1/2] docs: update chart repo to `https://azure.github.io/secrets-store-csi-driver-provider-azure/charts` (#784) Signed-off-by: Anish Ramasekar --- Makefile | 5 ----- .../csi-secrets-store-provider-azure/README.md | 16 +++++++++++++++- examples/kind/kind-demo.sh | 2 +- .../csi-secrets-store-provider-azure/README.md | 16 +++++++++++++++- .../en/configurations/deploy-in-openshift.md | 2 +- website/content/en/configurations/ingress-tls.md | 2 +- .../en/demos/standard-walkthrough/_index.md | 2 +- .../en/getting-started/installation/_index.md | 8 +++++++- 8 files changed, 41 insertions(+), 12 deletions(-) diff --git a/Makefile b/Makefile index e1cce37b6..472292be3 100644 --- a/Makefile +++ b/Makefile @@ -230,8 +230,3 @@ promote-staging-manifest: #promote staging manifests to release dir @cp -r manifest_staging/deployment . @rm -rf charts/csi-secrets-store-provider-azure @cp -r manifest_staging/charts/csi-secrets-store-provider-azure ./charts - @mkdir -p ./charts/tmp - @helm package ./charts/csi-secrets-store-provider-azure -d ./charts/tmp/ - @helm repo index ./charts/tmp --url https://raw.githubusercontent.com/Azure/secrets-store-csi-driver-provider-azure/master/charts --merge ./charts/index.yaml - @mv ./charts/tmp/* ./charts - @rm -rf ./charts/tmp diff --git a/charts/csi-secrets-store-provider-azure/README.md b/charts/csi-secrets-store-provider-azure/README.md index 7f5aecf10..9dbeab4a4 100644 --- a/charts/csi-secrets-store-provider-azure/README.md +++ b/charts/csi-secrets-store-provider-azure/README.md @@ -27,9 +27,23 @@ Azure Key Vault provider for Secrets Store CSI driver allows you to get secret c | `0.2.1` | `0.3.0` | `0.2.0` | | `1.0.0-rc.0` | `1.0.0-rc.0` | `1.0.0-rc.0` | | `1.0.0` | `1.0.0` | `1.0.0` | +| `1.0.1` | `1.0.1` | `1.0.1` | ## Installation +> Note: The helm chart repository URL has changed from `https://raw.githubusercontent.com/Azure/secrets-store-csi-driver-provider-azure/master/charts` to `https://azure.github.io/secrets-store-csi-driver-provider-azure/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 csi-secrets-store-provider-azure https://azure.github.io/secrets-store-csi-driver-provider-azure/charts --force-update +helm repo update +``` + +
+ Quick start instructions for the setup and configuration of secrets-store-csi-driver and azure keyvault provider using Helm. ### Prerequisites @@ -41,7 +55,7 @@ Quick start instructions for the setup and configuration of secrets-store-csi-dr - This chart installs the [secrets-store-csi-driver](https://github.com/kubernetes-sigs/secrets-store-csi-driver) and the azure keyvault provider for the driver ```shell -helm repo add csi-secrets-store-provider-azure https://raw.githubusercontent.com/Azure/secrets-store-csi-driver-provider-azure/master/charts +helm repo add csi-secrets-store-provider-azure https://azure.github.io/secrets-store-csi-driver-provider-azure/charts helm install csi-secrets-store-provider-azure/csi-secrets-store-provider-azure --generate-name ``` diff --git a/examples/kind/kind-demo.sh b/examples/kind/kind-demo.sh index 740e29aad..f7bda1971 100644 --- a/examples/kind/kind-demo.sh +++ b/examples/kind/kind-demo.sh @@ -5,7 +5,7 @@ CLIENT_SECRET=$2 kind create cluster --name kind-csi-demo # install csi-secrets-store-provider-azure -helm repo add csi-secrets-store-provider-azure https://raw.githubusercontent.com/Azure/secrets-store-csi-driver-provider-azure/master/charts +helm repo add csi-secrets-store-provider-azure https://azure.github.io/secrets-store-csi-driver-provider-azure/charts helm install csi-secrets-store-provider-azure/csi-secrets-store-provider-azure --generate-name # create secret in k8 diff --git a/manifest_staging/charts/csi-secrets-store-provider-azure/README.md b/manifest_staging/charts/csi-secrets-store-provider-azure/README.md index 7f5aecf10..9dbeab4a4 100644 --- a/manifest_staging/charts/csi-secrets-store-provider-azure/README.md +++ b/manifest_staging/charts/csi-secrets-store-provider-azure/README.md @@ -27,9 +27,23 @@ Azure Key Vault provider for Secrets Store CSI driver allows you to get secret c | `0.2.1` | `0.3.0` | `0.2.0` | | `1.0.0-rc.0` | `1.0.0-rc.0` | `1.0.0-rc.0` | | `1.0.0` | `1.0.0` | `1.0.0` | +| `1.0.1` | `1.0.1` | `1.0.1` | ## Installation +> Note: The helm chart repository URL has changed from `https://raw.githubusercontent.com/Azure/secrets-store-csi-driver-provider-azure/master/charts` to `https://azure.github.io/secrets-store-csi-driver-provider-azure/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 csi-secrets-store-provider-azure https://azure.github.io/secrets-store-csi-driver-provider-azure/charts --force-update +helm repo update +``` + +
+ Quick start instructions for the setup and configuration of secrets-store-csi-driver and azure keyvault provider using Helm. ### Prerequisites @@ -41,7 +55,7 @@ Quick start instructions for the setup and configuration of secrets-store-csi-dr - This chart installs the [secrets-store-csi-driver](https://github.com/kubernetes-sigs/secrets-store-csi-driver) and the azure keyvault provider for the driver ```shell -helm repo add csi-secrets-store-provider-azure https://raw.githubusercontent.com/Azure/secrets-store-csi-driver-provider-azure/master/charts +helm repo add csi-secrets-store-provider-azure https://azure.github.io/secrets-store-csi-driver-provider-azure/charts helm install csi-secrets-store-provider-azure/csi-secrets-store-provider-azure --generate-name ``` diff --git a/website/content/en/configurations/deploy-in-openshift.md b/website/content/en/configurations/deploy-in-openshift.md index b211c7935..40afa4793 100644 --- a/website/content/en/configurations/deploy-in-openshift.md +++ b/website/content/en/configurations/deploy-in-openshift.md @@ -12,7 +12,7 @@ description: > 1. Install the Azure Keyvault provider for Secrets Store CSI Driver on Azure RedHat OpenShift run: ```bash - helm repo add csi-secrets-store-provider-azure https://raw.githubusercontent.com/Azure/secrets-store-csi-driver-provider-azure/master/charts + helm repo add csi-secrets-store-provider-azure https://azure.github.io/secrets-store-csi-driver-provider-azure/charts helm install csi csi-secrets-store-provider-azure/csi-secrets-store-provider-azure --set linux.privileged=true ``` diff --git a/website/content/en/configurations/ingress-tls.md b/website/content/en/configurations/ingress-tls.md index 6830f81b5..cf572b778 100644 --- a/website/content/en/configurations/ingress-tls.md +++ b/website/content/en/configurations/ingress-tls.md @@ -43,7 +43,7 @@ az keyvault certificate import --vault-name $AKV_NAME -n $CERT_NAME -f $CERT_NAM Deploy the Azure Key Vault Provider and Secrets Store CSI Driver components: ```bash -helm repo add csi-secrets-store-provider-azure https://raw.githubusercontent.com/Azure/secrets-store-csi-driver-provider-azure/master/charts +helm repo add csi-secrets-store-provider-azure https://azure.github.io/secrets-store-csi-driver-provider-azure/charts helm install csi csi-secrets-store-provider-azure/csi-secrets-store-provider-azure --set secrets-store-csi-driver.syncSecret.enabled=true ``` diff --git a/website/content/en/demos/standard-walkthrough/_index.md b/website/content/en/demos/standard-walkthrough/_index.md index 39b6428dd..e7beea153 100644 --- a/website/content/en/demos/standard-walkthrough/_index.md +++ b/website/content/en/demos/standard-walkthrough/_index.md @@ -27,7 +27,7 @@ export KEYVAULT_NAME=secret-store-$(cat /dev/urandom | tr -dc 'a-zA-Z0-9' | fold Deploy the Azure Key Vault Provider and Secrets Store CSI Driver components: ```bash -helm repo add csi-secrets-store-provider-azure https://raw.githubusercontent.com/Azure/secrets-store-csi-driver-provider-azure/master/charts +helm repo add csi-secrets-store-provider-azure https://azure.github.io/secrets-store-csi-driver-provider-azure/charts helm install csi csi-secrets-store-provider-azure/csi-secrets-store-provider-azure ``` diff --git a/website/content/en/getting-started/installation/_index.md b/website/content/en/getting-started/installation/_index.md index b658897f0..43d13008f 100644 --- a/website/content/en/getting-started/installation/_index.md +++ b/website/content/en/getting-started/installation/_index.md @@ -9,6 +9,12 @@ description: > ### Install the Secrets Store CSI Driver and the Azure Keyvault Provider +{{% alert title="Note" color="info" %}} + +The helm chart repository URL has changed to `https://azure.github.io/secrets-store-csi-driver-provider-azure/charts` + +{{% /alert %}} + #### Prerequisites Recommended Kubernetes version: @@ -25,7 +31,7 @@ Azure Key Vault Provider for Secrets Store CSI Driver allows users to customize > Recommended to use Helm3 ```bash -helm repo add csi-secrets-store-provider-azure https://raw.githubusercontent.com/Azure/secrets-store-csi-driver-provider-azure/master/charts +helm repo add csi-secrets-store-provider-azure https://azure.github.io/secrets-store-csi-driver-provider-azure/charts helm install csi csi-secrets-store-provider-azure/csi-secrets-store-provider-azure ``` From 543aa98cc89c7b321218d6c8914ae0a180197e76 Mon Sep 17 00:00:00 2001 From: Anish Ramasekar Date: Tue, 1 Feb 2022 19:03:14 +0000 Subject: [PATCH 2/2] ci: add workflow for publishing helm charts Signed-off-by: Anish Ramasekar --- .github/workflows/chart.yaml | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 .github/workflows/chart.yaml diff --git a/.github/workflows/chart.yaml b/.github/workflows/chart.yaml new file mode 100644 index 000000000..1add35c08 --- /dev/null +++ b/.github/workflows/chart.yaml @@ -0,0 +1,30 @@ +name: publish_helm_chart + +on: + push: + branches: + - master + paths: + - ".github/workflows/chart.yaml" + - "charts/**" + +permissions: + contents: write + +jobs: + deploy: + runs-on: ubuntu-20.04 + steps: + # pinning to the sha 5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f from https://github.com/actions/checkout/releases/tag/v2.3.4 + - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 + with: + submodules: true + fetch-depth: 0 + - name: Publish Helm chart + # pinning to the sha f1701eb82e4d4b82016e7965501c8b6d79feaec9 from https://github.com/stefanprodan/helm-gh-pages/releases/tag/v1.4.1 + uses: stefanprodan/helm-gh-pages@f1701eb82e4d4b82016e7965501c8b6d79feaec9 + with: + token: ${{ secrets.GITHUB_TOKEN }} + charts_dir: charts + target_dir: charts + linting: off