ocm-references

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:

[+][<type>::][./]<file path>//<component id>[:<version>]

or

[+][<type>::][<json repo spec>//]<component id>[:<version>]

or

[+][<type>::][<scheme>://]<domain>[:<port>][/<repository prefix>]//<component id>[:<version]

or

[+][<type>::][<scheme>://]<host>[:<port>][/<repository prefix>]//<component id>[:<version]

Besides dedicated components it is also possible to denote repositories as a whole:

[+][<type>::][./]<file path>

or

[+][<type>::]<json repo spec>

or

[+][<type>::][<scheme>://]<domain>[:<port>][/<repository prefix>]

or

[+][<type>::][<scheme>://]<host>[:<port>][/<repository prefix>]

The optional + is used for file based implementations (Common Transport Format) to indicate the creation of a not yet existing file.

The type may contain a file format qualifier separated by a + character. The following formats are supported: directory, tar, tgz

Examples


Complete Component Reference Specifications (including all optional arguments):

+ctf+directory::./ocm/ctf//ocm.software/ocmcli:0.7.0

oci::{"baseUrl":"ghcr.io","componentNameMapping":"urlPath","subPath":"open-component-model"}//ocm.software/ocmcli.0.7.0

oci::https://ghcr.io:443/open-component-model//ocm.software/ocmcli:0.7.0

oci::http://localhost:8080/local-component-repository//ocm.software/ocmcli:0.7.0

---

Short-Hand Component Reference Specifications (omitting optional arguments):

./ocm/ctf//ocm.software/ocmcli:0.7.0

ghcr.io/open-component-model//ocm.software/ocmcli:0.7.0

localhost:8080/local-component-repository//ocm.software/ocmcli:0.7.0 (defaulting to https)

http://localhost:8080/local-component-repository//ocm.software/ocmcli:0.7.0

See Also