help on Open Component Model

attributes

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

Description

The OCM library supports a set of attributes, which can be used to influence the behaviour of various functions. The CLI also supports setting of those attributes using the config file (see ocm configfile) or by command line options of the main command (see ocm).

configfile

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

Description

The command line client supports configuring by a given configuration file. If existent, by default, the file $HOME/.ocmconfig will be read. Using the option –config an alternative file can be specified.

credential-handling

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

Description

In contrast to libraries intended for a dedicated technical environment, for example the handling of OCI images in OCI registries, the OCM ecosystem cannot provide a specialized credential management for a dedicated environment.

logging

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

Description

Logging can be configured as part of the ocm config file ( ocm configfile) or by command line options of the ocm command. Details about the YAML structure of a logging settings can be found on https://github.com/mandelsoft/logging.

oci-references

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

Description

The command line client supports a special notation scheme for specifying references to instances of oci like registries. This allows for specifying references to any registry supported by the OCM toolset that can host OCI artifacts. As a subset the regular OCI artifact notation used for docker images are possible:

ocm-accessmethods

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

Description

Access methods are used to handle the access to the content of artifacts described in a component version. Therefore, an artifact entry contains an access specification describing the access attributes for the dedicated artifact.

ocm-downloadhandlers

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

Description

A download handler can be used to process resources to be downloaded from on OCM repository. By default, the blobs provided from the access method (see ocm ocm-accessmethods) are used to store the resource content in the local filesystem. Download handlers can be used to tweak this process. They get access to the blob content and decide on their own what to do with it, or how to transform it into files stored in the file system.

ocm-labels

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

Description

Labels are a set of arbitrary properties, which can be attached to elements of a component version:

a component version itself
the provider of a component version
resources
sources
component references

The dedicated elements support this by providing a field labels, which is a list of label definitions. Every label definition has several fields:

ocm-pubsub

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

Description

An OCM repository can be configured to propagate change events via a publish/subscribe system, if there is a persistence provider for the dedicated repository type. If available any known publish/subscribe system can be configured with ocm set pubsub and shown with ocm get pubsub. Hereby, the pub/sub system is described by a typed specification.

ocm-references

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

Description

The command line client supports a special notation scheme for specifying references to OCM components and repositories. This allows for specifying references to any registry supported by the OCM toolset that can host OCM components:

ocm-uploadhandlers

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

Description

An upload handler is used to process resources using the access method localBlob transferred into an OCM repository. They may decide to store the content in some other storage repository. This may be an additional storage location or it may replace the storage of the resource as local blob. If an additional storage location is chosen, the local access method is kept and the additional location can be registered in the component descriptor as globalAccess attribute of the local access specification.

toi-bootstrapping

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

Description

Tiny OCM Installer (TOI) is a small toolset on top of the Open Component Model. It provides a possibility to run images taken from a component version with user configuration and feed them with the content of this component version. It is some basic mechanism, which can be used to execute simple installation steps based on content described by the Open Component Model (see ocm bootstrap package).