docs: DOC-1177 (#2800)

* docs: fix doc bug * add additional bug fix * vale * address comments * address comment * vale * Apply suggestions from code review Co-authored-by: caroldelwing <[email protected]> * prettier --------- Co-authored-by: Lenny Chen <[email protected]> Co-authored-by: caroldelwing <[email protected]>
spectrocloud · May 9, 2024 · 21a2971 · 21a2971
1 parent bedb829
commit 21a2971
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 11 deletions.
diff --git a/...sters/edge/site-deployment/deploy-custom-registries/deploy-custom-registries.md b/...sters/edge/site-deployment/deploy-custom-registries/deploy-custom-registries.md
@@ -37,12 +37,16 @@ After the provider images are downloaded, the Palette agent proceeds to download
 cluster from registries that are specified in each pack's YAML configuration. However, you can specify an _external
 registry_ as the registry from which all images used by the cluster will be downloaded, including the provider images.
 
-When an external registry is provided in the user data, the Palette agent will replace the registry URL of every image
-used by the cluster with the external registry. For example, if your OS pack specified that the provider images be
-downloaded from `quay.io/kairos/core-ubuntu-20-lts-rke2:v1.25.2-rke2r1`, but in your user data, you have specified an
-external registry `10.10.254.254:8000/spectro-images`. The Palette agent will automatically download the image using the
-tag `10.10.254.254:8000/spectro-images/core-ubuntu-20-lts-rke2:v1.25.2-rke2r1` instead of looking for the image in the
-`quay.io/kairos` registry.
+When an external registry is provided in the user data, the Palette agent will prepend the URL of the external registry
+to the URL of every image. For example, if your OS pack specified that the provider images be downloaded from
+`quay.io/kairos/core-ubuntu-20-lts-rke2:v1.25.2-rke2r1`, but in your user data, you have specified an external registry
+as `10.10.254.254:8000/spectro-images`, the Palette agent will automatically download the image using the tag
+`10.10.254.254:8000/spectro-images/quay.io/kairos/core-ubuntu-20-lts-rke2:v1.25.2-rke2r1` instead of looking for the
+image in the original registry.
+
+The provider image also includes core Kubernetes images such as images for api-server, etcd, and
+kube-controller-manager, which will be loaded directly from the provider image to containerd without fetching them from
+another registry.
 
 If you want to use a private image registry for applications on your Edge cluster, you can instruct the Palette agent to
 download images from an _authenticated external registry_. You can specify an external registry in the user-data used to

diff --git a/...sters/edge/site-deployment/deploy-custom-registries/deploy-external-registry.md b/...sters/edge/site-deployment/deploy-custom-registries/deploy-external-registry.md
@@ -13,12 +13,16 @@ for the registry in the user data used to build your Edge Installer ISO.
 
 Once you specify an external registry, images for all elements of the cluster are expected to be in the external
 registry. This includes the provider images, images for the network and storage layer, and images for all application
-layers. All images specified in the cluster profile will have their registry URL replaced by the registry URL of the
+layers. All images specified in the cluster profile will have their registry URL prefixed by the registry URL of the
 external image registry. For example, if your OS pack specified that the provider images be downloaded from
 `quay.io/kairos/core-ubuntu-20-lts-rke2:v1.25.2-rke2r1`, but in your user data, you have specified an external registry
-`10.10.254.254:8000/spectro-images`. The Palette agent will automatically download the image using the tag
-`10.10.254.254:8000/spectro-images/core-ubuntu-20-lts-rke2:v1.25.2-rke2r1` instead of looking for the image in the
-`quay.io/kairos` registry.
+`10.10.254.254:8000/spectro-images/`. The Palette agent will automatically download the image using the tag
+`10.10.254.254:8000/spectro-images/quay.io/kairos/core-ubuntu-20-lts-rke2:v1.25.2-rke2r1` instead of looking for the
+image in the original registry.
+
+The provider image also includes core Kubernetes images such as images for api-server, etcd, and
+kube-controller-manager, which will be loaded directly from the provider image to containerd without fetching them from
+another registry.
 
 :::tip
 
@@ -114,7 +118,22 @@ information, refer to [Enable Local Harbor Registry](./local-registry.md).
    [Upload Cluster Images to External Registry with Palette Edge CLI](./upload-images-to-registry.md) to learn how to
    use the Palette Edge CLI to upload all images in a cluster profile to an external registry.
 
-9. Follow the [Create Cluster Definition](../site-installation/cluster-deployment.md) guide and deploy your cluster.
+9. In the Kubernetes layer of your cluster profile, remove `AlwaysPullImages` from
+   `cluster.config.clusterConfiguration.apiServer.extraArgs.enable-admission-plugins`.
+
+   For example, if the original `enable-admission-plugins` parameter is the following.
+
+   ```yaml
+   enable-admission-plugins: AlwaysPullImages,NamespaceLifecycle,ServiceAccount,NodeRestriction
+   ```
+
+   The resulting layer configuration should look like the following.
+
+   ```yaml
+   enable-admission-plugins: NamespaceLifecycle,ServiceAccount,NodeRestriction
+   ```
+
+10. Follow the [Create Cluster Definition](../site-installation/cluster-deployment.md) guide and deploy your cluster.
 
 ## Validate