-
Notifications
You must be signed in to change notification settings - Fork 28
Edit onboarding flow to rewite image names in helm chart #3357
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 7 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
440679c
Edit onboarding flow to rewite image names in helm chart
paigecalvert 832b8fd
edits
paigecalvert c535b39
edits to air gap steps in onboarding flow
paigecalvert 11a8ca3
edits
paigecalvert 4f3698d
edit rewrite image names language
paigecalvert 91021b6
edits
paigecalvert 2a586d9
minor copy edit
paigecalvert 5c3c5c4
Update docs/partials/proxy-service/_step-rewrite-helm-values.mdx
paigecalvert 5523d22
language edit
paigecalvert File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
In the HelmChart v2 custom resource, configure the `values` key to inject the Replicated image pull secret into your Helm values. This provides authentication for the proxy registry. Use the KOTS [ImagePullSecretName](/reference/template-functions-config-context#imagepullsecretname) template function to get the pull secret name. | ||
|
||
<details> | ||
<summary>What is the Replicated image pull secret?</summary> | ||
<p>During application deployment, KOTS automatically creates an `imagePullSecret` with `type: kubernetes.io/dockerconfigjson` that is based on the customer license. This secret is used to authenticate with the proxy registry and grant proxy access to private images. For information about how Kubernetes uses the `kubernetes.io/dockerconfigjson` Secret type to authenticate to a private image 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.</p> | ||
</details> | ||
|
||
**Example**: | ||
|
||
```yaml | ||
# kots.io/v1beta2 HelmChart custom resource | ||
|
||
apiVersion: kots.io/v1beta2 | ||
kind: HelmChart | ||
metadata: | ||
name: samplechart | ||
spec: | ||
values: | ||
image: | ||
# Get the pull secret name with ImagePullSecretName | ||
pullSecrets: | ||
- name: '{{repl ImagePullSecretName }}' | ||
``` | ||
Ensure that you provide this pull secret in any Pod definitions that reference images to be pulled through the proxy registry. | ||
|
||
**Example**: | ||
|
||
```yaml | ||
apiVersion: v1 | ||
kind: Pod | ||
metadata: | ||
name: nginx | ||
spec: | ||
containers: | ||
- name: nginx | ||
image: {{ .Values.image.registry }}/{{ .Values.image.repository }} | ||
# Access the value to provide the KOTS pull secret | ||
{{- with .Values.image.pullSecrets }} | ||
imagePullSecrets: | ||
{{- toYaml . | nindent 2 }} | ||
{{- end }} | ||
``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
For each image reference in your Helm chart values file, set the image repository URL to the location of the image on the proxy registry. This is either `proxy.replicated.com` or your custom domain. | ||
|
||
The proxy registry URL has the following format: `DOMAIN/proxy/APP_SLUG/EXTERNAL_REGISTRY_IMAGE_URL` | ||
|
||
Where: | ||
* `DOMAIN` is either `proxy.replicated.com` or your custom domain. | ||
* `APP_SLUG` is the unique slug of your application. | ||
* `EXTERNAL_REGISTRY_IMAGE_URL` is the path to the private image on your external registry. | ||
|
||
**Example:** | ||
|
||
```yaml | ||
# values.yaml | ||
api: | ||
image: | ||
# proxy.replicated.com or your custom domain | ||
registry: proxy.replicated.com | ||
repository: proxy/your-app/ghcr.io/cloudnative-pg/cloudnative-pg | ||
tag: catalog-1.24.0 | ||
``` | ||
Ensure that any references to the image in your Helm chart access the field from your values file. | ||
**Example**: | ||
```yaml | ||
apiVersion: v1 | ||
kind: Pod | ||
spec: | ||
containers: | ||
- name: api | ||
# Access the registry, repository, and tag fields from the values file | ||
image: {{ .Values.image.api.registry }}/{{ .Values.image.api.repository }}:{{ .Values.image.api.tag }} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.