README
¶
Open Component Model
The Open Component Model (OCM) is an open standard to describe software bills of delivery (SBOD). OCM is a technology-agnostic and machine-readable format focused on the software artifacts that must be delivered for software products.
Check out the the main OCM project web page to find out what OCM offers you for implementing a secure software supply chain. It is your central entry point to all kind of OCM related docs and guides, the OCM specification and all project github repositories. It also offers a Getting Started to quickly make your hands dirty with OCM, its toolset and concepts 😃
OCM Specifications
OCM describes delivery artifacts that can be accessed from many types of component repositories. It defines a set of semantic, formatting, and other types of specifications that can be found in the ocm-spec repository. Start learning about the core concepts of OCM elements here.
OCM Library
This project provides a Go library containing an API for interacting with the Open Component Model (OCM) elements and mechanisms.
The library currently supports the following repository mappings:
- OCI: Use the repository prefix path of an OCI repository to implement an OCM repository.
- CTF (Common Transport Format): Use a file-based binding to represent any set of component versions as filesystem content (directory, tar, tgz).
- Component Archive: Compose the content of a component version on the filesystem.
For the usage of the library to access OCM repositories, handle configuration and credentials see the examples section.
Additionally, OCM provides a generic solution for how to:
- Sign component versions in any supported OCM repository implementation.
- Verify signatures based on public keys or verified certificates.
- Transport component versions, per reference or as values to any of the repository implementations.
OCM CLI
The ocm CLI may also be used to interact with OCM mechanisms. It makes it easy to create component versions and embed them in build processes.
The ocm CLI documentation can be found here.
The code for the CLI can be found in package cmds/ocm.
The OCI and OCM support can be found in packages
pkg/contexts/oci and pkg/contexts/ocm.
Installation
Install the latest release via Homebrew, Nix, Docker/Podman or directly from GitHub Releases.
Bash
To install with bash for macOS or Linux execute the following command:
curl -s https://ocm.software/install.sh | sudo bash
Install using Homebrew
# Homebrew (macOS and Linux)
brew install open-component-model/tap/ocm
Install using Nix (with Flakes)
# Nix (macOS, Linux, and Windows)
# ad hoc cmd execution
nix run github:open-component-model/ocm -- --help
nix run github:open-component-model/ocm#helminstaller -- --help
# install development version
nix profile install github:open-component-model/ocm
# or release <version>
nix profile install github:open-component-model/ocm/<version>
#check installation
nix profile list | grep ocm
# optionally, open a new shell and verify that cmd completion works
ocm --help
Usage via Docker / Podman
podman run -t ghcr.io/open-component-model/ocm:latest --help
Build and run it yourself
podman build -t ocm .
podman run --rm -t ocm --loglevel debug --help
or interactively:
podman run --rm -it ocm /bin/sh
You can pass in the following arguments to override the predefined defaults:
GO_VERSION: The golang version to be used for compiling.ALPINE_VERSION: The alpine version to be used as the base image.GO_PROXY: Your go proxy to be used for fetching dependencies.
Please check hub.docker.com for possible version combinations.
podman build -t ocm --build-arg GO_VERSION=1.22 --build-arg ALPINE_VERSION=3.19 --build-arg GO_PROXY=https://proxy.golang.org .
Examples
An example of how to use the ocm CLI in a Makefile can be found in examples/make.
More comprehensive examples can be taken from the components contained in this repository. Here a complete component build including a multi-arch image is done and finally packaged into a CTF archive which can be tranported into an OCI repository. See the readme files for details.
Contributing
Code contributions, feature requests, bug reports, and help requests are very welcome. Please refer to the Contributing Guide in the Community repository for more information on how to contribute to OCM.
OCM follows the CNCF Code of Conduct.
Licensing
Copyright 2024 SAP SE or an SAP affiliate company and Open Component Model contributors. Please see our LICENSE for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available via the REUSE tool.
Documentation
¶
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cmds
|
|
|
examples
|
|
|
hack
|
|
|
pkg
|
|
|
blobaccess
Package blobaccess provides the basic set of the most commonly needed BlobAccess implementations.
|
Package blobaccess provides the basic set of the most commonly needed BlobAccess implementations. |
|
cobrautils/flagsets/flagsetscheme
Package flagsetscheme provides a runtime.TypeScheme with support for command line option sets for the described object types.
|
Package flagsetscheme provides a runtime.TypeScheme with support for command line option sets for the described object types. |
|
contexts/credentials
Package credentials handles the access to credentials for consumers of credential sets.
|
Package credentials handles the access to credentials for consumers of credential sets. |
|
contexts/oci/ociutils/helm/ignore
Package ignore provides tools for writing ignore files (a la .gitignore).
|
Package ignore provides tools for writing ignore files (a la .gitignore). |
|
contexts/ocm/accessmethods/options
Package options defines standard options and option types usable to provide CLI options used to dynamically orchestrate arbitrary access specifications.
|
Package options defines standard options and option types usable to provide CLI options used to dynamically orchestrate arbitrary access specifications. |
|
contexts/ocm/accessmethods/plugin
Package plugin is an adapter implementation that provides a generic handling of all AccessMethods provided by plugins.
|
Package plugin is an adapter implementation that provides a generic handling of all AccessMethods provided by plugins. |
|
contexts/ocm/blobhandler
Package blobhandler contains blobhandlers for handling local blobs for dedicated repository types.
|
Package blobhandler contains blobhandlers for handling local blobs for dedicated repository types. |
|
contexts/ocm/blobhandler/handlers/oci
Package oci contains sub packages for blob handler implementations for dedicated implementations of the oci go binding interface.
|
Package oci contains sub packages for blob handler implementations for dedicated implementations of the oci go binding interface. |
|
contexts/ocm/blobhandler/handlers/ocm
Package ocm contains sub packages for blob handler implementations for dedicated implementations of the default ocm go binding interface.
|
Package ocm contains sub packages for blob handler implementations for dedicated implementations of the default ocm go binding interface. |
|
contexts/ocm/compdesc/normalizations/jsonv1
Package jsonv1 provides a normalization which uses schema specific normalizations.
|
Package jsonv1 provides a normalization which uses schema specific normalizations. |
|
contexts/ocm/compdesc/normalizations/jsonv2
Package jsonv2 provides a normalization which is completely based on the abstract (internal) version of the component descriptor and is therefore agnostic of the final serialization format.
|
Package jsonv2 provides a normalization which is completely based on the abstract (internal) version of the component descriptor and is therefore agnostic of the final serialization format. |
|
contexts/ocm/compdesc/versions/ocm.software/v3alpha1/jsonscheme
Package jsonscheme generated by go-bindata.// sources: ../../../../../../../../resources/component-descriptor-ocm-v3-schema.yaml
|
Package jsonscheme generated by go-bindata.// sources: ../../../../../../../../resources/component-descriptor-ocm-v3-schema.yaml |
|
contexts/ocm/compdesc/versions/v2/jsonscheme
Package jsonscheme generated by go-bindata.// sources: ../../../../../../../resources/component-descriptor-v2-schema.yaml
|
Package jsonscheme generated by go-bindata.// sources: ../../../../../../../resources/component-descriptor-v2-schema.yaml |
|
contexts/ocm/cpi/repocpi
Package repocpi contains the implementation support for repository backends.
|
Package repocpi contains the implementation support for repository backends. |
|
contexts/ocm/download
Package download provides an API for resource download handlers.
|
Package download provides an API for resource download handlers. |
|
contexts/ocm/download/handlers/blueprint
// SPDX-FileCopyrightText: 2023 SAP SE or an SAP affiliate company and Open Component Model contributors.
|
// SPDX-FileCopyrightText: 2023 SAP SE or an SAP affiliate company and Open Component Model contributors. |
|
contexts/ocm/elements
Package elements contains builders for elements of a component version, aka resources, sources and references.
|
Package elements contains builders for elements of a component version, aka resources, sources and references. |
|
contexts/ocm/elements/artifactaccess
Package artifactaccess hosts packages for ResourceAccess and SourceAccess builders used to add resources and sources referring to content in other repositories using access specification to a component version.
|
Package artifactaccess hosts packages for ResourceAccess and SourceAccess builders used to add resources and sources referring to content in other repositories using access specification to a component version. |
|
contexts/ocm/elements/artifactblob
Package artifactblob hosts packages for ResourceAccess and SourceAccess builders used to add resources and sources as local blobs to a component version.
|
Package artifactblob hosts packages for ResourceAccess and SourceAccess builders used to add resources and sources as local blobs to a component version. |
|
contexts/ocm/elements/artifactblob/externalblob
Package ociartifact provides a way to provide ResourceAccess and SourceAccess objects based on external access specification intended to be added as local access.
|
Package ociartifact provides a way to provide ResourceAccess and SourceAccess objects based on external access specification intended to be added as local access. |
|
contexts/ocm/labels/routingslip/types/plugin
Package plugin is an adapter implementation that provides a generic handling of all ValueSets provided by plugins.
|
Package plugin is an adapter implementation that provides a generic handling of all ValueSets provided by plugins. |
|
contexts/ocm/plugin
Package plugin maps a Go plugin interface to a technical command line interface.
|
Package plugin maps a Go plugin interface to a technical command line interface. |
|
contexts/ocm/plugin/cache
Package cache implements the plugin cache that contains all loaded plugins.
|
Package cache implements the plugin cache that contains all loaded plugins. |
|
contexts/ocm/plugin/descriptor
Package descriptor declares several structs that describe the information that formally describes the capabilities provided by each plugin.
|
Package descriptor declares several structs that describe the information that formally describes the capabilities provided by each plugin. |
|
contexts/ocm/plugin/ppi
Package ppi provides the plugin programming interface.
|
Package ppi provides the plugin programming interface. |
|
contexts/ocm/repositories/virtual/example
Package example contains a simple implementation providing a virtual OCM repository based on some opinionated filesystem structure.
|
Package example contains a simple implementation providing a virtual OCM repository based on some opinionated filesystem structure. |
|
contexts/ocm/transfer/transferhandler
Package transferhandler provides the API for transfer handlers used during the transfer process of an OCM component.
|
Package transferhandler provides the API for transfer handlers used during the transfer process of an OCM component. |
|
contexts/ocm/valuemergehandler/hpi
Package hpi contains the Handler Programming Interface for value merge handlers
|
Package hpi contains the Handler Programming Interface for value merge handlers |
|
errors
//nolint: errorlint // this is the new As method, also handling error lists
|
//nolint: errorlint // this is the new As method, also handling error lists |
|
exception
Package exception provides a simple exception mechanism to reduce boilerplate for trivial error forwarding in a function.
|
Package exception provides a simple exception mechanism to reduce boilerplate for trivial error forwarding in a function. |
|
mimeutils
Package mimeutils implements parts of the MIME spec.
|
Package mimeutils implements parts of the MIME spec. |
|
refmgmt
Package refmgmt provides a simple wrapper, which can be used to map a closable object type into an interface supporting reference counting and supporting a Dup() method.
|
Package refmgmt provides a simple wrapper, which can be used to map a closable object type into an interface supporting reference counting and supporting a Dup() method. |
|
refmgmt/finalized
Package finalized provided a view management for a backend object, which is based on Go Garbage Collection and runtime finalizers.
|
Package finalized provided a view management for a backend object, which is based on Go Garbage Collection and runtime finalizers. |
|
refmgmt/resource
Package resource provides support to implement closeable backing resources featuring multiple separately closeable references.
|
Package resource provides support to implement closeable backing resources featuring multiple separately closeable references. |
|
registrations
Package registrations provides a hierarchical namespace for denoting any kind of handlers to be registered on some target.
|
Package registrations provides a hierarchical namespace for denoting any kind of handlers to be registered on some target. |
Click to show internal directories.
Click to hide internal directories.