Skip to content

Commit 80fb43b

Browse files
committed
update links and add compatible registries partial
1 parent 63e0843 commit 80fb43b

File tree

4 files changed

+10
-9
lines changed

4 files changed

+10
-9
lines changed

docs/enterprise/image-registry-settings.mdx

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
11
import ImageRegistrySettings from "../partials/image-registry/_image-registry-settings.mdx"
2+
import DockerCompatibility from "../partials/image-registry/_docker-compatibility.mdx"
23

34
# Configuring Local Image Registries
45

56
This topic describes how to configure private registry settings in the Replicated KOTS Admin Console.
67

7-
The information in this topic applies to existing cluster installations with KOTS and installations with Replicated kURL.
8+
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.
89

910
## Overview
1011

11-
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.
12+
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.
1213

13-
Private registries can be used with online or air gap clusters.
14+
## Requirement
1415

15-
## Prerequisite
16+
The domain of the image registry must support a Docker V2 protocol. KOTS has been tested for compatibility with the following registries:
1617

17-
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_.
18+
<DockerCompatibility/>
1819

1920
## Configure Local Private Registries in Online Clusters
2021

docs/enterprise/installing-general-requirements.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -258,9 +258,9 @@ After manually creating these RBAC resources, the user must include both the `--
258258

259259
## Compatible Image Registries {#registries}
260260

261-
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.
261+
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.
262262

263-
Private registry settings can be changed at any time. For more information, see [Configuring Local Image Registries for KOTS Installations](image-registry-settings).
263+
Private registry settings can be changed at any time. For more information, see [Configuring Local Image Registries](image-registry-settings).
264264

265265
KOTS has been tested for compatibility with the following registries:
266266

docs/reference/custom-resource-helmchart-v2.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ The `builder` key is required for the following use cases:
101101

102102
* 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.
103103

104-
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).
104+
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).
105105

106106
<HelmBuilderRequirements/>
107107

docs/vendor/helm-native-v2-using.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -270,7 +270,7 @@ spec:
270270

271271
## Task 4: Support the Use of Local Image Registries {#local-registries}
272272

273-
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).
273+
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).
274274

275275
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_.
276276

0 commit comments

Comments
 (0)