From 81c0141bc9eb12aa8b6b525310d69206d1b110d6 Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Mon, 16 Dec 2024 12:02:53 -0700 Subject: [PATCH 1/7] remove kurl info from image registries topic --- docs/enterprise/image-registry-settings.mdx | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/docs/enterprise/image-registry-settings.mdx b/docs/enterprise/image-registry-settings.mdx index 86d318a548..e42b52206e 100644 --- a/docs/enterprise/image-registry-settings.mdx +++ b/docs/enterprise/image-registry-settings.mdx @@ -1,24 +1,20 @@ import ImageRegistrySettings from "../partials/image-registry/_image-registry-settings.mdx" -# Using Private Registries +# Using Private Registries for KOTS Existing Cluster Installations -This topic describes how to configure private registry settings in the Replicated KOTS Admin Console. +This topic describes how to configure private registry settings in the Replicated KOTS Admin Console. The information in this topic applies to existing cluster installations with KOTS in online (internet-connected) or air gap (limited or no outbound internet access) environments. -## About Private Registries +## Overview -Using a private registry lets you create a custom image pipeline. Any proprietary configurations that you make to the application are shared only with the groups that you allow access, such as your team or organization. You also have control over the storage location, logging messages, load balancing requests, and other configuration options. +You can push images to your own image registry. Any proprietary configurations that you make to the application are shared only with the groups that you allow access, such as your team or organization. This gives you control over the storage location, logging messages, load balancing requests, and other configuration options. -Private registries can be used with online or air gap clusters. For kURL clusters, if the Replicated kURL installer spec includes the kURL Registry add-on, then the built-in kURL registry is used to host the application images. For more information, see [Working with the kURL Image Registry](image-registry-kurl). - -## Prerequisites +## Prerequisite Your domain must support a Docker V2 protocol. For more information, see [Compatible Image Registries](installing-general-requirements#registries) in _KOTS Installation Requirements_. ## Configure Private Registries in Online Clusters -You configure the application to use a private registry in the Admin Console, unless you are using a kURL Registry add-on. You can also disable the connection or remove the registry settings if needed. - -For information about changing registry settings in an air gap environment, see [Change Private Registries in Air Gap Clusters](#air-gap). +You configure the application to use a private registry in the Admin Console. You can also disable the connection or remove the registry settings if needed. To configure private registry settings in an online cluster: From c814480458e64ab7dce6f511bd2c74aa53ce8fe7 Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Mon, 16 Dec 2024 12:18:06 -0700 Subject: [PATCH 2/7] edits --- docs/enterprise/image-registry-settings.mdx | 28 +++++++++++---------- sidebars.js | 2 +- 2 files changed, 16 insertions(+), 14 deletions(-) diff --git a/docs/enterprise/image-registry-settings.mdx b/docs/enterprise/image-registry-settings.mdx index e42b52206e..b65c3b41f3 100644 --- a/docs/enterprise/image-registry-settings.mdx +++ b/docs/enterprise/image-registry-settings.mdx @@ -1,24 +1,20 @@ import ImageRegistrySettings from "../partials/image-registry/_image-registry-settings.mdx" -# Using Private Registries for KOTS Existing Cluster Installations +# Configuring Local Image Registries for KOTS Installations This topic describes how to configure private registry settings in the Replicated KOTS Admin Console. The information in this topic applies to existing cluster installations with KOTS in online (internet-connected) or air gap (limited or no outbound internet access) environments. -## Overview - -You can push images to your own image registry. Any proprietary configurations that you make to the application are shared only with the groups that you allow access, such as your team or organization. This gives you control over the storage location, logging messages, load balancing requests, and other configuration options. - ## Prerequisite -Your domain must support a Docker V2 protocol. For more information, see [Compatible Image Registries](installing-general-requirements#registries) in _KOTS Installation Requirements_. +The domain of the image registry must support a Docker V2 protocol. For more information, see [Compatible Image Registries](installing-general-requirements#registries) in _KOTS Installation Requirements_. -## Configure Private Registries in Online Clusters +## Configure Local Private Registries in Online Clusters -You configure the application to use a private registry in the Admin Console. You can also disable the connection or remove the registry settings if needed. +In online (internet-connected) KOTS installations, you can optionally use a local private image registry. You can also disable the connection or remove the registry settings if needed. To configure private registry settings in an online cluster: -1. On the Registry Settings tab in the Admin Console, edit the fields: +1. In the Admin Console, on the **Registry Settings** tab, edit the fields: Registry Settings @@ -26,12 +22,10 @@ To configure private registry settings in an online cluster: -1. Click **Test Connection** to test the connection between Replicated KOTS and the private registry host. +1. Click **Test Connection** to test the connection between KOTS and the registry host. 1. Click **Save changes**. -1. (Optional) Click **Stop using registry** if you want to remove the registry settings from KOTS. - ## Change Private Registries in Air Gap Clusters {#air-gap} During air gap installations, you configure a private registry where KOTS pushes images. You can change the private registry settings at any time in the Admin Console. @@ -71,4 +65,12 @@ To change private registry settings in an air gap cluster: 1. Click **Test Connection** to test the connection between KOTS and the private registry host. -1. Click **Save changes**. \ No newline at end of file +1. Click **Save changes**. + +## Stop Using a Registry and Remove Registry Settings + +To stop using a registry: + +1. Log in to the Admin Console and go to **Registry Settings**. + +1. Click **Stop using registry** to remove the registry settings from the Admin Console. \ No newline at end of file diff --git a/sidebars.js b/sidebars.js index b68cd8ad93..409fd10569 100644 --- a/sidebars.js +++ b/sidebars.js @@ -399,7 +399,7 @@ const sidebars = { }, { type: 'category', - label: 'Configuring Local Image Registries for KOTS Installations', + label: 'Configuring Local Image Registries', items: [ 'enterprise/image-registry-settings', 'enterprise/image-registry-rate-limits', From cbcd2c41e21eb503bea8c661028031b005353918 Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Mon, 16 Dec 2024 12:48:09 -0700 Subject: [PATCH 3/7] edits --- docs/enterprise/image-registry-settings.mdx | 14 +++++++++----- .../enterprise/installing-general-requirements.mdx | 2 +- docs/reference/custom-resource-helmchart-v2.mdx | 2 +- docs/vendor/helm-native-v2-using.md | 2 +- 4 files changed, 12 insertions(+), 8 deletions(-) diff --git a/docs/enterprise/image-registry-settings.mdx b/docs/enterprise/image-registry-settings.mdx index b65c3b41f3..89f74d65ab 100644 --- a/docs/enterprise/image-registry-settings.mdx +++ b/docs/enterprise/image-registry-settings.mdx @@ -14,10 +14,12 @@ In online (internet-connected) KOTS installations, you can optionally use a loca To configure private registry settings in an online cluster: -1. In the Admin Console, on the **Registry Settings** tab, edit the fields: +1. In the Admin Console, on the **Registry settings** tab, edit the fields: Registry Settings + [View a larger version of this image](/images/registry-settings.png) + The following table describes the fields: @@ -32,9 +34,11 @@ During air gap installations, you configure a private registry where KOTS pushes To change private registry settings in an air gap cluster: -1. On the Registry Settings tab in the Admin Console, select the **Disable Pushing Images to Private Registry** checkbox, and click **Save changes**. +1. In the Admin Console, on the **Registry settings** tab, select the **Disable Pushing Images to Private Registry** checkbox. Click **Save changes**. - This is a temporary action that allows you to edit the registry namespace and hostname. If you only want to change the username or password, you do not have to disable pushing the images. + :::note + This is a temporary action that allows you to edit the registry namespace and hostname. If you only want to change the username or password for the registry, you do not have to disable pushing the images. + ::: 1. Edit the fields as needed, and click **Save changes**. @@ -61,7 +65,7 @@ To change private registry settings in an air gap cluster: -1. Deselect the **Disable Pushing Images to Private Registry** checkbox. This action re-enables KOTS to push images to your registry. +1. Deselect the **Disable Pushing Images to Private Registry** checkbox. This action re-enables KOTS to push images to the registry. 1. Click **Test Connection** to test the connection between KOTS and the private registry host. @@ -69,7 +73,7 @@ To change private registry settings in an air gap cluster: ## Stop Using a Registry and Remove Registry Settings -To stop using a registry: +To stop using a registry and remove registry settings from the Admin Console: 1. Log in to the Admin Console and go to **Registry Settings**. diff --git a/docs/enterprise/installing-general-requirements.mdx b/docs/enterprise/installing-general-requirements.mdx index 0f1d81b85a..23a66e55c1 100644 --- a/docs/enterprise/installing-general-requirements.mdx +++ b/docs/enterprise/installing-general-requirements.mdx @@ -260,7 +260,7 @@ After manually creating these RBAC resources, the user must include both the `-- A private image registry is required for air gap installations with KOTS in existing clusters. You provide the credentials for a compatible private registry during installation. You can also optionally configure a local private image registry for use with KOTS installations in online (internet-connected) environments. -Private registry settings can be changed at any time. For more information, see [Using Private Registries](image-registry-settings). +Private registry settings can be changed at any time. For more information, see [Configuring Local Image Registries for KOTS Installations](image-registry-settings). KOTS has been tested for compatibility with the following registries: diff --git a/docs/reference/custom-resource-helmchart-v2.mdx b/docs/reference/custom-resource-helmchart-v2.mdx index 00339b1bd3..a707be98f4 100644 --- a/docs/reference/custom-resource-helmchart-v2.mdx +++ b/docs/reference/custom-resource-helmchart-v2.mdx @@ -101,7 +101,7 @@ The `builder` key is required for the following use cases: * To support online installations that use a local private registry, the `builder` field renders the Helm chart with all of the necessary images so that KOTS knows where to pull the images. - You cannot prevent customers from configuring a local private registry in KOTS. If you think any of your customers will use a local private registry, you should use the `builder` key. For more information, see [Using Private Registries](/enterprise/image-registry-settings). + You cannot prevent customers from configuring a local private registry in KOTS. If you think any of your customers will use a local private registry, you should use the `builder` key. For more information, see [Configuring Local Image Registries for KOTS Installations](/enterprise/image-registry-settings). diff --git a/docs/vendor/helm-native-v2-using.md b/docs/vendor/helm-native-v2-using.md index 1da7fa0409..2c782a4eff 100644 --- a/docs/vendor/helm-native-v2-using.md +++ b/docs/vendor/helm-native-v2-using.md @@ -270,7 +270,7 @@ spec: ## Task 4: Support the Use of Local Image Registries {#local-registries} -Local image registries are required for KOTS installations in air-gapped environments with no outbound internet connection. Also, users in online environments can optionally use a local registry. For more information about how users configure a local image registry with KOTS, see [Using Private Registries](/enterprise/image-registry-settings). +Local image registries are required for KOTS installations in air-gapped environments with no outbound internet connection. Also, users in online environments can optionally use a local registry. For more information about how users configure a local image registry with KOTS, see [Configuring Local Image Registries for KOTS Installations](/enterprise/image-registry-settings). To support the use of local registries, configure the `builder` key. For more information about how to configure the `builder` key, see [`builder`](/reference/custom-resource-helmchart-v2#builder) in _HelmChart v2_. From 2921e9b4e7eff3333284c64c78d10e43fa8130ff Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Fri, 24 Jan 2025 13:47:37 -0700 Subject: [PATCH 4/7] remove kurl info --- docs/enterprise/image-registry-settings.mdx | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/docs/enterprise/image-registry-settings.mdx b/docs/enterprise/image-registry-settings.mdx index 89f74d65ab..ea578fb369 100644 --- a/docs/enterprise/image-registry-settings.mdx +++ b/docs/enterprise/image-registry-settings.mdx @@ -1,8 +1,14 @@ import ImageRegistrySettings from "../partials/image-registry/_image-registry-settings.mdx" -# Configuring Local Image Registries for KOTS Installations +# Configuring Local Image Registries -This topic describes how to configure private registry settings in the Replicated KOTS Admin Console. The information in this topic applies to existing cluster installations with KOTS in online (internet-connected) or air gap (limited or no outbound internet access) environments. +This topic describes how to configure private registry settings in the Replicated KOTS Admin Console. + +## Overview + +Using a private registry lets you create a custom image pipeline. Any proprietary configurations that you make to the application are shared only with the groups that you allow access, such as your team or organization. You also have control over the storage location, logging messages, load balancing requests, and other configuration options. + +Private registries can be used with online or air gap clusters. ## Prerequisite @@ -10,7 +16,7 @@ The domain of the image registry must support a Docker V2 protocol. For more inf ## Configure Local Private Registries in Online Clusters -In online (internet-connected) KOTS installations, you can optionally use a local private image registry. You can also disable the connection or remove the registry settings if needed. +In online (internet-connected) installations, you can optionally use a local private image registry. You can also disable the connection or remove the registry settings if needed. To configure private registry settings in an online cluster: @@ -30,7 +36,7 @@ To configure private registry settings in an online cluster: ## Change Private Registries in Air Gap Clusters {#air-gap} -During air gap installations, you configure a private registry where KOTS pushes images. You can change the private registry settings at any time in the Admin Console. +You can change the private registry settings at any time in the Admin Console. To change private registry settings in an air gap cluster: From 63e084302caa5a83e32e9ba039b40f810394aa66 Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Fri, 24 Jan 2025 15:25:43 -0700 Subject: [PATCH 5/7] add link to image registry doc from kurl page --- docs/enterprise/image-registry-kurl.md | 4 ++++ docs/enterprise/image-registry-settings.mdx | 2 ++ 2 files changed, 6 insertions(+) diff --git a/docs/enterprise/image-registry-kurl.md b/docs/enterprise/image-registry-kurl.md index 4ece0229e3..01b1a217e1 100644 --- a/docs/enterprise/image-registry-kurl.md +++ b/docs/enterprise/image-registry-kurl.md @@ -11,6 +11,10 @@ To keep the registry from running out of storage, images that are no longer used For more information about the kURL Registry add-on, see [Registry Add-On](https://kurl.sh/docs/add-ons/registry) in the kURL documentation. +:::note +Users can also optionally configure their own private registry for kURL installations in the Admin Console. For more information, see [Configuring Local Image Registries](/enterprise/image-registry-settings). +::: + ## Trigger Garbage Collection Every time the application instance is upgraded, image garbage collection automatically deletes images that are no longer used. diff --git a/docs/enterprise/image-registry-settings.mdx b/docs/enterprise/image-registry-settings.mdx index ea578fb369..64bdb14d3f 100644 --- a/docs/enterprise/image-registry-settings.mdx +++ b/docs/enterprise/image-registry-settings.mdx @@ -4,6 +4,8 @@ import ImageRegistrySettings from "../partials/image-registry/_image-registry-se This topic describes how to configure private registry settings in the Replicated KOTS Admin Console. +The information in this topic applies to existing cluster installations with KOTS and installations with Replicated kURL. + ## Overview Using a private registry lets you create a custom image pipeline. Any proprietary configurations that you make to the application are shared only with the groups that you allow access, such as your team or organization. You also have control over the storage location, logging messages, load balancing requests, and other configuration options. From 80fb43b66d121adbbdfc36e9bf7d111e97a0379d Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Fri, 24 Jan 2025 15:55:55 -0700 Subject: [PATCH 6/7] update links and add compatible registries partial --- docs/enterprise/image-registry-settings.mdx | 11 ++++++----- docs/enterprise/installing-general-requirements.mdx | 4 ++-- docs/reference/custom-resource-helmchart-v2.mdx | 2 +- docs/vendor/helm-native-v2-using.md | 2 +- 4 files changed, 10 insertions(+), 9 deletions(-) diff --git a/docs/enterprise/image-registry-settings.mdx b/docs/enterprise/image-registry-settings.mdx index 64bdb14d3f..96098199a4 100644 --- a/docs/enterprise/image-registry-settings.mdx +++ b/docs/enterprise/image-registry-settings.mdx @@ -1,20 +1,21 @@ import ImageRegistrySettings from "../partials/image-registry/_image-registry-settings.mdx" +import DockerCompatibility from "../partials/image-registry/_docker-compatibility.mdx" # Configuring Local Image Registries This topic describes how to configure private registry settings in the Replicated KOTS Admin Console. -The information in this topic applies to existing cluster installations with KOTS and installations with Replicated kURL. +The information in this topic applies to existing cluster installations with KOTS and installations with Replicated kURL. This topic does _not_ apply to Replciated Embedded Cluster installations. ## Overview -Using a private registry lets you create a custom image pipeline. Any proprietary configurations that you make to the application are shared only with the groups that you allow access, such as your team or organization. You also have control over the storage location, logging messages, load balancing requests, and other configuration options. +Using a private registry lets you create a custom image pipeline. Any proprietary configurations that you make to the application are shared only with the groups that you allow access, such as your team or organization. You also have control over the storage location, logging messages, load balancing requests, and other configuration options. Private registries can be used with online or air gap clusters. -Private registries can be used with online or air gap clusters. +## Requirement -## Prerequisite +The domain of the image registry must support a Docker V2 protocol. KOTS has been tested for compatibility with the following registries: -The domain of the image registry must support a Docker V2 protocol. For more information, see [Compatible Image Registries](installing-general-requirements#registries) in _KOTS Installation Requirements_. + ## Configure Local Private Registries in Online Clusters diff --git a/docs/enterprise/installing-general-requirements.mdx b/docs/enterprise/installing-general-requirements.mdx index 23a66e55c1..cd9110ec56 100644 --- a/docs/enterprise/installing-general-requirements.mdx +++ b/docs/enterprise/installing-general-requirements.mdx @@ -258,9 +258,9 @@ After manually creating these RBAC resources, the user must include both the `-- ## Compatible Image Registries {#registries} -A private image registry is required for air gap installations with KOTS in existing clusters. You provide the credentials for a compatible private registry during installation. You can also optionally configure a local private image registry for use with KOTS installations in online (internet-connected) environments. +A private image registry is required for air gap installations with KOTS in existing clusters. You provide the credentials for a compatible private registry during installation. You can also optionally configure a local private image registry for use with installations in online (internet-connected) environments. -Private registry settings can be changed at any time. For more information, see [Configuring Local Image Registries for KOTS Installations](image-registry-settings). +Private registry settings can be changed at any time. For more information, see [Configuring Local Image Registries](image-registry-settings). KOTS has been tested for compatibility with the following registries: diff --git a/docs/reference/custom-resource-helmchart-v2.mdx b/docs/reference/custom-resource-helmchart-v2.mdx index a707be98f4..edf90c5f6c 100644 --- a/docs/reference/custom-resource-helmchart-v2.mdx +++ b/docs/reference/custom-resource-helmchart-v2.mdx @@ -101,7 +101,7 @@ The `builder` key is required for the following use cases: * To support online installations that use a local private registry, the `builder` field renders the Helm chart with all of the necessary images so that KOTS knows where to pull the images. - You cannot prevent customers from configuring a local private registry in KOTS. If you think any of your customers will use a local private registry, you should use the `builder` key. For more information, see [Configuring Local Image Registries for KOTS Installations](/enterprise/image-registry-settings). + You cannot prevent customers from configuring a local private registry in the Admin Console. If you think any of your customers will use a local private registry, you should use the `builder` key. For more information, see [Configuring Local Image Registries](/enterprise/image-registry-settings). diff --git a/docs/vendor/helm-native-v2-using.md b/docs/vendor/helm-native-v2-using.md index 2c782a4eff..2141fb3389 100644 --- a/docs/vendor/helm-native-v2-using.md +++ b/docs/vendor/helm-native-v2-using.md @@ -270,7 +270,7 @@ spec: ## Task 4: Support the Use of Local Image Registries {#local-registries} -Local image registries are required for KOTS installations in air-gapped environments with no outbound internet connection. Also, users in online environments can optionally use a local registry. For more information about how users configure a local image registry with KOTS, see [Configuring Local Image Registries for KOTS Installations](/enterprise/image-registry-settings). +Local image registries are required for KOTS installations in air-gapped environments with no outbound internet connection. Also, users in online environments can optionally use a local registry. For more information about how users configure a local image registry with KOTS, see [Configuring Local Image Registries](/enterprise/image-registry-settings). To support the use of local registries, configure the `builder` key. For more information about how to configure the `builder` key, see [`builder`](/reference/custom-resource-helmchart-v2#builder) in _HelmChart v2_. From 12f3f9d72d1752ca640c62b0ecb0c975e6230f84 Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Fri, 24 Jan 2025 16:02:01 -0700 Subject: [PATCH 7/7] edits --- docs/enterprise/image-registry-kurl.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/enterprise/image-registry-kurl.md b/docs/enterprise/image-registry-kurl.md index 01b1a217e1..ea4e6eb3c0 100644 --- a/docs/enterprise/image-registry-kurl.md +++ b/docs/enterprise/image-registry-kurl.md @@ -12,7 +12,7 @@ To keep the registry from running out of storage, images that are no longer used For more information about the kURL Registry add-on, see [Registry Add-On](https://kurl.sh/docs/add-ons/registry) in the kURL documentation. :::note -Users can also optionally configure their own private registry for kURL installations in the Admin Console. For more information, see [Configuring Local Image Registries](/enterprise/image-registry-settings). +Users can also configure their own private registry for kURL installations instead of using the kURL registry. For more information, see [Configuring Local Image Registries](/enterprise/image-registry-settings). ::: ## Trigger Garbage Collection @@ -62,6 +62,6 @@ The kURL registry image garbage collection feature has following limitations: * **Shared Image Registries**: The image garbage collection process assumes that the registry is not shared with any other instances of Replicated KOTS, nor shared with any external applications. If the built-in kURL registry is used by another external application, disable garbage collection to prevent image loss. -* **Customer Supplied Registries**: Image garbage collection is supported only when used with the built-in kURL registry. If the KOTS instance is configured to use a different registry, disable garbage collection to prevent image loss. +* **Customer-Supplied Registries**: Image garbage collection is supported only when used with the built-in kURL registry. If the KOTS instance is configured to use a different registry, disable garbage collection to prevent image loss. For more information about configuring an image registry in the Admin Console, see [Configuring Local Image Registries](/enterprise/image-registry-settings). * **Application Rollbacks**: Image garbage collection has no effect when the `allowRollback` field in the KOTS Application custom resource is set to `true`. For more information, see [Application](/reference/custom-resource-application) in _KOTS Custom Resources_.