search

weaveworks / weave-gitops-enterprise

This repo provides the enterprise level features for the weave-gitops product, including CAPI cluster creation and team workspaces.
https://docs.gitops.weave.works/
Apache License 2.0
160 stars 30 forks source link

Users need a public reference for mccp chart values.yaml #2213

Open kingdonb opened 1 year ago

kingdonb commented 1 year ago

The mccp chart isn't published anywhere but within the Helm Repository, as far as I can tell. I noticed this when I was working out https://github.com/weaveworks/weave-gitops/issues/3263 and I was looking for the configuration options that weren't described all the way there. I was looking for options related to oidc and further explanation of the staticClients section that's presented in the Dex guide (the top-line subject of that issue linked above.)

I'm thinking that values.yaml is the usual reference point for users trying to understand how to configure the chart. Yes, users can helm fetch and untar the chart, and inspect it there, but I think that's not what type of experience we'd expect to show on enterprise software. Not sure how to fix this without making the repo public, but there needs to be discoverability of the options in values.yaml and it should ideally be not too far away from the chart repo itself.

Maybe would it make sense to make the chart itself public? Since you still can't use the chart without an entitlement... it might seem like something that shouldn't be public, but I don't think that loses anything (and if it isn't public then both users and potential users can't easily learn about the options available unless they have the option of going through support channels.)

Callisto13 commented 1 year ago

@foot

There are 4 charts in charts/, do we want a reference for all of them or just the mccp?

For any chart we want publicly rendered in the docs there needs to be as much documentation in comments as possible (skipping the really obvious fields), so some work needs to be done there too.

We can store the chart somewhere public, or move a copy into the docs on release, I can make either work so that's not a problem. The weirdness is around docs versioning. The OSS chart reference is generated automatically when there is a new release, so the published chart is pinned to that version. WGEE is not related to that release process or that versioning sequence. Does WGEE's own release process have an automated docs update bit? Or is that manual? Do we want the EE chart(s) versioned at all or just have the latest always?