-
Notifications
You must be signed in to change notification settings - Fork 31
Clarify supported install types for using local image registries #2905
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
81c0141
c814480
cbcd2c4
2921e9b
63e0843
80fb43b
12f3f9d
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,50 +1,53 @@ | ||
| import ImageRegistrySettings from "../partials/image-registry/_image-registry-settings.mdx" | ||
| import DockerCompatibility from "../partials/image-registry/_docker-compatibility.mdx" | ||
|
|
||
| # Using Private Registries | ||
| # Configuring Local Image Registries | ||
|
|
||
| This topic describes how to configure private registry settings in the Replicated KOTS Admin Console. | ||
|
|
||
| ## About Private Registries | ||
| 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. | ||
|
|
||
| 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. | ||
| ## Overview | ||
|
|
||
| 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). | ||
| 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. | ||
|
|
||
| ## Prerequisites | ||
| ## Requirement | ||
|
|
||
| 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. KOTS has been tested for compatibility with the following registries: | ||
|
|
||
| ## Configure Private Registries in Online Clusters | ||
| <DockerCompatibility/> | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ^ pulled in the partial instead of linking |
||
|
|
||
| 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. | ||
| ## Configure Local Private Registries in Online Clusters | ||
|
|
||
| For information about changing registry settings in an air gap environment, see [Change Private Registries in Air Gap Clusters](#air-gap). | ||
| 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: | ||
|
|
||
| 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: | ||
|
|
||
| <img src="/images/registry-settings.png" alt="Registry Settings" width="400"></img> | ||
|
|
||
| [View a larger version of this image](/images/registry-settings.png) | ||
|
|
||
| The following table describes the fields: | ||
|
|
||
| <ImageRegistrySettings/> | ||
|
|
||
| 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. | ||
|
|
||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ^ moved this step to its own procedure since no one would want to immediately remove a registry after adding it |
||
| ## 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: | ||
|
|
||
| 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**. | ||
|
|
||
|
|
@@ -71,8 +74,16 @@ To change private registry settings in an air gap cluster: | |
| </tr> | ||
| </table> | ||
|
|
||
| 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. | ||
|
|
||
| 1. Click **Save changes**. | ||
| 1. Click **Save changes**. | ||
|
|
||
| ## Stop Using a Registry and Remove Registry Settings | ||
|
|
||
| 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**. | ||
|
|
||
| 1. Click **Stop using registry** to remove the registry settings from the Admin Console. | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
^ removed this kurl info because it makes it sound like the registry add-on is what you always have to use for kurl, whereas you can actually configure a different registry for kurl too