generate docs

open-component-model · May 16, 2024 · 9f7ac4f · 9f7ac4f
1 parent 898d7fd
commit 9f7ac4f
Show file tree

Hide file tree

Showing 17 changed files with 310 additions and 29 deletions.
diff --git a/docs/pluginreference/plugin_accessmethod_compose.md b/docs/pluginreference/plugin_accessmethod_compose.md
@@ -35,6 +35,9 @@ by the plugin name.
 The following predefined option types can be used:
 
 
+  - <code>accessClassifier</code>: [*string*] mvn classifier
+  - <code>accessExtension</code>: [*string*] mvn extension name
+  - <code>accessGroup</code>: [*string*] GroupID or namespace
   - <code>accessHostname</code>: [*string*] hostname used for access
   - <code>accessPackage</code>: [*string*] package or object name
   - <code>accessRegistry</code>: [*string*] registry base URL

diff --git a/docs/pluginreference/plugin_descriptor.md b/docs/pluginreference/plugin_descriptor.md
@@ -120,6 +120,9 @@ It uses the following fields:
 The following predefined option types can be used:
 
 
+  - <code>accessClassifier</code>: [*string*] mvn classifier
+  - <code>accessExtension</code>: [*string*] mvn extension name
+  - <code>accessGroup</code>: [*string*] GroupID or namespace
   - <code>accessHostname</code>: [*string*] hostname used for access
   - <code>accessPackage</code>: [*string*] package or object name
   - <code>accessRegistry</code>: [*string*] registry base URL

diff --git a/docs/pluginreference/plugin_valueset_compose.md b/docs/pluginreference/plugin_valueset_compose.md
@@ -35,6 +35,9 @@ by the plugin name.
 The following predefined option types can be used:
 
 
+  - <code>accessClassifier</code>: [*string*] mvn classifier
+  - <code>accessExtension</code>: [*string*] mvn extension name
+  - <code>accessGroup</code>: [*string*] GroupID or namespace
   - <code>accessHostname</code>: [*string*] hostname used for access
   - <code>accessPackage</code>: [*string*] package or object name
   - <code>accessRegistry</code>: [*string*] registry base URL

diff --git a/docs/reference/ocm_add_resource-configuration.md b/docs/reference/ocm_add_resource-configuration.md
@@ -24,6 +24,9 @@ resource-configuration, resourceconfig, rsccfg, rcfg
 
 ```
       --access YAML                         blob access specification (YAML)
+      --accessClassifier string             mvn classifier
+      --accessExtension string              mvn extension name
+      --accessGroup string                  GroupID or namespace
       --accessHostname string               hostname used for access
       --accessPackage string                package or object name
       --accessRegistry string               registry base URL
@@ -680,6 +683,41 @@ shown below.
 
   Options used to configure fields: <code>--globalAccess</code>, <code>--hint</code>, <code>--mediaType</code>, <code>--reference</code>
 
+- Access type <code>mvn</code>
+
+  This method implements the access of a Maven (mvn) artifact in a Maven repository.
+
+  The following versions are supported:
+  - Version <code>v1</code>
+
+    The type specific specification fields are:
+
+    - **<code>repository</code>** *string*
+
+      Base URL of the Maven (mvn) repository
+
+    - **<code>groupId</code>** *string*
+
+      The groupId of the Maven (mvn) artifact
+
+    - **<code>artifactId</code>** *string*
+
+      The artifactId of the Maven (mvn) artifact
+
+    - **<code>version</code>** *string*
+
+      The version name of the Maven (mvn) artifact
+
+    - **<code>classifier</code>** *string*
+
+      The optional classifier of the Maven (mvn) artifact
+
+    - **<code>extension</code>** *string*
+
+      The optional extension of the Maven (mvn) artifact
+
+  Options used to configure fields: <code>--accessClassifier</code>, <code>--accessExtension</code>, <code>--accessGroup</code>, <code>--accessPackage</code>, <code>--accessRepository</code>, <code>--accessVersion</code>
+
 - Access type <code>none</code>
 
   dummy resource with no access

diff --git a/docs/reference/ocm_add_resources.md b/docs/reference/ocm_add_resources.md
@@ -30,6 +30,9 @@ resources, resource, res, r
 
 ```
       --access YAML                         blob access specification (YAML)
+      --accessClassifier string             mvn classifier
+      --accessExtension string              mvn extension name
+      --accessGroup string                  GroupID or namespace
       --accessHostname string               hostname used for access
       --accessPackage string                package or object name
       --accessRegistry string               registry base URL
