Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[version-4-0] docs: address tutorial suggestions (#3980) #4021

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitleaksignore
Original file line number Diff line number Diff line change
Expand Up @@ -139,3 +139,4 @@ e4040084011d4d7935a589959b96ebc5cfba7a94:docs/docs-content/integrations/kubernet
8f515d46ce2bb80b7173bf9684ed8e87cb96fd83:docs/docs-content/tutorials/edge/deploy-cluster-virtualbox.md:generic-api-key:229
732cee5bed26e19ab178d822352de641a924e3b6:docs/docs-content/tutorials/edge/deploy-cluster-virtualbox.md:generic-api-key:187
740c00193f308cecd7daebc2e2424702a3fbb944:docs/docs-content/integrations/kubernetes.md:generic-api-key:1005
a43d695980eb29b9d3201b6a4143d8090aeeb771:docs/docs-content/tutorials/edge/deploy-cluster-virtualbox.md:generic-api-key:187
34 changes: 32 additions & 2 deletions docs/docs-content/tutorials/profiles/deploy-pack.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
---
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
```
Expand All @@ -494,7 +509,15 @@ After creating the projects, proceed with the Harbor authentication. In the tuto
export HARBOR_ADDRESS=<Your_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
Expand Down Expand Up @@ -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
Expand Down
Binary file not shown.
Binary file not shown.
Loading