Skip to content

Commit

Permalink
[version-4-1] docs: address tutorial suggestions (#3980) (#4022)
Browse files Browse the repository at this point in the history
* docs: address tutorial suggestions (#3980)

* docs: address tutorial suggestions

* docs: vale suggestion

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

---------

Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
(cherry picked from commit 8ea96da)

* docs: fix gitleaks

---------

Co-authored-by: caroldelwing <[email protected]>
  • Loading branch information
1 parent 41db907 commit ce8e0ca
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 2 deletions.
1 change: 1 addition & 0 deletions .gitleaksignore
Original file line number Diff line number Diff line change
Expand Up @@ -135,3 +135,4 @@ e4040084011d4d7935a589959b96ebc5cfba7a94:docs/docs-content/integrations/kubernet
8f515d46ce2bb80b7173bf9684ed8e87cb96fd83:docs/docs-content/tutorials/edge/deploy-cluster-virtualbox.md:generic-api-key:229
59fcb296e3d4651a5d979fb8e9cab772e429bf81:docs/docs-content/tutorials/edge/deploy-cluster-virtualbox.md:generic-api-key:199
60a2dee998e99037999d2f561ffd442cc667af57:docs/docs-content/integrations/kubernetes.md:generic-api-key:1005
99f9720516a709d2122104a2fc95efefe8e798c5: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.

0 comments on commit ce8e0ca

Please sign in to comment.