Skip to content

Octopusy-dev/webapi-starter-dotnet8

BranchesTags

Repository files navigation

🧪 TP – Déploiement CI/CD d'une Web API .NET 8 sur Azure

🎯 Objectif

À partir d’une Web API en .NET 8 fournie, vous devez :

  1. Créer une Azure Web App (Linux, .NET 8)
  2. Mettre en place un pipeline CI/CD avec GitHub Actions
  3. Automatiser les étapes de :
    • Compilation
    • Tests
    • Publication sur Azure

🧰 Pré-requis

  • Un compte GitHub
  • Un compte Azure
  • Le code fourni (Web API .NET 8)
  • Visual Studio / VS Code
  • Git installé
  • Avoir .net 8 sur le poste

Ce Tp faire suite a la demo du formateur donc ne detaille pas toutes les etapes Il faut bien ecouter et regarder ce qui se passe

📦 Partie 1 – Récupération du projet

Clonez le projet de démarrage :

git clone <url>
cd webapi-starter-dotnet8

Le projet à builder se trouve dans le dossier MyWebApi

Testez le lancement local :

dotnet run --project MyWebApi/MyWebApi.csproj

  • De base vous aller voir afficher hello word

  • si vous rajouter /swagger a la fin de l'url Swagger

☁️ Partie 2 – Création de la Web App sur Azure

  1. Connectez-vous à https://portal.azure.com

  2. Créez une Web App :

    • Nom : webapi-votreprenom
    • Runtime : .NET 8
    • Système : Linux
    • Région : Europe ou proche
    • Plan App Service : Gratuit (F1) ou B1

  3. Accédez à la Web App > Centre de déploiement > Configurer manuellement plus tard

  4. Accédez à la Web App > Parametres > Configuration

    • Verifier que Paramètres de la pile Pile

    • Dans les Paramètres de plateforme activer le SCM Securite

  5. Allez dans "Profil de publication" :

    • Téléchargez le fichier XML
    • Gardez ce fichier pour l’étape GitHub

il se peut que ce ne soit pas aussi facile ;)

🔐 Partie 3 – Configuration des secrets GitHub & création du pipeline

🔑 Étape 1 – Ajouter les secrets GitHub

  1. Allez sur votre dépôt GitHub
  2. Ouvrez l’onglet Settings > Secrets and variables > Actions
  3. Cliquez sur New repository secret

Ajoutez ces deux secrets :

Nom du secret Valeur
AZURE_WEBAPP_NAME Nom de votre Web App (ex. webapi-votreprenom)
AZURE_PUBLISH_PROFILE Contenu du fichier XML de profil de publication

📄 Pour récupérer le AZURE_PUBLISH_PROFILE, ouvrez le fichier .PublishSettings téléchargé depuis Azure, copiez tout son contenu, et collez-le dans le champ du secret.

⚙️ Étape 2 – Créer le pipeline à partir d’un template

GitHub propose des modèles de workflow. Pour créer votre pipeline :

Avant de faire les modification ci dessous verifier "en dur" que le workflow fonctionne une fois fait decaler les variable dans les secret ;)

  1. Allez dans l’onglet Actions de votre dépôt GitHub
  2. Cliquez sur Configure à côté de "Deploy .NET Core app to an Azure Web App"
  3. Dans le fichier généré (azure-webapps-dotnet-core.yml) :
    • Remplacez myappname par \${{ secrets.AZURE_WEBAPP_NAME }}
    • Remplacez <publish-profile> par \${{ secrets.AZURE_PUBLISH_PROFILE }}
    • Modifiez le chemin du projet .csproj si nécessaire (ex : MyWebApi/MyWebApi.csproj)
  4. Sauvegardez et validez le fichier dans .github/workflows/

🧠 Cela vous permet de gagner du temps tout en personnalisant votre pipeline.

🚀 Partie 4 – Lancement du déploiement

  1. Poussez le fichier azure-webapps-dotnet-core.yml sur la branche main
  2. Allez dans l’onglet Actions du repo GitHub
  3. Vérifiez l'exécution du pipeline
  4. Accédez à votre Web App via l'URL Azure :
    https://webapi-votreprenom.azurewebsites.net

Compléter la Partie 6 avec un workflow GitHub Actions qui :

  1. Construit l’image Docker,
  2. La pousse sur Docker Hub,
  3. Déclenche ainsi la mise à jour automatique de la Web App (via le déploiement continu activé sur Azure).

🐳 Partie 5 – Déploiement via une image Docker

🎯 Objectif

Conteneuriser la Web API, publier l’image sur Docker Hub via GitHub Actions, et configurer une Web App Azure qui se met à jour automatiquement via le déploiement continu Docker.

⚙️ Étape 1 – Création du Dockerfile

Créez un fichier Dockerfile à la racine du projet avec ce contenu :

FROM mcr.microsoft.com/dotnet/aspnet:8.0 AS base
WORKDIR /app

FROM mcr.microsoft.com/dotnet/sdk:8.0 AS build
WORKDIR /src
COPY . .
RUN dotnet publish MyWebApi/MyWebApi.csproj -c Release -o /app/publish

FROM base AS final
WORKDIR /app
COPY --from=build /app/publish .
ENV ASPNETCORE_URLS=http://+:8080
EXPOSE 8080
ENTRYPOINT ["dotnet", "MyWebApi.dll"]

🐙 Étape 2 – Créer un compte Docker Hub

  1. Allez sur https://hub.docker.com
  2. Créez un compte
  3. Créez un repository public (ex. : webapi-demo)

