Integratie met bedrijfssystemen

Hoe communiceren GitHub Actions met externe en interne systemen?

• API-aanroepen: De meestgebruikte methode. Je workflow verstuurt HTTP-verzoeken (GET, POST, PUT) naar de REST-API van een bedrijfssysteem.
• Webhooks: Actions kan gegevens naar een vooraf bepaalde URL (een webhook-eindpunt) in een ander systeem sturen, waarmee daar een gebeurtenis wordt gestart.
• Aangepaste scripts: Voer shellscripts of programma's uit binnen je workflow die rechtstreeks communiceren met opdrachtregelprogramma's of SDK's voor specifieke bedrijfssoftware.

Voor een veilige verbinding met interne systemen is de juiste authenticatie vereist. Meestal gebruik je:

• API-sleutels/tokens: Unieke tekenreeksen waarmee je identiteit wordt gecontroleerd en verzoeken worden gemachtigd. Sla deze op als GitHub Secrets.
• Serviceaccounts: Speciale gebruikersaccounts met specifieke, beperkte rechten in het doelsysteem.
• OAuth/OIDC: Geavanceerdere protocollen die vaak worden gebruikt voor clouddiensten van derden, maar ook op interne systemen kunnen worden toegepast.

Volg altijd het principe van minimale rechten: ken alleen de noodzakelijke rechten toe.

Het opdrachtregelprogramma curl wordt vaak binnen GitHub Actions-workflows gebruikt om HTTP-verzoeken naar API's te versturen. Het is veelzijdig voor interactie met REST-API's.

Je kunt de verzoekmethode (POST, GET), headers (zoals Content-Type of Authorization) en de inhoud van het verzoek (-d voor gegevens) opgeven.

We simuleren het aanroepen van een interne API om een status bij te werken. Deze workflow gebruikt curl om een POST-verzoek met JSON-gegevens naar een hypothetisch intern eindpunt te sturen.

Voer dit voorbeeld uit om te zien hoe de opdracht binnen je workflow wordt uitgevoerd.

Een veelvoorkomend gebruiksscenario is integratie met ITSM-hulpmiddelen zoals Jira. Je kunt taken zoals deze automatiseren:

• Tickets maken: Automatisch een bugticket in Jira openen als een CI-build mislukt.
• Status bijwerken: Een implementatieticket na een geslaagde release naar 'Done' overzetten.
• Opmerkingen toevoegen: Workflogboeken of implementatiedetails als opmerkingen aan een bestaand ticket toevoegen.

Zo blijven projectmanagers en IT-teams zonder handmatige tussenkomst op de hoogte.

Bij verbindingen met interne systemen staat beveiliging voorop:

• Netwerktoegang: Zorg ervoor dat je GitHub Actions-runners (vooral zelfgehoste runners) toegang hebben tot interne API's.
• IP-toestemmingslijst: Beperk de toegang tot interne API's door specifieke IP-bereiken van door GitHub gehoste of zelfgehoste runners op een toestemmingslijst te zetten.
• Veilige geheimen: Gebruik altijd GitHub Secrets voor API-sleutels en gevoelige gegevens. Neem inloggegevens nooit rechtstreeks op in code.
• Controle: Leg alle integratiegebeurtenissen vast voor traceerbaarheid en beveiligingsaudits.

Voor robuuste en betrouwbare bedrijfsintegraties:

• Foutafhandeling: Implementeer foutafhandeling in je workflowstappen om API-fouten netjes af te handelen (bijvoorbeeld opnieuw proberen of een melding bij fouten versturen).
• Idempotentie: Ontwerp je API-aanroepen zo dat meerdere uitvoeringen hetzelfde effect hebben als één uitvoering, zodat ongewenste neveneffecten worden voorkomen.
• Duidelijke logboekregistratie: Zorg voor gedetailleerde logboeken voor elke integratiestap, zodat problemen eenvoudiger kunnen worden opgespoord.
• Versiebeheer: Houd je integratiescripts en workflowdefinities onder versiebeheer.

Je hebt onderzocht hoe je GitHub Actions kunt integreren met je interne bedrijfssystemen. Hierbij gaat het om inzicht in veelgebruikte patronen zoals API-aanroepen en webhooks, het gebruik van veilige authenticatiemethoden (vooral GitHub Secrets) en het toepassen van aanbevolen beveiligingspraktijken.

Door je CI/CD-pijplijnen te verbinden met ITSM, CMDB's of aangepaste interne hulpmiddelen, kun je een hogere mate van automatisering bereiken, de consistentie van gegevens verbeteren en de volledige levenscyclus van softwarelevering stroomlijnen.