From 285b415686a8d32b7842369ecb75ca6f5bdcbc03 Mon Sep 17 00:00:00 2001 From: Lenny Chen <55669665+lennessyy@users.noreply.github.com> Date: Tue, 24 Sep 2024 16:35:49 -0700 Subject: [PATCH] docs: backport limitation (#4065) Co-authored-by: Lenny Chen --- .../edge/edge-configuration/installer-reference.md | 5 +++++ .../edge/edgeforge-workflow/build-content-bundle.md | 9 +++++++++ 2 files changed, 14 insertions(+) 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 5626a0181a..7186245191 100644 --- a/docs/docs-content/clusters/edge/edge-configuration/installer-reference.md +++ b/docs/docs-content/clusters/edge/edge-configuration/installer-reference.md @@ -86,6 +86,11 @@ stylus: 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/build-content-bundle.md) and +[Enable Local Harbor Registry](../networking/local-registry.md). + | Parameter | Description | | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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/build-content-bundle.md b/docs/docs-content/clusters/edge/edgeforge-workflow/build-content-bundle.md index 81fe02e787..198c9bedc2 100644 --- a/docs/docs-content/clusters/edge/edgeforge-workflow/build-content-bundle.md +++ b/docs/docs-content/clusters/edge/edgeforge-workflow/build-content-bundle.md @@ -37,6 +37,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 + [Installer Reference](../edge-configuration/installer-reference.md#external-registry) and + [Enable Local Harbor Registry](../networking/local-registry.md). + ## Prerequisites - Linux Machine (Physical or VM) with an AMD64 architecture.