...
##### Sub Commands
-* [ocm get artifacts](/docs/cli-reference/get/artifacts) — get artifact version
-* [ocm get componentversions](/docs/cli-reference/get/componentversions) — get component version
-* [ocm get config](/docs/cli-reference/get/config) — Get evaluated config for actual command call
-* [ocm get credentials](/docs/cli-reference/get/credentials) — Get credentials for a dedicated consumer spec
-* [ocm get plugins](/docs/cli-reference/get/plugins) — get plugins
-* [ocm get pubsub](/docs/cli-reference/get/pubsub) — Get the pubsub spec for an ocm repository
-* [ocm get references](/docs/cli-reference/get/references) — get references of a component version
-* [ocm get resources](/docs/cli-reference/get/resources) — get resources of a component version
-* [ocm get routingslips](/docs/cli-reference/get/routingslips) — get routings slips for a component version
-* [ocm get sources](/docs/cli-reference/get/sources) — get sources of a component version
-* [ocm get verified](/docs/cli-reference/get/verified) — get verified component versions
+* [ocm get artifacts](/docs/cli-reference/get/artifacts/) — get artifact version
+* [ocm get componentversions](/docs/cli-reference/get/componentversions/) — get component version
+* [ocm get config](/docs/cli-reference/get/config/) — Get evaluated config for actual command call
+* [ocm get credentials](/docs/cli-reference/get/credentials/) — Get credentials for a dedicated consumer spec
+* [ocm get plugins](/docs/cli-reference/get/plugins/) — get plugins
+* [ocm get pubsub](/docs/cli-reference/get/pubsub/) — Get the pubsub spec for an ocm repository
+* [ocm get references](/docs/cli-reference/get/references/) — get references of a component version
+* [ocm get resources](/docs/cli-reference/get/resources/) — get resources of a component version
+* [ocm get routingslips](/docs/cli-reference/get/routingslips/) — get routings slips for a component version
+* [ocm get sources](/docs/cli-reference/get/sources/) — get sources of a component version
+* [ocm get verified]() — get verified component versions
diff --git a/content/docs/cli-reference/get/get_artifacts.md b/content/docs/cli-reference/get/get_artifacts.md
index 18a31418..6e8582ea 100644
--- a/content/docs/cli-reference/get/get_artifacts.md
+++ b/content/docs/cli-reference/get/get_artifacts.md
@@ -2,7 +2,6 @@
title: artifacts
name: get artifacts
url: /docs/cli-reference/get/artifacts/
-date: 2024-04-17T18:02:57+02:00
draft: false
images: []
toc: true
@@ -91,5 +90,5 @@ $ ocm get artifact --repo OCIRegistry::ghcr.io mandelsoft/kubelink
### See Also
-* [ocm get](/docs/cli-reference/get) — Get information about artifacts and components
+* [ocm get](/docs/cli-reference/get/) — Get information about artifacts and components
diff --git a/content/docs/cli-reference/get/get_componentversions.md b/content/docs/cli-reference/get/get_componentversions.md
index 84ffd1b2..041c1217 100644
--- a/content/docs/cli-reference/get/get_componentversions.md
+++ b/content/docs/cli-reference/get/get_componentversions.md
@@ -2,7 +2,6 @@
title: componentversions
name: get componentversions
url: /docs/cli-reference/get/componentversions/
-date: 2024-04-17T18:02:57+02:00
draft: false
images: []
toc: true
@@ -130,5 +129,5 @@ $ ocm get componentversion --repo OCIRegistry::ghcr.io mandelsoft/kubelink
### See Also
-* [ocm get](/docs/cli-reference/get) — Get information about artifacts and components
+* [ocm get](/docs/cli-reference/get/) — Get information about artifacts and components
diff --git a/content/docs/cli-reference/get/get_config.md b/content/docs/cli-reference/get/get_config.md
index 98846a3c..b3556130 100644
--- a/content/docs/cli-reference/get/get_config.md
+++ b/content/docs/cli-reference/get/get_config.md
@@ -2,7 +2,6 @@
title: config
name: get config
url: /docs/cli-reference/get/config/
-date: 2024-04-17T18:02:57+02:00
draft: false
images: []
toc: true
@@ -41,5 +40,5 @@ The following modes are supported:
### See Also
-* [ocm get](/docs/cli-reference/get) — Get information about artifacts and components
+* [ocm get](/docs/cli-reference/get/) — Get information about artifacts and components
diff --git a/content/docs/cli-reference/get/get_credentials.md b/content/docs/cli-reference/get/get_credentials.md
index c1f7c071..0cbafca6 100644
--- a/content/docs/cli-reference/get/get_credentials.md
+++ b/content/docs/cli-reference/get/get_credentials.md
@@ -2,7 +2,6 @@
title: credentials
name: get credentials
url: /docs/cli-reference/get/credentials/
-date: 2024-04-17T18:02:57+02:00
draft: false
images: []
toc: true
@@ -189,5 +188,5 @@ The usage of a dedicated matcher can be enforced by the option --matcher--output the output mode can be selected.
@@ -43,5 +42,5 @@ The following modes are supported:
### See Also
-* [ocm get](/docs/cli-reference/get) — Get information about artifacts and components
+* [ocm get](/docs/cli-reference/get/) — Get information about artifacts and components
diff --git a/content/docs/cli-reference/get/get_references.md b/content/docs/cli-reference/get/get_references.md
index f9f28ead..9a3aca29 100644
--- a/content/docs/cli-reference/get/get_references.md
+++ b/content/docs/cli-reference/get/get_references.md
@@ -2,7 +2,6 @@
title: references
name: get references
url: /docs/cli-reference/get/references/
-date: 2024-04-17T18:02:57+02:00
draft: false
images: []
toc: true
@@ -112,5 +111,5 @@ The following modes are supported:
### See Also
-* [ocm get](/docs/cli-reference/get) — Get information about artifacts and components
+* [ocm get](/docs/cli-reference/get/) — Get information about artifacts and components
diff --git a/content/docs/cli-reference/get/get_resources.md b/content/docs/cli-reference/get/get_resources.md
index 708ded17..bc0a3e3b 100644
--- a/content/docs/cli-reference/get/get_resources.md
+++ b/content/docs/cli-reference/get/get_resources.md
@@ -2,7 +2,6 @@
title: resources
name: get resources
url: /docs/cli-reference/get/resources/
-date: 2024-04-17T18:02:57+02:00
draft: false
images: []
toc: true
@@ -113,5 +112,5 @@ The following modes are supported:
### See Also
-* [ocm get](/docs/cli-reference/get) — Get information about artifacts and components
+* [ocm get](/docs/cli-reference/get/) — Get information about artifacts and components
diff --git a/content/docs/cli-reference/get/get_routingslips.md b/content/docs/cli-reference/get/get_routingslips.md
index dd45e227..71bad0ec 100644
--- a/content/docs/cli-reference/get/get_routingslips.md
+++ b/content/docs/cli-reference/get/get_routingslips.md
@@ -2,7 +2,6 @@
title: routingslips
name: get routingslips
url: /docs/cli-reference/get/routingslips/
-date: 2024-04-17T18:02:57+02:00
draft: false
images: []
toc: true
@@ -107,5 +106,5 @@ The following modes are supported:
### See Also
-* [ocm get](/docs/cli-reference/get) — Get information about artifacts and components
+* [ocm get](/docs/cli-reference/get/) — Get information about artifacts and components
diff --git a/content/docs/cli-reference/get/get_sources.md b/content/docs/cli-reference/get/get_sources.md
index 0bb2b08b..78ce8f9b 100644
--- a/content/docs/cli-reference/get/get_sources.md
+++ b/content/docs/cli-reference/get/get_sources.md
@@ -2,7 +2,6 @@
title: sources
name: get sources
url: /docs/cli-reference/get/sources/
-date: 2024-04-17T18:02:57+02:00
draft: false
images: []
toc: true
@@ -112,5 +111,5 @@ The following modes are supported:
### See Also
-* [ocm get](/docs/cli-reference/get) — Get information about artifacts and components
+* [ocm get](/docs/cli-reference/get/) — Get information about artifacts and components
diff --git a/content/docs/cli-reference/get/get_verified.md b/content/docs/cli-reference/get/get_verified.md
index 9b0e4c2a..7e29c152 100644
--- a/content/docs/cli-reference/get/get_verified.md
+++ b/content/docs/cli-reference/get/get_verified.md
@@ -2,7 +2,6 @@
title: verified
name: get verified
url: /docs/cli-reference/get/verified/
-date: 2024-04-17T18:02:57+02:00
draft: false
images: []
toc: true
@@ -50,5 +49,5 @@ $ ocm get verified -f verified.yaml acme.org/component -o yaml
### See Also
-* [ocm get](/docs/cli-reference/get) — Get information about artifacts and components
+* [ocm get](/docs/cli-reference/get/) — Get information about artifacts and components
diff --git a/content/docs/cli-reference/help/_index.md b/content/docs/cli-reference/help/_index.md
index 787f1412..9f8653b7 100644
--- a/content/docs/cli-reference/help/_index.md
+++ b/content/docs/cli-reference/help/_index.md
@@ -2,7 +2,6 @@
title: help
name: help
url: /docs/cli-reference/help
-date: 2024-04-17T18:02:57+02:00
draft: false
images: []
toc: true
@@ -10,15 +9,16 @@ sidebar:
collapsed: true
---
### Additional Topics
-* [attributes](/docs/cli-reference/attributes) — attributes
-* [configfile](/docs/cli-reference/configfile) — configfile
-* [credential-handling](/docs/cli-reference/credential-handling) — credential-handling
-* [logging](/docs/cli-reference/logging) — logging
-* [oci-references](/docs/cli-reference/oci-references) — oci-references
-* [ocm-accessmethods](/docs/cli-reference/ocm-accessmethods) — ocm-accessmethods
-* [ocm-downloadhandlers](/docs/cli-reference/ocm-downloadhandlers) — ocm-downloadhandlers
-* [ocm-labels](/docs/cli-reference/ocm-labels) — ocm-labels
-* [ocm-pubsub](/docs/cli-reference/ocm-pubsub) — ocm-pubsub
-* [ocm-references](/docs/cli-reference/ocm-references) — ocm-references
-* [ocm-uploadhandlers](/docs/cli-reference/ocm-uploadhandlers) — ocm-uploadhandlers
-* [toi-bootstrapping](/docs/cli-reference/toi-bootstrapping) — toi-bootstrapping
+
+* [attributes](/docs/cli-reference/help/attributes/) — attributes
+* [configfile](/docs/cli-reference/help/configfile/) — configfile
+* [credential-handling](/docs/cli-reference/help/credential-handling/) — credential-handling
+* [logging](/docs/cli-reference/help/logging/) — logging
+* [oci-references](/docs/cli-reference/help/oci-references/) — oci-references
+* [ocm-accessmethods](/docs/cli-reference/help/ocm-accessmethods/) — ocm-accessmethods
+* [ocm-downloadhandlers](/docs/cli-reference/help/ocm-downloadhandlers/) — ocm-downloadhandlers
+* [ocm-labels](/docs/cli-reference/help/ocm-labels/) — ocm-labels
+* [ocm-pubsub](/docs/cli-reference/help/ocm-pubsub/) — ocm-pubsub
+* [ocm-references](/docs/cli-reference/help/ocm-references/) — ocm-references
+* [ocm-uploadhandlers](/docs/cli-reference/help/ocm-uploadhandlers/) — ocm-uploadhandlers
+* [toi-bootstrapping](/docs/cli-reference/help/toi-bootstrapping/) — toi-bootstrapping
diff --git a/content/docs/cli-reference/help/attributes.md b/content/docs/cli-reference/help/attributes.md
index d7086258..2d234728 100644
--- a/content/docs/cli-reference/help/attributes.md
+++ b/content/docs/cli-reference/help/attributes.md
@@ -2,7 +2,6 @@
title: attributes
name: attributes
url: /docs/cli-reference/help/attributes/
-date: 2024-04-17T18:02:57+02:00
draft: false
images: []
toc: true
@@ -14,8 +13,8 @@ sidebar:
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](/docs/cli-reference/configfile)) or by
-command line options of the main command (see [ocm](/docs/cli-reference)).
+attributes using the config file (see [ocm configfile](/docs/cli-reference/help/configfile/)) or by
+command line options of the main command (see [ocm](/docs/cli-reference/)).
The following options are available in the currently used version of the
OCM library:
diff --git a/content/docs/cli-reference/help/configfile.md b/content/docs/cli-reference/help/configfile.md
index d0efb252..7ebc716b 100644
--- a/content/docs/cli-reference/help/configfile.md
+++ b/content/docs/cli-reference/help/configfile.md
@@ -2,7 +2,6 @@
title: configfile
name: configfile
url: /docs/cli-reference/help/configfile/
-date: 2024-04-17T18:02:57+02:00
draft: false
images: []
toc: true
@@ -71,7 +70,7 @@ The following configuration types are supported:
- downloader.ocm.config.ocm.software
The config type downloader.ocm.config.ocm.software can be used to define a list
- of preconfigured download handler registrations (see [ocm ocm-downloadhandlers](/docs/cli-reference/ocm-downloadhandlers)):
+ of preconfigured download handler registrations (see [ocm ocm-downloadhandlers](/docs/cli-reference/help/ocm-downloadhandlers/)):
type: downloader.ocm.config.ocm.software
@@ -322,7 +321,7 @@ The following configuration types are supported:
- uploader.ocm.config.ocm.software
The config type uploader.ocm.config.ocm.software can be used to define a list
- of preconfigured download handler registrations (see [ocm ocm-downloadhandlers](/docs/cli-reference/ocm-downloadhandlers)):
+ of preconfigured download handler registrations (see [ocm ocm-downloadhandlers](/docs/cli-reference/help/ocm-downloadhandlers/)):
type: uploader.ocm.config.ocm.software
diff --git a/content/docs/cli-reference/help/credential-handling.md b/content/docs/cli-reference/help/credential-handling.md
index d5ff1124..8ec0ee14 100644
--- a/content/docs/cli-reference/help/credential-handling.md
+++ b/content/docs/cli-reference/help/credential-handling.md
@@ -2,7 +2,6 @@
title: credential-handling
name: credential-handling
url: /docs/cli-reference/help/credential-handling/
-date: 2024-04-17T18:02:57+02:00
draft: false
images: []
toc: true
@@ -274,7 +273,7 @@ by the provider type).
The type Credentials can be used to inline
credentials in credential configuration objects
to configure mappings of consumer identities to a credential
-set (see [ocm configfile](/docs/cli-reference/configfile)).
+set (see [ocm configfile](/docs/cli-reference/help/configfile/)).
The following types are currently available:
diff --git a/content/docs/cli-reference/help/logging.md b/content/docs/cli-reference/help/logging.md
index e0b5a698..4629339e 100644
--- a/content/docs/cli-reference/help/logging.md
+++ b/content/docs/cli-reference/help/logging.md
@@ -2,7 +2,6 @@
title: logging
name: logging
url: /docs/cli-reference/help/logging/
-date: 2024-04-17T18:02:57+02:00
draft: false
images: []
toc: true
@@ -12,8 +11,8 @@ sidebar:
### Description
-Logging can be configured as part of the ocm config file ([ocm configfile](/docs/cli-reference/configfile))
-or by command line options of the [ocm](/docs/cli-reference) command. Details about
+Logging can be configured as part of the ocm config file ([ocm configfile](/docs/cli-reference/help/configfile/))
+or by command line options of the [ocm](/docs/cli-reference/) command. Details about
the YAML structure of a logging settings can be found on https://github.com/mandelsoft/logging.
The command line also supports some quick-config options for enabling log levels
diff --git a/content/docs/cli-reference/help/oci-references.md b/content/docs/cli-reference/help/oci-references.md
index 13cf0fa6..06d8f729 100644
--- a/content/docs/cli-reference/help/oci-references.md
+++ b/content/docs/cli-reference/help/oci-references.md
@@ -2,7 +2,6 @@
title: oci-references
name: oci-references
url: /docs/cli-reference/help/oci-references/
-date: 2024-04-17T18:02:57+02:00
draft: false
images: []
toc: true
diff --git a/content/docs/cli-reference/help/ocm-accessmethods.md b/content/docs/cli-reference/help/ocm-accessmethods.md
index d93994be..38856d25 100644
--- a/content/docs/cli-reference/help/ocm-accessmethods.md
+++ b/content/docs/cli-reference/help/ocm-accessmethods.md
@@ -2,7 +2,6 @@
title: ocm-accessmethods
name: ocm-accessmethods
url: /docs/cli-reference/help/ocm-accessmethods/
-date: 2024-04-17T18:02:57+02:00
draft: false
images: []
toc: true
@@ -133,7 +132,7 @@ shown below.
An optional keyring used to verify the chart.
It uses the consumer identity type HelmChartRepository with the fields
- for a hostpath identity matcher (see [ocm get credentials](/docs/cli-reference/get/credentials)).
+ for a hostpath identity matcher (see [ocm get credentials](/docs/cli-reference/get/credentials/)).
Options used to configure fields: --accessRepository, --accessVersion, --package
diff --git a/content/docs/cli-reference/help/ocm-downloadhandlers.md b/content/docs/cli-reference/help/ocm-downloadhandlers.md
index a48f4a48..d32efd55 100644
--- a/content/docs/cli-reference/help/ocm-downloadhandlers.md
+++ b/content/docs/cli-reference/help/ocm-downloadhandlers.md
@@ -2,7 +2,6 @@
title: ocm-downloadhandlers
name: ocm-downloadhandlers
url: /docs/cli-reference/help/ocm-downloadhandlers/
-date: 2024-04-17T18:02:57+02:00
draft: false
images: []
toc: true
@@ -14,7 +13,7 @@ sidebar:
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](/docs/cli-reference/ocm-accessmethods)) are used to store the resource content
+(see [ocm ocm-accessmethods](/docs/cli-reference/help/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.
@@ -31,7 +30,7 @@ New handlers can be provided by plugins. In general available handlers,
plugin-based or as part of the CLI coding are nameable using an hierarchical
namespace. Those names can be used by a --downloader option
to register handlers for various conditions for CLI commands like
-[ocm download resources](/docs/cli-reference/download/resources) (implicitly registered download handlers
+[ocm download resources](/docs/cli-reference/download/resources/) (implicitly registered download handlers
can be enabled using the option -d).
Besides the activation constraints (resource type and media type of the
@@ -121,7 +120,7 @@ The following handler names are possible:
-See [ocm ocm-downloadhandlers](/docs/cli-reference/ocm-downloadhandlers) for further details on using
+See [ocm ocm-downloadhandlers](/docs/cli-reference/help/ocm-downloadhandlers/) for further details on using
download handlers.
diff --git a/content/docs/cli-reference/help/ocm-labels.md b/content/docs/cli-reference/help/ocm-labels.md
index 7de9c785..2708411a 100644
--- a/content/docs/cli-reference/help/ocm-labels.md
+++ b/content/docs/cli-reference/help/ocm-labels.md
@@ -2,7 +2,6 @@
title: ocm-labels
name: ocm-labels
url: /docs/cli-reference/help/ocm-labels/
-date: 2024-04-17T18:02:57+02:00
draft: false
images: []
toc: true
diff --git a/content/docs/cli-reference/help/ocm-pubsub.md b/content/docs/cli-reference/help/ocm-pubsub.md
index f4683d91..39625bdb 100644
--- a/content/docs/cli-reference/help/ocm-pubsub.md
+++ b/content/docs/cli-reference/help/ocm-pubsub.md
@@ -2,7 +2,6 @@
title: ocm-pubsub
name: ocm-pubsub
url: /docs/cli-reference/help/ocm-pubsub/
-date: 2024-04-17T18:02:57+02:00
draft: false
images: []
toc: true
@@ -15,8 +14,8 @@ sidebar:
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](/docs/cli-reference/set/pubsub) and shown with
-[ocm get pubsub](/docs/cli-reference/get/pubsub). Hereby, the pub/sub system
+be configured with [ocm set pubsub](/docs/cli-reference/set/pubsub/) and shown with
+[ocm get pubsub](/docs/cli-reference/get/pubsub/). Hereby, the pub/sub system
is described by a typed specification.
diff --git a/content/docs/cli-reference/help/ocm-references.md b/content/docs/cli-reference/help/ocm-references.md
index da399957..a1025483 100644
--- a/content/docs/cli-reference/help/ocm-references.md
+++ b/content/docs/cli-reference/help/ocm-references.md
@@ -2,7 +2,6 @@
title: ocm-references
name: ocm-references
url: /docs/cli-reference/help/ocm-references/
-date: 2024-04-17T18:02:57+02:00
draft: false
images: []
toc: true
diff --git a/content/docs/cli-reference/help/ocm-uploadhandlers.md b/content/docs/cli-reference/help/ocm-uploadhandlers.md
index b48dfabb..c71c5efd 100644
--- a/content/docs/cli-reference/help/ocm-uploadhandlers.md
+++ b/content/docs/cli-reference/help/ocm-uploadhandlers.md
@@ -2,7 +2,6 @@
title: ocm-uploadhandlers
name: ocm-uploadhandlers
url: /docs/cli-reference/help/ocm-uploadhandlers/
-date: 2024-04-17T18:02:57+02:00
draft: false
images: []
toc: true
@@ -38,7 +37,7 @@ New handlers can be provided by plugins. In general available handlers,
plugin-based or as part of the CLI coding are nameable using an hierarchical
namespace. Those names can be used by a --uploader option
to register handlers for various conditions for CLI commands like
-[ocm transfer componentversions](/docs/cli-reference/transfer/componentversions) or [ocm transfer commontransportarchive](/docs/cli-reference/transfer/commontransportarchive).
+[ocm transfer componentversions](/docs/cli-reference/transfer/componentversions/) or [ocm transfer commontransportarchive](/docs/cli-reference/transfer/commontransportarchive/).
Besides the activation constraints (resource type and media type of the
resource blob), it is possible to pass a target configuration controlling the
@@ -93,7 +92,7 @@ The following handler names are possible:
-See [ocm ocm-uploadhandlers](/docs/cli-reference/ocm-uploadhandlers) for further details on using
+See [ocm ocm-uploadhandlers](/docs/cli-reference/help/ocm-uploadhandlers/) for further details on using
upload handlers.
diff --git a/content/docs/cli-reference/help/toi-bootstrapping.md b/content/docs/cli-reference/help/toi-bootstrapping.md
index 07b89871..96171cc7 100644
--- a/content/docs/cli-reference/help/toi-bootstrapping.md
+++ b/content/docs/cli-reference/help/toi-bootstrapping.md
@@ -2,7 +2,6 @@
title: toi-bootstrapping
name: toi-bootstrapping
url: /docs/cli-reference/help/toi-bootstrapping/
-date: 2024-04-17T18:02:57+02:00
draft: false
images: []
toc: true
@@ -17,11 +16,11 @@ 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](/docs/cli-reference/bootstrap/package)).
+(see [ocm bootstrap package](https://github.com/open-component-model/ocm/blob/main/docs/reference/ocm_bootstrap_package.md)).
Therefore, a dedicated resource type toiPackage is defined,
which describes an installation package to be handled by TOI.
-When calling the [ocm bootstrap package](/docs/cli-reference/bootstrap/package) command it is selected by a resource
+When calling the [ocm bootstrap package](https://github.com/open-component-model/ocm/blob/main/docs/reference/ocm_bootstrap_package.md) command it is selected by a resource
identity pattern. The first resource in given component version matching the
pattern is used. A possible use case could be to provide different packages for
different environments. The resource can use an identity attribute
@@ -110,7 +109,7 @@ It has the following format:
- **configFile**: an example template for a parameter file
- **credentialsFile**: an example template for a credentials file
- Those templates can be downloaded with [ocm bootstrap configuration](/docs/cli-reference/bootstrap/configuration).
+ Those templates can be downloaded with [ocm bootstrap configuration](https://github.com/open-component-model/ocm/blob/main/docs/reference/ocm_bootstrap_configuration.md).
#### *ExecutorSpecification*
@@ -359,7 +358,7 @@ It uses the following fields:
in the OCM support library, if used by the executor. At least the field
type and one additional field must be set.
-Credentials are provided in an ocm config file (see [ocm configfile](/docs/cli-reference/configfile)).
+Credentials are provided in an ocm config file (see [ocm configfile](/docs/cli-reference/help/configfile/)).
It uses a memory credential repository with the name default
to store the credentials under the given name. Additionally appropriate
consumer ids will be propagated, if requested in the credentials request config.
diff --git a/content/docs/cli-reference/list/_index.md b/content/docs/cli-reference/list/_index.md
index cab31889..76f07d48 100644
--- a/content/docs/cli-reference/list/_index.md
+++ b/content/docs/cli-reference/list/_index.md
@@ -2,7 +2,6 @@
title: list
name: list
url: /docs/cli-reference/list/
-date: 2024-04-17T18:02:57+02:00
draft: false
images: []
toc: true
@@ -27,5 +26,5 @@ ocm list [] ...
##### Sub Commands
-* [ocm list componentversions](/docs/cli-reference/list/componentversions) — list component version names
+* [ocm list componentversions](/docs/cli-reference/list/componentversions/) — list component version names
diff --git a/content/docs/cli-reference/list/list_componentversions.md b/content/docs/cli-reference/list/list_componentversions.md
index 2d8a39c5..3556096d 100644
--- a/content/docs/cli-reference/list/list_componentversions.md
+++ b/content/docs/cli-reference/list/list_componentversions.md
@@ -2,7 +2,6 @@
title: componentversions
name: list componentversions
url: /docs/cli-reference/list/componentversions/
-date: 2024-04-17T18:02:57+02:00
draft: false
images: []
toc: true
@@ -124,5 +123,5 @@ $ ocm list componentversion --repo OCIRegistry::ghcr.io mandelsoft/kubelink
### See Also
-* [ocm list](/docs/cli-reference/list) — List information about components
+* [ocm list](/docs/cli-reference/list/) — List information about components
diff --git a/content/docs/cli-reference/set/_index.md b/content/docs/cli-reference/set/_index.md
index ff940c87..baf49e71 100644
--- a/content/docs/cli-reference/set/_index.md
+++ b/content/docs/cli-reference/set/_index.md
@@ -2,7 +2,6 @@
title: set
name: set
url: /docs/cli-reference/set/
-date: 2024-04-17T18:02:57+02:00
draft: false
images: []
toc: true
@@ -27,5 +26,5 @@ ocm set [] ...
##### Sub Commands
-* [ocm set pubsub](/docs/cli-reference/set/pubsub) — Set the pubsub spec for an ocm repository
+* [ocm set pubsub](/docs/cli-reference/set/pubsub/) — Set the pubsub spec for an ocm repository
diff --git a/content/docs/cli-reference/set/set_pubsub.md b/content/docs/cli-reference/set/set_pubsub.md
index ff8d7cdf..0f429403 100644
--- a/content/docs/cli-reference/set/set_pubsub.md
+++ b/content/docs/cli-reference/set/set_pubsub.md
@@ -2,7 +2,6 @@
title: pubsub
name: set pubsub
url: /docs/cli-reference/set/pubsub/
-date: 2024-04-17T18:02:57+02:00
draft: false
images: []
toc: true
@@ -32,12 +31,12 @@ to set the pub/sub specification for a repository.
If no specification is given an existing specification
will be removed for the given repository.
The specification
-can be queried with the [ocm get pubsub](/docs/cli-reference/get/pubsub).
+can be queried with the [ocm get pubsub](/docs/cli-reference/get/pubsub/).
Types and specification formats are shown for the topic
-[ocm ocm-pubsub](/docs/cli-reference/ocm-pubsub).
+[ocm ocm-pubsub](/docs/cli-reference/help/ocm-pubsub/).
### See Also
-* [ocm set](/docs/cli-reference/set) — Set information about OCM repositories
+* [ocm set](/docs/cli-reference/set/) — Set information about OCM repositories
diff --git a/content/docs/cli-reference/show/_index.md b/content/docs/cli-reference/show/_index.md
index ea81e936..27ae87fa 100644
--- a/content/docs/cli-reference/show/_index.md
+++ b/content/docs/cli-reference/show/_index.md
@@ -2,7 +2,6 @@
title: show
name: show
url: /docs/cli-reference/show/
-date: 2024-04-17T18:02:57+02:00
draft: false
images: []
toc: true
@@ -27,6 +26,6 @@ ocm show [] ...
##### Sub Commands
-* [ocm show tags](/docs/cli-reference/show/tags) — show dedicated tags of OCI artifacts
-* [ocm show versions](/docs/cli-reference/show/versions) — show dedicated versions (semver compliant)
+* [ocm show tags](/docs/cli-reference/show/tags/) — show dedicated tags of OCI artifacts
+* [ocm show versions](/docs/cli-reference/show/versions/) — show dedicated versions (semver compliant)
diff --git a/content/docs/cli-reference/show/show_tags.md b/content/docs/cli-reference/show/show_tags.md
index 99722e9b..d957d2b8 100644
--- a/content/docs/cli-reference/show/show_tags.md
+++ b/content/docs/cli-reference/show/show_tags.md
@@ -2,7 +2,6 @@
title: tags
name: show tags
url: /docs/cli-reference/show/tags/
-date: 2024-04-17T18:02:57+02:00
draft: false
images: []
toc: true
@@ -75,5 +74,5 @@ $ oci show tags ghcr.io/mandelsoft/kubelink
### See Also
-* [ocm show](/docs/cli-reference/show) — Show tags or versions
+* [ocm show](/docs/cli-reference/show/) — Show tags or versions
diff --git a/content/docs/cli-reference/show/show_versions.md b/content/docs/cli-reference/show/show_versions.md
index bc283ddb..7260e85c 100644
--- a/content/docs/cli-reference/show/show_versions.md
+++ b/content/docs/cli-reference/show/show_versions.md
@@ -2,7 +2,6 @@
title: versions
name: show versions
url: /docs/cli-reference/show/versions/
-date: 2024-04-17T18:02:57+02:00
draft: false
images: []
toc: true
@@ -83,5 +82,5 @@ $ ocm show versions ghcr.io/mandelsoft/cnudie//github.com/mandelsoft/playground
### See Also
-* [ocm show](/docs/cli-reference/show) — Show tags or versions
+* [ocm show](/docs/cli-reference/show/) — Show tags or versions
diff --git a/content/docs/cli-reference/sign/_index.md b/content/docs/cli-reference/sign/_index.md
index f13fe7f9..8052e2ab 100644
--- a/content/docs/cli-reference/sign/_index.md
+++ b/content/docs/cli-reference/sign/_index.md
@@ -2,7 +2,6 @@
title: sign
name: sign
url: /docs/cli-reference/sign/
-date: 2024-04-17T18:02:57+02:00
draft: false
images: []
toc: true
@@ -27,6 +26,6 @@ ocm sign [] ...
##### Sub Commands
-* [ocm sign componentversions](/docs/cli-reference/sign/componentversions) — Sign component version
-* [ocm sign hash](/docs/cli-reference/sign/hash) — sign hash
+* [ocm sign componentversions](/docs/cli-reference/sign/componentversions/) — Sign component version
+* [ocm sign hash](/docs/cli-reference/sign/hash/) — sign hash
diff --git a/content/docs/cli-reference/sign/sign_componentversions.md b/content/docs/cli-reference/sign/sign_componentversions.md
index ea800d45..bc1b790b 100644
--- a/content/docs/cli-reference/sign/sign_componentversions.md
+++ b/content/docs/cli-reference/sign/sign_componentversions.md
@@ -2,7 +2,6 @@
title: componentversions
name: sign componentversions
url: /docs/cli-reference/sign/componentversions/
-date: 2024-04-17T18:02:57+02:00
draft: false
images: []
toc: true
@@ -156,5 +155,5 @@ $ ocm sign componentversion --signature mandelsoft --private-key=mandelsoft.key
### See Also
-* [ocm sign](/docs/cli-reference/sign) — Sign components or hashes
+* [ocm sign](/docs/cli-reference/sign/) — Sign components or hashes
diff --git a/content/docs/cli-reference/sign/sign_hash.md b/content/docs/cli-reference/sign/sign_hash.md
index 3def637a..0f38f60f 100644
--- a/content/docs/cli-reference/sign/sign_hash.md
+++ b/content/docs/cli-reference/sign/sign_hash.md
@@ -2,7 +2,6 @@
title: hash
name: sign hash
url: /docs/cli-reference/sign/hash/
-date: 2024-04-17T18:02:57+02:00
draft: false
images: []
toc: true
@@ -41,5 +40,5 @@ $ ocm sign hash key.priv SHA-256:810ff2fb242a5dee4220f2cb0e6a519891fb67f2f828a6c
### See Also
-* [ocm sign](/docs/cli-reference/sign) — Sign components or hashes
+* [ocm sign](/docs/cli-reference/sign/) — Sign components or hashes
diff --git a/content/docs/cli-reference/transfer/_index.md b/content/docs/cli-reference/transfer/_index.md
index 5b605d6f..c906b659 100644
--- a/content/docs/cli-reference/transfer/_index.md
+++ b/content/docs/cli-reference/transfer/_index.md
@@ -2,7 +2,6 @@
title: transfer
name: transfer
url: /docs/cli-reference/transfer/
-date: 2024-04-17T18:02:57+02:00
draft: false
images: []
toc: true
@@ -27,8 +26,8 @@ ocm transfer [] ...
##### Sub Commands
-* [ocm transfer artifacts](/docs/cli-reference/transfer/artifacts) — transfer OCI artifacts
-* [ocm transfer commontransportarchive](/docs/cli-reference/transfer/commontransportarchive) — transfer transport archive
-* [ocm transfer componentarchive](/docs/cli-reference/transfer/componentarchive) — transfer component archive to some component repository
-* [ocm transfer componentversions](/docs/cli-reference/transfer/componentversions) — transfer component version
+* [ocm transfer artifacts](/docs/cli-reference/transfer/artifacts/) — transfer OCI artifacts
+* [ocm transfer commontransportarchive](/docs/cli-reference/transfer/commontransportarchive/) — transfer transport archive
+* [ocm transfer componentarchive](/docs/cli-reference/transfer/componentarchive/) — transfer component archive to some component repository
+* [ocm transfer componentversions](/docs/cli-reference/transfer/componentversions/) — transfer component version
diff --git a/content/docs/cli-reference/transfer/transfer_artifacts.md b/content/docs/cli-reference/transfer/transfer_artifacts.md
index 3a6b3468..57aebca9 100644
--- a/content/docs/cli-reference/transfer/transfer_artifacts.md
+++ b/content/docs/cli-reference/transfer/transfer_artifacts.md
@@ -2,7 +2,6 @@
title: artifacts
name: transfer artifacts
url: /docs/cli-reference/transfer/artifacts/
-date: 2024-04-17T18:02:57+02:00
draft: false
images: []
toc: true
@@ -91,5 +90,5 @@ $ ocm oci artifact transfer /tmp/ctf gcr.io/my-project
### See Also
-* [ocm transfer](/docs/cli-reference/transfer) — Transfer artifacts or components
+* [ocm transfer](/docs/cli-reference/transfer/) — Transfer artifacts or components
diff --git a/content/docs/cli-reference/transfer/transfer_commontransportarchive.md b/content/docs/cli-reference/transfer/transfer_commontransportarchive.md
index be21b7ab..b1767fe9 100644
--- a/content/docs/cli-reference/transfer/transfer_commontransportarchive.md
+++ b/content/docs/cli-reference/transfer/transfer_commontransportarchive.md
@@ -2,7 +2,6 @@
title: commontransportarchive
name: transfer commontransportarchive
url: /docs/cli-reference/transfer/commontransportarchive/
-date: 2024-04-17T18:02:57+02:00
draft: false
images: []
toc: true
@@ -162,7 +161,7 @@ The uploader name may be a path expression with the following possibilities:
-See [ocm ocm-uploadhandlers](/docs/cli-reference/ocm-uploadhandlers) for further details on using
+See [ocm ocm-uploadhandlers](/docs/cli-reference/help/ocm-uploadhandlers/) for further details on using
upload handlers.
@@ -196,5 +195,5 @@ $ ocm transfer ctf ctf.tgz ghcr.io/mandelsoft/components
### See Also
-* [ocm transfer](/docs/cli-reference/transfer) — Transfer artifacts or components
+* [ocm transfer](/docs/cli-reference/transfer/) — Transfer artifacts or components
diff --git a/content/docs/cli-reference/transfer/transfer_componentarchive.md b/content/docs/cli-reference/transfer/transfer_componentarchive.md
index 701ba0fa..a08cd844 100644
--- a/content/docs/cli-reference/transfer/transfer_componentarchive.md
+++ b/content/docs/cli-reference/transfer/transfer_componentarchive.md
@@ -2,7 +2,6 @@
title: componentarchive
name: transfer componentarchive
url: /docs/cli-reference/transfer/componentarchive/
-date: 2024-04-17T18:02:57+02:00
draft: false
images: []
toc: true
@@ -94,5 +93,5 @@ with the script option family.
### See Also
-* [ocm transfer](/docs/cli-reference/transfer) — Transfer artifacts or components
+* [ocm transfer](/docs/cli-reference/transfer/) — Transfer artifacts or components
diff --git a/content/docs/cli-reference/transfer/transfer_componentversions.md b/content/docs/cli-reference/transfer/transfer_componentversions.md
index cfd8e291..99910225 100644
--- a/content/docs/cli-reference/transfer/transfer_componentversions.md
+++ b/content/docs/cli-reference/transfer/transfer_componentversions.md
@@ -2,7 +2,6 @@
title: componentversions
name: transfer componentversions
url: /docs/cli-reference/transfer/componentversions/
-date: 2024-04-17T18:02:57+02:00
draft: false
images: []
toc: true
@@ -219,7 +218,7 @@ The uploader name may be a path expression with the following possibilities:
-See [ocm ocm-uploadhandlers](/docs/cli-reference/ocm-uploadhandlers) for further details on using
+See [ocm ocm-uploadhandlers](/docs/cli-reference/help/ocm-uploadhandlers/) for further details on using
upload handlers.
@@ -254,5 +253,5 @@ $ ocm transfer components -t tgz --repo OCIRegistry::ghcr.io mandelsoft/kubelink
### See Also
-* [ocm transfer](/docs/cli-reference/transfer) — Transfer artifacts or components
+* [ocm transfer](/docs/cli-reference/transfer/) — Transfer artifacts or components
diff --git a/content/docs/cli-reference/verify/_index.md b/content/docs/cli-reference/verify/_index.md
index 79010377..7a5d89f6 100644
--- a/content/docs/cli-reference/verify/_index.md
+++ b/content/docs/cli-reference/verify/_index.md
@@ -2,7 +2,6 @@
title: verify
name: verify
url: /docs/cli-reference/verify/
-date: 2024-04-17T18:02:57+02:00
draft: false
images: []
toc: true
@@ -27,5 +26,5 @@ ocm verify [] ...
##### Sub Commands
-* [ocm verify componentversions](/docs/cli-reference/verify/componentversions) — Verify signature of component version
+* [ocm verify componentversions](/docs/cli-reference/verify/componentversions/) — Verify signature of component version
diff --git a/content/docs/cli-reference/verify/verify_componentversions.md b/content/docs/cli-reference/verify/verify_componentversions.md
index 3d92a63f..5fcd6b68 100644
--- a/content/docs/cli-reference/verify/verify_componentversions.md
+++ b/content/docs/cli-reference/verify/verify_componentversions.md
@@ -2,7 +2,6 @@
title: componentversions
name: verify componentversions
url: /docs/cli-reference/verify/componentversions/
-date: 2024-04-17T18:02:57+02:00
draft: false
images: []
toc: true
@@ -131,5 +130,5 @@ $ ocm verify componentversion --signature mandelsoft --public-key=mandelsoft.key
### See Also
-* [ocm verify](/docs/cli-reference/verify) — Verify component version signatures
+* [ocm verify](/docs/cli-reference/verify/) — Verify component version signatures
diff --git a/content/docs/contribution/contributing.md b/content/docs/contribution/contributing.md
index afdcdaa1..eda31557 100644
--- a/content/docs/contribution/contributing.md
+++ b/content/docs/contribution/contributing.md
@@ -2,8 +2,6 @@
title: "Contributing Guideline"
description: "Contributing Guideline"
lead: ""
-date: 2022-08-12T10:38:22+01:00
-lastmod: 2022-08-12T10:38:22+01:00
draft: false
images: []
weight: 101
@@ -29,9 +27,9 @@ Thank you for taking the time to contribute to OCM.
## DCO
-By contributing to this project you agree to the Developer Certificate of Origin ([DCO](DCO)). This document was created by the Linux Kernel community and is a simple statement that you, as a contributor, have the legal right to make the contribution.
+By contributing to this project you agree to the Developer Certificate of Origin ([DCO](https://raw.githubusercontent.com/open-component-model/.github/main/DCO)). This document was created by the Linux Kernel community and is a simple statement that you, as a contributor, have the legal right to make the contribution.
-We require all commits to be [signed](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits). By signing off with your signature, you certify that you wrote the patch or otherwise have the right to contribute the material by the rules of the [DCO](DCO):
+We require all commits to be [signed](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits). By signing off with your signature, you certify that you wrote the patch or otherwise have the right to contribute the material by the rules of the [DCO](https://raw.githubusercontent.com/open-component-model/.github/main/DCO):
`Signed-off-by: Jane Doe `
@@ -60,7 +58,7 @@ We welcome all types of contributions, including:
- Reviews
- [Board discussions](https://github.com/open-component-model/ocm/discussions)
-You may find it helpful to start a new thread in the [`ocm` Discussion Board](https://github.com/open-component-model/ocm/discussions) for questions, help requests, feature requests, or any other type of discussion about OCM. A maintaine will reach out to you as soon as possible.
+You may find it helpful to start a new thread in the [`ocm` Discussion Board](https://github.com/open-component-model/ocm/discussions) for questions, help requests, feature requests, or any other type of discussion about OCM. A maintainer will reach out to you as soon as possible.
### Find an Issue
diff --git a/content/docs/controller/installation.md b/content/docs/controller/installation.md
index 8ed6f6fe..de16fb1e 100644
--- a/content/docs/controller/installation.md
+++ b/content/docs/controller/installation.md
@@ -11,7 +11,7 @@ toc: true
## ocm-controller
-The `ocm-controller` can be installed using the [OCM CLI](/docs/overview/installation):
+The `ocm-controller` can be installed using the [OCM CLI](/docs/getting-started/installing-the-ocm-cli):
```bash
ocm controller install
diff --git a/content/docs/examples/secure-software-delivery.md b/content/docs/examples/secure-software-delivery.md
index 1d69ed49..b8be74e0 100644
--- a/content/docs/examples/secure-software-delivery.md
+++ b/content/docs/examples/secure-software-delivery.md
@@ -22,6 +22,7 @@ This walkthrough deploys a full end-to-end pipeline demonstrating how OCM and Fl
The demo environment consists of Gitea, Tekton, Flux and the OCM controller.
Two Gitea organizations are created:
+
- [software-provider](https://gitea.ocm.dev/software-provider)
- [software-consumer](https://gitea.ocm.dev/software-consumer)
@@ -155,5 +156,5 @@ OCM follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/m
## Licensing
Copyright 2024 SE or an SAP affiliate company and Open Component Model contributors.
-Please see our [LICENSE](LICENSE) for copyright and license information.
+Please see our [LICENSE](https://raw.githubusercontent.com/open-component-model/.github/main/LICENSE) for copyright and license information.
Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/open-component-model/demo-secure-delivery).
diff --git a/content/docs/overview/project.md b/content/docs/overview/project.md
index 27d6d35e..252ba04f 100644
--- a/content/docs/overview/project.md
+++ b/content/docs/overview/project.md
@@ -3,8 +3,6 @@ title : "About the OCM Project"
description: "About the Open Component Model Project"
url: /docs/overview/about
lead: ""
-date: 2020-10-06T08:48:23+00:00
-lastmod: 2020-10-06T08:48:23+00:00
draft: false
weight: 11
toc: true
@@ -13,7 +11,7 @@ images: []
The Open Component Model (OCM) project provides an open standard for describing software artifacts and lifecycle metadata, with the purpose to securely deliver and deploy software products. It facilitates asynchronous handling of various lifecycle management processes, such as compliance checks, security scans, deployments, and more, in a decoupled and streamlined manner. OCM provides the ability to deliver software securely, consistently, and compliantly across cloud, on-prem, hybrid and air-gapped environments.
-
+
Below are the main projects, but please also check out the others in our [Github org](https://github.com/open-component-model).
@@ -22,5 +20,3 @@ Below are the main projects, but please also check out the others in our [Github
- [OCM CLI](https://github.com/open-component-model/ocm#ocm-cli) - With the `ocm` command line interface end users can interact with OCM elements, helping them create component versions and embed them in CI and CD processes. Examples can be found in [this Makefile](https://github.com/open-component-model/ocm/blob/main/examples/make/Makefile).
- [OCM Controller](https://github.com/open-component-model/ocm-controller) - The `ocm-controllers` are designed to enable the automated deployment of software using the [Open Component Model](https://ocm.software) and Flux.
- [OCM Website](https://github.com/open-component-model/ocm-website) - The `ocm-website` you are currently visiting. It is built using Hugo and hosted on Github Pages.
-
-
diff --git a/content/docs/roadmap/roadmap.md b/content/docs/roadmap/roadmap.md
index 4697e280..ee333c74 100644
--- a/content/docs/roadmap/roadmap.md
+++ b/content/docs/roadmap/roadmap.md
@@ -14,4 +14,4 @@ sidebar:
You can checkout the [Project Roadmap on GitHub](https://github.com/orgs/open-component-model/projects/10/views/5) which is based on issues and PRs from the [OCM project repository](https://github.com/open-component-model/ocm-project).
-
+
diff --git a/content/docs/tutorials/best-practices-with-ocm.md b/content/docs/tutorials/best-practices-with-ocm.md
index 8575b170..7219f911 100644
--- a/content/docs/tutorials/best-practices-with-ocm.md
+++ b/content/docs/tutorials/best-practices-with-ocm.md
@@ -29,7 +29,7 @@ This chapter contains guidelines for common scenarios how to work with the Open
The Open Component Model (OCM) provides a public schema to validate and offer auto-completion of component constructor files
used to create component descriptors.
-This schema is available at [https://ocm.software/schemas/configuration-schema.yaml](https://ocm.software/schemas/configuration-schema.yaml).
+This schema is available at [https://ocm.software/schemas/configuration-schema.yaml](/schemas/configuration-schema.yaml).
To use this schema in your IDE, you can add the following line to your component constructor file:
@@ -88,7 +88,7 @@ OCM component versions generated by the build. This archive can then be
used by the build-system to do whatever is required to make the content accessible
by others.
-The composition of such archives is described in the [Getting Started](/docs/getting-started/getting-started-with-ocm/prerequisites) section.
+The composition of such archives is described in the [Getting Started](/docs/getting-started/getting-started-with-ocm/prerequisites/) section.
To secure further processes, a *certified build-system* could even sign the content with
its build system certificate to enable followup-processes to verify that involved component
@@ -101,7 +101,7 @@ versions are provided by accepted and well-known processes.
At the time of writing this guide Docker is not able to build multi-architecture (multi-arch / multi-platform)
images natively. Instead, the `buildx` plugin is used. However, this implies building and pushing
images in one step to a remote container registry as the local Docker image store does not
-support multi-arch images (for additional information, see the [Multi-arch build and images, the simple way](https://www.docker.com/blog/multi-arch-build-and-images-the-simple-way) blogpost)
+support multi-arch images (for additional information, see the [Multi-arch build and images, the simple way](https://www.docker.com/blog/multi-arch-build-and-images-the-simple-way) blog post)
The OCM CLI has some built-in support for dealing with multi-arch images during the
component version composition ([`ocm add resources`](https://github.com/open-component-model/ocm/blob/main/docs/reference/ocm_add_resources.md)).
@@ -266,11 +266,11 @@ eu.gcr.io/acme/simpleserver 0.1.0-linux-amd64 08641d64f612 About a minute
In the next step we create a component archive and a transport archive
```shell
-$ PROVIDER=acme
-$ COMPONENT=github.com/$(PROVIDER)/simpleserver
-$ VERSION=0.1.0
-$ mkdir gen
-$ ocm create ca ${COMPONENT} ${VERSION} --provider ${PROVIDER} --file gen/ca
+PROVIDER=acme
+COMPONENT=github.com/$(PROVIDER)/simpleserver
+VERSION=0.1.0
+mkdir gen
+ocm create ca ${COMPONENT} ${VERSION} --provider ${PROVIDER} --file gen/ca
```
Create the file `resources.yaml`. Note the variants in the image input and the type `dockermulti`:
@@ -417,6 +417,7 @@ x index.json
}
}
```
+
You can create a common transport archive from the component archive.
@@ -632,7 +633,7 @@ declared in the Makefile. Use either an environment variable or an argument when
Example:
```shell
-$ PROVIDER=foo make ca
+PROVIDER=foo make ca
```
### Templating the Resources
@@ -755,6 +756,7 @@ NGINX_CHART_VERSION: 4.4.2
```
auto-generated from a build script:
+
```yaml
VERSION: 0.23.1
COMMIT: 5f03021059c7dbe760ac820a014a8a84166ef8b4
diff --git a/content/docs/tutorials/build-deploy-software-via-helm-charts-with-ocm-101.md b/content/docs/tutorials/build-deploy-software-via-helm-charts-with-ocm-101.md
index ac284c5a..7a8ac34f 100644
--- a/content/docs/tutorials/build-deploy-software-via-helm-charts-with-ocm-101.md
+++ b/content/docs/tutorials/build-deploy-software-via-helm-charts-with-ocm-101.md
@@ -13,7 +13,7 @@ toc: true
## Introduction
Let's illustrate a very simple "Hello World" example application and show how to leverage OCM to build an application component containing a Helm Chart and an OCI Image and deploy it to a local `kind` k8s cluster.
-The topics `ocm` [`localization`](https://ocm.software/docs/tutorials/deployment-scenario-using-an-aggregated-component/#localization) and [`configuration`](https://ocm.software/docs/tutorials/deployment-scenario-using-an-aggregated-component/#configuration) are NOT part of this very simple example, but is covered in other tutorials.
+The topics `ocm` [`localization`](/docs/tutorials/structuring-and-deploying-software-products-with-ocm/#localization) and [`configuration`](/docs/tutorials/structuring-and-deploying-software-products-with-ocm/#configuration) are NOT part of this very simple example, but is covered in other tutorials.
As base we use the `podinfo` application from Stefan Prodan's [Github repo](https://github.com/stefanprodan/podinfo).
All files can be found [here](https://github.com/open-component-model/ocm-examples/tree/main/components).
@@ -96,7 +96,7 @@ components:
access:
type: ociArtifact
imageReference: ghcr.io/stefanprodan/charts/podinfo:${PODINFO_VERSION}
- # Helm Chart in Helm repository
+ # Helm Chart in Helm repository
- name: helm-chart-external-helm-repo
type: helmChart
version: ${PODINFO_VERSION}
@@ -130,7 +130,7 @@ components:
Some frequently changing parameters have been extracted as variables. The OCM CLI uses
templating to fill them with values. The templating mechanism is described
-[here](https://ocm.software/docs/tutorials/best-practices/#templating-the-resources). For this example
+[here](/docs/tutorials/best-practices/#templating-the-resources). For this example
we use the default template engine type `subst`.
Note the differences between the various components:
@@ -190,7 +190,7 @@ configuration of credentials for the OCM CLI):
ocm transfer ctf -f
```
-Using the `--copy-resources` flag the OCM CLI will copy also copy all referenced resourcres to the OCI registry, making the resources part of the OCM component version, creating a self-contained component version.
+Using the `--copy-resources` flag the OCM CLI will copy also copy all referenced resources to the OCI registry, making the resources part of the OCM component version, creating a self-contained component version.
```shell
ocm transfer ctf --copy-resources --enforce --overwrite ./ocm-hello-world OCIRegistry::ghcr.io/stb1337/ocm-hello-world-v1
@@ -216,7 +216,7 @@ and should never be changed.
Navigate to the overview of your OCI repository, which should list the following items:
-
+
## Deploying the OCM Software Artifact
@@ -605,7 +605,7 @@ Forwarding from [::1]:9898 -> 9898
Handling connection for 9898
```
-
+
```shell
kubectl port-forward service/podinfo-helm-chart-local-tgz -n default 9898:9898
@@ -614,4 +614,4 @@ Forwarding from [::1]:9898 -> 9898
Handling connection for 9898
```
-
+
diff --git a/content/docs/tutorials/complex-component-structure-deployment.md b/content/docs/tutorials/complex-component-structure-deployment.md
index 3524a59c..46039f92 100644
--- a/content/docs/tutorials/complex-component-structure-deployment.md
+++ b/content/docs/tutorials/complex-component-structure-deployment.md
@@ -46,7 +46,7 @@ references, you could collect all artifacts belonging to this product version.
## Prerequisites
-We assume that you have already read the guides in the [Getting Started](https://ocm.software/docs/getting-started/getting-started-with-ocm/prerequisites/) section, as this guide discusses a more
+We assume that you have already read the guides in the [Getting Started](/docs/getting-started/getting-started-with-ocm/prerequisites/) section, as this guide discusses a more
complex scenario using plain Localizations and Configurations without the use of [Unpacker](https://github.com/open-component-model/unpacker-controller).
## Constructing the Component
@@ -275,7 +275,7 @@ tree .
2 directories, 19 files
```
-These blobs contain the resources we described when modelling our podinfo application. If we `cat `a random blob we get
+These blobs contain the resources we described when modelling our podinfo application. If we `cat` a random blob we get
something like this:
```sh
@@ -990,7 +990,7 @@ The **helm-controller** and **notification-controller** aren't relevant.
The `ComponentVersion` object contains information about what components have been reconciled. We talked about that
earlier at [Component Version](#componentversion). The `Status` section contains any errors that could have
-occurred when reconciling information.
+occurred when reconciling information.
**ComponentDescriptor**:
@@ -1094,7 +1094,6 @@ kubectl port-forward service/registry -n ocm-system 5000:5000
Then, verify that the connection is working by running a `catalog` command:
-
```sh
crane catalog http://127.0.0.1:5000
```
diff --git a/content/docs/tutorials/input_and_access.md b/content/docs/tutorials/input_and_access.md
index 8c5428bf..2c579af4 100644
--- a/content/docs/tutorials/input_and_access.md
+++ b/content/docs/tutorials/input_and_access.md
@@ -50,23 +50,23 @@ in a component descriptor.
The following input types are supported:
-* binary
-* dir
-* docker
-* dockermulti
-* file
-* helm
-* ociImage
-* spiff
-* utf-8
+- binary
+- dir
+- docker
+- dockermulti
+- file
+- helm
+- ociImage
+- spiff
+- utf-8
The following list of access types is supported:
-* gitHub
-* localBlob
-* ociArtifact
-* ociBlob
-* s3
+- gitHub
+- localBlob
+- ociArtifact
+- ociBlob
+- s3
Not all access and input types can be combined in useful ways with all artifact types. But the OCM specification does not define any restrictions on possible combinations.
diff --git a/content/docs/tutorials/ocm-and-gitops/air-gapped-gitops-with-ocm-and-flux.md b/content/docs/tutorials/ocm-and-gitops/air-gapped-gitops-with-ocm-and-flux.md
index 3094f26e..8aa8d7d8 100644
--- a/content/docs/tutorials/ocm-and-gitops/air-gapped-gitops-with-ocm-and-flux.md
+++ b/content/docs/tutorials/ocm-and-gitops/air-gapped-gitops-with-ocm-and-flux.md
@@ -16,7 +16,7 @@ In this guide, we will show you how the tools provided by OCM make it possible t
Air-gapped can mean different things depending on the context. For this guide, we'll assume it means your deployment artifacts are stored in a private registry protected by the security controls at your organization. Your applications only have access to this private registry and little to no public internet access.
-We'll take the same `podinfo` component that we deployed in the [Deploy Applications with OCM & GitOps](https://ocm.software/docs/tutorials/ocm-and-gitops/deploying-applications-with-ocm-gitops/) guide but this time we will use the OCM CLI to transfer the component to our own registry. The application will then be deployed from this "private" registry. This, of course, mimics a real-world air-gap scenario. In practice, there could be many layers of security between the two registries; however, the mechanics are ultimately the same.
+We'll take the same `podinfo` component that we deployed in the [Deploy Applications with OCM & GitOps](/docs/tutorials/ocm-and-gitops/deploying-applications-with-ocm-gitops/) guide but this time we will use the OCM CLI to transfer the component to our own registry. The application will then be deployed from this "private" registry. This, of course, mimics a real-world air-gap scenario. In practice, there could be many layers of security between the two registries; however, the mechanics are ultimately the same.
## Table of Contents
@@ -122,7 +122,7 @@ We can see that the image reference now points to an image stored in our air-gap
Now that our component has been successfully transferred, let's deploy it using GitOps.
-We assume you have completed the [Deploy Applications with OCM & GitOps](https://ocm.software/docs/tutorials/ocm-and-gitops/deploying-applications-with-ocm-gitops/) guide and will use that repository as the starting point for our air-gapped deployment.
+We assume you have completed the [Deploy Applications with OCM & GitOps](/docs/tutorials/ocm-and-gitops/deploying-applications-with-ocm-gitops/) guide and will use that repository as the starting point for our air-gapped deployment.
Because our air-gapped OCM repository is private, we need to provide credentials. This will enable the `ocm-controller` to retrieve components from the repository.
@@ -259,7 +259,7 @@ LAST SEEN TYPE REASON OBJECT MESSAGE
5m44s Warning Failed pod/podinfo-7b7d874bf8-xv75x Error: ImagePullBackOff
```
-Check out our [GitOps Driven Configuration of OCM Applications](https://ocm.software/docs/tutorials/ocm-and-gitops/gitops-driven-configuration-of-ocm-applications) guide to see how we can use the `ocm-controller` to configure our application at runtime and solve exactly this kind of problem!
+Check out our [GitOps Driven Configuration of OCM Applications](/docs/tutorials/ocm-and-gitops/gitops-driven-configuration-of-ocm-applications) guide to see how we can use the `ocm-controller` to configure our application at runtime and solve exactly this kind of problem!
### Conclusion
diff --git a/content/docs/tutorials/ocm-and-gitops/deploying-applications-with-ocm-and-gitops.md b/content/docs/tutorials/ocm-and-gitops/deploying-applications-with-ocm-and-gitops.md
index c5bd35d7..5c06333d 100644
--- a/content/docs/tutorials/ocm-and-gitops/deploying-applications-with-ocm-and-gitops.md
+++ b/content/docs/tutorials/ocm-and-gitops/deploying-applications-with-ocm-and-gitops.md
@@ -22,7 +22,7 @@ Here's a diagram showing what we'll be building:
As you can see, we'll add some manifests to a git repository that will be deployed by Flux. These will, in turn, deploy a resource from an OCM repository, in this case, a `Deployment` of the `podinfo` microservice.
-If you'd like to learn how to build a component, then check out our [Getting Started guide](https://ocm.software/docs/getting-started/getting-started-with-ocm/prerequisites).
+If you'd like to learn how to build a component, then check out our [Getting Started guide](/docs/getting-started/getting-started-with-ocm/prerequisites).
## Table of Contents
@@ -211,5 +211,5 @@ That's it! That's how easy it is to get started using the Open Component Model a
If you want to know more about working with OCM and GitOps, check out these guides:
-- [Air-gapped GitOps with OCM & Flux](https://ocm.software/docs/tutorials/ocm-and-gitops/air-gapped-gitops-with-ocm-flux/)
-- [GitOps Driven Configuration of OCM Applications](https://ocm.software/docs/tutorials/ocm-and-gitops/gitops-driven-configuration-of-ocm-applications/)
+- [Air-gapped GitOps with OCM & Flux](/docs/tutorials/ocm-and-gitops/air-gapped-gitops-with-ocm-flux/)
+- [GitOps Driven Configuration of OCM Applications](/docs/tutorials/ocm-and-gitops/gitops-driven-configuration-of-ocm-applications/)
diff --git a/content/docs/tutorials/ocm-and-gitops/gitops-driven-configuration-of-ocm-applications.md b/content/docs/tutorials/ocm-and-gitops/gitops-driven-configuration-of-ocm-applications.md
index fd8e87fa..1e4153c4 100644
--- a/content/docs/tutorials/ocm-and-gitops/gitops-driven-configuration-of-ocm-applications.md
+++ b/content/docs/tutorials/ocm-and-gitops/gitops-driven-configuration-of-ocm-applications.md
@@ -16,8 +16,8 @@ This guide is the final part of our series exploring OCM, the `ocm-controller`,
Check out the previous guides if you haven't already:
-- [Deploy Applications with OCM & GitOps](https://ocm.software/docs/tutorials/ocm-and-gitops/deploying-applications-with-ocm-and-gitops)
-- [Air-gapped GitOps with OCM & Flux](https://ocm.software/docs/tutorials/ocm-and-gitops/air-gapped-gitops-with-ocm-and-flux)
+- [Deploy Applications with OCM & GitOps](/docs/tutorials/ocm-and-gitops/deploying-applications-with-ocm-gitops/)
+- [Air-gapped GitOps with OCM & Flux](/docs/tutorials/ocm-and-gitops/air-gapped-gitops-with-ocm-flux/)
In this guide we will pick-up where we left off in the air-gapped example.
diff --git a/content/docs/tutorials/test_images.md b/content/docs/tutorials/test_images.md
deleted file mode 100644
index fbca9528..00000000
--- a/content/docs/tutorials/test_images.md
+++ /dev/null
@@ -1 +0,0 @@
-
\ No newline at end of file
diff --git a/content/mpas/bootstrap.md b/content/mpas/bootstrap.md
index eb7dac20..22d2f30d 100644
--- a/content/mpas/bootstrap.md
+++ b/content/mpas/bootstrap.md
@@ -145,7 +145,6 @@ mpas bootstrap gitea \
--dev
```
-
## Bootstrap for an air-gapped environment
If you want to bootstrap `MPAS` for a repository in an air-gapped environment, only Gitea
diff --git a/content/mpas/core_concepts.md b/content/mpas/core_concepts.md
index 581e47b6..4e6d3979 100644
--- a/content/mpas/core_concepts.md
+++ b/content/mpas/core_concepts.md
@@ -19,7 +19,7 @@ see [Architecture](https://github.com/open-component-model/MPAS/tree/main/docs/c
A Product is a package of software that can be deployed to target environments such as Kubernetes clusters,
virtual machines or bare-metal devices.
-Products are made available to the `MPAS` system as [OCM Components](https://github.com/open-component-model/ocm-spec/blob/main/doc/introduction/component_versions.md#component-versions) via a `Subscription`.
+Products are made available to the `MPAS` system as [OCM Components](https://github.com/open-component-model/ocm-spec/blob/main/doc/01-model/01-model.md#components-and-component-versions) via a `Subscription`.
Multiple instances of a Product may be installed that refer to the same Subscription.
A `ProductDeployment` is a Kubernetes Custom Resource that represents a product to
@@ -38,7 +38,6 @@ A `ProductDeploymentPipeline` is a Kubernetes Custom Resource that defines a res
that needs to be deployed as part of the `ProductDeployment`. The `ProductDeploymentPipeline` is
reconciled by the `MPAS Product Controller` as part of the `ProductDeployment` deployment.
-
## Project
A `Project` is a Kubernetes Custom Resource that is used to manage the lifecycle of
diff --git a/content/mpas/getting_started.md b/content/mpas/getting_started.md
index 445b39a6..fa309ce8 100644
--- a/content/mpas/getting_started.md
+++ b/content/mpas/getting_started.md
@@ -3,7 +3,6 @@ title: "Get Started with MPAS"
description: ""
lead: ""
date: 2023-09-12T10:37:58+01:00
-lastmod: 2023-11-03T10:53:00+01:00
draft: false
images: []
weight: 131
@@ -35,7 +34,7 @@ To install the MPAS CLI using `brew`:
brew install open-component-model/tap/mpas
```
-For other installation methods, see the [installation guide](/mpas/overview/installation/).
+For other installation methods, see the [installation guide](/mpas/installation/).
## Bootstrap MPAS
@@ -50,7 +49,7 @@ export GITHUB_USER=
export MY_EMAIL=
```
-### Bootstrap MPAS
+### Bootstrap
To bootstrap MPAS to your Kubernetes cluster, run the following command. If nothing is specified it will use the KUBECONFIG specified in the user's environment. It is also possible to specify a dedicated config using the --kubeconfig option.
@@ -80,7 +79,7 @@ reconciles the `Project` resource.
The output of the bootstrap is similar to the following:
-```bash
+```text
Running mpas bootstrap ...
✓ Preparing Management repository mpas-bootstrap
✓ Fetching bootstrap component from ghcr.io/open-component-model/mpas-bootstrap-component
@@ -110,7 +109,7 @@ be configured to watch the target github repository for changes in the path `./c
Clone the `mpas-bootstrap` repository to your local machine:
-```sh
+```bash
git clone https://github.com/$GITHUB_USER/mpas-bootstrap
cd mpas-bootstrap
```
@@ -118,233 +117,231 @@ cd mpas-bootstrap
### Deploy podinfo application
The [podinfo application](https://github.com/stefanprodan/podinfo) has been packaged
-as an OCM component and can be retrieved from [Github](ghcr.io/open-component-model/podinfo).
+as an OCM component and can be retrieved from [Github](https://ghcr.io/open-component-model/podinfo).
-1. Create a secret containing your GitHub credentials that will be used by MPAS to
-create your project repository.
+1. Create a secret containing your GitHub credentials that will be used by MPAS to create your project repository.
-```bash
-kubectl create secret generic \
- github-access \
- --from-literal=username=$GITHUB_USER \
- --from-literal=password=$GITHUB_TOKEN \
- -n mpas-system
-```
+ ```bash
+ kubectl create secret generic \
+ github-access \
+ --from-literal=username=$GITHUB_USER \
+ --from-literal=password=$GITHUB_TOKEN \
+ -n mpas-system
+ ```
2. Create a project that will contain the podinfo application.
-Let's create a directory for the project:
+ Let's create a directory for the project:
-```bash
-mkdir -p ./clusters/my-cluster/podinfo
-````
+ ```bash
+ mkdir -p ./clusters/my-cluster/podinfo
+ ````
-Then, create a `project.yaml` file in the `./clusters/my-cluster/podinfo` directory:
+ Then, create a `project.yaml` file in the `./clusters/my-cluster/podinfo` directory:
-```bash
-mpas create project podinfo-application \
- --owner=$GITHUB_USER \
- --provider=github \
- --visibility=public \
- --already-exists-policy=fail \
- --branch=main \
- --secret-ref=github-access \
- --email=$MY_EMAIL \
- --message=xxx \
- --author=mpas-admin \
- --maintainers=$GITHUB_USER \
- --prune \
- --personal \
- --export >> ./clusters/my-cluster/podinfo/project.yaml
-```
+ ```bash
+ mpas create project podinfo-application \
+ --owner=$GITHUB_USER \
+ --provider=github \
+ --visibility=public \
+ --already-exists-policy=fail \
+ --branch=main \
+ --secret-ref=github-access \
+ --email=$MY_EMAIL \
+ --message=xxx \
+ --author=mpas-admin \
+ --maintainers=$GITHUB_USER \
+ --prune \
+ --personal \
+ --export >> ./clusters/my-cluster/podinfo/project.yaml
+ ```
-Then, apply the project to the cluster in a GitOps fashion:
+ Then, apply the project to the cluster in a GitOps fashion:
-```bash
-git add --all && git commit -m "Add podinfo project" && git push
-```
+ ```bash
+ git add --all && git commit -m "Add podinfo project" && git push
+ ```
-`Flux` will detect the changes and apply the project to the cluster.
+ `Flux` will detect the changes and apply the project to the cluster.
-This will create a `namespace` for the project, a `serviceaccount`, and RBAC in the cluster.
-It will also create a GitHub repository for the project, and configure `Flux` to manage the project's resources.
+ This will create a `namespace` for the project, a `serviceaccount`, and RBAC in the cluster.
+ It will also create a GitHub repository for the project, and configure `Flux` to manage the project's resources.
3. Add the needed secrets to the namespace
-`Flux` is used to deploy all workloads in a GitOps way. `Flux` needs a secret in
-the project namespace that will be used to communicate with github:
+ `Flux` is used to deploy all workloads in a GitOps way. `Flux` needs a secret in
+ the project namespace that will be used to communicate with github:
-```bash
-kubectl create secret generic \
- github-access \
- --from-literal=username=$GITHUB_USER \
- --from-literal=password=$GITHUB_TOKEN \
- -n mpas-podinfo-application
-```
+ ```bash
+ kubectl create secret generic \
+ github-access \
+ --from-literal=username=$GITHUB_USER \
+ --from-literal=password=$GITHUB_TOKEN \
+ -n mpas-podinfo-application
+ ```
-**Note** The credentials should have access to GitHub packages.
+ **Note** The credentials should have access to GitHub packages.
-As part of step 2, a `serviceaccount` was created for the project. We will use this service account
-to provide the necessary permissions to pull from the `ghcr` registry.
+ As part of step 2, a `serviceaccount` was created for the project. We will use this service account
+ to provide the necessary permissions to pull from the `ghcr` registry.
-First, create a secret containing the credentials for the service account:
+ First, create a secret containing the credentials for the service account:
-```bash
-kubectl create secret docker-registry github-registry-key --docker-server=ghcr.io \
- --docker-username=$GITHUB_USER --docker-password=$GITHUB_TOKEN \
- --docker-email=$MY_EMAIL -n mpas-podinfo-application
-```
+ ```bash
+ kubectl create secret docker-registry github-registry-key --docker-server=ghcr.io \
+ --docker-username=$GITHUB_USER --docker-password=$GITHUB_TOKEN \
+ --docker-email=$MY_EMAIL -n mpas-podinfo-application
+ ```
-Then, patch the service account to use the secret:
+ Then, patch the service account to use the secret:
-```bash
-kubectl patch serviceaccount mpas-podinfo-application -p '{"imagePullSecrets": [{"name": "github-registry-key"}]}' \
- -n mpas-podinfo-application
-```
+ ```bash
+ kubectl patch serviceaccount mpas-podinfo-application -p '{"imagePullSecrets": [{"name": "github-registry-key"}]}' \
+ -n mpas-podinfo-application
+ ```
-1. Clone the project repository
+4. Clone the project repository
-```bash
-git clone https://github.com/$GITHUB_USER/mpas-podinfo-application
-cd mpas-podinfo-application
-```
+ ```bash
+ git clone https://github.com/$GITHUB_USER/mpas-podinfo-application
+ cd mpas-podinfo-application
+ ```
5. Add the podinfo `ComponentSubscription`
-Create a file under `./subscriptions/` that will contain the subscription declaration.
+ Create a file under `./subscriptions/` that will contain the subscription declaration.
-```bash
-mpas create cs podinfo-subscription \
- --component=ocm.software/mpas/podinfo \
- --semver=">=v1.0.0" \
- --source-url=ghcr.io/open-component-model/mpas \
- --source-secret-ref=github-access \
- --target-url=ghcr.io/$GITHUB_USER \
- --target-secret-ref=github-access \
- --namespace=mpas-podinfo-application \
- --export >> ./subscriptions/podinfo.yaml
-```
+ ```bash
+ mpas create cs podinfo-subscription \
+ --component=ocm.software/mpas/podinfo \
+ --semver=">=v1.0.0" \
+ --source-url=ghcr.io/open-component-model/mpas \
+ --source-secret-ref=github-access \
+ --target-url=ghcr.io/$GITHUB_USER \
+ --target-secret-ref=github-access \
+ --namespace=mpas-podinfo-application \
+ --export >> ./subscriptions/podinfo.yaml
+ ```
-Then, apply the `ComponentSubscription` to the project in a GitOps fashion:
+ Then, apply the `ComponentSubscription` to the project in a GitOps fashion:
-```bash
-git add --all && git commit -m "Add podinfo subscription" && git push
-```
+ ```bash
+ git add --all && git commit -m "Add podinfo subscription" && git push
+ ```
-`Flux` will detect the changes and apply the subscription to the cluster.
+ `Flux` will detect the changes and apply the subscription to the cluster.
-This will replicate the product referenced by the field `spec.component` in the `ComponentSubscription` resource from
-the defined registry in `spec.source.url` to the `spec.destination.url` registry.
+ This will replicate the product referenced by the field `spec.component` in the `ComponentSubscription` resource from
+ the defined registry in `spec.source.url` to the `spec.destination.url` registry.
6. Add a `Target` for the podinfo application
-The target will define where the application will be installed
-
-
-```bash
-cat <> ./targets/podinfo.yaml
-apiVersion: mpas.ocm.software/v1alpha1
-kind: Target
-metadata:
- name: podinfo-kubernetes-target
- namespace: mpas-podinfo-application
- labels:
- target.mpas.ocm.software/ingress-enabled: "true" # This label is defined by the component that will use it to select an appropriate target to deploy to.
-spec:
- type: kubernetes
- access:
- targetNamespace: podinfo
- serviceAccountName: podinfo-sa
- selector:
- matchLabels:
- mpas.ocm.software/target-selector: podinfo-kubernetes-target
- interval: 5m0s
-EOF
-```
-
-Then, apply the `Target` to the project in a GitOps fashion:
-
-```bash
-git add --all && git commit -m "Add a target for podinfo" && git push
-```
-
-`Flux` will detect the changes and apply the target to the cluster.
-
-In order for the `Target` to reach a `Ready` state, the needed secrets should be created in the `podinfo` namespace.
-
-First, create a secret containing the credentials for the service account:
-
-```bash
-kubectl create secret docker-registry github-registry-key --docker-server=ghcr.io \
- --docker-username=$GITHUB_USER --docker-password=$GITHUB_TOKEN \
- --docker-email=$MY_EMAIL -n podinfo
-```
-
-Then, add a label to allow the target to select it using the label selector:
-
-```bash
-kubectl label secret github-registry-key mpas.ocm.software/target-selector=podinfo-kubernetes-target -n podinfo
-```
-
-1. Deploy the podinfo application
-
-In order to deploy the podinfo application, we need to create a `ProductDeploymentGenerator` resource:
-
-```bash
-mpas create pdg podinfo \
- --service-account=mpas-podinfo-application \
- --subscription-name=podinfo-subscription \
- --subscription-namespace=mpas-podinfo-application \
- --namespace=mpas-podinfo-application \
- --export >> ./generators/podinfo.yaml
-```
-
-Then, apply the `ProductDeploymentGenerator` to the project in a GitOps fashion:
-
-```bash
-git add --all && git commit -m "Add podinfo deployment generator" && git push
-```
-
-`Flux` will detect the changes and apply the resource to the cluster.
-
-This will create a pull request in the project repository with the `ProductDeployment` resource
-that will deploy the podinfo application.
-
-Go to the project repository and retrieve the pull request.
-It should contain a `ProductDeployment` declaration that provides the configuration and
-all steps needed to deploy the product, as well as a `values.yaml` file. The `values` file
-contains values that should be used to configure the different resources that are part of
-the product to be deployed. There is a check that should pass before merging the pull request.
-
-Once the pull request is merged, `Flux` will detect the changes and deploy the application to the cluster.
-
-After a moment the `ProductDeployment` should be deployed successfully.
-It is possible to verify this with the command:
-
-```bash
-k describe productdeployment -n mpas-podinfo-application
-```
-
-The result should look something like:
-
-```bash
-Name: podinfo
-Namespace: mpas-podinfo-application
-Labels: kustomize.toolkit.fluxcd.io/name=mpas-podinfo-application-products
- kustomize.toolkit.fluxcd.io/namespace=mpas-system
-API Version: mpas.ocm.software/v1alpha1
-Kind: ProductDeployment
-Metadata:
-...
-Status:
- Conditions:
- Last Transition Time: 2023-09-14T10:14:41Z
- Message: Reconciliation success
- Observed Generation: 1
- Reason: Succeeded
- Status: True
- Type: Ready
- Observed Generation: 1
-```
-
-The application is deployed in the `podinfo` namespace.
+ The target will define where the application will be installed
+
+ ```bash
+ cat <> ./targets/podinfo.yaml
+ apiVersion: mpas.ocm.software/v1alpha1
+ kind: Target
+ metadata:
+ name: podinfo-kubernetes-target
+ namespace: mpas-podinfo-application
+ labels:
+ target.mpas.ocm.software/ingress-enabled: "true" # This label is defined by the component that will use it to select an appropriate target to deploy to.
+ spec:
+ type: kubernetes
+ access:
+ targetNamespace: podinfo
+ serviceAccountName: podinfo-sa
+ selector:
+ matchLabels:
+ mpas.ocm.software/target-selector: podinfo-kubernetes-target
+ interval: 5m0s
+ EOF
+ ```
+
+ Then, apply the `Target` to the project in a GitOps fashion:
+
+ ```bash
+ git add --all && git commit -m "Add a target for podinfo" && git push
+ ```
+
+ `Flux` will detect the changes and apply the target to the cluster.
+
+ In order for the `Target` to reach a `Ready` state, the needed secrets should be created in the `podinfo` namespace.
+
+ First, create a secret containing the credentials for the service account:
+
+ ```bash
+ kubectl create secret docker-registry github-registry-key --docker-server=ghcr.io \
+ --docker-username=$GITHUB_USER --docker-password=$GITHUB_TOKEN \
+ --docker-email=$MY_EMAIL -n podinfo
+ ```
+
+ Then, add a label to allow the target to select it using the label selector:
+
+ ```bash
+ kubectl label secret github-registry-key mpas.ocm.software/target-selector=podinfo-kubernetes-target -n podinfo
+ ```
+
+7. Deploy the podinfo application
+
+ In order to deploy the podinfo application, we need to create a `ProductDeploymentGenerator` resource:
+
+ ```bash
+ mpas create pdg podinfo \
+ --service-account=mpas-podinfo-application \
+ --subscription-name=podinfo-subscription \
+ --subscription-namespace=mpas-podinfo-application \
+ --namespace=mpas-podinfo-application \
+ --export >> ./generators/podinfo.yaml
+ ```
+
+ Then, apply the `ProductDeploymentGenerator` to the project in a GitOps fashion:
+
+ ```bash
+ git add --all && git commit -m "Add podinfo deployment generator" && git push
+ ```
+
+ `Flux` will detect the changes and apply the resource to the cluster.
+
+ This will create a pull request in the project repository with the `ProductDeployment` resource
+ that will deploy the podinfo application.
+
+ Go to the project repository and retrieve the pull request.
+ It should contain a `ProductDeployment` declaration that provides the configuration and
+ all steps needed to deploy the product, as well as a `values.yaml` file. The `values` file
+ contains values that should be used to configure the different resources that are part of
+ the product to be deployed. There is a check that should pass before merging the pull request.
+
+ Once the pull request is merged, `Flux` will detect the changes and deploy the application to the cluster.
+
+ After a moment the `ProductDeployment` should be deployed successfully.
+ It is possible to verify this with the command:
+
+ ```bash
+ k describe productdeployment -n mpas-podinfo-application
+ ```
+
+ The result should look something like:
+
+ ```text
+ Name: podinfo
+ Namespace: mpas-podinfo-application
+ Labels: kustomize.toolkit.fluxcd.io/name=mpas-podinfo-application-products
+ kustomize.toolkit.fluxcd.io/namespace=mpas-system
+ API Version: mpas.ocm.software/v1alpha1
+ Kind: ProductDeployment
+ Metadata:
+ ...
+ Status:
+ Conditions:
+ Last Transition Time: 2023-09-14T10:14:41Z
+ Message: Reconciliation success
+ Observed Generation: 1
+ Reason: Succeeded
+ Status: True
+ Type: Ready
+ Observed Generation: 1
+ ```
+
+ The application is deployed in the `podinfo` namespace.
diff --git a/content/mpas/installation.md b/content/mpas/installation.md
index a6fc0e89..d204b79c 100644
--- a/content/mpas/installation.md
+++ b/content/mpas/installation.md
@@ -18,10 +18,14 @@ To install the MPAS CLI, you can download the binaries for major platforms from
You can also install via [homebrew](https://brew.sh/) for macOS and Linux:
-`brew install open-component-model/tap/mpas`
+```bash
+brew install open-component-model/tap/mpas
+```
## Bash
To install with `bash` for macOS or Linux execute the following command:
-`curl -sfL https://raw.githubusercontent.com/open-component-model/mpas/main/install.sh | sh -`
+```bash
+curl -sfL https://raw.githubusercontent.com/open-component-model/mpas/main/install.sh | sh -
+```
diff --git a/hack/generate-cli-docs/generate_markdown.go b/hack/generate-cli-docs/generate_markdown.go
index 8b78653b..be5d744f 100644
--- a/hack/generate-cli-docs/generate_markdown.go
+++ b/hack/generate-cli-docs/generate_markdown.go
@@ -3,23 +3,20 @@ package main
import (
"bytes"
"fmt"
+ "github.com/spf13/cobra"
"io"
+ "ocm.software/ocm/api/utils/cobrautils"
"os"
"path"
"path/filepath"
"sort"
"strings"
- "time"
-
- "github.com/spf13/cobra"
- "ocm.software/ocm/api/utils/cobrautils"
)
const fmTmpl = `---
title: %s
name: %s
url: %s
-date: 2024-04-17T18:02:57+02:00
draft: false
images: []
toc: true
@@ -80,9 +77,7 @@ func genMarkdownTreeCustom(cmd *cobra.Command, dir, urlPrefix, parentCmd string)
defer f.Close()
linkHandler := func(path string) string {
- link := strings.Replace(path, " ", "/", -1)
- link = strings.Replace(link, "ocm", "cli-reference", 1)
- return "/docs/" + link
+ return cmdToLink[path]
}
frontmatter := func() string {
@@ -164,11 +159,6 @@ func genMarkdownCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string)
buf.WriteString(fmt.Sprintf("* [%s](%s)\t — %s\n", pname, linkHandler(parent.CommandPath()), parent.Short))
}
}
- cmd.VisitParents(func(c *cobra.Command) {
- if c.DisableAutoGenTag {
- cmd.DisableAutoGenTag = c.DisableAutoGenTag
- }
- })
}
children := cmd.Commands()
@@ -206,9 +196,6 @@ func genMarkdownCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string)
}
}
- if !cmd.DisableAutoGenTag {
- buf.WriteString("###### Auto generated by spf13/cobra on " + time.Now().Format("2-Jan-2006") + "\n")
- }
_, err := buf.WriteTo(w)
diff --git a/hack/generate-cli-docs/generate_root_index.go b/hack/generate-cli-docs/generate_root_index.go
index 872d7b6f..5d5956ad 100644
--- a/hack/generate-cli-docs/generate_root_index.go
+++ b/hack/generate-cli-docs/generate_root_index.go
@@ -34,10 +34,10 @@ func genIndexForRootHelpTopics(dir string, urlBase string) (err error) {
}()
f.WriteString(fmt.Sprintf(fmTmpl, "help", "help", urlBase+"help"))
- f.WriteString("### Additional Topics\n")
+ f.WriteString("### Additional Topics\n\n")
for _, topic := range topics {
- f.WriteString(fmt.Sprintf("* [%s](%s)\t — %s\n", topic, urlBase+topic, topic))
+ f.WriteString(fmt.Sprintf("* [%s](%shelp/%s/) — %s\n", topic, urlBase, topic, topic))
}
return nil
diff --git a/hack/generate-cli-docs/main.go b/hack/generate-cli-docs/main.go
index b1b19294..62061706 100644
--- a/hack/generate-cli-docs/main.go
+++ b/hack/generate-cli-docs/main.go
@@ -4,13 +4,12 @@ import (
"flag"
"fmt"
"log"
+ clictx "ocm.software/ocm/api/cli"
+ "ocm.software/ocm/cmds/ocm/app"
"os"
"path/filepath"
"slices"
"strings"
-
- clictx "ocm.software/ocm/api/cli"
- "ocm.software/ocm/cmds/ocm/app"
)
var commandDenyList = []string{
@@ -62,7 +61,6 @@ func run(dir, urlPrefix string) error {
}
cmd := app.NewCliCommand(clictx.DefaultContext())
- cmd.DisableAutoGenTag = true
for _, subCmd := range cmd.Commands() {
if slices.Contains(commandDenyList, subCmd.Name()) {
diff --git a/hack/generate-cli-docs/map.go b/hack/generate-cli-docs/map.go
new file mode 100644
index 00000000..cdfd4729
--- /dev/null
+++ b/hack/generate-cli-docs/map.go
@@ -0,0 +1,70 @@
+package main
+
+var cmdToLink = map[string]string{
+ "ocm add componentversions": "/docs/cli-reference/add/componentversions/",
+ "ocm add references": "/docs/cli-reference/add/references/",
+ "ocm add resource-configuration": "/docs/cli-reference/add/resource-configuration/",
+ "ocm add resources": "/docs/cli-reference/add/resources/",
+ "ocm add routingslips": "/docs/cli-reference/add/routingslips/",
+ "ocm add source-configuration": "/docs/cli-reference/add/source-configuration/",
+ "ocm add sources": "/docs/cli-reference/add/sources/",
+ "ocm add": "/docs/cli-reference/add/",
+ "ocm attributes": "/docs/cli-reference/help/attributes/",
+ "ocm bootstrap configuration": "https://github.com/open-component-model/ocm/blob/main/docs/reference/ocm_bootstrap_configuration.md",
+ "ocm bootstrap package": "https://github.com/open-component-model/ocm/blob/main/docs/reference/ocm_bootstrap_package.md",
+ "ocm check componentversions": "/docs/cli-reference/check/componentversions/",
+ "ocm check": "/docs/cli-reference/check/",
+ "ocm clean cache": "/docs/cli-reference/clean/cache/",
+ "ocm clean": "/docs/cli-reference/clean/",
+ "ocm configfile": "/docs/cli-reference/help/configfile/",
+ "ocm create componentarchive": "/docs/cli-reference/create/componentarchive/",
+ "ocm create rsakeypair": "/docs/cli-reference/create/rsakeypair/",
+ "ocm create transportarchive": "/docs/cli-reference/create/transportarchive/",
+ "ocm create": "/docs/cli-reference/create/",
+ "ocm describe artifacts": "/docs/cli-reference/describe/artifacts/",
+ "ocm describe cache": "/docs/cli-reference/describe/cache/",
+ "ocm describe package": "/docs/cli-reference/describe/package/",
+ "ocm describe plugins": "/docs/cli-reference/describe/plugins/",
+ "ocm describe": "/docs/cli-reference/describe/",
+ "ocm download artifacts": "/docs/cli-reference/download/artifacts/",
+ "ocm download cli": "/docs/cli-reference/download/cli/",
+ "ocm download componentversions": "/docs/cli-reference/download/componentversions/",
+ "ocm download resources": "/docs/cli-reference/download/resources/",
+ "ocm download": "/docs/cli-reference/download/",
+ "ocm get artifacts": "/docs/cli-reference/get/artifacts/",
+ "ocm get componentversions": "/docs/cli-reference/get/componentversions/",
+ "ocm get config": "/docs/cli-reference/get/config/",
+ "ocm get credentials": "/docs/cli-reference/get/credentials/",
+ "ocm get plugins": "/docs/cli-reference/get/plugins/",
+ "ocm get pubsub": "/docs/cli-reference/get/pubsub/",
+ "ocm get references": "/docs/cli-reference/get/references/",
+ "ocm get resources": "/docs/cli-reference/get/resources/",
+ "ocm get routingslips": "/docs/cli-reference/get/routingslips/",
+ "ocm get sources": "/docs/cli-reference/get/sources/",
+ "ocm get": "/docs/cli-reference/get/",
+ "ocm list componentversions": "/docs/cli-reference/list/componentversions/",
+ "ocm list": "/docs/cli-reference/list/",
+ "ocm logging": "/docs/cli-reference/help/logging/",
+ "ocm ocm-accessmethods": "/docs/cli-reference/help/ocm-accessmethods/",
+ "ocm ocm-downloadhandlers": "/docs/cli-reference/help/ocm-downloadhandlers/",
+ "ocm ocm-labels": "/docs/cli-reference/help/ocm-labels/",
+ "ocm ocm-pubsub": "/docs/cli-reference/help/ocm-pubsub/",
+ "ocm ocm-uploadhandlers": "/docs/cli-reference/help/ocm-uploadhandlers/",
+ "ocm set pubsub": "/docs/cli-reference/set/pubsub/",
+ "ocm set": "/docs/cli-reference/set/",
+ "ocm show tags": "/docs/cli-reference/show/tags/",
+ "ocm show versions": "/docs/cli-reference/show/versions/",
+ "ocm show": "/docs/cli-reference/show/",
+ "ocm sign componentversions": "/docs/cli-reference/sign/componentversions/",
+ "ocm sign hash": "/docs/cli-reference/sign/hash/",
+ "ocm sign": "/docs/cli-reference/sign/",
+ "ocm toi-bootstrapping": "/docs/cli-reference/help/toi-bootstrapping/",
+ "ocm transfer artifacts": "/docs/cli-reference/transfer/artifacts/",
+ "ocm transfer commontransportarchive": "/docs/cli-reference/transfer/commontransportarchive/",
+ "ocm transfer componentarchive": "/docs/cli-reference/transfer/componentarchive/",
+ "ocm transfer componentversions": "/docs/cli-reference/transfer/componentversions/",
+ "ocm transfer": "/docs/cli-reference/transfer/",
+ "ocm verify componentversions": "/docs/cli-reference/verify/componentversions/",
+ "ocm verify": "/docs/cli-reference/verify/",
+ "ocm": "/docs/cli-reference/",
+}
diff --git a/netlify.toml b/netlify.toml
index 6fa3cf58..4ebcd10f 100644
--- a/netlify.toml
+++ b/netlify.toml
@@ -3,8 +3,8 @@
functions = "functions"
[build.environment]
- NODE_VERSION = "16.16.0"
- NPM_VERSION = "8.11.0"
+ NODE_VERSION = "20.16.0"
+ NPM_VERSION = "10.8.1"
[context.production]
command = "npm run build"
diff --git a/package-lock.json b/package-lock.json
index e679f055..89ce9016 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -8,7 +8,7 @@
"name": "ocm-website",
"version": "0.0.0",
"hasInstallScript": true,
- "license": "MIT",
+ "license": "Apache-2.0",
"dependencies": {
"@hyas/doks-core": "^1.4.1",
"@hyas/images": "^3.1.0",
@@ -23,8 +23,8 @@
"shx": "^0.3.4"
},
"engines": {
- "node": ">=18.14.1",
- "pnpm": ">=8.10.0"
+ "node": ">=20.16.0",
+ "pnpm": ">=9.7.1"
}
},
"node_modules/@ampproject/remapping": {
diff --git a/package.json b/package.json
index fb1fce85..359570fa 100644
--- a/package.json
+++ b/package.json
@@ -3,7 +3,7 @@
"version": "0.0.0",
"description": "OCM website",
"author": "open-component-model",
- "license": "MIT",
+ "license": "Apache-2.0",
"scripts": {
"dev": "exec-bin node_modules/.bin/hugo/hugo server --bind=0.0.0.0 --disableFastRender --baseURL=http://localhost --noHTTPCache",
"dev:drafts": "exec-bin node_modules/.bin/hugo/hugo server --bind=0.0.0.0 --disableFastRender --baseURL=http://localhost --noHTTPCache --buildDrafts",
@@ -44,8 +44,8 @@
"semver": "^7.5.4"
},
"engines": {
- "node": ">=18.14.1",
- "pnpm": ">=8.10.0"
+ "node": ">=20.16.0",
+ "pnpm": ">=9.7.1"
},
- "packageManager": "pnpm@8.12.0"
+ "packageManager": "pnpm@9.7.1"
}
\ No newline at end of file