Skip to content

Commit fcf7c19

Browse files
committed
edits
1 parent e7753eb commit fcf7c19

File tree

2 files changed

+12
-13
lines changed

2 files changed

+12
-13
lines changed

docs/vendor/helm-image-registry.mdx

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,29 +4,29 @@ import RewriteHelmValues from "../partials/proxy-service/_step-rewrite-helm-valu
44

55
# Use the Proxy Registry with Helm Installations
66

7-
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 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).
88

99
## Overview
1010

11-
With the Replicated proxy registry, each customer's unique license can grant proxy access to images in an external private registry.
11+
During Helm 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.
1212

13-
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.
1414

15-
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+
:::
1618

17-
## Pull Private Images Through the Proxy Registry in Helm Installations
19+
## Configure Your Application to Use the Proxy Registry
1820

19-
To use the Replicated proxy registry for applications installed with Helm:
21+
To configure your application to use the proxy registry with Helm installations:
2022

2123
1. <StepCreds/>
2224

2325
1. <StepCustomDomain/>
2426

2527
1. <RewriteHelmValues/>
2628

27-
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.
28-
29-
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.
3030

3131
:::note
3232
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.
@@ -47,8 +47,7 @@ To use the Replicated proxy registry for applications installed with Helm:
4747
{{ end }}
4848
```
4949

50-
51-
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.
5251

5352
**Example:**
5453

docs/vendor/private-images-kots.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@ import InjectPullSecret from "../partials/proxy-service/_step-inject-pull-secret
77

88
# Use the Proxy Registry with Replicated Installers
99

10-
This topic describes how to use the Replicated proxy registry for applications deployed with Replicated installers (Embedded Cluster, KOTS existing cluster, or kURL).
10+
This topic describes how to use the Replicated proxy registry for applications deployed with Replicated installers (Embedded Cluster, KOTS existing cluster, or kURL). For more information about the proxy registry, see [About the Replicated Proxy Registry](private-images-about).
1111

1212
## Configure Your Application to Use the Proxy Registry
1313

1414
These steps assume that you package your application with Helm and that you install with the KOTS [HelmChart v2](/reference/custom-resource-helmchart-v2) custom resource.
1515

1616
If you are installing with the HelmChart v1 custom resource, or if your application is not packaged with Helm, there are different steps for configuring your application to use the proxy registry. See [Configure Other Application Types](#other-scenarios) below.
1717

18-
To configure your application to use the proxy registry:
18+
To configure your application to use the proxy registry for installations with a Replicated installer:
1919

2020
1. <StepCreds/>
2121

0 commit comments

Comments
 (0)