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

docs: add limitation for external registry + content bundle #4049

Merged
merged 4 commits into from
Sep 24, 2024
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
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,11 @@ listed in alphabetical order.
You can point the Edge Installer to a non-default registry to load content from another source. Use the
`registryCredentials` parameter object to specify the registry configurations.

If you are using an external registry and want to use content bundles when deploying your Edge cluster, you must also
enable the local Harbor registry. For more information, refer to
[Build Content Bundles](../edgeforge-workflow/palette-canvos/build-content-bundle.md) and
[Enable Local Harbor Registry](../site-deployment/deploy-custom-registries/local-registry.md).

| Parameter | Description | Default |
| -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
| `stylus.registryCredentials.domain` | The domain of the registry. You can use an IP address plus the port or a domain name. | |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,15 @@ Creating a content bundle provides several benefits that may address common use
- Organizations that want better control over the software used by their Edge hosts can use content bundles to ensure
that only approved software is consumed.

## Limitation

- You cannot use content bundles with an external registry if you do not enable the local Harbor registry on your Edge
host. If you specify a external registry without enabling the local Harbor registry, the images will be downloaded
from the external registry even if you provide a content bundle, and deployment will fail if the necessary images
cannot be located in the external registry. For more information, refer to
[Deploy Cluster with External Registry](../../site-deployment/deploy-custom-registries/deploy-external-registry.md)
and [Enable Local Harbor Registry](../../site-deployment/deploy-custom-registries/local-registry.md).

## Prerequisites

- Linux Machine (Physical or VM) with an AMD64 architecture.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,13 @@ information, refer to [Enable Local Harbor Registry](./local-registry.md).
- Palette Edge supports basic username/password authentication. Token authentication schemes used by services such as
AWS ECR and Google Artifact Registry are not supported.

- You cannot use content bundles with an external registry if you do not enable the local Harbor registry on your Edge
host. If you specify a external registry without enabling the local Harbor registry, the images will be downloaded
from the external registry even if you provide a content bundle, and deployment will fail if the necessary images
cannot be located in the external registry. For more information, refer to
[Build Content Bundles](../../edgeforge-workflow/palette-canvos/build-content-bundle.md) and
[Enable Local Harbor Registry](../../site-deployment/deploy-custom-registries/local-registry.md).

## Prerequisites

- Specifying the external registry and providing credentials happens during the EdgeForge process. You should become
Expand Down