diff --git a/charts/karpenter/README.md.gotmpl b/charts/karpenter/README.md.gotmpl deleted file mode 100644 index ee4c8d1..0000000 --- a/charts/karpenter/README.md.gotmpl +++ /dev/null @@ -1,44 +0,0 @@ -{{ template "chart.header" . }} -{{ template "chart.description" . }} - -{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} - -## Documentation - -For full Karpenter documentation please checkout [https://karpenter.sh](https://karpenter.sh/docs/). - -## Installing the Chart - -You can follow the detailed installation instruction in the [documentation](https://karpenter.sh/docs/getting-started/getting-started-with-karpenter) which covers the Karpenter prerequisites and installation options. The outcome of these instructions should result in something like the following command. - -```bash -helm upgrade --install --namespace karpenter --create-namespace \ - karpenter oci://public.ecr.aws/karpenter/{{ template "chart.name" . }} \ - --version {{ template "chart.version" . }} \ - --set "serviceAccount.annotations.eks\.amazonaws\.com/role-arn=${KARPENTER_IAM_ROLE_ARN}" \ - --set settings.clusterName=${CLUSTER_NAME} \ - --set settings.interruptionQueue=${CLUSTER_NAME} \ - --wait -``` - -### Verification - -As the OCI Helm chart is signed by [Cosign](https://github.com/sigstore/cosign) as part of the release process you can verify the chart before installing it by running the following command. - -```shell -cosign verify public.ecr.aws/karpenter/karpenter:{{ template "chart.version" . }} \ - --certificate-oidc-issuer=https://token.actions.githubusercontent.com \ - --certificate-identity-regexp='https://github\.com/aws/karpenter-provider-aws/\.github/workflows/release\.yaml@.+' \ - --certificate-github-workflow-repository=aws/karpenter-provider-aws \ - --certificate-github-workflow-name=Release \ - --certificate-github-workflow-ref=refs/tags/v{{ template "chart.version" . }} \ - --annotations version={{ template "chart.version" . }} -``` - -{{ template "chart.requirementsSection" . }} - -{{ template "chart.valuesSection" . }} - ----------------------------------------------- - -Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs/).