ocm_install_plugins.md

January 29, 2025 · View on GitHub

ocm install plugins — Install Or Update An OCM Plugin

Synopsis

ocm install plugins [<options>] <component version ref> [<name>] | <name>

Aliases

plugins, plugin, p

Options

  -c, --constraints constraints   version constraint
  -d, --describe                  describe plugin, only
  -f, --force                     overwrite existing plugin
  -h, --help                      help for plugins
  -r, --remove                    remove plugin
  -u, --update                    update plugin

Description

Download and install a plugin provided by an OCM component version. For the update mode only the plugin name is required.

If no version is specified the latest version is chosen. If at least one version constraint is given, only the matching versions are considered.

If the --repo option is specified, the given names are interpreted relative to the specified repository using the syntax

<component>[:<version>]

If no --repo option is specified the given names are interpreted as located OCM component version references:

[<repo type>::]<host>[:<port>][/<base path>]//<component>[:<version>]

Additionally there is a variant to denote common transport archives and general repository specifications

[<repo type>::]<filepath>|<spec json>[//<component>[:<version>]]

The --repo option takes an OCM repository specification:

[<repo type>::]<configured name>|<file path>|<spec json>

For the Common Transport Format the types directory, tar or tgz is possible.

Using the JSON variant any repository types supported by the linked library can be used:

OCI Repository types (using standard component repository to OCI mapping):

CommonTransportFormat: v1
OCIRegistry: v1
oci: v1
ociRegistry

Examples

$ ocm install plugin ghcr.io/github.com/mandelsoft/cnudie//github.com/mandelsoft/ocmplugin:0.1.0-dev
$ ocm install plugin -c 1.2.x ghcr.io/github.com/mandelsoft/cnudie//github.com/mandelsoft/ocmplugin
$ ocm install plugin -u demo
$ ocm install plugin -r demo