Merge branch 'main' into 464edependabot/github_actions/ci-1b43af929e

open-component-model · Dec 22, 2023 · fe2cba4 · fe2cba4
2 parents 78cf277 + 35e332b
commit fe2cba4
Show file tree

Hide file tree

Showing 10 changed files with 49 additions and 62 deletions.
diff --git a/docs/reference/ocm.md b/docs/reference/ocm.md
@@ -45,7 +45,7 @@ The command accepts some top level options, they can only be given before the su
 
 With the option <code>--cred</code> it is possible to specify arbitrary credentials
 for various environments on the command line. Nevertheless it is always preferrable
-to use the CLI [config file](./ocm_configfile.md).
+to use the cli config file.
 Every credential setting is related to a dedicated consumer and provides a set of
 credential attributes. All this can be specified by a sequence of <code>--cred</code>
 options.
@@ -198,7 +198,7 @@ The value can be a simple type or a JSON/YAML string for complex values
   Note that the host name part of the transfer target <code>ghcr.io/acme</code> is excluded from the
   prefix but the path <code>acme</code> is considered.
 
-  The same using a [config file](./ocm_configfile.md) <code>.ocmconfig</code>:
+  The same using a config file <code>.ocmconfig</code>:
   <pre>
   type: generic.config.ocm.software/v1
   configurations:
@@ -303,7 +303,9 @@ start with the prefix <code>!</code> or as direct string with the prefix
 With <code>--issuer</code> it is possible to declare expected issuer
 constraints for public key certificates provided as part of a signature
 required to accept the provisioned public key (besides the successful
-validation of the certificate).
+validation of the certificate). By default, the issuer constraint is
+derived from the signature name. If it is not a formal distinguished name,
+it is assumed to be a plain common name.
 
 With <code>--ca-cert</code> it is possible to define additional root
 certificates for signature verification, if public keys are provided
@@ -339,7 +341,6 @@ by a certificate delivered with the signature.
 
 * [ocm <b>cache</b>](ocm_cache.md)	 &mdash; Cache related commands
 * [ocm <b>credentials</b>](ocm_credentials.md)	 &mdash; Commands acting on credentials
-* [ocm <b>hash</b>](ocm_hash.md)	 &mdash; Commands acting on hashes
 * [ocm <b>oci</b>](ocm_oci.md)	 &mdash; Dedicated command flavors for the OCI layer
 * [ocm <b>ocm</b>](ocm_ocm.md)	 &mdash; Dedicated command flavors for the Open Component Model
 * [ocm <b>toi</b>](ocm_toi.md)	 &mdash; Dedicated command flavors for the TOI layer

diff --git a/docs/reference/ocm_add_resource-configuration.md b/docs/reference/ocm_add_resource-configuration.md
@@ -288,7 +288,7 @@ with the field <code>type</code> in the <code>input</code> field:
   This blob type specification supports the following fields:
   - **<code>path</code>** *string*
 
-    This REQUIRED property describes the file path to the helm chart relative to the
+    This REQUIRED property describes the path to the file relative to the
     resource file location.
 
   - **<code>mediaType</code>** *string*
@@ -387,7 +387,7 @@ with the field <code>type</code> in the <code>input</code> field:
   This blob type specification supports the following fields:
   - **<code>path</code>** *string*
 
-    This REQUIRED property describes the file path to the helm chart relative to the
+    This REQUIRED property describes the path to the file relative to the
     resource file location.
 
   - **<code>mediaType</code>** *string*

diff --git a/docs/reference/ocm_add_resources.md b/docs/reference/ocm_add_resources.md
@@ -298,7 +298,7 @@ with the field <code>type</code> in the <code>input</code> field:
   This blob type specification supports the following fields:
   - **<code>path</code>** *string*
 
-    This REQUIRED property describes the file path to the helm chart relative to the
+    This REQUIRED property describes the path to the file relative to the
     resource file location.
 
   - **<code>mediaType</code>** *string*
@@ -397,7 +397,7 @@ with the field <code>type</code> in the <code>input</code> field:
   This blob type specification supports the following fields:
   - **<code>path</code>** *string*
 
-    This REQUIRED property describes the file path to the helm chart relative to the
+    This REQUIRED property describes the path to the file relative to the
     resource file location.
 
   - **<code>mediaType</code>** *string*

diff --git a/docs/reference/ocm_add_source-configuration.md b/docs/reference/ocm_add_source-configuration.md
@@ -288,7 +288,7 @@ with the field <code>type</code> in the <code>input</code> field:
   This blob type specification supports the following fields:
   - **<code>path</code>** *string*
 
-    This REQUIRED property describes the file path to the helm chart relative to the
+    This REQUIRED property describes the path to the file relative to the
     resource file location.
 
   - **<code>mediaType</code>** *string*
@@ -387,7 +387,7 @@ with the field <code>type</code> in the <code>input</code> field:
   This blob type specification supports the following fields:
   - **<code>path</code>** *string*
 
