Getting Started on Open Component Model

Prerequisites

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

This and the following chapters walk you through some basic steps to get started with OCM concepts and the OCM CLI. You will learn how to create a component version, display and examine the component, and how to transport and sign it.

Install the OCM CLI

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

Overview

You can install the latest release of the OCM CLI from any of the following sources (more details below):

Create Component Versions

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

Creating and Storing Component Versions

Component Versions are created using a component-constructor.yaml file, which is a description file that contains one or multiple components. The file describes the components and their artifacts - resources and sources, metadata in form of labels and references to other components.

Display and Examine Component Versions

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

List Component Versions

To show a component stored in an OCM repository or CTF archive (which itself is an OCM repository), the ocm get componentversion command can be used:

Sign Component Versions

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

Component versions can be signed to ensure integrity along a transport chain.

Signing requires a key pair, a signature, and, optionally, an issuer, as well as an algorithm and a name for the signature.

Transport Component Versions

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

The section Add Component Version to CTF archive explained how to store component versions in a CTF archive.

During the transfer, it is possible to include component references as local blobs. It is also possible to include references in a recursive way.

Set Up OCM Controller Environment

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

This document describes how to set up a local environment to Deploy a Helm Chart using the OCM controllers.

Prerequisites

kubectl

Start a Local Kubernetes Cluster with kind

Kubernetes Cluster

You don’t need to run kind if you are using a remote Kubernetes cluster you have access to. If so, you can skip this.

Deploy Helm Charts

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

This guide demonstrates how to deploy a Helm Chart from an OCM component version using OCM controllers, kro, and FluxCD. It is a rather basic example, in which it is assumed that a developer created an application, packaged it as a Helm chart, and publishes it as OCM component version in an OCI registry. Then, an operator who wants to deploy the application via Helm chart in a Kubernetes cluster, creates a ResourceGraphDefinition with resources that point to this OCM component version. Using CEL expressions inside the ResourceGraphDefinition, the information about the resource location will be passed to FluxCD, which will then configure the Helm chart and deploy it into the Kubernetes cluster.