diff --git a/docs/docs-content/clusters/edge/edge-configuration/installer-reference.md b/docs/docs-content/clusters/edge/edge-configuration/installer-reference.md index 5e80480533..5bfb52f8f6 100644 --- a/docs/docs-content/clusters/edge/edge-configuration/installer-reference.md +++ b/docs/docs-content/clusters/edge/edge-configuration/installer-reference.md @@ -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. | | diff --git a/docs/docs-content/clusters/edge/edgeforge-workflow/palette-canvos/build-content-bundle.md b/docs/docs-content/clusters/edge/edgeforge-workflow/palette-canvos/build-content-bundle.md index 29d39705c7..575d281046 100644 --- a/docs/docs-content/clusters/edge/edgeforge-workflow/palette-canvos/build-content-bundle.md +++ b/docs/docs-content/clusters/edge/edgeforge-workflow/palette-canvos/build-content-bundle.md @@ -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. diff --git a/docs/docs-content/clusters/edge/site-deployment/deploy-custom-registries/deploy-external-registry.md b/docs/docs-content/clusters/edge/site-deployment/deploy-custom-registries/deploy-external-registry.md index f1d34cad87..a55bd4c638 100644 --- a/docs/docs-content/clusters/edge/site-deployment/deploy-custom-registries/deploy-external-registry.md +++ b/docs/docs-content/clusters/edge/site-deployment/deploy-custom-registries/deploy-external-registry.md @@ -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