@@ -690,6 +693,41 @@ shown below.
 
   Options used to configure fields: <code>--globalAccess</code>, <code>--hint</code>, <code>--mediaType</code>, <code>--reference</code>
 
+- Access type <code>mvn</code>
+
+  This method implements the access of a Maven (mvn) artifact in a Maven repository.
+
+  The following versions are supported:
+  - Version <code>v1</code>
+
+    The type specific specification fields are:
+
+    - **<code>repository</code>** *string*
+
+      Base URL of the Maven (mvn) repository
+
+    - **<code>groupId</code>** *string*
+
+      The groupId of the Maven (mvn) artifact
+
+    - **<code>artifactId</code>** *string*
+
+      The artifactId of the Maven (mvn) artifact
+
+    - **<code>version</code>** *string*
+
+      The version name of the Maven (mvn) artifact
+
+    - **<code>classifier</code>** *string*
+
+      The optional classifier of the Maven (mvn) artifact
+
+    - **<code>extension</code>** *string*
+
+      The optional extension of the Maven (mvn) artifact
+
+  Options used to configure fields: <code>--accessClassifier</code>, <code>--accessExtension</code>, <code>--accessGroup</code>, <code>--accessPackage</code>, <code>--accessRepository</code>, <code>--accessVersion</code>
+
 - Access type <code>none</code>
 
   dummy resource with no access

diff --git a/docs/reference/ocm_add_source-configuration.md b/docs/reference/ocm_add_source-configuration.md
@@ -24,6 +24,9 @@ source-configuration, sourceconfig, srccfg, scfg
 
 ```
       --access YAML                         blob access specification (YAML)
+      --accessClassifier string             mvn classifier
+      --accessExtension string              mvn extension name
+      --accessGroup string                  GroupID or namespace
       --accessHostname string               hostname used for access
       --accessPackage string                package or object name
       --accessRegistry string               registry base URL
@@ -680,6 +683,41 @@ shown below.
 
   Options used to configure fields: <code>--globalAccess</code>, <code>--hint</code>, <code>--mediaType</code>, <code>--reference</code>
 
+- Access type <code>mvn</code>
+
+  This method implements the access of a Maven (mvn) artifact in a Maven repository.
+
+  The following versions are supported:
+  - Version <code>v1</code>
+
+    The type specific specification fields are:
+
+    - **<code>repository</code>** *string*
+
+      Base URL of the Maven (mvn) repository
+
+    - **<code>groupId</code>** *string*
+
+      The groupId of the Maven (mvn) artifact
+
+    - **<code>artifactId</code>** *string*
+
+      The artifactId of the Maven (mvn) artifact
+
+    - **<code>version</code>** *string*
+
+      The version name of the Maven (mvn) artifact
+
+    - **<code>classifier</code>** *string*
+
+      The optional classifier of the Maven (mvn) artifact
+
+    - **<code>extension</code>** *string*
+
+      The optional extension of the Maven (mvn) artifact
+
+  Options used to configure fields: <code>--accessClassifier</code>, <code>--accessExtension</code>, <code>--accessGroup</code>, <code>--accessPackage</code>, <code>--accessRepository</code>, <code>--accessVersion</code>
+
 - Access type <code>none</code>
 
   dummy resource with no access

diff --git a/docs/reference/ocm_add_sources.md b/docs/reference/ocm_add_sources.md
@@ -29,6 +29,9 @@ sources, source, src, s
 
 ```
       --access YAML                         blob access specification (YAML)
+      --accessClassifier string             mvn classifier
+      --accessExtension string              mvn extension name
+      --accessGroup string                  GroupID or namespace
       --accessHostname string               hostname used for access
       --accessPackage string                package or object name
       --accessRegistry string               registry base URL
@@ -688,6 +691,41 @@ shown below.
 
   Options used to configure fields: <code>--globalAccess</code>, <code>--hint</code>, <code>--mediaType</code>, <code>--reference</code>
 
