kadaster-labs / sensrnet-helm-charts

Other
0 stars 0 forks source link

Improve Helm Charts #11

Closed kad-busses closed 3 years ago

kad-busses commented 3 years ago

In deze PR zijn wat kleinere onderhoudswerkzaamheden aan de Helm Charts doorgevoerd. Voor overzicht komen de vijf changes overeen met de commits:

  1. image.tag is toegevoegd aan de Charts die dat nog niet hadden. Hiermee kan een andere image tag gedeployed worden dan strict in de Chart.yaml's appVersion staat. Kunnen we bijvoorbeeld gebruiken voor lokale deployments, waarmee we Kustomize volledig kunnen uitfaseren. Het volgende voorbeeld voor de registry-frontend:
    
    # Oude methode
    kustomize build deployments/overlays/local | kubectl apply -f -

Nieuwe methode

(sensrnet-registry-frontend_registry-frontend is de default Docker-compose naam voor de image)

helm upgrade --install frontend charts/registry-frontend \ --set image.repository=sensrnet-registry-frontend_registry-frontend \ --set image.tag=latest \ --set image.pullPolicy=Never


2. Een aantal van de `_helpers.tpl` waren gegeneerd met een oude Helm CLI, waardoor er superfluous `-`'s in stonden, dit is opgeschoond.
3. De `README.md`'s en `value.schema.json`'s zijn uitgebreid met de `tag` parameter (in verlenging van punt 1)
4. Een aantal van de templates bevatte commented code. Weggegooid, want Clean Code 🧼
5. In de README's valt nog niet veel te lezen over de charts, of het gebruik ervan. In een poging de charts beter te documenteren heb ik in de `values.yaml` van de `multichain-node` comments toegevoegd, welke opgepakt worden door de docs generator. Hiermee hebben we een mooi gevulde "Description" kolom, te bewonderen op https://github.com/kadaster-labs/sensrnet-helm-charts/blob/add-image.tag-to-chart-values/charts/multichain-node/README.md. Als we hier happy mee zijn, kan ook extra documentatie aan de overige charts toegevoegd worden.
kad-busses commented 3 years ago

Zo probeer ik het een beetje inzichtelijk te houden. Zou ook best direct naar main kunnen pushen als dit te lastig inhoudelijk te beoordelen is en/of minder strakke controle nodig heeft dan de andere repo's. Maar zo blijf je ook een beetje in de loop natuurlijk 😁