diff --git a/cmds/ocm/commands/ocmcmds/common/inputs/types/docker/type.go b/cmds/ocm/commands/ocmcmds/common/inputs/types/docker/type.go index 159e8c4af7..789b8282dc 100644 --- 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 ` + annotations.COMPVERS_ANNOTATION + `. diff --git a/cmds/ocm/commands/ocmcmds/common/inputs/types/dockermulti/type.go b/cmds/ocm/commands/ocmcmds/common/inputs/types/dockermulti/type.go index 3c367a33ca..87e09c0399 100644 --- 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 ` + annotations.COMPVERS_ANNOTATION + `. diff --git a/cmds/ocm/commands/ocmcmds/common/inputs/types/ociartifact/type.go b/cmds/ocm/commands/ocmcmds/common/inputs/types/ociartifact/type.go index 68374686c2..af0c0e3c7f 100644 --- 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: - **path** *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. - **repository** *string* diff --git a/docs/reference/ocm_add_resource-configuration.md b/docs/reference/ocm_add_resource-configuration.md index 533a494438..28648499cf 100644 --- a/docs/reference/ocm_add_resource-configuration.md +++ b/docs/reference/ocm_add_resource-configuration.md @@ -255,8 +255,8 @@ with the field type in the input field: - Input type docker - 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 software.ocm/component-version. @@ -278,8 +278,8 @@ with the field type in the input 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 software.ocm/component-version. @@ -409,12 +409,14 @@ with the field type in the input field: - Input type ociArtifact - 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: - **path** *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. - **repository** *string* diff --git a/docs/reference/ocm_add_resources.md b/docs/reference/ocm_add_resources.md index 6079ff1755..042abf8c78 100644 --- a/docs/reference/ocm_add_resources.md +++ b/docs/reference/ocm_add_resources.md @@ -266,8 +266,8 @@ with the field type in the input field: - Input type docker - 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 software.ocm/component-version. @@ -289,8 +289,8 @@ with the field type in the input 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 software.ocm/component-version. @@ -420,12 +420,14 @@ with the field type in the input field: - Input type ociArtifact - 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: - **path** *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. - **repository** *string* diff --git a/docs/reference/ocm_add_source-configuration.md b/docs/reference/ocm_add_source-configuration.md index 7ebe3f1241..f6fd2fa7ba 100644 --- a/docs/reference/ocm_add_source-configuration.md +++ b/docs/reference/ocm_add_source-configuration.md @@ -255,8 +255,8 @@ with the field type in the input field: - Input type docker - 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 software.ocm/component-version. @@ -278,8 +278,8 @@ with the field type in the input 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 software.ocm/component-version. @@ -409,12 +409,14 @@ with the field type in the input field: - Input type ociArtifact - 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: - **path** *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. - **repository** *string* diff --git a/docs/reference/ocm_add_sources.md b/docs/reference/ocm_add_sources.md index fe3c6a12b9..8863d7d9fc 100644 --- a/docs/reference/ocm_add_sources.md +++ b/docs/reference/ocm_add_sources.md @@ -264,8 +264,8 @@ with the field type in the input field: - Input type docker - 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 software.ocm/component-version. @@ -287,8 +287,8 @@ with the field type in the input 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 software.ocm/component-version. @@ -418,12 +418,14 @@ with the field type in the input field: - Input type ociArtifact - 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: - **path** *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. - **repository** *string*