+- Access type <code>mvn</code>
+
+  This method implements the access of a Maven (mvn) artifact in a Maven repository.
+
+  The following versions are supported:
+  - Version <code>v1</code>
+
+    The type specific specification fields are:
+
+    - **<code>repository</code>** *string*
+
+      Base URL of the Maven (mvn) repository
+
+    - **<code>groupId</code>** *string*
+
+      The groupId of the Maven (mvn) artifact
+
+    - **<code>artifactId</code>** *string*
+
+      The artifactId of the Maven (mvn) artifact
+
+    - **<code>version</code>** *string*
+
+      The version name of the Maven (mvn) artifact
+
+    - **<code>classifier</code>** *string*
+
+      The optional classifier of the Maven (mvn) artifact
+
+    - **<code>extension</code>** *string*
+
+      The optional extension of the Maven (mvn) artifact
+
+  Options used to configure fields: <code>--accessClassifier</code>, <code>--accessExtension</code>, <code>--accessGroup</code>, <code>--accessPackage</code>, <code>--accessRepository</code>, <code>--accessVersion</code>
+
 - Access type <code>none</code>
 
   dummy resource with no access

diff --git a/docs/reference/ocm_controller.md b/docs/reference/ocm_controller.md
@@ -22,4 +22,5 @@ ocm controller [<options>] <sub command> ...
 ##### Sub Commands
 
 * [ocm controller <b>install</b>](ocm_controller_install.md)	 &mdash; Install either a specific or latest version of the ocm-controller. Optionally install prerequisites required by the controller.
+* [ocm controller <b>uninstall</b>](ocm_controller_uninstall.md)	 &mdash; Uninstalls the ocm-controller and all of its dependencies
 
diff --git a/docs/reference/ocm_controller_install.md b/docs/reference/ocm_controller_install.md
@@ -19,6 +19,7 @@ ocm controller install controller {--version v0.0.1}
   -i, --install-prerequisites                 install prerequisites required by ocm-controller (default true)
   -n, --namespace string                      the namespace into which the controller is installed (default "ocm-system")
   -a, --release-api-url string                the base url to the ocm-controller's API release page (default "https://api.github.com/repos/open-component-model/ocm-controller/releases")
+  -l, --silent                                don't fail on error
   -s, --skip-pre-flight-check                 skip the pre-flight check for clusters
   -t, --timeout duration                      maximum time to wait for deployment to be ready (default 1m0s)
   -v, --version string                        the version of the controller to install (default "latest")

diff --git a/docs/reference/ocm_controller_uninstall.md b/docs/reference/ocm_controller_uninstall.md
@@ -0,0 +1,33 @@
+## ocm controller uninstall &mdash; Uninstalls The Ocm-Controller And All Of Its Dependencies
+
+### Synopsis
+
+```
+ocm controller uninstall controller
+```
+
+### Options
+
+```
+  -u, --base-url string                       the base url to the ocm-controller's release page (default "https://github.com/open-component-model/ocm-controller/releases")
+      --cert-manager-base-url string          the base url to the cert-manager's release page (default "https://github.com/cert-manager/cert-manager/releases")
+      --cert-manager-release-api-url string   the base url to the cert-manager's API release page (default "https://api.github.com/repos/cert-manager/cert-manager/releases")
+      --cert-manager-version string           version for cert-manager (default "v1.13.2")
+  -c, --controller-name string                name of the controller that's used for status check (default "ocm-controller")
+  -d, --dry-run                               if enabled, prints the downloaded manifest file
+  -h, --help                                  help for uninstall
+  -n, --namespace string                      the namespace into which the controller is installed (default "ocm-system")
+  -a, --release-api-url string                the base url to the ocm-controller's API release page (default "https://api.github.com/repos/open-component-model/ocm-controller/releases")
+  -l, --silent                                don't fail on error
+  -t, --timeout duration                      maximum time to wait for deployment to be ready (default 1m0s)
+  -p, --uninstall-prerequisites               uninstall prerequisites required by ocm-controller
+  -v, --version string                        the version of the controller to install (default "latest")
+```
+
+### SEE ALSO
+
+##### Parents
+
+* [ocm controller](ocm_controller.md)	 &mdash; Commands acting on the ocm-controller
+* [ocm](ocm.md)	 &mdash; Open Component Model command line client
+
diff --git a/docs/reference/ocm_credential-handling.md b/docs/reference/ocm_credential-handling.md
@@ -157,32 +157,43 @@ The following credential consumer types are used/supported:
       - <code>certificateAuthority</code>: TLS certificate authority
 
 
-  - <code>OCIRegistry</code>: OCI registry credential matcher
+  - <code>MavenRepository</code>: MVN repository
 
