04 - Déploiement d'une version staging et procédure de déploiement

Objectif

Déployer une version staging de votre application pour que le client puisse y accéder et documenter la procédure de déploiement.

Valant pour 15% de la session, vous aurez à déployer une version staging de votre application afin qu'elle soit accessible.

Il vous est suggéré d'utiliser Azure, la procédure étant bien documentée pour les cas classiques d'utilisation de MVC et Blazor, mais vous êtes libre d'utiliser n'importe quelle plateforme de déploiement. En effet, votre application peut avoir des particularités bien à elle ou encore votre client pourrait avoir des besoins spécifiques nécessitant un environnement de déploiement particulier.

D'ailleurs, un guide vous est aussi offert dans la section du même nom pour des déploiements qui auraient des besoins plus pointues. Pour ce faire, il vous est suggéré de déployer à l'aide de Docker sur un serveur privé virtuel (VPS).

Si vous utilisez Azure, vous pourrez utiliser le forfait éducationnel de Azure pour profiter de services gratuits et donc de n'avoir aucuns frais à débourser pour vous et votre client. Si vous utilisez AWS, vous pourrez profiter de certains services gratuits pour une durée de 3 ou 12 mois, tout dépendant du service.

Pour terminer, une fois le déploiement effectué, vous devrez documenter la procédure de déploiement et les configurations requises liées aux particularités de votre application.

Détails de la tâche

Déploiement

Vous devez déployer votre application sur Microsoft Azure ou autre fournisseur de adapté à vos besoins. L'idée est de vivre l'expérience complète d'un déploiement applicatif et de rendre une version de votre application accessible au client.

Vous devrez remettre les URL accessibles publiquement de votre application lors de la remise.

Documentation

Vous devrez documenter la procédure de déploiement, les problèmes possibles & solutions, puis comment vérifier que le déploiement est 100% fonctionnel.

info

Écrivez à l'intention d'un développeur avec des connaissances techniques et non le client final.

Vous pouvez joindre cette documentation à la documentation utilisateur si vous utilisez un outil comme Docusaurus pour générer la documentation et ainsi avoir une section supplémentaire pour le déploiement. Vous pouvez aussi consigner cette documentation d'une autre façon (Word, Google Docs, etc.).

1. Procédure de déploiement, prérequis et les dépendances

   • Quels services sont requis (Framework, BD, App Service, Stockage de fichiers)
   • Quelles versions utiliser pour les différents services/dépendances
   • Comment configurer adéquatement les différents services
   • Explication des configurations propres à l'environnement de déploiement (ex.: connection string, serveur SMTP, etc.), quelles configurations modifier et à quel endroit.
   • Dépendances sur des API externes (ex.: Stripe)
   • Comment procéder au déploiement et démarrer l'application chez l'hébergeur

2. Problèmes possibles et pistes de solution

   • Quels sont les problèmes possibles et erreurs classiques? Comment les résoudre?
   • Vous avez vous-même surement déjà rencontré plusieurs problèmes liés à l'exécution de votre projet (configuration manquant, mauvaise version logicielle, etc.), vous pouvez vous en inspirer pour cette section.

3. Vérification de l'installation et du déploiement

   • Présenter les étapes permettant de vérifier que l'installation/déploiement a bien été effectuée et que l'application fonctionne correctement (ex.: il devrait être possible de se connecter, de créer un compte, des courriels devraient s'envoyer, etc.).
   • Il ne s'agit pas d'exécuter les tests ici, mais d'expliquer ce que représente l'application fonctionnelle (comportement, connexion fonctionnelle, envoi de courriel fonctionnel, sauvegarde d'images, fonctionnalités particulières, etc.).

astuce

Voici deux exemples de documentation technique de déploiement présentant la majeure partie des éléments attendus (ex.: déploiement/installation de GitLab sur AWS/GCP):

• https://docs.gitlab.com/ee/install/aws/
• https://docs.gitlab.com/ee/install/google_cloud_platform/

Modalités de remise

• Remis via Confluence
• Procédure de déploiement
  • Word ou autre: fichier placé dans une section Remise Finale de votre Confluence.
  • Docusaurus: me donner accès à votre repo contenant le docusaurus (@bentremblay.cd) et mentionnez l'URL dans une section Remise Finale de votre Confluence.
• IMPORTANT: Votre documentation doit inclure les URL pour accéder à votre application déployée!
• À remettre avant le 9 mars 2025 23:59

Critère	Points
Déploiement d'une version staging de l'application	50%
Procédure de déploiement → Qualité, détails et clarté de la procédure de déploiement	30%
Procédure de déploiement → Problèmes possibles & solutions et vérification de l'installation	20%