Gérer les tâches d'application de correctifs

Après avoir créé un job d'application de correctifs, vous pouvez utiliser les procédures suivantes pour examiner et gérer vos correctifs :

Vous pouvez gérer vos jobs d'application de correctifs en utilisant la console Google Cloud, Google Cloud CLI ou REST.

Avant de commencer

  • Consultez les quotas d'OS Config.
  • Si ce n'est pas déjà fait, configurez l'authentification. L'authentification est le processus permettant de valider votre identité pour accéder aux Google Cloud services et aux API. Pour exécuter du code ou des exemples depuis un environnement de développement local, vous pouvez vous authentifier auprès de Compute Engine en sélectionnant l'une des options suivantes:

    Select the tab for how you plan to use the samples on this page:

    Consolegcloud

    When you use the Google Cloud console to access Google Cloud services and APIs, you don't need to set up authentication.

    1. After installing the Google Cloud CLI, initialize it by running the following command: 

      gcloud init

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

    2. Set a default region and zone.

      3. REST

      Pour utiliser les exemples d'API REST de cette page dans un environnement de développement local, vous devez utiliser les identifiants que vous fournissez à gcloud CLI.

        After installing the Google Cloud CLI, initialize it by running the following command: 

        gcloud init

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

      Pour en savoir plus, consultez la section S'authentifier pour utiliser REST dans la documentation sur l'authentification Google Cloud.

Autorisations

Les propriétaires d'un projet disposent d'un accès complet pour exécuter et gérer des jobs d'application de correctifs. Pour tous les autres utilisateurs, vous devez accorder des autorisations. Vous pouvez attribuer l'un des rôles suivants :

  • roles/osconfig.patchJobExecutor : contient les autorisations nécessaires pour exécuter, annuler, obtenir et répertorier les jobs d'application de correctifs. Le rôle contient également des autorisations permettant d'afficher les détails de l'instance pour un job d'application de correctif.
  • roles/osconfig.patchJobViewer : contient des autorisations d'accès en lecture seule pour obtenir et répertorier les jobs d'application de correctifs. Le rôle contient également des autorisations permettant d'afficher les détails de l'instance pour un job d'application de correctif.

Répertorier les tâches d'application de correctifs

Affichez la liste de toutes les tâches actives et terminées.

Console gcloud REST
  1. Dans la console Google Cloud, accédez à la page Compute Engine > VM Manager > Patch.

    Accéder à la page "Correction"

  2. Sélectionnez l'onglet Jobs d'application de correctifs.

Utilisez la commande os-config patch-jobs list pour répertorier les jobs d'application de correctifs.

gcloud compute os-config patch-jobs list

Pour Google Cloud CLI, la sortie par défaut renvoie les 10 jobs d'application de correctifs, qu'ils soient terminés ou actifs. Vous pouvez remplacer ce paramètre à l'aide de l'option --limit.

Le résultat se présente comme suit :

ID                                          NAME    DESCRIPTION               CREATE_TIME               UPDATE_TIME               STATE                  TARGETED_INSTANCES
23b0815e-1c94-4dc6-91b1-30a6da395cb9                                          2019-11-05T20:22:54.150Z  2019-11-06T19:40:08.641Z  COMPLETED_WITH_ERRORS  4
4116ad72-bd57-4e48-94dc-7a577dc707b6                                          2019-08-23T20:36:03.068Z  2019-08-23T20:36:15.984Z  CANCELED               2
06856cbe-9a7b-498e-9105-9ae4eb566511                                          2019-08-12T20:27:38.410Z  2019-08-12T20:28:37.583Z  SUCCEEDED              1
04a15964-9eaa-4282-96f5-9cd535352cf6                                          2019-08-12T17:48:22.938Z  2019-08-12T17:48:42.274Z  SUCCEEDED              0
21dc1e06-deee-4e3a-821e-8082a32abde5                testing patch job reboot  2019-07-24T22:45:07.451Z  2019-07-25T00:44:44.459Z  TIMED_OUT              1

Vous pouvez utiliser davantage d'options pour filtrer, trier et formater votre recherche. Par exemple, pour filtrer la sortie ci-dessus afin de ne répertorier que les URI des jobs d'application de correctifs dont l'état est SUCCEEDED trié par heure de création et par ordre croissant, exécutez la commande suivante :

gcloud compute os-config patch-jobs list \
   --filter="state=SUCCEEDED" \
   --sort-by="create_time" --uri

Le résultat se présente comme suit :

https://osconfig.googleapis.com/v1/projects/1234567/patchJobs/04a15964-9eaa-4282-96f5-9cd535352cf6
https://osconfig.googleapis.com/v1/projects/1234567/patchJobs/06856cbe-9a7b-498e-9105-9ae4eb566511

Pour obtenir la liste complète des options, consultez la commande os-config patch-jobs list.

Dans l'API, envoyez une requête GET à la méthode patchJobs.list. Remplacez project-id par l'ID du projet.

GET https://osconfig.googleapis.com/v1/projects/project-id/patchJobs

Répertorier tous les détails de l'instance de VM pour un job d'application de correctifs spécifique

Consultez l'état du job d'application de correctif pour obtenir la liste complète des instances de VM qui utilisent OS Patch Management.

Console gcloud REST
  1. Dans la console Google Cloud, accédez à la page Compute Engine > VM Manager > Patch.

    Accéder à la page "Correction"

  2. Sélectionnez l'onglet Jobs d'application de correctifs.
  3. Cliquez sur le nom du job d'application de correctif que vous souhaitez examiner.
  4. Faites défiler la page jusqu'à la section Instances de VM mises à jour.

