Clarify that local registry template functions can also return Embedded Cluster/kURL registries #2753

paigecalvert · 2024-10-17T21:51:55Z

https://deploy-preview-2753--replicated-docs.netlify.app/vendor/helm-native-v2-using

Also updated the local registry template func descriptions:
https://deploy-preview-2753--replicated-docs.netlify.app/reference/template-functions-config-context#localregistryhost

netlify · 2024-10-17T21:52:11Z

✅ Deploy Preview for replicated-docs ready!

Name	Link
🔨 Latest commit	`d9a9189`
🔍 Latest deploy log	https://app.netlify.com/sites/replicated-docs/deploys/6734dff9ff9e020008503fb0
😎 Deploy Preview	https://deploy-preview-2753--replicated-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify · 2024-10-17T21:52:11Z

✅ Deploy Preview for replicated-docs-upgrade ready!

Name	Link
🔨 Latest commit	`d9a9189`
🔍 Latest deploy log	https://app.netlify.com/sites/replicated-docs-upgrade/deploys/6734dff9140d840008631ae1
😎 Deploy Preview	https://deploy-preview-2753--replicated-docs-upgrade.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

docs/reference/template-functions-config-context.md

paigecalvert · 2024-10-18T17:59:54Z

docs/vendor/helm-native-v2-using.md

 This topic describes how to configure the Replicated HelmChart custom resource version `kots.io/v1beta2` to support Helm chart installations with Replicated KOTS.

-## Overview
+## Workflow


Just updated this workflow section to turn it into a numbered list, which tends to do a better job at conveying required action than unordered lists

paigecalvert · 2024-10-18T18:01:04Z

docs/vendor/helm-native-v2-using.md

 ```

-#### Example: Rewrite public image names {#local-public-example}
+### Task 1b: Rewrite Public Image Names


Updated this section to use gchr in the example instead of docker, which we had done in this unmerged PR: https://github.com/replicatedhq/replicated-docs/pull/2628/files

paigecalvert · 2024-10-18T18:04:00Z

docs/vendor/helm-native-v2-using.md

+
+:::note
+The Replicated [snapshots](snapshots-overview) feature for backup and restsore is supported only for existing cluster installations with KOTS. Snapshots are not support for installations with Embedded Cluster. For more information about disaster recovery for installations with Embedded Cluster, see [Disaster Recovery for Embedded Cluster](/vendor/embedded-disaster-recovery.mdx).
+:::


^ Added in this note which we added in the not-yet-merged-onboarding PR

Also moved this Task to last (after builder key)

paigecalvert · 2024-10-18T18:12:11Z

docs/vendor/helm-native-v2-using.md

 ```

-### Support Local Image Registries for Online Installations {#local-registries}
+## Additional Information


^ Moved the overview, v1/v2 differences and the info about migrating existing v1 installations down under Additional Information. Felt less noisy. This also aligns with a change you had requested in the onboarding PR

docs/vendor/helm-native-v2-using.md

crdant · 2024-10-18T19:54:39Z

docs/vendor/helm-native-v2-using.md

