Naar de inhoud
WinkelwagenControlepaneel

Blog overzicht

Stop met kopiëren-plakken: schrijf herbruikbare Helm charts

Ga direct naar


Stel dat je een afspraakapplicatie ontwikkelt voor organisaties. Klanten boeken hiermee via de website en app van de organisatie afspraken met medewerkers. Een klant kiest uit beschikbare tijdsloten en krijgt daarna een bevestigingsmail. Een dag voor de afspraak volgt ook nog een herinnering. De organisaties stellen tijdsloten in via een beheeromgeving. Daar kunnen zij de afspraken zien. Via een ICS-feed verschijnen afspraken bij de juiste medewerker in de agenda.

Door dit op te zetten op Kubernetes kan jouw app meegroeien met de vraag. Als je meer klanten krijgt, schaal je gewoon jouw cluster op. Binnen jouw cluster kun je alle organisaties (jouw klanten) één installatie van de applicatie laten gebruiken, of voor iedere organisatie een eigen installatie starten. Dat tweede scenario is voor dit voorbeeld het beste. De organisaties betalen dan voor hun installatie en je kunt ze laten kiezen uit verschillende pakketten die je via jouw Helm chart beheert.

Wat Helm oplost ten opzichte van losse manifests 

Een gemiddelde applicatie gebruikt verschillende Kubernetes-objecten. In een YAML-manifest leg je vast welke resources dit zijn. Hier worden de Deployment, Service, Ingress, ConfigMap, Secrets en eventueel een HPA (Horizontal Pod Autoscaler) benoemd. Tijdens de ontwikkeling en eerste uitrol van een applicatie pas je parameters in het YAML-manifest aan de omgeving aan.

Meerdere kopieën van één manifest gebruiken

Is je applicatie geschikt voor gebruik in een productieomgeving, dan kun je gewoon zo blijven werken. Iedere keer als er een extra installatie nodig is, pas je het YAML-manifest aan de omgeving aan en lanceer je de applicatie. Maar als je op deze manier werkt, krijg je een verzameling kopieën van één manifest waarin de image-tags, hostnames, resource-limits en andere configuratiedetails onderling verschillen.

Na verloop van tijd ontstaat door deze manier van werken configuration drift. Kleine fixes of aangepaste resource-limits kopieer je per installatie met de hand. Oudere installaties hebben deze wijzigingen niet, en soms vergeet je het bij een nieuwe installatie ook door te voeren. Kopieën van hetzelfde YAML-manifest groeien langzaam uit elkaar, en als je ze gelijk wilt trekken is het niet één-twee-drie helder welke wijziging de beste/laatste is. 

Helm charts inzetten

Helm is de package manager van Kubernetes. Hiermee maak je één template-set voor een applicatie aan in een chart. Aan die chart ken je per installatie van je applicatie unieke waardes toe. Je scheidt daarmee configuratieaanpassingen per installatie van het overzicht van de benodigde resources voor de applicatie. Fixes en betere resource-allocatie pas je één keer aan in de chart en rol je daarna met een upgrade uit naar alle installaties. Dat maakt deployments voorspelbaarder en rollbacks eenvoudiger. Je kunt de charts ook delen met andere teams zonder een wildgroei aan uit elkaar groeiende installaties te riskeren. 

Vanaf Kubernetes 1.14 zou je met Kustomize iets soortgelijks kunnen doen zonder een extra tool te installeren. Je maakt dan een overlay met de afwijkingen per klant en gebruikt kubectl apply -k om je basis-manifest te patchen. Dit geeft iets meer overzicht dan helemaal handmatig werken, maar je mist nog steeds het versiebeheer, de mogelijkheden om snel te distribueren en de rollbacks die Helm wel biedt. 

Aan de slag met Helm: templates, values en dependencies 

Helm is een command-line tool die je op jouw ontwikkelmachine installeert. Je gebruikt het op een map met een vaste opbouw. Dit is de Helm chart. Daarin zitten vier soorten onderdelen:

  • De metadata van de chart 
  • De templates met Kubernetes-resources
  • De instellingen per installatie
  • De dependencies van de chart

Samen bepalen deze onderdelen hoe je applicatie wordt uitgerold. Helm kan zelf een basisstructuur voor je aanmaken. Stel dat we de applicatie uit ons voorbeeld ‘Afsprakenmaken’ noemen, dan kunnen we met helm create afsprakenmaken direct aan de slag met een basisopzet.