Utilisez la commande os-config patch-jobs list-instance-details pour répertorier les détails de toutes les VM d'un job d'application de correctif spécifique. Remplacez patch-job-id par l'ID de votre job d'application de correctif.

gcloud compute os-config patch-jobs list-instance-details patch-job-id

Par exemple, pour afficher les détails de toutes les instances faisant partie du job d'application de correctif 23b0815e-1c94-4dc6-91b1-30a6da395cb9, exécutez la commande suivante :

gcloud compute os-config patch-jobs list-instance-details 23b0815e-1c94-4dc6-91b1-30a6da395cb9

Le résultat se présente comme suit :

NAME                        ZONE           STATE      FAILURE_REASON
instance-1                  us-central1-a  SUCCEEDED
guest-policy-test-instance  us-east1-c     TIMED_OUT  Instance timed out while in state: APPLYING_PATCHES after PT1H2.225S
my-centos                   us-west1-b     SUCCEEDED
my-windows                  us-west1-b     FAILED     Error running pre-patch step: fork/exec /tmp/pre_patch_script.sh: no such file ..."

Vous pouvez utiliser davantage d'options pour filtrer, trier et formater votre recherche. Par exemple, pour répertorier les détails de toutes les VM inactives triées par nom d'instance par ordre décroissant, exécutez la commande suivante. Remplacez patch-job-id par l'ID de votre job d'application de correctif.

gcloud compute os-config patch-jobs list-instance-details patch-job-id \
   --filter="state=INACTIVE" \
   --sort-by="~name"

Pour obtenir la liste complète des options, consultez la commande os-config patch-jobs list-instance-details.

Dans l'API, envoyez une requête GET à la méthode patchJobs.instanceDetails.

GET https://osconfig.googleapis.com/v1/projects/project-id/patchJobs/patch-job-id/instanceDetails

Remplacez les éléments suivants :

  • project-id : ID de votre projet
  • patch-job-id : ID de votre job d'application de correctifs.

Décrire les jobs d'application de correctifs

Consultez les informations détaillées d'un job d'application de correctif.

Console gcloud REST
  1. Dans la console Google Cloud, accédez à la page Compute Engine > VM Manager > Patch.

    Accéder à la page "Correction"

  2. Sélectionnez l'onglet Jobs d'application de correctifs.
  3. Cliquez sur le nom du job d'application de correctif que vous souhaitez examiner.
  4. Consultez la section Mettre à jour les informations.

Utilisez la commande os-config patch-jobs describe pour décrire un job d'application de correctif. Remplacez patch-job-id par l'ID de votre job d'application de correctifs.

gcloud compute os-config patch-jobs describe patch-job-id

Par exemple, pour afficher des informations sur le job d'application de correctif 23b0815e-1c94-4dc6-91b1-30a6da395cb9, exécutez la commande suivante :

gcloud compute os-config patch-jobs describe 23b0815e-1c94-4dc6-91b1-30a6da395cb9

Le résultat se présente comme suit :

createTime: '2019-11-05T20:22:54.150Z'
errorMessage: Completed with 2 instance failure(s).
filter: id=*
instanceDetailsSummary:
  instancesFailed: '1'
  instancesSucceeded: '2'
  instancesTimedOut: '1'
instanceFilter: {}
name: projects/1234567/patchJobs/23b0815e-1c94-4dc6-91b1-30a6da395cb9
patchConfig: {}
percentComplete: 100.0
state: COMPLETED_WITH_ERRORS
updateTime: '2019-11-06T19:40:08.641Z'

Dans l'API, envoyez une requête GET à la méthode patchJobs.get.

GET https://osconfig.googleapis.com/v1/projects/project-id/patchJobs/patch-job-id

Remplacez l'élément suivant :

  • project-id : ID de votre projet
  • patch-job-id : ID de votre job d'application de correctifs.

Annuler des jobs d'application de correctifs

Lors de l'annulation d'un job d'application de correctif, l'agent OS Config termine la sous-tâche active, mais ne se poursuit pas. La sous-tâche fait référence à une tâche exécutée par l'agent qui ne peut pas être facilement arrêtée.

Par exemple, si le job d'application de correctif est annulé pendant le redémarrage de l'instance de VM, le redémarrage (et tout correctif automatique potentiel après le redémarrage) s'exécute toujours, mais l'agent ne lance pas de tâches supplémentaires pour ce job d'application de correctif.

Console gcloud REST
  1. Dans la console Google Cloud, accédez à la page Compute Engine > VM Manager > Patch.

    Accéder à la page "Correction"

    1. Sélectionnez l'onglet Jobs d'application de correctifs.
    2. Développez le menu Actions pour le job d'application de correctif que vous souhaitez annuler.
    3. Sélectionnez Annuler.

Utilisez la commande os-config patch-jobs cancel pour annuler un job d'application de correctif. Remplacez patch-job-id par l'ID de votre job d'application de correctifs.

gcloud compute os-config patch-jobs cancel patch-job-id

Dans l'API, envoyez une requête POST à la méthode patchJobs.cancel.

POST https://osconfig.googleapis.com/v1/projects/project-id/patchJobs/patch-job-id:cancel

Remplacez l'élément suivant :

  • project-id : ID de votre projet
  • patch-job-id : ID de votre job d'application de correctifs.

Étape suivante