Skip to content

Commit

Permalink
fix: sign helm chart (#45)
Browse files Browse the repository at this point in the history
  • Loading branch information
soniqua authored Nov 18, 2024
1 parent 0a49fd6 commit 742ee34
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 0 deletions.
1 change: 1 addition & 0 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,7 @@ jobs:
- run:
name: Run semantic-release
command: npx semantic-release
## Note - signing happens via GitHub Action to leverage OIDC. CircleCI doesn't support this directly, yet.

security_scans:
docker:
Expand Down
33 changes: 33 additions & 0 deletions .github/workflows/sigstore.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
on:
## This workflow only runs on the default branch
check_suite:
types: [completed]

jobs:
sign:
runs-on: ubuntu-latest
permissions:
contents: read
id-token: write
name: Sign Chart
steps:
- name: Checkout
uses: actions/checkout@main
with:
fetch-depth: 0
- name: Install Cosign
uses: sigstore/cosign-installer@v3.7.0
- name: Check Cosign
run: cosign version
- name: Cosign with OIDC
run: |
# Get the latest tag
LATEST_TAG=$(git describe --tags 'git rev-list --tags --max-count=1')
# Obtain the digest from this tag
DIGEST=$(curl "https://hub.docker.com/v2/repositories/snyk/snyk-universal-broker/tags/${LATEST_TAG}" | jq '.digest' -r)
# Sign the image, using GitHub as an OIDC provider
cosign sign --yes oci://registry-1.docker.io/snyk/snyk-universal-broker-helm@${DIGEST}
- name: Verify signature
run: |
cosign verify oci://registry-1.docker.io/snyk/snyk-universal-broker-helm@${DIGEST}
cosign verify oci://registry-1.docker.io/snyk/snyk-universal-broker-helm@${LATEST_TAG}
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ This is a Helm Chart to deploy the [Snyk Universal Broker](https://docs.snyk.io/

## Requirements

- Helm `3.8.0` or newer
- (Optionally) the `helm-sigstore` Helm plugin, or `cosign`

### Networking

#### Outbound
Expand All @@ -21,6 +24,14 @@ If a proxy, firewall, or other network appliance sits between Broker and the pub
- the above domains are whitelisted, _and_
- the proxy, firewall or other network appliance supports the websockets protocol

## Installing the Helm Chart for Universal Broker

Pull the Helm Chart, and provide any configuration necessary:

```
helm pull oci://registry-1.docker.io/snyk/snyk-universal-broker
```

## Basic Configuration

### Selecting your Snyk Region
Expand Down

0 comments on commit 742ee34

Please sign in to comment.