feat: improve Helm documentation #22859
Conversation
Signed-off-by: Andrew Block <andy.block@gmail.com>
❌ Preview Environment deleted from BunnyshellAvailable commands (reply to this comment):
|
|
|
||
| Non standard Helm Chart repositories have to be registered explicitly. |
There was a problem hiding this comment.
Why is this not longer a requirement? Since which version of Argo CD?
I think I remember if I didn't register the public ECR (no auth required) to install karpenter from the OCI registry it didn't work.
There was a problem hiding this comment.
Not sure the specific version support was introduced, but its no longer needed
| namespace: nginx | ||
| ``` | ||
|
|
||
| Helm charts located in sources that require additional configuration, such as authentication or TLS connection details, are defined within a _repository_ Secret. Each Secret must specify the `url`, `type` and `name` fields. Additional fields including `username`, `password`, `tlsClientCertData` and `tlsClientCertKey` can be specified as desired. |
There was a problem hiding this comment.
I think we can provide a link on what repository Secret is, which I'm assuming your referring a Secret with a label argocd.argoproj.io/secret-type: repository
There was a problem hiding this comment.
Yes. If you look further down, you will see an example with the appropriate label
There was a problem hiding this comment.
Could we just highlight that name is really important to add when using Helm dependencies?
(the real question is why having name is a requirement for Helm dependencies rather than just filtering by url in the repo server but that's another story...)
| @@ -1138,6 +1169,23 @@ stringData: | |||
| tlsClientCertKey: ... | |||
| ``` | |||
|
|
|||
| Helm charts sourced from OCI registries should utilize the fields described previously as well as set the `enableOCI` field as `true`. | |||
There was a problem hiding this comment.
So glad we are documenting this, I had an end user I support recently asking me where is the enableOCI documented.
|
|
||
| 1. Navigate to `Settings/Repositories` | ||
|
|
||
|  |
There was a problem hiding this comment.
Super, that you added a picture for this.
| ``` | ||
|
|
||
| !!! note | ||
| The protocol, such as `oci://` should be omitted when referencing an OCI registry |
There was a problem hiding this comment.
Should we mentioned, that this prefix is reserved for future support of OCI native?
There was a problem hiding this comment.
Not until the new feature is made available. At that time, we can denote the differences and intended capabilities
Signed-off-by: Andrew Block <andy.block@gmail.com>
Signed-off-by: Andrew Block <andy.block@gmail.com> Signed-off-by: dsuhinin <suhinin.dmitriy@gmail.com>
Signed-off-by: Andrew Block <andy.block@gmail.com> Signed-off-by: dsuhinin <suhinin.dmitriy@gmail.com>
Signed-off-by: Andrew Block <andy.block@gmail.com> Signed-off-by: enneitex <etienne.divet@gmail.com>
Improvements to Helm related documentation
ApplicationChecklist: