Skip to content

Commit c1c55ee

Browse files
committed
feat(sdk): update values schema
1 parent 13118b2 commit c1c55ee

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

docs/vendor/replicated-sdk-values-schema.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,3 +69,35 @@ The `global.replicated` values schema is a set of values that are injected by th
6969

7070
## Using Replicated Registry Values
7171
With the Replicated proxy registry, each customer’s license information is injected into the application’s environment and grant proxy access to images in an external private registry.
72+
To use the Replicated registry values, you must first configure the Replicated proxy registry in your Kubernetes cluster. For more information, see [Replicated Proxy Registry](/vendor/replicated-proxy-registry).
73+
74+
Here is an example of how to use the `global.replicated` values schema in your application:
75+
76+
```yaml
77+
dockerconfigjson: '{{ .Values.global.replicated.dockerconfigjson }}'
78+
images:
79+
myapp:
80+
# Add image URL in the values file
81+
apiImageRepository: proxy.replicated.com/proxy/my-app/quay.io/my-org/api
82+
apiImageTag: v1.0.1
83+
```
84+
In your deployment manifest, you can reference the `global.replicated` values schema to access the license information and other values injected by the Replicated registry.
85+
```yaml
86+
# /templates/deployment.yaml
87+
88+
apiVersion: apps/v1
89+
kind: Deployment
90+
metadata:
91+
name: example
92+
spec:
93+
template:
94+
spec:
95+
containers:
96+
- name: api
97+
# Access the apiImageRepository field from the values file
98+
image: "{{ .Values.images.myapp.apiImageRepository }}:{{ .Values.images.myapp.apiImageTag }}"
99+
{{ if .Values.global.replicated.dockerconfigjson }}
100+
imagePullSecrets:
101+
- name: replicated-pull-secret
102+
{{ end }}
103+
```

0 commit comments

Comments
 (0)