add changes for multi-arch (#851)

add multi-arch images to the docs
open-component-model · Jul 31, 2024 · 3d4c539 · 3d4c539
1 parent e28fca7
commit 3d4c539
Show file tree

Hide file tree

Showing 7 changed files with 40 additions and 30 deletions.
diff --git a/cmds/ocm/commands/ocmcmds/common/inputs/types/docker/type.go b/cmds/ocm/commands/ocmcmds/common/inputs/types/docker/type.go
@@ -12,8 +12,8 @@ func init() {
 }
 
 const usage = `
-The path must denote an image tag that can be found in the local
-docker daemon. The denoted image is packed as OCI artifact set.
+The path must denote an image tag that can be found in the local docker daemon.
+The denoted image is packed as OCI artifact set.
 The OCI image will contain an informational back link to the component version
 using the manifest annotation <code>` + annotations.COMPVERS_ANNOTATION + `</code>.
 

diff --git a/cmds/ocm/commands/ocmcmds/common/inputs/types/dockermulti/type.go b/cmds/ocm/commands/ocmcmds/common/inputs/types/dockermulti/type.go
@@ -14,8 +14,8 @@ func init() {
 const usage = `
 This input type describes the composition of a multi-platform OCI image.
 The various variants are taken from the local docker daemon. They should be 
-built with the buildx command for cross platform docker builds.
-The denoted images, as well as the wrapping image index is packed as OCI
+built with the "buildx" command for cross platform docker builds (see https://ocm.software/docs/tutorials/best-practices/#building-multi-architecture-images).
+The denoted images, as well as the wrapping image index, are packed as OCI
 artifact set.
 They will contain an informational back link to the component version
 using the manifest annotation <code>` + annotations.COMPVERS_ANNOTATION + `</code>.

diff --git a/cmds/ocm/commands/ocmcmds/common/inputs/types/ociartifact/type.go b/cmds/ocm/commands/ocmcmds/common/inputs/types/ociartifact/type.go
@@ -19,12 +19,14 @@ DEPRECATED: This type is deprecated, please use ` + TYPE + ` instead.
 `
 
 const usage = `
-The path must denote an OCI image reference.
+This input type is used to import an OCI image from an OCI registry.
+If it is a multi-arch image the set of platforms to be imported can be filtered using the "platforms"
+attribute. The path must denote an OCI image reference. 
 
 This blob type specification supports the following fields: 
 - **<code>path</code>** *string*
 
-  This REQUIRED property describes the OVI image reference of the image to
+  This REQUIRED property describes the OCI image reference of the image to
   import.
 
 - **<code>repository</code>** *string*

diff --git a/docs/reference/ocm_add_resource-configuration.md b/docs/reference/ocm_add_resource-configuration.md
@@ -255,8 +255,8 @@ with the field <code>type</code> in the <code>input</code> field:
 
 - Input type <code>docker</code>
 
-  The path must denote an image tag that can be found in the local
-  docker daemon. The denoted image is packed as OCI artifact set.
+  The path must denote an image tag that can be found in the local docker daemon.
+  The denoted image is packed as OCI artifact set.
   The OCI image will contain an informational back link to the component version
   using the manifest annotation <code>software.ocm/component-version</code>.
 
@@ -278,8 +278,8 @@ with the field <code>type</code> in the <code>input</code> field:
 
   This input type describes the composition of a multi-platform OCI image.
   The various variants are taken from the local docker daemon. They should be
-  built with the buildx command for cross platform docker builds.
-  The denoted images, as well as the wrapping image index is packed as OCI
+  built with the "buildx" command for cross platform docker builds (see https://ocm.software/docs/tutorials/best-practices/#building-multi-architecture-images).
+  The denoted images, as well as the wrapping image index, are packed as OCI
   artifact set.
   They will contain an informational back link to the component version
   using the manifest annotation <code>software.ocm/component-version</code>.
@@ -409,12 +409,14 @@ with the field <code>type</code> in the <code>input</code> field:
 
 - Input type <code>ociArtifact</code>
 
-  The path must denote an OCI image reference.
+  This input type is used to import an OCI image from an OCI registry.
+  If it is a multi-arch image the set of platforms using the "platforms"
+  attribute. The path must denote an OCI image reference.
 
   This blob type specification supports the following fields:
   - **<code>path</code>** *string*
 
-    This REQUIRED property describes the OVI image reference of the image to
+    This REQUIRED property describes the OCI image reference of the image to
     import.
 
   - **<code>repository</code>** *string*

diff --git a/docs/reference/ocm_add_resources.md b/docs/reference/ocm_add_resources.md
@@ -266,8 +266,8 @@ with the field <code>type</code> in the <code>input</code> field:
 
 - Input type <code>docker</code>
 
-  The path must denote an image tag that can be found in the local
-  docker daemon. The denoted image is packed as OCI artifact set.
+  The path must denote an image tag that can be found in the local docker daemon.
+  The denoted image is packed as OCI artifact set.
   The OCI image will contain an informational back link to the component version
   using the manifest annotation <code>software.ocm/component-version</code>.
 
@@ -289,8 +289,8 @@ with the field <code>type</code> in the <code>input</code> field:
 
   This input type describes the composition of a multi-platform OCI image.
   The various variants are taken from the local docker daemon. They should be
-  built with the buildx command for cross platform docker builds.
-  The denoted images, as well as the wrapping image index is packed as OCI
+  built with the "buildx" command for cross platform docker builds (see https://ocm.software/docs/tutorials/best-practices/#building-multi-architecture-images).
+  The denoted images, as well as the wrapping image index, are packed as OCI
   artifact set.
   They will contain an informational back link to the component version
   using the manifest annotation <code>software.ocm/component-version</code>.
@@ -420,12 +420,14 @@ with the field <code>type</code> in the <code>input</code> field:
 
 - Input type <code>ociArtifact</code>
 
-  The path must denote an OCI image reference.
+  This input type is used to import an OCI image from an OCI registry.
+  If it is a multi-arch image the set of platforms using the "platforms"
+  attribute. The path must denote an OCI image reference.
 
   This blob type specification supports the following fields:
   - **<code>path</code>** *string*
 
-    This REQUIRED property describes the OVI image reference of the image to
+    This REQUIRED property describes the OCI image reference of the image to
     import.
 
   - **<code>repository</code>** *string*

diff --git a/docs/reference/ocm_add_source-configuration.md b/docs/reference/ocm_add_source-configuration.md
@@ -255,8 +255,8 @@ with the field <code>type</code> in the <code>input</code> field:
 
 - Input type <code>docker</code>
 
-  The path must denote an image tag that can be found in the local
-  docker daemon. The denoted image is packed as OCI artifact set.
+  The path must denote an image tag that can be found in the local docker daemon.
+  The denoted image is packed as OCI artifact set.
   The OCI image will contain an informational back link to the component version
   using the manifest annotation <code>software.ocm/component-version</code>.
 
@@ -278,8 +278,8 @@ with the field <code>type</code> in the <code>input</code> field:
 
   This input type describes the composition of a multi-platform OCI image.
   The various variants are taken from the local docker daemon. They should be
-  built with the buildx command for cross platform docker builds.
-  The denoted images, as well as the wrapping image index is packed as OCI
+  built with the "buildx" command for cross platform docker builds (see https://ocm.software/docs/tutorials/best-practices/#building-multi-architecture-images).
+  The denoted images, as well as the wrapping image index, are packed as OCI
   artifact set.
   They will contain an informational back link to the component version
   using the manifest annotation <code>software.ocm/component-version</code>.
@@ -409,12 +409,14 @@ with the field <code>type</code> in the <code>input</code> field:
 
 - Input type <code>ociArtifact</code>
 
-  The path must denote an OCI image reference.
+  This input type is used to import an OCI image from an OCI registry.
+  If it is a multi-arch image the set of platforms using the "platforms"
+  attribute. The path must denote an OCI image reference.
 
   This blob type specification supports the following fields:
   - **<code>path</code>** *string*
 
-    This REQUIRED property describes the OVI image reference of the image to
+    This REQUIRED property describes the OCI image reference of the image to
     import.
 
   - **<code>repository</code>** *string*

diff --git a/docs/reference/ocm_add_sources.md b/docs/reference/ocm_add_sources.md
@@ -264,8 +264,8 @@ with the field <code>type</code> in the <code>input</code> field:
 
 - Input type <code>docker</code>
 
-  The path must denote an image tag that can be found in the local
-  docker daemon. The denoted image is packed as OCI artifact set.
+  The path must denote an image tag that can be found in the local docker daemon.
+  The denoted image is packed as OCI artifact set.
   The OCI image will contain an informational back link to the component version
   using the manifest annotation <code>software.ocm/component-version</code>.
 
@@ -287,8 +287,8 @@ with the field <code>type</code> in the <code>input</code> field:
 
   This input type describes the composition of a multi-platform OCI image.
   The various variants are taken from the local docker daemon. They should be
-  built with the buildx command for cross platform docker builds.
-  The denoted images, as well as the wrapping image index is packed as OCI
+  built with the "buildx" command for cross platform docker builds (see https://ocm.software/docs/tutorials/best-practices/#building-multi-architecture-images).
+  The denoted images, as well as the wrapping image index, are packed as OCI
   artifact set.
   They will contain an informational back link to the component version
   using the manifest annotation <code>software.ocm/component-version</code>.
@@ -418,12 +418,14 @@ with the field <code>type</code> in the <code>input</code> field:
 
 - Input type <code>ociArtifact</code>
 
-  The path must denote an OCI image reference.
+  This input type is used to import an OCI image from an OCI registry.
+  If it is a multi-arch image the set of platforms using the "platforms"
+  attribute. The path must denote an OCI image reference.
 
   This blob type specification supports the following fields:
   - **<code>path</code>** *string*
 
-    This REQUIRED property describes the OVI image reference of the image to
+    This REQUIRED property describes the OCI image reference of the image to
     import.
 
   - **<code>repository</code>** *string*