1. Metadata instellen in Chart.yaml

In Chart.yaml kun je met een eenvoudige tekstbewerker de metadata van de applicatie instellen. Hier voer je een korte omschrijving, de versie en de dependencies in. Twee velden lijken op elkaar, maar hebben een andere functie: 

  • In version hou je de versie van de chart zelf bij. Verhoog deze als je de templates of standaardwaarden wijzigt. 
  • Met appVersion hou je de versie van de applicatie die de chart uitrolt bij. 

Als je een nieuwe versie van Afsprakenmaken uitbrengt, verhoog je appVersion. Wijzig je in de chart een resource-limit of iets dergelijks, dan verhoog je version. Zo kun je altijd terugzien welke applicatieversie met welke chartversie is uitgerold.

2. De blauwdruk van je applicatie instellen met templates

In de map /templates staan de Kubernetes-manifests van jouw applicatie. Voor Afsprakenmaken zijn dat Deployments voor de web-app en de worker, plus een Service, Ingress, ConfigMap en Secret. In plaats van de vaste waarden die losse manifests hebben, staat er in deze manifests een placeholder op plekken die per installatie verschillen. Het aantal replica’s, de hostname en de image-tag vult Helm pas in op het moment dat je de chart installeert.

Elke installatie krijgt daarbij een eigen naam, bijvoorbeeld organisatie-a. Die naam gebruik je in de templates als voorvoegsel voor alle resources. Daardoor kunnen installaties voor verschillende organisaties naast elkaar draaien zonder dat ze botsen. Dezelfde naam zorgt ook dat de onderdelen elkaar vinden; de web-app van organisatie A maakt verbinding met de database van organisatie A, en niet met die van een andere klant.

3. Herbruikbare bouwstenen maken

De web-app en de worker draaien hetzelfde image en hebben dezelfde labels en database-instellingen nodig. Die stukken herhaal je niet in beide templates, maar leg je in één keer vast in _helpers.tpl. Bestanden waarvan de naam met een underscore (_) begint, leveren zelf geen resource op. Ze bevatten herbruikbare blokken die je vanuit elke template kunt aanroepen. Je kunt hiermee op één plek labels later aanpassen of extra omgevingsvariabelen aan onderdelen meegeven. Je houdt een chart hiermee herbruikbaar, en voorkomt dat templates onderling uit elkaar gaan lopen.

4. Standaardwaarden bijhouden

In values.yaml staan de standaardwaarden voor alle placeholders in je templates. Voor alles wat per installatie mag verschillen, staat hier een verstandige standaardwaarde. Vergeet je ergens een waarde in te voeren, dan kijkt Helm hier om gewoon door te kunnen werken. Voor Afsprakenmaken stellen we in values.yaml onder meer in hoeveel replica’s van de web-app we willen, wat de hostname en tijdzone is en of Redis aanstaat. 

Als we een nieuwe klant krijgen, hoeven we alleen nog een klein bestand met de afwijkingen voor die organisatie te maken. Organisatie A krijgt bijvoorbeeld drie replica’s, een eigen hostname en Redis. Organisatie B, een kleine klant, draait met de standaardwaarden en krijgt alleen een eigen hostname. Bij de installatie van Afsprakenmaken voor een klant combineert Helm het klantbestand met de standaardwaarden. 

5. Dependencies bijhouden

In Chart.yaml houd je een lijst met de dependencies van jouw app bij. Voor veel gangbare software bestaan kant-en-klare charts. Als je die in Chart.yaml opneemt als dependency, downloadt Helm ze met het commando helm dependency update naar de map /charts. Ze worden dan als subchart met de installatie van de chart meegeïnstalleerd. Je kunt via values bepalen of een onderdeel meedraait door per dependency een voorwaarde in te stellen. Als we Redis alleen aan willen zetten bij organisaties die ons Pro-pakket afnemen, stellen we dat hier in. Instellingen van een subchart, zoals de naam van de database, geef je door via de values van de klant. Elke klantinstallatie bestaat zo uit onze eigen applicatie plus de onderdelen die nodig zijn om die klant de afgenomen dienst te leveren.

Best practices voor Helm charts

