Automatiser la reconstruction des images de conteneurs pour synchroniser les mises à jour des images de base

Cloud Workstations vous permet de créer et d'utiliser des images personnalisées pour vos stations de travail. Une fois qu'une image personnalisée est utilisée, il est utile d'automatiser sa recompilation afin d'intégrer les correctifs et les mises à jour disponibles dans les images de base.

Dans ce tutoriel, vous allez apprendre à créer un pipeline automatisé pour vous assurer d'inclure les mises à jour de sécurité et les correctifs dans vos images de station de travail personnalisées.

Objectifs

En suivant ce tutoriel, vous allez créer un pipeline automatisé pour votre image de base en procédant comme suit :

1. Créez un dépôt Artifact Registry pour stocker et analyser votre image personnalisée.
2. Configurez GitHub avec Google Cloud pour stocker vos configurations d'image.
3. Créez un déclencheur de compilation Cloud Build pour automatiser la création et le déploiement d'images personnalisées dans Artifact Registry.
4. Configurez Cloud Scheduler pour lancer des compilations régulièrement.
5. Examinez les résultats des processus automatisés.

Coûts

Dans ce document, vous utilisez les composants facturables suivants de Google Cloud :

• Cloud Build
• Cloud Scheduler
• Container Scanning
• Artifact Registry

Obtenez une estimation des coûts en fonction de votre utilisation prévue à l'aide du simulateur de coût.

Les nouveaux utilisateurs de Google Cloud peuvent bénéficier d'un essai sans frais.

Une fois que vous avez terminé les tâches décrites dans ce document, supprimez les ressources que vous avez créées pour éviter que des frais vous soient facturés. Pour en savoir plus, consultez la section Effectuer un nettoyage.

Avant de commencer

1. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Roles required to select or create a project

   • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
   • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.
   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

2. Verify that billing is enabled for your Google Cloud project.

3. Enable the Artifact Registry, Container Scanning API, Cloud Build, and Cloud Scheduler APIs, if any are not already enabled.

   Roles required to enable APIs

   To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

   Enable the APIs

4. Install the Google Cloud CLI.

5. Configure the gcloud CLI to use your federated identity.

   For more information, see Sign in to the gcloud CLI with your federated identity.

6. To initialize the gcloud CLI, run the following command:

   gcloud init

Préparer l'environnement

Avant de continuer, assurez-vous de définir les variables d'environnement suivantes.

1. Définissez l'ID du projet cloud que vous prévoyez d'utiliser :

   PROJECT_ID=$PROJECT_ID
   

2. Définissez le nom d'utilisateur GitHub où vous prévoyez de stocker votre dépôt :

   GITHUB_USER=$GITHUB_ID
   

3. Définissez les variables PROJECT_NUMBER et REGION à utiliser tout au long du processus :

   PROJECT_NUMBER=$(gcloud projects describe $PROJECT_ID \
       --format='value(projectNumber)')
   
   REGION=$REGION
   

   Dans l'exemple précédent, remplacez $REGION par le nom de la région que vous prévoyez d'utiliser (par exemple, us-central1).

   Pour en savoir plus sur les régions disponibles, consultez Emplacements Cloud Workstations.

Créer un dépôt Artifact Registry

Dans ce tutoriel, vous allez utiliser Artifact Registry pour stocker et analyser vos images.

1. Créez un dépôt à l'aide de la commande suivante :

   gcloud artifacts repositories create custom-images \
         --repository-format=docker \
         --location=$REGION \
         --description="Docker repository"
   

   Remplacez $REGION par le nom de la région que vous prévoyez d'utiliser.

2. Configurez Docker pour qu'il utilise vos identifiants de la CLI gcloud lorsque vous accédez à Artifact Registry.

   gcloud auth configure-docker $REGION-docker.pkg.dev
   

   Remarque : N'oubliez pas que cette configuration active également l'analyse automatisée des conteneurs, qui permet d'analyser les failles, mais entraîne un coût supplémentaire par image analysée. Consultez les informations tarifaires.

   Pour désactiver Artifact Analysis, exécutez la commande suivante :

   gcloud services disable containerscanning.googleapis.com
   

Configurer votre dépôt GitHub

En pratique, vous conservez le Dockerfile de vos images personnalisées dans un dépôt Git. Le processus automatisé accède à ce dépôt pendant le processus de compilation pour extraire les configurations et le Dockerfile appropriés.

Dupliquer l'exemple de dépôt

Pour dupliquer un exemple de dépôt fournissant des définitions de conteneur, procédez comme suit :