+To support Helm chart installations with the KOTS `kots.io/v1beta2` HelmChart custom resource, do the following:
+1. Rewrite image names to use the Replicated proxy registry. See [Rewrite Image Names](#rewrite-image-names).
+1. Inject a KOTS-generated image pull secret that grants proxy access to private images. See [Inject Image Pull Secrets](#inject-image-pull-secrets).
+1. Add a pull secret for any Docker Hub images that could be rate limited. See [Add Pull Secret for Rate-Limited Docker Hub Images](#docker-secret).


I think we should be advising people to pull these through the proxy. The overhead of the Docker Hub secret is the same overhead as allowing access to the private registry without us. By telling them to manage a secret for Docker Hub we blow a giant hole in our value prop.

I agree, and Paige had a PR ready to do that, but Dmitriy wanted it tested in a KOTS app first. So we need to do that and get his/VP team sign off. https://replicated.slack.com/archives/CEEFDQURM/p1726020572386039?thread_ts=1726010537.693589&cid=CEEFDQURM

crdant · 2024-10-18T19:56:00Z

docs/vendor/helm-native-v2-using.md

+      # If the user configured a registry, use the registry namespace they provided
+      # If air gap Embedded Cluster/kURL install, use the buit-in registry's hostname
+      # Else use the image's namespace at proxy.replicated.com
      repository: '{{repl HasLocalRegistry | ternary LocalRegistryNamespace "proxy/my-app/quay.io/my-org" }}/nginx'


This example should use a function to get the app slug.

Is that a license field value, or what is the template function way to get that?

paigecalvert · 2024-11-07T16:32:38Z

docs/reference/cron-expressions.md

  ```
  @every 1h45m
  ```
-


^ ignore me

docs/vendor/helm-native-v2-using.md

ajp-io · 2024-10-18T20:30:37Z

docs/vendor/helm-native-v2-using.md

+To support Helm chart installations with the KOTS `kots.io/v1beta2` HelmChart custom resource, do the following:
+1. Rewrite image names to use the Replicated proxy registry. See [Rewrite Image Names](#rewrite-image-names).
+1. Inject a KOTS-generated image pull secret that grants proxy access to private images. See [Inject Image Pull Secrets](#inject-image-pull-secrets).
+1. Add a pull secret for any Docker Hub images that could be rate limited. See [Add Pull Secret for Rate-Limited Docker Hub Images](#docker-secret).


I agree, and Paige had a PR ready to do that, but Dmitriy wanted it tested in a KOTS app first. So we need to do that and get his/VP team sign off. https://replicated.slack.com/archives/CEEFDQURM/p1726020572386039?thread_ts=1726010537.693589&cid=CEEFDQURM

docs/reference/template-functions-config-context.md

ajp-io · 2024-11-12T21:34:02Z

docs/vendor/helm-native-v2-using.md

+      # If the user configured a registry, use the registry namespace they provided
+      # If air gap Embedded Cluster/kURL install, use the buit-in registry's hostname
+      # Else use the image's namespace at proxy.replicated.com
      repository: '{{repl HasLocalRegistry | ternary LocalRegistryNamespace "proxy/my-app/quay.io/my-org" }}/nginx'


Is that a license field value, or what is the template function way to get that?

docs/vendor/helm-native-v2-using.md

Co-authored-by: Alex Parker <[email protected]>

paigecalvert added 9 commits October 16, 2024 14:33

Clarify local registry template funtions for EC/kURL installs

800290a

edits

9a87491

edits

6cc1a04

edits

e4e8a58

edits

c331e0e

edits

f2354b4

edits

ce2d361

edits

eecf391

edits

52bf075

replicated-ci added type::docs Improvements or additions to documentation type::feature labels Oct 17, 2024

paigecalvert added 3 commits October 17, 2024 15:56

update reference docs

b56a7aa

edit public image example

6003988

edits

81454de

paigecalvert marked this pull request as ready for review October 18, 2024 17:49

paigecalvert requested a review from a team as a code owner October 18, 2024 17:49

paigecalvert commented Oct 18, 2024

View reviewed changes

docs/reference/template-functions-config-context.md Show resolved Hide resolved

paigecalvert commented Oct 18, 2024

View reviewed changes

docs/vendor/helm-native-v2-using.md Show resolved Hide resolved

paigecalvert requested a review from ajp-io October 18, 2024 18:13

crdant reviewed Oct 18, 2024

View reviewed changes

paigecalvert added 4 commits November 7, 2024 09:14

Merge branch 'main' into 114155

b72adfe

Remove unsupported characters

116b54d

revert changes to cron expressions topic

c2dc332

revert changes to cron expressions topic

66bcee6

paigecalvert added 3 commits November 7, 2024 09:31

revert changes to cron expressions topic

50b7fdb

revert changes to cron expressions topic

5de0300

revert changes to cron expressions topic

f49065b

paigecalvert commented Nov 7, 2024

View reviewed changes

docs/reference/cron-expressions.md Outdated

```

@every 1h45m

```

Copy link

Contributor Author

paigecalvert Nov 7, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

^ ignore me

ajp-io reviewed Nov 12, 2024

View reviewed changes

paigecalvert and others added 3 commits November 13, 2024 09:36

Apply suggestions from code review

43c1a57

Co-authored-by: Alex Parker <[email protected]>

edits

65398bf

Merge branch 'main' into 114155

d9a9189

paigecalvert merged commit e615188 into main Nov 13, 2024
3 of 4 checks passed

paigecalvert deleted the 114155 branch November 13, 2024 17:21

Clarify that local registry template functions can also return Embedded Cluster/kURL registries #2753

Clarify that local registry template functions can also return Embedded Cluster/kURL registries #2753

Uh oh!

Conversation

paigecalvert commented Oct 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

netlify bot commented Oct 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for replicated-docs ready!

Uh oh!

netlify bot commented Oct 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for replicated-docs-upgrade ready!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

paigecalvert commented Oct 17, 2024 •

edited

Loading

netlify bot commented Oct 17, 2024 •

edited

Loading

netlify bot commented Oct 17, 2024 •

edited

Loading