Door met Helm te werken, houd je overzicht over jouw applicatie, zelfs als je die vele malen met unieke configuraties installeert. Met deze best practices bewaar je dat overzicht zo goed mogelijk en blijft de herbruikbaarheid van jouw Helm chart intact. 

Gebruik één chart en meerdere values-bestanden

In één chart kun je meerdere values-bestanden gebruiken om lagen toe te voegen. Bij installatie geef je die mee met -f. Helm haalt basiswaarden uit values.yaml, en overschrijft afwijkende waarden. Het laatst geladen bestand geeft de eindwaarde (als die afwijkt). Voor Afsprakenmaken kunnen we bijvoorbeeld met values.yaml, values-basic.yaml en values-pro.yaml werken. Voor een klant met een Pro-pakket verwerken we de drie bestanden, iemand met Basic krijgt alleen de eerste twee. Pakketwijzigingen voeren we in één values-bestand door waarna ze voor alle klanten bij hun volgende upgrade gaan gelden.  

Valideer de input 

Neem naast values.yaml ook een values.schema.json in jouw chart op. Daarin leg je in JSON Schema vast welke waarden toegestaan zijn. Helm controleert bij install, upgrade, lint en template of de ingevoerde waarden binnen de vastgelegde normen vallen. Typt iemand bijvoorbeeld een tekst in plaats van een getal of een boolean in de verkeerde taal, dan meldt Helm direct dat er een fout gemaakt is. Hiermee voorkom je dat er een half werkende installatie wordt uitgerold. 

Variabele waarden niet hardcoden

Alles wat per klant of omgeving kan verschillen, hoort in values. Denk daarbij aan hostnames, image-tags, resource-limits, storageclasses en ga zo maar door. Leg je dit soort waarden vast in een template, dan moet je de chart aanpassen of kopiëren zodra één klant iets anders nodig heeft. Daarmee ben je direct terug bij af; met Helm gingen we dit juist voorkomen. Namespaces vormen een uitzondering op deze regel. Die zet je niet in values, maar geef je op bij de installatie (--namespace organisatie-a). 

Sla geen wachtwoorden op in Git

Values-bestanden staan meestal in Git. Dat is voor standaardwaarden geen probleem, maar wachtwoorden horen daar niet thuis. Voor onze applicatie Afsprakenmaken moeten wij het databasewachtwoord en de SMTP-gegevens van ieder van onze klanten ergens bewaren. We hebben daar drie gangbare keuzes voor. We kunnen de chart laten verwijzen naar een Secret dat al in ons cluster staat (met de existingSecret-optie in de values). Optie twee is werken met een External Secrets Operator die ze ophaalt uit een kluis (zoals HashiCorp Vault). Of we gaan onze gevoelige values-bestanden toch opslaan in Git, maar versleutelen ze eerst met SOPS om ze voor derden onleesbaar te maken.

Gebruik je chart om overzicht te houden

Met Helm charts kun je overzicht houden over je product; zelfs als jouw applicatie bij heel veel klanten draait. Zorg dat je dit vast kunt houden door bij elke wijziging het versienummer volgens semantic versioning (Major.Minor.Patch) te verhogen. Gebruik helm package en helm push om je chart naast je container-images in een OCI-registry op te slaan. Elke klantinstallatie haalt dan dezelfde, vastgelegde versie op; en een upgrade naar een nieuwe versie is met één commando uit te voeren. 

Welke applicatie wil jij bouwen?

Applicaties rol je op het Kubernetes-platform snel uit, pas je minstens zo snel aan én kun je ook nog eens razendsnel schalen. Weet je al wat jij wilt gaan bouwen? Wij kunnen een goede tip geven waar je het beste jouw cluster kunt opzetten. Ons Kubernetes platform beheert het Kubernetes-controlplane: wij zorgen ervoor dat het controlplane blijft draaien, terwijl jij snel en eenvoudig updatet, upgradet en securitypatches op het platform doorvoert. Kijk hier naar onze Kubernetes mogelijkheden.


Beoordeel dit artikel

Deel dit artikel

Gerelateerde artikelen

Blog overzicht

Auteur: TIP-redactie

Is de auteursnaam die we gebruiken wanneer een blogpost in teamverband door meerdere TransIP’ers is samengesteld. Denk bijvoorbeeld aan een eventverslag of onze Recommends.