1. Cliquez sur ce lien pour créer un fork du dépôt software-delivery-workshop.
2. Si vous y êtes invité, connectez-vous à GitHub.
3. Sélectionnez votre nom d'utilisateur GitHub comme propriétaire. Le nom du dépôt s'affiche sous la forme software-delivery-workshop.
4. Cliquez sur Create fork (Créer un fork) et attendez quelques secondes que le processus se termine.

Connecter Cloud Build à GitHub

Ensuite, connectez ce dépôt à Cloud Build à l'aide de la fonctionnalité de connexion GitHub intégrée. Cliquez sur le lien vers le dépôt GitHub, puis suivez les instructions décrivant comment terminer le processus. Vous n'avez pas besoin de créer le déclencheur à la dernière étape de l'assistant. Vous pouvez ignorer les dernières étapes, car vous pourrez le faire plus tard à partir de la ligne de commande.

• Connecter Cloud Build au dépôt GitHub

Si vous utilisez une autre solution de dépôt Git, vous pouvez également suivre les instructions pour connecter Cloud Build à GitLab ou Bitbucket.

Créer un déclencheur Cloud Build

L'exemple de dépôt contient une définition de conteneur et une configuration Cloud Build permettant de créer l'image de conteneur. Dans cette étape, vous allez créer un déclencheur de compilation Cloud Build qui exécute les instructions du fichier cloudbuild.yaml que vous trouverez dans le dossier labs/cloudbuild-scheduled-jobs/code-oss-java.

gcloud builds triggers create manual \
    --name=custom-image-trigger \
    --repo=$GITHUB_USER/software-delivery-workshop \
    --repo-type=GITHUB \
    --branch=main \
    --build-config=labs/cloudbuild-scheduled-jobs/code-oss-java/cloudbuild.yaml \
    --substitutions=_REGION=$REGION,_AR_REPO_NAME=custom-images,_AR_IMAGE_NAME=code-oss-java,_IMAGE_DIR=labs/cloudbuild-scheduled-jobs/code-oss-java

TRIGGER_ID=$(gcloud builds triggers list \
    --filter=name="custom-image-trigger" --format="value(id)")

Cet exemple configure les éléments suivants :

• La commande CLI gcloud crée un déclencheur manuel dans Cloud Build nommé custom-image-trigger, comme indiqué par l'option name sur la deuxième ligne.
• Les trois lignes suivantes contiennent des options liées au dépôt GitHub source :
  • Chemin d'accès au dépôt
  • Type de dépôt
  • Branche Git à compiler
• L'option build-config indique le chemin d'accès au fichier Cloud Build dans le dépôt Git.

• Pour rendre le job dynamique, utilisez l'option substitutions. Pour ce job, la commande transmet les variables suivantes :

  • Région, $_REGION
  • Nom du dépôt Artifact Registry, $_AR_REPO_NAME
  • Nom de l'image de conteneur, $_AR_IMAGE_NAME
  • Emplacement du fichier Dockerfile à compiler, $_IMAGE_DIR

  Affichez le fichier cloudbuild.yaml pour voir comment ces variables sont utilisées dans le processus.

• Une fois le déclencheur créé, son nom unique est récupéré et stocké dans la variable d'environnement $TRIGGER_ID pour une utilisation ultérieure.

Configurer Cloud Scheduler

Pour vous assurer que vos images sont à jour avec les dernières mises à jour et correctifs, utilisez Cloud Scheduler pour exécuter le déclencheur Cloud Build à une fréquence définie. Pour ce tutoriel, le job s'exécute tous les jours. En pratique, définissez cette fréquence en fonction des besoins de votre organisation pour vous assurer que les dernières mises à jour sont toujours incluses.

1. Attribuez un rôle requis au compte de service par défaut pour appeler le déclencheur de compilation Cloud Build :

   gcloud projects add-iam-policy-binding $PROJECT_ID \
       --member="serviceAccount:$PROJECT_NUMBER-compute@" \
       --role="roles/cloudbuild.builds.editor"
   

2. Attribuez un rôle requis au compte de service Cloud Build pour importer des images dans Artifact Registry :

   gcloud projects add-iam-policy-binding $PROJECT_ID \
       --member=serviceAccount:$PROJECT_NUMBER@cloudbuild. \
       --role="roles/artifactregistry.admin"
   

3. Créez le job Cloud Scheduler à l'aide de la commande suivante :

   gcloud scheduler jobs create http run-build \
       --schedule='0 1 * * *' \
       --uri=https://cloudbuild.googleapis.com/v1/projects/$PROJECT_ID/locations/global/triggers/$TRIGGER_ID:run \
       --location=us-central1 \
       --oauth-service-account-email=$PROJECT_NUMBER-compute@ \
       --oauth-token-scope=https://www.googleapis.com/auth/cloud-platform
   

