Tutorials on Open Component Model

Best Practices

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

This chapter contains guidelines for common scenarios how to work with the Open Component Model, focusing on using CI/CD, build and publishing processes.

Structure Software Products with OCM

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

Introduction

In this tutorial software products are comprised of logical units called components. A component version consists of a set of technical artifacts (e.g., Docker images, Helm charts, binaries, configuration data, etc.). Such artifacts are called resources in this specification. Resources are usually built from something, e.g., code in a git repo. Those are named sources in this specification.

Input and Access Types

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

Overview
- Input Types
  - binary
  - dir
  - docker
  - dockermulti
  - file
  - helm
  - ociImage
  - spiff
  - utf-8
- Access Types
  - gitHub
  - helm
  - npm
  - ociArtifact
  - s3

Overview

The Open Component Model spec supports multiple methods how to add resources to a component version. There are two different ways to add content: Input Type and Access Type.

Credentials in an .ocmconfig File

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

Overview

The OCM command line client can be configured by supplying it with a configuration file. By default, the CLI looks for configuration in $HOME/.ocmconfig, if it exists.

Configure Credentials for OCM Controllers

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

OCM controller resources need access to OCM components and their resources. If these OCM components are stored in a private OCM repository, we need to configure credentials to allow OCM controller resources to access these repositories.

Example of a Component Descriptor

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

The following is an example of a public-key-based signed component descriptor containing a resource, source and one component reference.

The component is publicly available in the GitHub container registry and can be inspected using the following command:

Deploy a Helm Chart (with Bootstrap)

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

The concept and the Deploy Helm Chart guide showed a basic example of how to deploy a Helm chart from an OCM component. By defining a ResourceGraphDefinition that contains all the required resources to deploy the Helm chart into a Kubernetes cluster.

Transport to Air-Gapped Environments

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

Working with air-gapped environments requires careful preparation and a systematic approach to ensure all component dependencies are available offline. This section demonstrates how to prepare, transport, and deploy OCM components in secure, disconnected environments.