diff --git a/docs/docs-content/tutorials/profiles/deploy-pack.md b/docs/docs-content/tutorials/profiles/deploy-pack.md index d4fe759b25..739215979c 100644 --- a/docs/docs-content/tutorials/profiles/deploy-pack.md +++ b/docs/docs-content/tutorials/profiles/deploy-pack.md @@ -5,6 +5,7 @@ description: "Learn how to deploy applications to a Kubernetes cluster using Palette's custom packs, hosted in either the Spectro registry or an OCI registry." sidebar_position: 0 +toc_max_heading_level: 2 tags: ["packs", "tutorial"] category: ["tutorial"] --- @@ -361,6 +362,13 @@ Next, export the variables below, which you will use later to create the ECR rep - `VERSION` - the pack's version, which must match the version in the **pack.json** file. - `ACCOUNT_ID` - your AWS account ID, containing only numerical digits and no dashes. +:::warning + +Ensure that the variables `NAME` and `VERSION` match the pack name and version in the **pack.json** file. This is a +requirement for the pack to be correctly pushed to the registry. + +::: + ```bash export REGISTRY_NAME=spectro-oci-registry export NAME=hellouniverse @@ -470,9 +478,16 @@ Login Succeeded After you have created the repositories, authenticate to your ECR registry using the `aws ecr get-login-password` command. The ECR authorization token is then passed to the `oras login` command with **AWS** as username and the -registry Uniform Resource Identifier (URI). [Oras](https://oras.land/docs/) is a CLI tool to push and pull OCI artifacts +registry Uniform Resource Identifier (URI). [ORAS](https://oras.land/docs/) is a CLI tool to push and pull OCI artifacts to and from OCI registries. +:::warning + +If you are not using the tutorial container, ensure you have ORAS version `1.0.0` installed. This version is explicitly +required for pushing packs to OCI registries. + +::: + ```bash aws ecr get-login-password --region $AWS_DEFAULT_REGION | oras login --username AWS --password-stdin $ACCOUNT_ID.dkr.ecr.$AWS_DEFAULT_REGION.amazonaws.com ``` @@ -494,7 +509,15 @@ After creating the projects, proceed with the Harbor authentication. In the tuto export HARBOR_ADDRESS= ``` -Now, issue the command `oras login`. +Now, issue the command `oras login`. [ORAS](https://oras.land/docs/) is a CLI tool to push and pull OCI artifacts to and +from OCI registries. + +:::warning + +If you are not using the tutorial container, ensure you have ORAS version `1.0.0` installed. This version is explicitly +required for pushing packs to OCI registries. + +::: ```bash oras login $HARBOR_ADDRESS @@ -603,6 +626,13 @@ Harbor repository and push the pack. - `NAME` - the pack's name, which must match the name in the **pack.json** file. - `VERSION` - the pack's version, which must match the version in the **pack.json** file. +:::warning + +Ensure that the variables `NAME` and `VERSION` match the pack name and version in the **pack.json** file. This is a +requirement for the pack to be correctly pushed to the registry. + +::: + ```bash export HARBOR_PROJECT=spectro-oci-registry export NAME=hellouniverse diff --git a/static/assets/docs/images/tutorials/deploy-pack/registries-and-packs_deploy-pack_oci-registry-edit.webp b/static/assets/docs/images/tutorials/deploy-pack/registries-and-packs_deploy-pack_oci-registry-edit.webp index 9578a05f28..5d2d91570c 100644 Binary files a/static/assets/docs/images/tutorials/deploy-pack/registries-and-packs_deploy-pack_oci-registry-edit.webp and b/static/assets/docs/images/tutorials/deploy-pack/registries-and-packs_deploy-pack_oci-registry-edit.webp differ diff --git a/static/assets/docs/images/tutorials/deploy-pack/registries-and-packs_deploy-pack_oci-registry-sync.webp b/static/assets/docs/images/tutorials/deploy-pack/registries-and-packs_deploy-pack_oci-registry-sync.webp index ce083078bd..4dadebb034 100644 Binary files a/static/assets/docs/images/tutorials/deploy-pack/registries-and-packs_deploy-pack_oci-registry-sync.webp and b/static/assets/docs/images/tutorials/deploy-pack/registries-and-packs_deploy-pack_oci-registry-sync.webp differ