Skip to content

Commit 8e92f68

Browse files
committed
update examples
1 parent 26f935c commit 8e92f68

File tree

1 file changed

+9
-39
lines changed

1 file changed

+9
-39
lines changed

docs/vendor/helm-image-registry.mdx

Lines changed: 9 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -27,57 +27,30 @@ To use the Replicated proxy registry for applications installed with Helm:
2727
* `DOMAIN` is either `proxy.replicated.com` or your custom domain.
2828
* `APP_SLUG` is the unique slug of your application.
2929
* `EXTERNAL_REGISTRY_IMAGE_URL` is the path to the private image on your external registry.
30-
31-
**Example with custom domain:**
32-
33-
```yaml
34-
# values.yaml
35-
images:
36-
your-app:
37-
apiImageRepository: images.yourcompany.com/proxy/your-app-slug/ghcr.io/org-name/api
38-
apiImageTag: v1.0.1
39-
```
4030

4131
**Example with proxy.replicated.com:**
4232

4333
```yaml
4434
# values.yaml
45-
images:
46-
your-app:
47-
registry: proxy.replicated.com
48-
repository: proxy/your-app-slug/ghcr.io/cloudnative-pg/cloudnative-pg
35+
api:
36+
image:
37+
registry: ghcr.io
38+
repository: proxy/app/ghcr.io/cloudnative-pg/cloudnative-pg
4939
tag: catalog-1.24.0
5040
```
5141
5242
1. Ensure that any references to the image in your Helm chart access the field from your values file.
5343
54-
**Example**:
55-
56-
```yaml
57-
# /templates/deployment.yaml
58-
59-
apiVersion: apps/v1
60-
kind: Deployment
61-
metadata:
62-
name: example
63-
spec:
64-
template:
65-
spec:
66-
containers:
67-
- name: api
68-
# Access the repository and tag fields from the values file
69-
image: {{ .Values.images.your-app.apiImageRepository }}:{{ .Values.images.your-app.apiImageTag }}
70-
```
7144
**Example**:
7245
7346
```yaml
7447
apiVersion: v1
7548
kind: Pod
7649
spec:
7750
containers:
78-
- name:
51+
- name: api
7952
# Access the registry, repository, and tag fields from the values file
80-
image: {{ .Values.images.your-app.registry }}/{{ .Values.images.your-app.repository }}:{{ .Values.images.your-app.tag }}
53+
image: {{ .Values.images.api.registry }}/{{ .Values.images.api.repository }}:{{ .Values.images.api.tag }}
8154
```
8255
8356
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.
@@ -89,7 +62,7 @@ To use the Replicated proxy registry for applications installed with Helm:
8962
:::
9063

9164
```yaml
92-
# /templates/replicated-pull-secret.yaml
65+
# templates/replicated-pull-secret.yaml
9366
9467
{{ if .Values.global.replicated.dockerconfigjson }}
9568
apiVersion: v1
@@ -109,7 +82,7 @@ To use the Replicated proxy registry for applications installed with Helm:
10982
**Example:**
11083

11184
```yaml
112-
# /templates/deployment.yaml
85+
# templates/deployment.yaml
11386
11487
image: "{{ .Values.images.your-app.apiImageRepository }}:{{ .Values.images.your-app.apiImageTag }}"
11588
# Add the pull secret
@@ -125,7 +98,4 @@ To use the Replicated proxy registry for applications installed with Helm:
12598

12699
1. Package your Helm chart and add it to a release. Promote the release to a development channel. See [Managing Releases with Vendor Portal](releases-creating-releases).
127100

128-
1. Install in a development environment to test your changes. See [Installing with Helm](/vendor/install-with-helm).
129-
130-
131-
101+
1. Install in a development environment to test your changes. See [Installing with Helm](/vendor/install-with-helm).

0 commit comments

Comments
 (0)