Skip to content

Commit aa5f140

Browse files
committed
docs edits part 1
1 parent 173d46b commit aa5f140

File tree

1 file changed

+33
-8
lines changed

1 file changed

+33
-8
lines changed

docs/vendor/helm-install-airgap.mdx

Lines changed: 33 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -102,18 +102,43 @@ 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-
## Pull through registry proxies and mirrors
105+
## Using a Pull-Through Proxy
106106

107-
The Replicated proxy registry supports additional functionality that can help streamline the air gap installation and update process for customers. For authenticated users, the Replicated proxy registry exposes standard catalog and tag listing endpoints that can be used to generate a list of images required for installation. These endpoints will list images for the last 10 releases.
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.
108108

109-
### Integration with Harbor
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.
110110

111-
[Harbor](https://goharbor.io) is a popular open-source container registry that supports both pull through proxy caching and repository mirroring (via pull based replication rules). Customers can use Harbor to cache images on demand and set up replication rules to proactively mirror images.
111+
### Limitations
112112

113-
The first step is simply adding the Replicated proxy registry with the customer's credentials (the `license_id`) as a standard Docker Registry ([Harbor - Configure Proxy Cache](https://goharbor.io/docs/2.11.0/administration/configure-proxy-cache/)). That alone will allow the customer to pull images through Harbor on demand and utilize Harbor's caching, security, and other features.
113+
Connecting the Replicated proxy registry with Harbor and Artifactory has the following limitations:
114114

115-
The second optional step is to set up a **pull based** replication rule in Harbor to mirror images needed proactively ([Harbor - Creating a replication rule](https://goharbor.io/docs/2.11.0/administration/configuring-replication/create-replication-rules/)). This will periodically (or when manually triggered) pull images from the Replicated proxy registry to store them in Harbor.
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.
116118

117-
### Integration with Artifactory
119+
### Integrate With Harbor
118120

119-
Artifactory support's a pull through caching mode for Docker registries but does not support Docker registry mirroring or replication. For information on setting up a pull through cache with Artifactory, see [Artifactory - Remote Repository](https://jfrog.com/help/r/jfrog-artifactory-documentation/configure-a-remote-repository).
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.

0 commit comments

Comments
 (0)