You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/partials/helm/_helm-install-prereqs.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,6 @@
2
2
3
3
* The customer used to install must have the **Existing Cluster (Helm CLI)** install type enabled. If installing into an air gap environment, additionally enable the **Helm CLI Air Gap Instructions** option for the customer. For more information about enabling install types for customers in the Vendor Portal, see [Manage Install Types for a License](licenses-install-types).
4
4
5
-
* To ensure that the Replicated proxy registry can be used to grant proxy access to your application images during Helm installations, you must create an image pull secret for the proxy registry and add it to your Helm chart. To do so, follow the steps in [Using the Proxy Registry with Helm Installations](/vendor/helm-image-registry).
5
+
* To ensure that the Replicated proxy registry can be used to grant proxy access to your application images during Helm installations, you must create an image pull secret for the proxy registry and add it to your Helm chart. To do so, follow the steps in [Use the Proxy Registry with Helm CLI Installations](/vendor/helm-image-registry).
6
6
7
7
* Declare the SDK as a dependency in your Helm chart. For more information, see [Install the SDK as a Subchart](replicated-sdk-installing#install-the-sdk-as-a-subchart) in _Installing the Replicated SDK_.
If you are deploying Pods to namespaces other than the application namespace, add the namespace to the `additionalNamespaces` attribute of the KOTS Application custom resource. This ensures that KOTS can provision the `imagePullSecret` in the namespace to allow the Pod to pull the image. For instructions, see [Define Additional Namespaces](operator-defining-additional-namespaces).
# Use the Proxy Registry with Helm CLI Installations
5
6
6
-
This topic describes how to use the Replicated proxy registry to proxy images for installations with the Helm CLI. For more information about the proxy registry, see [About the Replicated Proxy Registry](private-images-about).
7
+
This topic describes how to configure your application to use the Replicated proxy registry with Helm CLI installations. For more information about the proxy registry, see [About the Replicated Proxy Registry](private-images-about). For more information about installing applications distributed with Replicated using Helm, see [About Helm Installations with Replicated](/vendor/helm-install-overview).
7
8
8
9
## Overview
9
10
10
-
With the Replicated proxy registry, each customer's unique license can grant proxy access to images in an external private registry.
11
+
During Helm CLI installations with Replicated, after customers provide their unique license ID, a `global.replicated.dockerconfigjson` field that contains a base64 encoded Docker configuration file is automatically injected in the Helm chart values.
11
12
12
-
During Helm installations, after customers provide their license ID, a `global.replicated.dockerconfigjson` field that contains a base64 encoded Docker configuration file is automatically injected in the Helm chart values. You can use this `global.replicated.dockerconfigjson`field to create the pull secret required to authenticate with the proxy registry, allowing you to use the proxy registry for images in your Helm charts.
13
+
You can use this `global.replicated.dockerconfigjson` field to create the pull secret required to authenticate with the proxy registry. For more information about how Kubernetes uses the `kubernetes.io/dockerconfigjson`Secret type to provide authentication for a private registry, see [Pull an Image from a Private Registry](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/)in the Kubernetes documentation.
13
14
14
-
Additionally, if you include the Replicated SDK as a dependency in your Helm chart, the image used by the Replicated SDK is automatically proxied through the proxy registry.
15
+
:::note
16
+
For Helm charts that include the Replicated SDK as a dependency, the image used by the Replicated SDK is automatically proxied through the proxy registry. No additional configuration is required. For more information, see [About the Replicated SDK](/vendor/replicated-sdk-overview).
17
+
:::
15
18
16
-
## Pull Private Images Through the Proxy Registry in Helm Installations
19
+
## Configure Your Application to Use the Proxy Registry
17
20
18
-
To use the Replicated proxy registry for applications installed with Helm:
21
+
To configure your application to use the proxy registry with Helm CLI installations:
19
22
20
23
1. <StepCreds/>
21
24
22
25
1. <StepCustomDomain/>
23
26
24
-
1.In your Helm chart values file, set your image repository URL to the location of the image on the proxy registry. If you added a custom domain, use your custom domain. Otherwise, use `proxy.replicated.com`.
27
+
1.<RewriteHelmValues/>
25
28
26
-
The proxy registry URL has the following format: `DOMAIN/proxy/APP_SLUG/EXTERNAL_REGISTRY_IMAGE_URL`
27
-
28
-
Where:
29
-
*`DOMAIN` is either `proxy.replicated.com` or your custom domain.
30
-
*`APP_SLUG` is the unique slug of your application.
31
-
*`EXTERNAL_REGISTRY_IMAGE_URL` is the path to the private image on your external registry.
1. In your Helm chart templates, create a Kubernetes Secret to evaluate if the `global.replicated.dockerconfigjson` value is set and then write the rendered value into a Secret on the cluster, as shown below.
60
-
61
-
This Secret is used to authenticate with the proxy registry. For information about how Kubernetes uses the `kubernetes.io/dockerconfigjson` Secret type to provide authentication for a private registry, see [Pull an Image from a Private Registry](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/) in the Kubernetes documentation.
29
+
1. In your Helm chart templates, add a YAML file that evaluates if the `global.replicated.dockerconfigjson` value is set, and then writes the rendered value into a Secret on the cluster, as shown below.
62
30
63
31
:::note
64
32
Do not use `replicated` for the name of the image pull secret because the Replicated SDK automatically creates a Secret named `replicated`. Using the same name causes an error.
@@ -79,8 +47,7 @@ To use the Replicated proxy registry for applications installed with Helm:
79
47
{{ end }}
80
48
```
81
49
82
-
83
-
1. Add the image pull secret that you created to any manifests that reference the image:
50
+
1. Add the image pull secret that you created to any manifests that reference the image.
Copy file name to clipboardExpand all lines: docs/vendor/packaging-public-images.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ For more information about the Replicated proxy registry, see [About the Replica
6
6
7
7
## Pull Public Images Through the Replicated Proxy Registry
8
8
9
-
You can use the Replicated proxy registry to pull both public and private images. Using the Replicated proxy registry for public images can simplify network access requirements for your customers, as they only need to whitelist a single domain (either `proxy.replicated.com` or your custom domain) instead of multiple registry domains. These are authenticated requests to avoid the proxy from hitting rate limits and preventing pulls. For more information about how to reference these in your values, see [Use the Proxy Registry with Helm Installations](/vendor/helm-image-registry).
9
+
You can use the Replicated proxy registry to pull both public and private images. Using the Replicated proxy registry for public images can simplify network access requirements for your customers, as they only need to whitelist a single domain (either `proxy.replicated.com` or your custom domain) instead of multiple registry domains. These are authenticated requests to avoid the proxy from hitting rate limits and preventing pulls. For more information about how to reference these in your values, see [Use the Proxy Registry with Helm CLI Installations](/vendor/helm-image-registry).
10
10
11
11
> [!IMPORTANT]
12
12
> For public images, you need to first configure registry credentials.
0 commit comments