From ad018a7b1a6dcb756fe2ef5d9f74615e19cff2b0 Mon Sep 17 00:00:00 2001 From: Tim Ramlot <42113979+inteon@users.noreply.github.com> Date: Thu, 15 Feb 2024 11:10:58 +0100 Subject: [PATCH] improve Chart.yaml and README.md Signed-off-by: Tim Ramlot <42113979+inteon@users.noreply.github.com> --- .../charts/cert-manager/Chart.template.yaml | 28 +++++++++++-------- deploy/charts/cert-manager/README.template.md | 10 +++---- 2 files changed, 21 insertions(+), 17 deletions(-) diff --git a/deploy/charts/cert-manager/Chart.template.yaml b/deploy/charts/cert-manager/Chart.template.yaml index 3b5a2d18b..5e1798802 100644 --- a/deploy/charts/cert-manager/Chart.template.yaml +++ b/deploy/charts/cert-manager/Chart.template.yaml @@ -1,23 +1,27 @@ -apiVersion: v1 +apiVersion: v2 + name: cert-manager -# The version and appVersion fields are set automatically by the release tool -version: v0.1.0 -appVersion: v0.1.0 -kubeVersion: ">= 1.22.0-0" description: A Helm chart for cert-manager -home: https://github.com/cert-manager/cert-manager -icon: https://raw.githubusercontent.com/cert-manager/cert-manager/d53c0b9270f8cd90d908460d69502694e1838f5f/logo/logo-small.png +home: https://cert-manager.io +icon: https://raw.githubusercontent.com/cert-manager/community/4d35a69437d21b76322157e6284be4cd64e6d2b7/logo/logo-small.png keywords: - cert-manager - kube-lego - letsencrypt - tls -sources: - - https://github.com/cert-manager/cert-manager +annotations: + artifacthub.io/license: Apache-2.0 + artifacthub.io/category: security + artifacthub.io/prerelease: "{{IS_PRERELEASE}}" maintainers: - name: cert-manager-maintainers email: cert-manager-maintainers@googlegroups.com url: https://cert-manager.io -annotations: - artifacthub.io/license: Apache-2.0 - artifacthub.io/prerelease: "{{IS_PRERELEASE}}" +sources: + - https://github.com/cert-manager/cert-manager + +kubeVersion: ">= 1.22.0-0" + +# The version and appVersion fields are set automatically by the release tool +version: v0.0.0 +appVersion: v0.0.0 \ No newline at end of file diff --git a/deploy/charts/cert-manager/README.template.md b/deploy/charts/cert-manager/README.template.md index d39d3101d..94df384b9 100644 --- a/deploy/charts/cert-manager/README.template.md +++ b/deploy/charts/cert-manager/README.template.md @@ -22,14 +22,14 @@ This is performed in a separate step to allow you to easily uninstall and reinst $ kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/{{RELEASE_VERSION}}/cert-manager.crds.yaml ``` -To install the chart with the release name `my-release`: +To install the chart with the release name `cert-manager`: ```console ## Add the Jetstack Helm repository -$ helm repo add jetstack https://charts.jetstack.io +$ helm repo add jetstack https://charts.jetstack.io --force-update ## Install the cert-manager helm chart -$ helm install my-release --namespace cert-manager --version {{RELEASE_VERSION}} jetstack/cert-manager +$ helm install cert-manager --namespace cert-manager --version {{RELEASE_VERSION}} jetstack/cert-manager ``` In order to begin issuing certificates, you will need to set up a ClusterIssuer @@ -53,10 +53,10 @@ are documented in our full [upgrading guide](https://cert-manager.io/docs/instal ## Uninstalling the Chart -To uninstall/delete the `my-release` deployment: +To uninstall/delete the `cert-manager` deployment: ```console -$ helm delete my-release +$ helm delete cert-manager --namespace cert-manager ``` The command removes all the Kubernetes components associated with the chart and deletes the release.