Skip to content

Commit d78c550

Browse files
committed
docs edits part 2
1 parent aa5f140 commit d78c550

File tree

3 files changed

+56
-40
lines changed

3 files changed

+56
-40
lines changed
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Using a Registry Proxy for Helm Air Gap Installations (Alpha)
2+
3+
This topic describes how enterprise users can configure a registry proxy using Harbor or jFrog Artifactory in order to proxy and cache images for Helm air gap installations.
4+
5+
## Overview
6+
7+
When installing with Helm in air-gapped environments, authenticated users must first pull the images that are required for installation from the [Replicated proxy registry](/vendor/private-images-about) using an internet-connected machine.
8+
9+
Users can optionally connect the Replicated proxy registry with their own [Harbor](https://goharbor.io) or [jFrog Artifactory](https://jfrog.com/help/r/jfrog-artifactory-documentation) instance in order to set up a registry proxy. The Replicated proxy regsitry exposes standard catalog and tag listing endpoints that can be used by authenticated users to proxy and cache images on demand from a Harbor or Artifactory instance:
10+
* The catalog endpoint returns a list of repositories built from images of the last 10 releases.
11+
* The tags listing endpoint lists the tags available in a given repository for those same releases.
12+
13+
In addition to on-demand image caching, using a registry proxy also has the following benefits:
14+
* Registry proxies typically support access controls as well as scanning images for security vulnerabilities
15+
* With Harbor, users can set up replicated rules for mirroring to improve the availability and reliability of the data
16+
17+
## Limitations
18+
19+
Using Harbor or Artifactory as a registry proxy has the following limitations:
20+
21+
* Neither the catalog or tags listing endpoints exposed by the Replicated proxy service respect pagination requests. However, Harbor requests 1000 items at a time.
22+
23+
* Only authenticated users can perform catalog calls or list tags. Authenticated users are those with an email address and license ID associated with a customer in the Vendor Portal.
24+
25+
* Artifactory does not support mirroring or replication for Docker registries.
26+
27+
## Connect the Replicated Proxy Registry to Harbor
28+
29+
[Harbor](https://goharbor.io) is a popular open-source container registry that supports both pull-through proxy caching and repository mirroring through pull based replication rules. Users can add the Replicated proxy registry to Harbor in order to cache images on demand and set up replication rules to proactively mirror images. This also allows customers use Harbor's caching, security, and other features.
30+
31+
To connect the Replicated proxy registry to Harbor:
32+
33+
1. Log in to Harbor and create a new replication endpoint. You will configure this endpoint to connect to the Replicated proxy registry. For more information, see [Creating Replication Endpoints](https://goharbor.io/docs/2.11.0/administration/configuring-replication/create-replication-endpoints/) in the Harbor documentation.
34+
35+
1. Enter the following details for the endpoint:
36+
37+
* For the provider field, choose Docker Registry.
38+
* For the URL field, enter `https://proxy.replicated.com` or the custom domain that you configured for the proxy registry. For more information about configuring custom domains in the Vendor Portal, see [Using Custom Domains](/vendor/custom-domains-using).
39+
* For the access ID, enter the email address associated with the customer in the Vendor Portal.
40+
* For the access secret, enter the customer's license ID. You can find the license ID in the Vendor Portal by going to **Customers > [Customer Name]**.
41+
42+
1. Verify your configuration by testing the connection and then save the endpoint.
43+
44+
1. After adding the Replicated proxy registry as a replication endpoint in Harbor, set up a proxy cache. Configuring a proxy cache allows users to pull images through Harbor on demand and also use Harbor's caching, security, and other features. For more information, see [Configure Proxy Cache](https://goharbor.io/docs/2.11.0/administration/configure-proxy-cache/) in the Harbor documentation.
45+
46+
1. (Optional) Set up a **pull based** replication rule in Harbor to mirror images proactively. This periodically (or when manually triggered) pulls images from the Replicated proxy registry to store them in Harbor. For more information, see [Creating a replication rule](https://goharbor.io/docs/2.11.0/administration/configuring-replication/create-replication-rules/)in the Harbor documentation.
47+
48+
## Connect the Replicated Proxy Registry to Artifactory
49+
50+
[jFrog Artifactory](https://jfrog.com/help/r/jfrog-artifactory-documentation) supports pull-through caching for Docker registries.
51+
52+
For information about how to configure a pull-through cache with Artifactory, see [Remote Repository](https://jfrog.com/help/r/jfrog-artifactory-documentation/configure-a-remote-repository) in the Artifactory documentation.

docs/vendor/helm-install-airgap.mdx

Lines changed: 3 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ To install with Helm in an air gap environment:
7272
Replicated recommends that vendors provide detailed documentation that describes the values that customers need to configure.
7373
:::
7474

75-
1. Finally, use the commands provided and the edited `values.yaml` to run preflight checks and install the release with Helm.
75+
1. Use the commands provided and the edited `values.yaml` to run preflight checks and install the release with Helm.
7676

7777
## Perform Updates
7878

@@ -102,43 +102,6 @@ With the list of images the provided `bash` script will automate the process of
102102

103103
Unless the customer has set up the `values` to preserve the updated tag (for example, by using the `latest` tag), they need to edit the `values.yaml` to reference the new image tags. After doing so, they can log in to the OCI registry and perform the commands to install the updated chart.
104104

105-
## Using a Pull-Through Proxy
105+
## Use a Harbor or Artifactory Registry Proxy
106106

107-
For authenticated users, the [Replicated proxy registry](/vendor/private-images-about) exposes standard catalog and tag listing endpoints that are used during Helm installations in air-gapped environments to generate the list of images required for installation. These endpoints are provided in the Helm air gap installation instructions in the Replicated Download Portal. For example, an `'updates.wp-e.10/my-app/1.2.3/images'` endpoint would return images for version 1.2.3 of an application from the proxy registry.
108-
109-
Users can optionally connect the Replicated proxy registry with [Harbor](https://goharbor.io) or Artifactory in order to use these endpoints to cache images. Integrating with Harbor also allows users to set up replicated rules for mirroring.
110-
111-
### Limitations
112-
113-
Connecting the Replicated proxy registry with Harbor and Artifactory has the following limitations:
114-
115-
* Neither the catalog or tags listing endpoints respect pagination requests yet but harbor requests 1000 items at a time. (Documented in "Harbor _catalog use": https://docs.google.com/document/d/1Ece7PaFOV12EVhMWFMHkrVZLDHFQfWUv4rWzi_wRjAM/edit#heading=h.wxiwuxpqb3pw)
116-
* Only authenticated users can perform catalog calls or list tags
117-
* Artifactory does not support Docker registry mirroring or replication.
118-
119-
### Integrate With Harbor
120-
121-
[Harbor](https://goharbor.io) is a popular open-source container registry that supports both pull-through proxy caching and repository mirroring through pull based replication rules. Users can add the Replicated proxy registry to Harbor in order to cache images on demand and set up replication rules to proactively mirror images. It also allows customers use Harbor's caching, security, and other features.
122-
123-
To connect the Replicated proxy registry with Harbor:
124-
125-
1. Log in to Harbor and create a new registry endpoint. You will configure this endpoint to connect to the Replicated proxy registry.
126-
127-
1. Enter the following details for the registry endpoint:
128-
129-
* For the provider field, choose Docker Registry
130-
* For the URL field, enter `https://proxy.replicated.com` or the custom domain that you configured for the proxy registry. For more information about configuring custom domains in the Vendor Portal, see [Using Custom Domains](/vendor/custom-domains-using).
131-
* For the access ID, enter the email address associated with the customer in the Vendor Portal.
132-
* For the access secret, enter the customer's license ID. You can find the license ID in the Vendor Portal by going to **Customers > [Customer Name]**.
133-
134-
1. Verify your configuration by testing the connection and then save the endpoint.
135-
136-
After connecting the Replicated proxy registry with Harbor, users can set up a proxy cache. For more information, see [Configure Proxy Cache](https://goharbor.io/docs/2.11.0/administration/configure-proxy-cache/)
137-
138-
Users can also optionally set up a **pull based** replication rule in Harbor to mirror images proactively. This periodically (or when manually triggered) pulls images from the Replicated proxy registry to store them in Harbor. For more information, see [Creating a replication rule](https://goharbor.io/docs/2.11.0/administration/configuring-replication/create-replication-rules/)in the Harbor documentation.
139-
140-
### Integrate With Artifactory
141-
142-
Artifactory supports a pull-through caching mode for Docker registries.
143-
144-
For information about how to configure a pull through cache with Artifactory, see [Remote Repository](https://jfrog.com/help/r/jfrog-artifactory-documentation/configure-a-remote-repository) in the Artifactory documentation.
107+
You can integrate the Replicated proxy registry with an existing Harbor or jFrog Artifactory instance to proxy and cache images on demand. For more information, see [Using a Registry Proxy for Helm Air Gap Installations (Alpha)](helm-install-airgap-registry-proxy).

sidebars.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -494,6 +494,7 @@ const sidebars = {
494494
'vendor/helm-install-overview',
495495
'vendor/install-with-helm',
496496
'vendor/helm-install-airgap',
497+
'vendor/helm-install-airgap-registry-proxy',
497498
],
498499
},
499500
{

0 commit comments

Comments
 (0)