Update charts and docs #11
Conversation
drew-viles
force-pushed
the
update-charts
branch
from
14aa9d7 to
69f31de
Compare
|
I've pulled the chart and doc updates out of the other PR. Once this has gone through I'll rebase the other and we can continue over there ;-) Let's make this cleaner! |
| @@ -22,14 +22,15 @@ This chart requires the following to be installed on the target cluster first: | |||
| ```shell | |||
| helm repo add jetstack https://charts.jetstack.io | |||
| helm repo update | |||
| helm install cert-manager jetstack/cert-manager --version v1.10.1 --namespace cert-manager --create-namespace | |||
| helm install cert-manager jetstack/cert-manager --version v1.15.1 --namespace cert-manager --create-namespace --set crds.enabled=true | |||
There was a problem hiding this comment.
Note to self: delete this, we shouldn't be telling users how to install a 3rd part application, and have to update the instructions all the time in different locations, a link to the docs will suffice.
| @@ -67,14 +68,15 @@ There is a top level chart-of-charts that will just install everything as a big | |||
| ```shell | |||
| helm repo add unikorn-cloud-capi https://unikorn-cloud.github.io/helm-cluster-api | |||
| helm repo update | |||
| helm install unikorn-cloud-capi/cluster-api --version v0.1.1 | |||
| helm install cluster-api unikorn-cloud-capi/cluster-api --version v0.2.0 | |||
There was a problem hiding this comment.
Note to self: history repeating itself... we need a way to not have to change versions all over the place and every time something changes. Now asciidoc is good in that it has attributes, so that's a single place, markdown less so. Ideally we'd like the source of truth to be the chart version. So I guess the proposal would be to have a pre-commit hook that looks at charts/*/Chart.yaml and generates a README.md from a template, modifying in place just isn't going to fly given most of these things live in verbatim sections so markup of these things is impossible.
There was a problem hiding this comment.
There was a problem hiding this comment.
sed... sounds a bit flaky 🤣 Inspiration of what not to do certainly!
There was a problem hiding this comment.
aaah yeah, just looked at that script (for probably the first time!).
ok yes, probably some parsing of the Chart.yeaml in the latest release for this would be sufficient then.
|
Don't do anything about the version templating by the way, I'll handle that as it applies to the entire organization! |
…tination.server examples in READMEs
|
All updated. I've left the version bump in the docs for the sake of having it updated in this PR but yeah, automation around that would be nice :-) |
| @@ -2,8 +2,8 @@ | |||
| CHART_VERSION = v0.2.0 | |||
There was a problem hiding this comment.
Note to self: you need to bump this in the next PR... and obviously change all the versions... again
| @@ -49,28 +50,25 @@ spec: | |||
| region: en-west-1 | |||
There was a problem hiding this comment.
Note to self: ca I fixed, so it resolves automatically and shouldn't be documented, region doesn't exist.
| api: | ||
| allowList: | ||
| - 123.45.67.89 | ||
| certificateSANs: | ||
| - kubernetes.my-domain.com | ||
| controlPlane: | ||
| version: v1.30.2 |
There was a problem hiding this comment.
Note to self: we should probably be more opinionated here and just set it at the top level, mixed verison clusters seems like a bad idea.
This PR is taking the chart and docs updates out of this PR 10 and creating it's own as it's a bit noisy over there.
This will not trigger a new release as it makes sense to do it with the other changes in too - unless there is disagreement there? Happy to do one here but I'll leave that to discussion.