-    This REQUIRED property describes the file path to the helm chart relative to the
+    This REQUIRED property describes the path to the file relative to the
     resource file location.
 
   - **<code>mediaType</code>** *string*

diff --git a/docs/reference/ocm_add_sources.md b/docs/reference/ocm_add_sources.md
@@ -295,7 +295,7 @@ with the field <code>type</code> in the <code>input</code> field:
   This blob type specification supports the following fields:
   - **<code>path</code>** *string*
 
-    This REQUIRED property describes the file path to the helm chart relative to the
+    This REQUIRED property describes the path to the file relative to the
     resource file location.
 
   - **<code>mediaType</code>** *string*
@@ -394,7 +394,7 @@ with the field <code>type</code> in the <code>input</code> field:
   This blob type specification supports the following fields:
   - **<code>path</code>** *string*
 
-    This REQUIRED property describes the file path to the helm chart relative to the
+    This REQUIRED property describes the path to the file relative to the
     resource file location.
 
   - **<code>mediaType</code>** *string*

diff --git a/docs/reference/ocm_configfile.md b/docs/reference/ocm_configfile.md
@@ -3,7 +3,7 @@
 ### Description
 
 
-The command line client supports configuration using a configuration file.
+The command line client supports configuring by a given configuration file.
 If existent, by default, the file <code>$HOME/.ocmconfig</code> will be read.
 Using the option <code>--config</code> an alternative file can be specified.
 
@@ -305,9 +305,7 @@ The following configuration types are supported:
 
 ### Examples
 
-Pointing to an existing Docker config json:
-
-```yaml
+```
 type: generic.config.ocm.software/v1
 configurations:
   - type: credentials.config.ocm.software
@@ -326,49 +324,6 @@ configurations:
 #           process: true
 ```
 
-Pointing to an existing Docker config json and configure two additional consumers
-for a Github repository and a Helm chart repository. Caching for OCM component versions is switched on.
-A key pair for signing / verifiying OCM component versions has been configured, too.
-
-```yaml
-type: generic.config.ocm.software/v1
-configurations:
-  - type: credentials.config.ocm.software
-    consumers:
-      - identity:
-          type: HelmChartRepository
-          hostname: my.repository.mycomp.com
-          pathprefix: artifactory/myhelm-repo
-          port: "443"
-        credentials:
-          - type: Credentials
-            properties:
-              username: myuser
-              password: 8eYwL5Ru44L6ZySyLUcyP
-      - identity:
-          type: Github
-          hostname: github.com
-        credentials:
-          - type: Credentials
-            properties:
-              token: ghp_QRP489abcd1234A9q3x17a8BlD42kabv65
-    repositories:
-      - repository:
-          type: DockerConfig/v1
-          dockerConfigFile: ~/.docker/config.json
-          propagateConsumerIdentity: true
-  - type: attributes.config.ocm.software
-    attributes:
-      cache: ~/.ocm/cache
-  - type: keys.config.ocm.software
-    privateKeys:
-      sap.com:
-        path: /Users/myuser/.ocm/keys/mycomp.com.key
-    publicKeys:
-      sap.com:
-        path: /Users/myuser/.ocm/keys/mycomp.com.pub
-```
-
 ### SEE ALSO
 
 ##### Parents

diff --git a/docs/reference/ocm_hash.md b/docs/reference/ocm_hash.md
@@ -1,4 +1,4 @@
-## ocm hash &mdash; Commands Acting On Hashes
+## ocm hash &mdash; Hash And Normalization Operations
 
 ### Synopsis
 
@@ -21,5 +21,5 @@ ocm hash [<options>] <sub command> ...
 
 ##### Sub Commands
 
-* ocm hash <b>sign</b>	 &mdash; sign hash
+* [ocm hash <b>componentversions</b>](ocm_hash_componentversions.md)	 &mdash; hash component version
 
diff --git a/pkg/contexts/ocm/compdesc/meta/v1/signature.go b/pkg/contexts/ocm/compdesc/meta/v1/signature.go
@@ -166,6 +166,10 @@ func (s *SignatureSpec) ConvertToSigning() *signing.Signature {
 	}
 }
 
+// TimestampSpec provides a timestamp and the
+// appropriate pem encoded TSA value.
+// +k8s:deepcopy-gen=true
+// +k8s:openapi-gen=true
 type TimestampSpec struct {
 	// Value contains the PEM encoded TSA value.
 	Value string     `json:"value"`

diff --git a/pkg/contexts/ocm/compdesc/meta/v1/zz_generated.deepcopy.go b/pkg/contexts/ocm/compdesc/meta/v1/zz_generated.deepcopy.go
diff --git a/pkg/contexts/ocm/compdesc/versions/v2/zz_generated.deepcopy.go b/pkg/contexts/ocm/compdesc/versions/v2/zz_generated.deepcopy.go