Skip to content

Latest commit

 

History

History
149 lines (105 loc) · 5.28 KB

dev-straat.md

File metadata and controls

149 lines (105 loc) · 5.28 KB
Raw
title date
Ontwikkelstraat
31-7-2018

De ontwikkelstraat is zoveel mogelijk geautomatiseerd zodat code-wijzigingen automatisch leiden tot het bijwerken van (test-)omgevingen.

Verder vinden er automatische checks plaats die de correctheid van implementaties en netheid van code bewaken.

Architectuurschets

DevOps pipeline

Github

Alle ontwikkeling vindt plaats op Github. Het centrale punt is de gemma-zaken repository.

Het one-flow git-branching model wordt hier aangehouden - dit betekent dat de master branch altijd de 'huidige waarheid' is, en aanpassingen worden via feature branches geïntroduceerd.

Daarnaast zijn er repositories voor de referentie-implementaties en ondersteunende tooling.

Referentie-implementaties

Iedere referentieimplementatie van een component leeft in zijn eigen repository:

Voor de referentieimplementaties wordt het git-flow git-branching model aangehouden. Dit houdt in dat de master branch de huidige stabiele, 'productie' versie is en de develop branch de volgende versie wordt. Wijzigingen komen via feature branches in develop terecht. Releases worden getagged om ze te merken als een stable release, waarbij semantic versioning gebruikt wordt.

Generatie API-specificatie

Momenteel wordt de OAS 3.0 specificatie gegenereerd uit de referentie- implementatie, waarna deze via een pull request in gemma-zaken aangeboden wordt.

De developer moet binnen de ontwikkelomgeving van de component generate-schema aanroepen (beschikbaar via de gemma-zaken-common libaries).

Dit is essentieel, aangezien de unit-tests van de referentieimplementaties deze yaml file gebruiken om de juiste endpoints af te leiden voor een operatie op een resource.

Ondersteunende tooling

De volgende repositories bevatten ondersteunende software:

Overige registratiecomponenten (ORC) Het ORC dient ter ondersteuning van gegevens waarvan onduidelijk is waar ze leven. Het kan zijn dat hier later een informatiemodel voor komt en ze naar een andere component verhuizen.

gemma-zaken-common De gemma-zaken-common repository bevat code en tooling die gedeeld wordt tussen componenten. Het is een dependency van ZRC, DRC, ZTC en ORC.

Zaakintegratietesten (ZIT) De gemma-zaken-test-integratie repository bevat een test-suite die 'live' tegen de services praat. De test-suite vraagt de openapi specificatie op bij de services, en simuleert vervolgens de calls zoals een vakapplicatie die kan doen. Deze zijn geschikt voor ketentesten.

Jenkins

Jenkins is de continuous-integration/deployment server. Voor elke referentieimplementatie worden de volgende taken uitgevoerd:

  • voor een nieuwe pull-request:

    • voer de automatische test-suite uit
    • verifieer dat de Docker image succesvol build
    • rapporteer de resultaten naar Github

  • voor elke change op de develop branch:

    • voer de automatische test-suite uit
    • rapporteer het resultaat naar Github

  • voor elke change op de master branch:

    • voer de automatische test-suite uit
    • rapporteer het resultaat naar Github
    • indien de tests slagen:
      • build een nieuwe docker image
      • push de nieuwe image naar Docker Hub
      • indien de commit getagged is met een release tag:
        • rol de nieuwe image uit in de Kubernetes cluster

Docker hub

De docker images worden publiek beschikbaar gemaakt op Docker Hub. De tags zijn gebasseerd op de git release tags. Jenkins zorgt ervoor dat tags automatisch gepubliceerd worden.

Kubernetes

Er is een Kubernetes cluster beschikbaar om de referentie-implementaties te hosten, binnen de gemma namespace. Deze cluster is niet publiek toegankelijk, maar de services, deployments en ingress configuratie wordt in de gemma-zaken repository bijgehouden.

Vanuit Jenkins worden automatisch deployment updates doorgevoerd.

De referentieimplementaties zijn gehost op:

Merk op dat dit testomgevingen zijn waar geen enkele garantie van stabiliteit is. In een latere fase komen er stabiele omgevingen.

Swagger

(Voorlopig) worden de gepubliceerde OAS 3.0 specificaties voor de services inzichtelijk gemaakt op Swagger.io. Zie de spec documentatie.

NLX Directory

De referentie-implementaties en hun API specs zijn geïntegreerd in de NLX directory (vooralsnog de demo-omgeving). Het toevoegen hiervan gebeurt via Kubernetes en is (voor nu) een handmatige actie.

Docker-compose

Er is een docker-compose file beschikbaar om de volledige referentie-implementatie stack op te brengen. Zie de developer documentatie.