-    It matches the <code>OCIRegistry</code> consumer type and additionally acts like
+    It matches the <code>MavenRepository</code> consumer type and additionally acts like
     the <code>hostpath</code> type.
 
-    Credential consumers of the consumer type OCIRegistry evaluate the following credential properties:
+    Credential consumers of the consumer type MavenRepository evaluate the following credential properties:
 
       - <code>username</code>: the basic auth user name
       - <code>password</code>: the basic auth password
-      - <code>identityToken</code>: the bearer token used for non-basic auth authorization
-      - <code>certificateAuthority</code>: the certificate authority certificate used to verify certificates
 
 
-  - <code>Registry.npmjs.com</code>: NPM repository
+  - <code>NpmRegistry</code>: NPM repository
 
-    It matches the <code>Registry.npmjs.com</code> consumer type and additionally acts like
+    It matches the <code>NpmRegistry</code> consumer type and additionally acts like
     the <code>hostpath</code> type.
 
-    Credential consumers of the consumer type Registry.npmjs.com evaluate the following credential properties:
+    Credential consumers of the consumer type NpmRegistry evaluate the following credential properties:
 
       - <code>username</code>: the basic auth user name
       - <code>password</code>: the basic auth password
       - <code>email</code>: NPM registry, require an email address
       - <code>token</code>: the token attribute. May exist after login at any npm registry. Check your .npmrc file!
 
 
+  - <code>OCIRegistry</code>: OCI registry credential matcher
+
+    It matches the <code>OCIRegistry</code> consumer type and additionally acts like
+    the <code>hostpath</code> type.
+
+    Credential consumers of the consumer type OCIRegistry evaluate the following credential properties:
+
+      - <code>username</code>: the basic auth user name
+      - <code>password</code>: the basic auth password
+      - <code>identityToken</code>: the bearer token used for non-basic auth authorization
+      - <code>certificateAuthority</code>: the certificate authority certificate used to verify certificates
+
+
   - <code>S3</code>: S3 credential matcher
 
     This matcher is a hostpath matcher.

diff --git a/docs/reference/ocm_get_credentials.md b/docs/reference/ocm_get_credentials.md
@@ -83,32 +83,43 @@ Matchers exist for the following usage contexts or consumer types:
       - <code>certificateAuthority</code>: TLS certificate authority
 
 
-  - <code>OCIRegistry</code>: OCI registry credential matcher
+  - <code>MavenRepository</code>: MVN repository
 
-    It matches the <code>OCIRegistry</code> consumer type and additionally acts like
+    It matches the <code>MavenRepository</code> consumer type and additionally acts like
     the <code>hostpath</code> type.
 
-    Credential consumers of the consumer type OCIRegistry evaluate the following credential properties:
+    Credential consumers of the consumer type MavenRepository evaluate the following credential properties:
 
       - <code>username</code>: the basic auth user name
       - <code>password</code>: the basic auth password
-      - <code>identityToken</code>: the bearer token used for non-basic auth authorization
-      - <code>certificateAuthority</code>: the certificate authority certificate used to verify certificates
 
 
-  - <code>Registry.npmjs.com</code>: NPM repository
+  - <code>NpmRegistry</code>: NPM repository
 
-    It matches the <code>Registry.npmjs.com</code> consumer type and additionally acts like
+    It matches the <code>NpmRegistry</code> consumer type and additionally acts like
     the <code>hostpath</code> type.
 
-    Credential consumers of the consumer type Registry.npmjs.com evaluate the following credential properties:
+    Credential consumers of the consumer type NpmRegistry evaluate the following credential properties:
 
       - <code>username</code>: the basic auth user name
       - <code>password</code>: the basic auth password
       - <code>email</code>: NPM registry, require an email address
       - <code>token</code>: the token attribute. May exist after login at any npm registry. Check your .npmrc file!
 
 
+  - <code>OCIRegistry</code>: OCI registry credential matcher
+
+    It matches the <code>OCIRegistry</code> consumer type and additionally acts like
+    the <code>hostpath</code> type.
+
+    Credential consumers of the consumer type OCIRegistry evaluate the following credential properties:
+
+      - <code>username</code>: the basic auth user name
+      - <code>password</code>: the basic auth password
+      - <code>identityToken</code>: the bearer token used for non-basic auth authorization
+      - <code>certificateAuthority</code>: the certificate authority certificate used to verify certificates
+
+
   - <code>S3</code>: S3 credential matcher
 
     This matcher is a hostpath matcher.