🔐 Étape 3 – Ajouter les secrets GitHub

Dans le dépôt GitHub :

  • Va dans Settings > Secrets and variables > Actions
  • Ajoute ces secrets :
Nom du secret Contenu
DOCKERHUB_USERNAME Ton identifiant Docker Hub
DOCKERHUB_TOKEN Ton token d'accès (à créer dans Docker Hub)

🧠 Pour générer un token : Docker Hub > Account Settings > Security > New Access Token

🤖 Étape 4 – Créer le workflow GitHub Actions

Crée un fichier .github/workflows/docker-publish.yml :

name: Build and Push Docker image

on:
  push:
    branches: [ "main" ]

jobs:
  build-and-push:
    runs-on: ubuntu-latest

    steps:
    - name: Checkout code
      uses: actions/checkout@v3

    - name: Log in to Docker Hub
      uses: docker/login-action@v2
      with:
        username: ${{ secrets.DOCKERHUB_USERNAME }}
        password: ${{ secrets.DOCKERHUB_TOKEN }}

    - name: Build and push Docker image
      uses: docker/build-push-action@v5
      with:
        context: .
        file: ./Dockerfile
        push: true
        tags: ${{ secrets.DOCKERHUB_USERNAME }}/webapi-demo:latest

☁️ Étape 5 – Configurer la Web App sur Azure

  1. Créez une Web App for Containers

    • OS : Linux
    • Type de conteneur : Unique
    • Source : Docker Hub
    • Accès : Public
    • Image : votrepseudo/webapi-demo:latest
    • Déploiement continu : ✅ activé

  2. Allez dans Configuration > Variables d'application

    • Ajoutez : WEBSITES_PORT = 8080

⭐ Bonus (Facultatif)

  • Ajouter un badge GitHub Actions dans le README.md
  • Ajouter un test unitaire s’il n’y en a pas
  • Ajouter une étape de dotnet format
  • Ajouter un slot de préproduction sur Azure
  • Utiliser un environnement GitHub pour déploiement conditionnel
  • Separer en 2 pipeline CI.yml et CD.yml

Bien sûr, voici la version mise à jour du TP avec la précision que le runtime (.NET 8) doit être envoyé en paramètre à l’étape 3, pour que les étudiants l’utilisent dans leur workflow principal :

TP : Déploiement automatisé d’une Web App Azure avec GitHub Actions

Durée estimée : 3 heures

Objectif

Automatiser la création d’une Web App Azure (si elle n’existe pas) et le déploiement d’une application .NET 8 via GitHub Actions.

Prérequis

  • Installer la CLI Azure (az) : Installation CLI Azure
  • Avoir un compte Azure avec un abonnement actif
  • Configurer un service principal Azure et récupérer le JSON des credentials pour le secret AZURE_CREDENTIALS dans GitHub
  • Se connecter à Azure en local avec az login (ou az login --use-device-code si besoin)

Étapes du TP

Étape 1 : Connexion à Azure

  • En local, connectez-vous à Azure via la CLI :

    az login

    ou

    az login --use-device-code

  • Créez un service principal si ce n’est pas déjà fait, et exportez les credentials JSON dans un secret GitHub nommé AZURE_CREDENTIALS

Étape 2 : Création du workflow verify-create-webapp.yml

  • Créez un fichier .github/workflows/verify-create-webapp.yml

  • Ce workflow doit :

    • Vérifier si la Web App Azure existe dans un groupe de ressources donné
    • Si elle n’existe pas, la créer avec le runtime passé en paramètre (ex : .NET 8)
    • Récupérer le profil de publication à la volée (sans écrire sur disque)
    • Retourner ce profil de publication en output du workflow

  • Ce workflow sera appelé via un workflow_call dans un autre pipeline

Étape 3 : Création du workflow principal

  • Créez un fichier .github/workflows/deploy-webapp.yml

  • Ce workflow doit :

    • Recevoir en paramètre le runtime cible (ex : .NET 8)
    • Appeler le workflow verify-create-webapp.yml en lui passant ce runtime
    • Récupérer en sortie le profil de publication retourné par le workflow appelé
    • Utiliser ce profil pour publier une application .NET compilée
    • Vérifier que l’URL de base retourne bien "Hello World" et afficher un avertissement sinon

Étape 4 : Bonus (à explorer)

  • Ajouter une étape de cleanup qui s’exécute toujours, même en cas d’échec des étapes précédentes
  • Améliorer la gestion des erreurs et des logs dans les workflows
  • Étendre la vérification pour supporter plusieurs slots de déploiement

Remarques importantes

  • Le profil de publication contient les informations nécessaires pour déployer l’application.
  • En le retournant en output de votre workflow appelé, vous évitez de devoir le stocker sur disque ou dans des secrets, ce qui simplifie le pipeline.
  • Faites attention à la taille des outputs dans GitHub Actions (limite ~64Ko).
  • La CLI Azure sera votre principal outil pour manipuler les ressources Azure dans ce TP.
  • Envoyer le runtime en paramètre permet de rendre le workflow flexible et réutilisable.

Questions pour guider la réflexion

  • Comment passer un paramètre (runtime) à un workflow appelé via workflow_call ?
  • Comment récupérer un output de ce workflow appelé ?
  • Comment utiliser la CLI Azure pour créer une Web App avec un runtime spécifique ?
  • Comment exploiter le profil de publication pour publier sans écrire de fichier sur disque ?

About

TP – Déploiement CI/CD d'une Web API .NET 8 sur Azure

Topics

devops tp eni

Resources

Readme
Activity

Stars

0 stars

Watchers

2 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages