Skip to content

Latest commit

 

History

History
98 lines (68 loc) · 5.4 KB

README.md

File metadata and controls

98 lines (68 loc) · 5.4 KB
Raw

Artifact Attestations Helm Charts

This repository hosts GitHub's Helm charts for deploying a Kubernetes admission controller for Artifact Attestations. This admission controller allows you to enforce the provenance of artifacts deployed to your cluster by verifying their Artifact Attestations.

The admission controller consists of:

These charts are published to GitHub Container Registry (GHCR) as OCI images. Every release is attested with the Attest Build Provenance Action.

You can verify these releases using the gh CLI:

gh attestation verify --owner github \
    oci://ghcr.io/github/artifact-attestations-helm-charts/policy-controller:v0.10.0-github9

For more information, see our documentation on using artifact attestations to establish build provenance and our blog post introducing Artifact Attestations.

Installation

1. Install the Sigstore Policy Controller

You will need to install two charts. First, install the Sigstore policy controller:

helm install policy-controller --atomic \
  --create-namespace --namespace artifact-attestations \
  oci://ghcr.io/github/artifact-attestations-helm-charts/policy-controller \
  --version v0.10.0-github9

The --atomic flag will delete the installation if failure occurs. The --create-namespace will create the release namespace if not present.

2. Install GitHub's TrustRoot and a ClusterImagePolicy

Next, install the GitHub TrustRoot and our default ClusterImagePolicy:

helm install trust-policies --atomic \
 --namespace artifact-attestations \
 oci://ghcr.io/github/artifact-attestations-helm-charts/trust-policies \
 --version v0.6.2 \
 --set policy.enabled=true \
 --set policy.organization=MY-ORGANIZATION

By setting policy.organization to a specific organization, the Sigstore policy controller will verify that the workflow that signed an image's attestation is hosted in a repository owned by the specified organization MY-ORGANIZATION

See the trust-policies values.yaml file for the complete set of ClusterImagePolicy values that can be customized.

3. Enable the policy in your namespace

Now that the ClusterImagePolicy has been installed, we must enable it. The policy will not be enforced until you specify which namespaces it should apply to.

Each namespace in your cluster can independently enforce policies. To enable enforcement in a namespace, you can add the following label to the namespace:

metadata:
  labels:
    policy.sigstore.dev/include: true

Alternatively, you may run:

kubectl label namespace MYNAMESPACE policy.sigstore.dev/include=true

See GitHub's documentation on Enforcing artifact attestations with a Kubernetes admission controller for more information.

License

This project is licensed under the terms of the Apache 2.0 open source license. Please refer to Apache 2.0 for the full terms.

Maintainers

See CODEOWNERS for a list of maintainers.

Support

If you have any questions or issues following examples outlined in this repository, please file an issue and we will assist you.

Maintainer Documentation

Cutting a New Release

When you are ready to cut a new release for a given Helm chart

  1. Update the chart's AppVersion and Version to the appropriate values
  2. Create a new tag prefixed with the targeted chart name in the format -v0.1.2, ex: git tag -s "policy-controller-v0.10.0-github9" -m "policy-controller-v0.10.0-github9"
  3. Push the tag, ex: git push origin "policy-controller-v0.10.0-github9"
  4. The release workflow will be triggered if the chart's tag format is included in the list of tags that trigger the workflow. The tag must follow the format <my-chart-name>-v<semantic-version>