Skip to content

Commit

Permalink
feat(chart): Added cosign verify docs (#5759)
Browse files Browse the repository at this point in the history
Signed-off-by: Steve Hipwell <steve.hipwell@gmail.com>
Co-authored-by: Jonathan Innis <joinnis@amazon.com>
  • Loading branch information
stevehipwell and jonathan-innis committed Mar 2, 2024
1 parent 7b4854c commit ab96997
Show file tree
Hide file tree
Showing 6 changed files with 45 additions and 3 deletions.
16 changes: 16 additions & 0 deletions charts/karpenter/README.md
Expand Up @@ -22,6 +22,20 @@ helm upgrade --install --namespace karpenter --create-namespace \
--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:0.35.0 \
--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/v0.35.0 \
--annotations version=0.35.0
```

## Values

| Key | Type | Default | Description |
Expand Down Expand Up @@ -97,3 +111,5 @@ helm upgrade --install --namespace karpenter --create-namespace \
| webhook.metrics.port | int | `8001` | The container port to use for webhook metrics. |
| webhook.port | int | `8443` | The container port to use for the webhook. |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.13.0](https://github.com/norwoodj/helm-docs/releases/v1.13.0)
14 changes: 14 additions & 0 deletions charts/karpenter/README.md.gotmpl
Expand Up @@ -21,6 +21,20 @@ helm upgrade --install --namespace karpenter --create-namespace \
--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" . }}
Expand Down
2 changes: 1 addition & 1 deletion hack/release/common.sh
Expand Up @@ -192,7 +192,7 @@ removeOldWebsiteDirectories() {
editWebsiteConfig() {
local version="${1}"

yq -i ".params.latest_release_version = \"v${version}\"" website/hugo.yaml
yq -i ".params.latest_release_version = \"${version}\"" website/hugo.yaml
}

# editWebsiteVersionsMenu sets relevant releases in the version dropdown menu of the website
Expand Down
Expand Up @@ -90,6 +90,18 @@ See [Enabling Windows support](https://docs.aws.amazon.com/eks/latest/userguide/

{{% script file="./content/en/{VERSION}/getting-started/getting-started-with-karpenter/scripts/step08-apply-helm-chart.sh" language="bash"%}}

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.

```bash
cosign verify public.ecr.aws/karpenter/karpenter:{{< param "latest_release_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{{< param "latest_release_version" >}} \
--annotations version={{< param "latest_release_version" >}}
```

{{% alert title="DNS Policy Notice" color="warning" %}}
Karpenter uses the `ClusterFirst` pod DNS policy by default. This is the Kubernetes cluster default and this ensures that Karpetner can reach-out to internal Kubernetes services during its lifetime. There may be cases where you do not have the DNS service that you are using on your cluster up-and-running before Karpenter starts up. The most common case of this is you want Karpenter to manage the node capacity where your DNS service pods are running.

Expand Down
2 changes: 1 addition & 1 deletion website/hugo.yaml
Expand Up @@ -76,7 +76,7 @@ params:
url: "https://slack.k8s.io/"
icon: fab fa-slack
desc: "Chat with us on Slack in the #aws-provider channel"
latest_release_version: v0.35.0
latest_release_version: 0.35.0
latest_k8s_version: 1.29
versions:
- v0.35
Expand Down
2 changes: 1 addition & 1 deletion website/layouts/partials/navbar-version-selector.html
@@ -1,7 +1,7 @@
{{ $pageDir := index (split (path.Dir .Page.RelPermalink) "/") 1 }}
<!-- special treatment for the homepage. we treat it same as latest docs //-->
{{ if or (eq $pageDir "docs") (eq $pageDir "") }}
{{ $pageDir = printf "%s.%s" ( index ( split .Site.Params.latest_release_version "." ) 0 ) ( index ( split .Site.Params.latest_release_version "." ) 1 ) }}
{{ $pageDir = printf "v%s.%s" ( index ( split .Site.Params.latest_release_version "." ) 0 ) ( index ( split .Site.Params.latest_release_version "." ) 1 ) }}
{{ end }}
{{ $pagePath := replace .Page.RelPermalink "docs" "" }}
{{ $pagePath = replace $pagePath $pageDir "" }}
Expand Down

0 comments on commit ab96997

Please sign in to comment.