4. La tâche est configurée pour s'exécuter une fois par jour. Toutefois, pour tester la fonctionnalité immédiatement, exécutez la tâche manuellement à partir de Cloud Scheduler :

   Accéder à Cloud Scheduler

   1. Sur la page Cloud Scheduler, recherchez l'entrée que vous venez de créer, appelée run-build.
   2. Dans la colonne "Actions", cliquez sur le menu d'options more_vertPlus pour cette ligne.
   3. Cliquez sur Forcer l'exécution d'un job pour tester le système manuellement.

   4. Une fois la commande exécutée, accédez à la page de l'historique Cloud Build pour suivre la progression :

      Accéder à l'historique de Cloud Build

Étudier les résultats

Comme vous avez activé l'API Container Scanning lors du processus de configuration, Artifact Registry analyse automatiquement les images pour détecter d'éventuelles failles de sécurité.

Pour examiner les failles :

1. Ouvrez la page "Dépôts Artifact Registry" :

   Accéder aux dépôts Artifact Registry

2. Dans la liste des dépôts, cliquez sur un dépôt.

3. Cliquez sur le nom d'une image. Le nombre total de failles pour chaque condensé d'image s'affiche dans la colonne Failles.

   

4. Pour afficher la liste des failles d'une image, cliquez sur le lien dans la colonne Vulnerabilities (Failles). La liste des failles indique la gravité, la disponibilité d'un correctif et le nom du package contenant la faille.

   

Effectuer un nettoyage

Pour éviter que les ressources utilisées lors de ce tutoriel soient facturées sur votre compte Google Cloud, supprimez le projet contenant les ressources, ou conservez le projet et supprimez les ressources individuelles.

Pour éviter que les ressources utilisées sur cette page ne soient facturées sur votre compte Google Cloud , n'oubliez pas de supprimer celles dont vous n'avez plus besoin.

Pour supprimer un projet Google Cloud de la console Google Cloud ou de la CLIgcloud :

Console

Attention : La suppression d'un projet entraîne les effets décrits ci-dessous :

• Tout le contenu du projet est supprimé. Si vous avez utilisé un projet existant pour les tâches décrites dans ce document et que vous le supprimez, vous supprimerez également tout autre travail effectué dans le projet.
• Les ID de projets personnalisés sont perdus. Lorsque vous avez créé ce projet, vous avez peut-être créé un ID de projet personnalisé que vous souhaitez utiliser à l'avenir. Pour conserver les URL qui utilisent l'ID de projet, telle qu'une URL appspot.com, supprimez les ressources sélectionnées dans le projet au lieu de supprimer l'ensemble du projet.

Si vous envisagez d'explorer plusieurs architectures, tutoriels et guides de démarrage rapide, réutiliser des projets peut vous aider à ne pas dépasser les limites de quotas des projets.

1. Dans la console Google Cloud , accédez à la page Gérer les ressources.

   Accéder à la page "Gérer les ressources"

2. Dans la liste des projets, sélectionnez le projet que vous souhaitez supprimer, puis cliquez sur Supprimer.
3. Dans la boîte de dialogue, saisissez l'ID du projet, puis cliquez sur Arrêter pour supprimer le projet.

gcloud

Attention : La suppression d'un projet entraîne les effets décrits ci-dessous :

• Tout le contenu du projet est supprimé. Si vous avez utilisé un projet existant pour les tâches décrites dans ce document et que vous le supprimez, vous supprimerez également tout autre travail effectué dans le projet.
• Les ID de projets personnalisés sont perdus. Lorsque vous avez créé ce projet, vous avez peut-être créé un ID de projet personnalisé que vous souhaitez utiliser à l'avenir. Pour conserver les URL qui utilisent l'ID de projet, telle qu'une URL appspot.com, supprimez les ressources sélectionnées dans le projet au lieu de supprimer l'ensemble du projet.

Si vous envisagez d'explorer plusieurs architectures, tutoriels et guides de démarrage rapide, réutiliser des projets peut vous aider à ne pas dépasser les limites de quotas des projets.

Supprimer un projet Google Cloud  :

gcloud projects delete PROJECT_ID

Pour en savoir plus sur la suppression d'autres ressources, telles que des clusters, des configurations et des stations de travail, consultez Supprimer des ressources.

Étapes suivantes

• Consultez la liste des images de base préconfigurées disponibles.
• Personnalisez vos images de conteneurs.
• Consultez les types de machines disponibles.
• Configurez les bonnes pratiques de sécurité.
• Découvrez des architectures de référence, des schémas et des bonnes pratiques concernant Google Cloud. Consultez notre Cloud Architecture Center.