Edit docs on using the proxy registry #3366
Conversation
✅ Deploy Preview for replicated-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for replicated-docs-upgrade ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
replicated-ci
added
type::docs
| @@ -1,64 +1,32 @@ | |||
| import StepCreds from "../partials/proxy-service/_step-creds.mdx" | |||
| import StepCustomDomain from "../partials/proxy-service/_step-custom-domain.mdx" | |||
| import RewriteHelmValues from "../partials/proxy-service/_step-rewrite-helm-values.mdx" | |||
There was a problem hiding this comment.
pulls in the new partial that has the step on how to modify image refs in your helm values
docs/vendor/helm-image-registry.mdx
Outdated
| ## Overview | ||
|
|
||
| With the Replicated proxy registry, each customer's unique license can grant proxy access to images in an external private registry. | ||
| During Helm installations with Replicated, after customers provide their unique license ID, a `global.replicated.dockerconfigjson` field that contains a base64 encoded Docker configuration file is automatically injected in the Helm chart values. |
There was a problem hiding this comment.
minor rewording in overview section mainly to try to remove extra info/words
| 1. <StepCustomDomain/> | ||
|
|
||
| 1. In your Helm chart values file, set your image repository URL to the location of the image on the proxy registry. If you added a custom domain, use your custom domain. Otherwise, use `proxy.replicated.com`. | ||
| 1. <RewriteHelmValues/> |
There was a problem hiding this comment.
^ replaced with the partial
| import InjectPullSecret from "../partials/proxy-service/_step-inject-pull-secret.mdx" | ||
|
|
||
| # Use the Proxy Registry with KOTS Installations | ||
| # Use the Proxy Registry with Replicated Installers |
There was a problem hiding this comment.
with KOTS Installations --> with Replicated Installers
Open to other suggestions on wording. Goal is to avoid using "KOTS" to actually mean KOTS/EC/kURL
| This topic describes how to use the Replicated proxy registry with applications deployed with Replicated KOTS. | ||
| This topic describes how to use the Replicated proxy registry for applications deployed with Replicated installers (Embedded Cluster, KOTS existing cluster, or kURL). For more information about the proxy registry, see [About the Replicated Proxy Registry](private-images-about). | ||
|
|
||
| ## Overview |
There was a problem hiding this comment.
Did some deleting/shuffling so this no longer needs such a big overview section
Instead, jumps right into the steps on how to configure your app to use the proxy, with a couple other subheadings for the non-HelmChart v2 apps
|
|
||
| <details> | ||
|
|
||
| <summary>How does KOTS patch image names?</summary> |
There was a problem hiding this comment.
^ adds all this info to a details element
| ## Enable the Proxy Registry | ||
|
|
||
| This section describes how to enable the proxy registry for applications deployed with KOTS, including how to ensure that image names are rewritten and that the required image pull secret is provided. | ||
| ### Kubernetes Operators |
There was a problem hiding this comment.
Left in the k8s operator stuff. Not sure if anyone's still using them/if this could be removed yet
If it can be removed, that would of course make it easier to further simplify this page
There was a problem hiding this comment.
people do use operators, maybe even increasingly so
There was a problem hiding this comment.
but often people deploy their operator via Helm. if that makes sense.
basically they deploy the operator via helm, but the operator can deploy other things, which is why the extra steps are needed.
There was a problem hiding this comment.
Interesting, yeah that makes sense.
| These steps assume that you package your application with Helm and that you install with the KOTS [HelmChart v2](/reference/custom-resource-helmchart-v2) custom resource. | ||
|
|
||
| ### Image Pull Secret | ||
| If you are installing with the HelmChart v1 custom resource, or if your application is not packaged with Helm, there are different steps for configuring your application to use the proxy registry. See [Configure Other Application Types](#other) below. |
There was a problem hiding this comment.
^ I landed on a main "Configure Your App" section that assumes Helm app and HelmChart v2. And then links people that use other packaging/install methods down to the "other" options
My thought is that it highlights the main path that we expect most people to follow while minimizing noise of other possibilities
Open to suggestions on this
There was a problem hiding this comment.
i think that makes sense. sometimes we try to cater to everyone and it gets confusing. maybe better to keep the main thing the main thing and put other stuff separately.
ajp-io
left a comment
ajp-io
left a comment
There was a problem hiding this comment.
still need to review the replicated installers page, but might be headed to the hopsital this morning, so i'll submit this for now.
docs/vendor/helm-image-registry.mdx
Outdated
| import StepCustomDomain from "../partials/proxy-service/_step-custom-domain.mdx" | ||
| import RewriteHelmValues from "../partials/proxy-service/_step-rewrite-helm-values.mdx" | ||
|
|
||
| # Use the Proxy Registry with Helm Installations |
There was a problem hiding this comment.
one thing that could clarify the docs a bit is if we said something like "with Helm CLI installations." i know helm is all over the place now, and people are using helm for all installation methods, so maybe that would clear up the fact that this is when you're using helm install directly. just a thought.
There was a problem hiding this comment.
Yeah that sounds good to me. For awhile I wasn't sure if "Helm CLI" was overly explanatory compared to just "Helm", but couldn't hurt if you think it would be a little clearer
There was a problem hiding this comment.
i'm up for a discussion. i just felt that Helm is all over the place now, and maybe this would be clearer (since every install method uses helm at this point)
Previews: