Automatiser la recompilation des images de conteneur 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 postes de travail. Une fois qu'une image personnalisée est utilisée, il est utile d'automatiser sa reconstruction 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 et les correctifs de sécurité dans vos images de postes 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'images.
  3. Créez un déclencheur 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 :

Pour obtenir une estimation des coûts en fonction de votre utilisation prévue, utilisez le simulateur de coût.

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

Une fois que vous avez terminé les tâches décrites dans ce document, vous pouvez éviter de continuer à payer des frais en supprimant les ressources que vous avez créées. Pour en savoir plus, consultez la section Effectuer un nettoyage.

Avant de commencer

  1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.
  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  3. Make sure that billing is enabled for your Google Cloud project.

  4. Enable the Artifact Registry, Container Scanning API, Cloud Build, and Cloud Scheduler APIs.

    Enable the APIs

  5. Install the Google Cloud CLI.

  6. If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

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

    gcloud init
  8. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  9. Make sure that billing is enabled for your Google Cloud project.

  10. Enable the Artifact Registry, Container Scanning API, Cloud Build, and Cloud Scheduler APIs.

    Enable the APIs

  11. Install the Google Cloud CLI.

  12. If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

  13. 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
    

    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 fichier Dockerfile de vos images personnalisées dans un dépôt Git. Le processus automatisé accède à ce dépôt lors du processus de compilation pour extraire les configurations et le fichier Dockerfile pertinents.

Dupliquer l'exemple de dépôt

Pour dupliquer un dépôt d'exemple qui fournit 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 patientez quelques secondes.

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 et suivez les instructions pour terminer la procédure. 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.

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 utilisée pour créer l'image de conteneur. Dans cette étape, vous allez créer un déclencheur 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'indicateur name sur la deuxième ligne.
  • Les trois lignes suivantes contiennent des indicateurs liés au dépôt GitHub source :
  • L'indicateur 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 du conteneur, $_AR_IMAGE_NAME
    • Emplacement du fichier Dockerfile à compiler, $_IMAGE_DIR

    Consultez 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 les derniers 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 valeur sur une fréquence adaptée aux 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 Cloud Build :

    gcloud projects add-iam-policy-binding $PROJECT_ID \
        --member="serviceAccount:$PROJECT_NUMBER-compute@developer.gserviceaccount.com" \
        --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.gserviceaccount.com \
        --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@developer.gserviceaccount.com \
        --oauth-token-scope=https://www.googleapis.com/auth/cloud-platform
    
  4. La tâche est définie pour s'exécuter une fois par jour. Toutefois, pour tester immédiatement la fonctionnalité, 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 et qui s'appelle 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 "Historique Cloud Build" pour examiner la progression :

      Accéder à l'historique de Cloud Build

Étudier les résultats

Comme vous avez activé l'API Container Scanning lors de la configuration, Artifact Registry analyse automatiquement les images pour détecter les 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 résumé d'image s'affiche dans la colonne Vulnerabilities (Failles).

    Page "Dépôts Artifact Registry" affichant un exemple de nom d'image

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

    Page "Failles" d'Artifact Registry affichant un exemple de liste de failles

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 , veillez à supprimer celles dont vous n'avez plus besoin.

Pour supprimer un projet Google Cloud de la console Google Cloud ou de l'CLI commandegcloud :

Console

  1. In the Google Cloud console, go to the Manage resources page.

    Go to Manage resources

  2. In the project list, select the project that you want to delete, and then click Delete.
  3. In the dialog, type the project ID, and then click Shut down to delete the project.

gcloud

    Delete a Google Cloud project:

    gcloud projects delete PROJECT_ID

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

Étapes suivantes