From 6cc1cf1d3ccaa763b113e89ee5e39cf265c68581 Mon Sep 17 00:00:00 2001 From: Jonathan Stacks Date: Wed, 4 Sep 2024 10:19:24 -0500 Subject: [PATCH] chore(helm): Update docs and chart icon We are moving our repository to charts.ngrok.com --- .github/workflows/install-relased-helm.yaml | 2 +- README.md | 2 +- docs/developer-guide/releasing.md | 2 +- docs/examples/hello-world/README.md | 2 +- helm/ingress-controller/CHANGELOG.md | 8 ++++++++ helm/ingress-controller/Chart.yaml | 4 ++-- helm/ingress-controller/README.md | 2 +- .../__snapshot__/controller-deployment_test.yaml.snap | 4 ++-- .../tests/__snapshot__/controller-pdb_test.yaml.snap | 2 +- .../__snapshot__/controller-serviceaccount_test.yaml.snap | 2 +- .../tests/__snapshot__/ingress-class_test.yaml.snap | 2 +- 11 files changed, 20 insertions(+), 12 deletions(-) diff --git a/.github/workflows/install-relased-helm.yaml b/.github/workflows/install-relased-helm.yaml index 5ab2170a..2c874143 100644 --- a/.github/workflows/install-relased-helm.yaml +++ b/.github/workflows/install-relased-helm.yaml @@ -35,7 +35,7 @@ jobs: - name: Report k8s version run: kubectl version - name: Add helm repo - run: helm repo add ngrok https://ngrok.github.io/kubernetes-ingress-controller + run: helm repo add ngrok https://charts.ngrok.com # - name: Install helm chart env: diff --git a/README.md b/README.md index fa2c5d31..ad644f88 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ Leverage [ngrok](https://ngrok.com/) for your ingress in your Kubernetes cluster Add the ngrok Ingress Controller Helm chart: ```sh -helm repo add ngrok https://ngrok.github.io/kubernetes-ingress-controller +helm repo add ngrok https://charts.ngrok.com ``` Then, install the latest version (setting the appropriate values for your environment): diff --git a/docs/developer-guide/releasing.md b/docs/developer-guide/releasing.md index 5dcf4a03..4cab5048 100644 --- a/docs/developer-guide/releasing.md +++ b/docs/developer-guide/releasing.md @@ -23,7 +23,7 @@ support `amd64` and `arm64` architectures, with future plans to build for other ### Helm Chart -The helm chart is packaged and published to its own [helm repository](https://ngrok.github.io/kubernetes-ingress-controller/index.yaml) +The helm chart is packaged and published to its own [helm repository](https://charts.ngrok.com/index.yaml) and can be installed by following the instructions in the chart's [README](../helm/ingress-controller/README.md). ## Semantic Versioning diff --git a/docs/examples/hello-world/README.md b/docs/examples/hello-world/README.md index baffde2d..4ec146e4 100644 --- a/docs/examples/hello-world/README.md +++ b/docs/examples/hello-world/README.md @@ -14,7 +14,7 @@ First we need to install the controller in the cluster. We'll export our credent ```bash export NGROK_API_KEY= export NGROK_AUTHTOKEN= -helm repo add ngrok https://ngrok.github.io/kubernetes-ingress-controller +helm repo add ngrok https://charts.ngrok.com helm install ngrok-ingress-controller ngrok/kubernetes-ingress-controller --version 0.8.0 \ --set image.tag=0.4.0 \ --namespace ngrok-ingress-controller \ diff --git a/helm/ingress-controller/CHANGELOG.md b/helm/ingress-controller/CHANGELOG.md index 7856a96a..dfdf4698 100644 --- a/helm/ingress-controller/CHANGELOG.md +++ b/helm/ingress-controller/CHANGELOG.md @@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## 0.14.3 +**Full Changelog**: https://github.com/ngrok/kubernetes-ingress-controller/compare/helm-chart-0.14.2...helm-chart-0.14.3 + +### Changed + +- Update `icon` location in `Chart.yaml`. This is a passive change as we migrate to our helm repository to `charts.ngrok.com`. + + ## 0.14.2 **Full Changelog**: https://github.com/ngrok/kubernetes-ingress-controller/compare/helm-chart-0.14.1...helm-chart-0.14.2 diff --git a/helm/ingress-controller/Chart.yaml b/helm/ingress-controller/Chart.yaml index 28b50c0a..449a0264 100644 --- a/helm/ingress-controller/Chart.yaml +++ b/helm/ingress-controller/Chart.yaml @@ -1,7 +1,7 @@ apiVersion: v2 name: kubernetes-ingress-controller description: A Kubernetes ingress controller built using ngrok. -version: 0.14.2 +version: 0.14.3 appVersion: 0.12.2 keywords: - ngrok @@ -12,7 +12,7 @@ keywords: home: https://ngrok.com sources: - https://github.com/ngrok/kubernetes-ingress-controller -icon: https://ngrok.github.io/kubernetes-ingress-controller/ngrok-favicon.svg +icon: https://charts.ngrok.com/assets/ngrok-favicon.svg dependencies: - name: common repository: https://charts.bitnami.com/bitnami diff --git a/helm/ingress-controller/README.md b/helm/ingress-controller/README.md index 40a99201..fe5d3916 100644 --- a/helm/ingress-controller/README.md +++ b/helm/ingress-controller/README.md @@ -17,7 +17,7 @@ Helm's [documentation](https://helm.sh/docs) to get started. Once Helm has been set up correctly, add the repo as follows: -`helm repo add ngrok https://ngrok.github.io/kubernetes-ingress-controller` +`helm repo add ngrok https://charts.ngrok.com` If you had already added this repo earlier, run `helm repo update` to retrieve the latest versions of the packages. You can then run `helm search repo ngrok` to see the charts. diff --git a/helm/ingress-controller/tests/__snapshot__/controller-deployment_test.yaml.snap b/helm/ingress-controller/tests/__snapshot__/controller-deployment_test.yaml.snap index df549051..60c9528a 100644 --- a/helm/ingress-controller/tests/__snapshot__/controller-deployment_test.yaml.snap +++ b/helm/ingress-controller/tests/__snapshot__/controller-deployment_test.yaml.snap @@ -13,7 +13,7 @@ Should match all-options snapshot: app.kubernetes.io/name: kubernetes-ingress-controller app.kubernetes.io/part-of: kubernetes-ingress-controller app.kubernetes.io/version: 0.12.2 - helm.sh/chart: kubernetes-ingress-controller-0.14.2 + helm.sh/chart: kubernetes-ingress-controller-0.14.3 name: RELEASE-NAME-kubernetes-ingress-controller-manager namespace: NAMESPACE spec: @@ -553,7 +553,7 @@ Should match default snapshot: app.kubernetes.io/name: kubernetes-ingress-controller app.kubernetes.io/part-of: kubernetes-ingress-controller app.kubernetes.io/version: 0.12.2 - helm.sh/chart: kubernetes-ingress-controller-0.14.2 + helm.sh/chart: kubernetes-ingress-controller-0.14.3 name: RELEASE-NAME-kubernetes-ingress-controller-manager namespace: NAMESPACE spec: diff --git a/helm/ingress-controller/tests/__snapshot__/controller-pdb_test.yaml.snap b/helm/ingress-controller/tests/__snapshot__/controller-pdb_test.yaml.snap index 57fa518b..713e0d79 100644 --- a/helm/ingress-controller/tests/__snapshot__/controller-pdb_test.yaml.snap +++ b/helm/ingress-controller/tests/__snapshot__/controller-pdb_test.yaml.snap @@ -10,7 +10,7 @@ should match snapshot: app.kubernetes.io/name: kubernetes-ingress-controller app.kubernetes.io/part-of: kubernetes-ingress-controller app.kubernetes.io/version: 0.12.2 - helm.sh/chart: kubernetes-ingress-controller-0.14.2 + helm.sh/chart: kubernetes-ingress-controller-0.14.3 name: test-release-kubernetes-ingress-controller-controller-pdb namespace: test-namespace spec: diff --git a/helm/ingress-controller/tests/__snapshot__/controller-serviceaccount_test.yaml.snap b/helm/ingress-controller/tests/__snapshot__/controller-serviceaccount_test.yaml.snap index 5f9670ea..4ee6e4ec 100644 --- a/helm/ingress-controller/tests/__snapshot__/controller-serviceaccount_test.yaml.snap +++ b/helm/ingress-controller/tests/__snapshot__/controller-serviceaccount_test.yaml.snap @@ -10,6 +10,6 @@ Should match the snapshot: app.kubernetes.io/name: kubernetes-ingress-controller app.kubernetes.io/part-of: kubernetes-ingress-controller app.kubernetes.io/version: 0.12.2 - helm.sh/chart: kubernetes-ingress-controller-0.14.2 + helm.sh/chart: kubernetes-ingress-controller-0.14.3 name: test-release-kubernetes-ingress-controller namespace: test-namespace diff --git a/helm/ingress-controller/tests/__snapshot__/ingress-class_test.yaml.snap b/helm/ingress-controller/tests/__snapshot__/ingress-class_test.yaml.snap index d9f7b4e5..a80d31c0 100644 --- a/helm/ingress-controller/tests/__snapshot__/ingress-class_test.yaml.snap +++ b/helm/ingress-controller/tests/__snapshot__/ingress-class_test.yaml.snap @@ -10,7 +10,7 @@ Should match snapshot: app.kubernetes.io/name: kubernetes-ingress-controller app.kubernetes.io/part-of: kubernetes-ingress-controller app.kubernetes.io/version: 0.12.2 - helm.sh/chart: kubernetes-ingress-controller-0.14.2 + helm.sh/chart: kubernetes-ingress-controller-0.14.3 name: ngrok spec: controller: k8s.ngrok.com/ingress-controller