ARM-sjablonen implementeren met behulp van GitHub Actions
GitHub Actions is een suite met functies in GitHub om uw werkstromen voor softwareontwikkeling te automatiseren op dezelfde plaats waar u code opslaat en samenwerkt aan pull-aanvragen en problemen.
Gebruik de actie Azure Resource Manager-sjabloon implementeren om het implementeren van een Azure Resource Manager-sjabloon (ARM-sjabloon) in Azure te automatiseren.
Vereisten
Een Azure-account met een actief abonnement. Gratis een account maken
Een GitHub-account. Als u geen account hebt, kunt u zich registreren voor een gratis account.
- Een GitHub-opslagplaats voor het opslaan van uw Resource Manager-sjablonen en uw werkstroombestanden. Zie Een nieuwe opslagplaats maken om er een te maken.
Overzicht van werkstroom bestand
Een werkstroom wordt gedefinieerd door een YAML-bestand (.yml) in het pad /.github/workflows/ in uw opslagplaats. Deze definitie bevat de verschillende stappen en parameters die deel uitmaken van de werkstroom.
Het bestand heeft twee secties:
| Sectie | Opdrachten |
|---|---|
| Verificatie | 1. Implementatiereferenties genereren. |
| Implementeren | 1. Implementeer de Resource Manager-sjabloon. |
Genereer implementatiereferenties
Als u azure-aanmeldingsactie wilt gebruiken met OIDC, moet u een federatieve identiteitsreferentie configureren in een Microsoft Entra-toepassing of een door de gebruiker toegewezen beheerde identiteit.
Optie 1: Microsoft Entra-toepassing
- Maak een Microsoft Entra-toepassing met een service-principal via Azure Portal, Azure CLI of Azure PowerShell.
- Kopieer de waarden voor client-id, abonnements-id en map-id (tenant) voor later gebruik in uw GitHub Actions-werkstroom.
- Wijs een geschikte rol toe aan uw service-principal via Azure Portal, Azure CLI of Azure PowerShell.
- Configureer een federatieve identiteitsreferentie in een Microsoft Entra-toepassing om tokens te vertrouwen die door GitHub Actions zijn uitgegeven aan uw GitHub-opslagplaats.
Optie 2: Door de gebruiker toegewezen beheerde identiteit
- Een door een gebruiker toegewezen beheerde identiteit maken.
- Kopieer de waarden voor client-id, abonnements-id en map-id (tenant) voor later gebruik in uw GitHub Actions-werkstroom.
- Wijs een geschikte rol toe aan uw door de gebruiker toegewezen beheerde identiteit.
- Configureer een federatieve identiteitsreferentie op een door de gebruiker toegewezen beheerde identiteit om tokens te vertrouwen die zijn uitgegeven door GitHub Actions aan uw GitHub-opslagplaats.
De GitHub-geheimen configureren
U moet de client-id, map-id en abonnements-id van uw toepassing opgeven voor de aanmeldingsactie. Deze waarden kunnen rechtstreeks in de werkstroom worden opgegeven of kunnen worden opgeslagen in GitHub-geheimen en waarnaar wordt verwezen in uw werkstroom. Het opslaan van de waarden als GitHub-geheimen is de veiligere optie.
Ga in GitHub naar uw opslagplaats.
Selecteer Acties voor beveiligingsgeheimen > en variabelen>.
Selecteer Nieuw opslagplaatsgeheim.
Notitie
Als u de werkstroombeveiliging in openbare opslagplaatsen wilt verbeteren, gebruikt u omgevingsgeheimen in plaats van opslagplaatsgeheimen. Als voor de omgeving goedkeuring is vereist, heeft een taak geen toegang tot omgevingsgeheimen totdat een van de vereiste revisoren deze goedkeurt.
Geheimen maken voor
AZURE_CLIENT_ID,AZURE_TENANT_IDenAZURE_SUBSCRIPTION_ID. Kopieer deze waarden uit uw Microsoft Entra-toepassing of door de gebruiker toegewezen beheerde identiteit voor uw GitHub-geheimen:GitHub-geheim Microsoft Entra-toepassing of door de gebruiker toegewezen beheerde identiteit AZURE_CLIENT_ID Client ID AZURE_SUBSCRIPTION_ID Abonnements-id AZURE_TENANT_ID Id van directory (tenant) Notitie
Om veiligheidsredenen raden we u aan GitHub Secrets te gebruiken in plaats van waarden rechtstreeks door te geven aan de werkstroom.
Resource Manager-sjabloon toevoegen
Voeg een Resource Manager-sjabloon toe aan uw GitHub-opslagplaats. Met deze sjabloon maakt u een opslagaccount.
https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/quickstarts/microsoft.storage/storage-account-create/azuredeploy.json
U kunt het bestand overal in de opslagplaats plaatsen. In het voorbeeld van de werkstroom in de volgende sectie wordt ervan uitgegaan dat het sjabloonbestand de naam azuredeploy.json heeft en wordt opgeslagen in de hoofdmap van uw opslagplaats.
Werkstroom maken
Het werkstroombestand moet worden opgeslagen in de map .github/workflows in de hoofdmap van uw opslagplaats. De bestandsextensie van de werkstroom kan .yml of .yaml zijn.
- Selecteer in uw GitHub-opslagplaats Acties in het bovenste menu.
- Selecteer Nieuwe werkstroom.
- Selecteer zelf een werkstroom instellen.
- Wijzig de naam van het werkstroombestand als u de voorkeur geeft aan een andere naam dan main.yml. Bijvoorbeeld: deployStorageAccount.yml.
- Vervang de inhoud van het yml-bestand door het volgende:
on: [push]
name: Azure ARM
jobs:
build-and-deploy:
runs-on: ubuntu-latest
steps:
# Checkout code
- uses: actions/checkout@main
# Log into Azure
- uses: azure/login@v1
with:
creds: ${{ secrets.AZURE_CREDENTIALS }}
# Deploy ARM template
- name: Run ARM deploy
uses: azure/arm-deploy@v1
with:
subscriptionId: ${{ secrets.AZURE_SUBSCRIPTION }}
resourceGroupName: ${{ secrets.AZURE_RG }}
template: ./azuredeploy.json
parameters: storageAccountType=Standard_LRS
# output containerName variable from template
- run: echo ${{ steps.deploy.outputs.containerName }}
Notitie
U kunt in plaats daarvan een parameterbestand voor de JSON-indeling opgeven in de ARM-implementatieactie (bijvoorbeeld: .azuredeploy.parameters.json).
De eerste sectie van het werkstroombestand bevat:
- name: De naam van de werkstroom.
- on: De naam van de GitHub-gebeurtenissen die de werkstroom activeren. De werkstroom wordt geactiveerd wanneer er een pushgebeurtenis op de hoofdbranch staat, die ten minste één van de twee opgegeven bestanden wijzigt. De twee bestanden zijn het werkstroombestand en het sjabloonbestand.
- Selecteer Doorvoeren starten.
- Selecteer Doorvoeren rechtstreeks naar de hoofdbranch.
- Selecteer Nieuw bestand doorvoeren (of Wijzigingen doorvoeren).
Omdat de werkstroom is geconfigureerd om te worden geactiveerd door het werkstroombestand of het sjabloonbestand dat wordt bijgewerkt, start de werkstroom direct nadat u de wijzigingen hebt doorgevoerd.
Werkstroomstatus controleren
- Selecteer het tabblad Acties . Er wordt een werkstroom maken deployStorageAccount.yml weergegeven. Het duurt 1-2 minuten om de werkstroom uit te voeren.
- Selecteer de werkstroom om deze te openen.
- Selecteer ARM-implementatie uitvoeren in het menu om de implementatie te controleren.
Resources opschonen
Wanneer uw resourcegroep en opslagplaats niet meer nodig zijn, schoont u de resources op die u hebt geïmplementeerd door de resourcegroep en uw GitHub-opslagplaats te verwijderen.