Pack on Open Component Model

Add Resources from GitHub

Mon, 01 Jan 0001 00:00:00 +0000

The GitHub/v1 access type is deprecated and will be removed in a future release. For new component versions, use the Git/v1 access type instead: it works with GitHub and every other Git server. Follow the Working with Git Repositories tutorial. Keep this guide for resources that are already published with GitHub/v1.

Add HTTP Resources

Mon, 01 Jan 0001 00:00:00 +0000

Goal

Add a file served over plain HTTP or HTTPS (a release archive, a checksum, a signed binary) to a component version using the Wget/v1 type.

Add OCI Artifacts

Mon, 01 Jan 0001 00:00:00 +0000

In this guide, you’ll learn how to embed OCI artifacts as local blobs inside component versions, so that after a transfer they become natively accessible — pullable with standard OCI tools like docker pull, oras pull, or crane.

Add Helm Chart Resources

Mon, 01 Jan 0001 00:00:00 +0000

Package a Helm chart into an OCM component version as a helmChart resource. A chart can be referenced in place so the component only records where to pull it, or embedded by value so it travels with the component. When the chart is stored in an OCI registry, reference it with the OCIImage/v1 access. This is the recommended way: the chart stays a native OCI artifact, directly helm pull oci://-able, with no copy at build time.

Add Component References

Mon, 01 Jan 0001 00:00:00 +0000

Overview

A component can declare references to other components with the componentReferences field in its constructor. This lets you compose a product out of independently versioned components — for example an app that depends on a backend and a frontend. This guide covers the authoring side: creating and pushing the referenced components, then declaring the references in the app’s constructor.

Add SBOMs

Mon, 01 Jan 0001 00:00:00 +0000

A component version tells you which artifacts you deliver. It does not tell you what is inside them. That answer lives in a Software Bill of Materials. Today, SBOMs might be located in various places, and we need a way to unify them and get all of them together to one location. For the why, see Software Bills of Materials.

Add Git Repositories

Mon, 01 Jan 0001 00:00:00 +0000

OCM can add the files of a Git commit to a component version. This works with any Git server, such as GitHub, GitLab, Gitea, Azure DevOps or your own server, over HTTPS or SSH. This tutorial adds one repository as a resource, as a source and as an embedded snapshot, builds a component version, and downloads the files back.

Add and Verify Ownership Information

Mon, 01 Jan 0001 00:00:00 +0000

Goal

Attach ownership information to a resource so that, given the resource image in a registry, anyone can trace it back to the OCM component version that owns it — then verify that link with standard registry tools.

Compose a Multi-Component Product

Mon, 01 Jan 0001 00:00:00 +0000

Overview

Real-world software products rarely consist of a single component. A web platform, for example, might combine a frontend, a backend, shared configuration, and deployment manifests — each versioned independently. The OCM component constructor lets you model this entire hierarchy in a single file, wiring components together with references, attaching provenance metadata, and injecting versions through environment variables.

Configure a Versioning Scheme

Mon, 01 Jan 0001 00:00:00 +0000

By default OCM assumes semantic versioning. This tutorial shows how to configure a calendar versioning (CalVer) scheme so OCM accepts versions like 2024.03.15 and orders them newest-first.