Afficher, modifier et supprimer des outils d'orchestration des règles

Cette page explique comment afficher et supprimer des orchestrateurs de règles dans vos dossiers ou votre organisation.

Avant de commencer

  • Consultez les pages Règle d'OS et attribution de règles d'OS.
  • Consultez les quotas d'OS Config.
  • Assurez-vous de remplir les conditions préalables pour utiliser l'orchestrateur de règles.
  • 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 services et aux API Google Cloud. 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:

    Console

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

    gcloud

    1. Install the Google Cloud CLI, then initialize it by running the following command: 

      gcloud init
    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.

        Install the Google Cloud CLI, then initialize it by running the following command: 

        gcloud init

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

Répertorier tous les orchestrateurs de règles d'un dossier

Pour afficher tous les orchestrateurs de règles d'un dossier, procédez comme suit:

Console

Pour répertorier les orchestrateurs de règles dans un dossier, procédez comme suit:

  1. Dans la console Google Cloud, accédez à la page Règles d'OS.

    Accéder aux règles d'OS

  2. Cliquez sur le sélecteur de projet dans la barre d'action de la console Google Cloud, puis sélectionnez le dossier dans lequel vous souhaitez créer l'orchestrateur de règles.

  3. Cliquez sur Orchestrateurs de règles.

gcloud

Pour afficher les détails d'un orchestrateur de règles créé dans un dossier, exécutez la commande beta os-config policy-orchestrators list:

  gcloud --billing-project=QUOTA_PROJECT_ID beta compute os-config policy-orchestrators list \
    --folder=FOLDER_NUMBER \

Remplacez les éléments suivants :

  • QUOTA_PROJECT_ID: ID du projet du quota ou du projet de facturation.
  • FOLDER_NUMBER: ID numérique du dossier dans lequel vous avez créé les orchestrateurs de stratégie.

Exemple

  gcloud beta compute os-config policy-orchestrators list \
    --folder=123456 \

REST

Pour afficher tous les orchestrateurs de règles d'un dossier, envoyez une requête GET à la méthode folders.locations.global.policyOrchestrators.list:

GET https://osconfig.googleapis.com/v2beta/folders/FOLDER_NUMBER/locations/global/policyOrchestrators
-H "x-goog-user-project: QUOTA_PROJECT_ID"

Remplacez FOLDER_NUMBER par l'ID numérique du dossier dans lequel vous avez créé les orchestrateurs de règles.

Afficher les détails d'un outil d'orchestration des stratégies

Pour afficher les détails d'un orchestrateur de règles dans un dossier, procédez comme suit:

Console

Pour afficher un orchestrateur de règles, procédez comme suit:

  1. Dans la console Google Cloud, accédez à la page Règles d'OS.

    Accéder aux règles d'OS

  2. Cliquez sur le sélecteur de projet dans la barre d'action de la console Google Cloud, puis sélectionnez le dossier dans lequel vous souhaitez créer l'orchestrateur de règles.

  3. Cliquez sur Orchestrateurs de règles.

  4. Sélectionnez le nom de l'orchestrateur de règles que vous souhaitez afficher. La page Détails de l'orchestrateur s'ouvre.

  5. Pour afficher les détails des règles d'OS appliquées aux VM, cliquez sur Template OS Policy (Modèle de règle d'OS).

gcloud

Pour afficher les détails d'un orchestrateur de règles créé dans un dossier, exécutez la commande beta os-config policy-orchestrators describe:

gcloud --billing-project=QUOTA_PROJECT_ID beta compute os-config policy-orchestrators describe ORCHESTRATOR_NAME \
  --folder=FOLDER_NUMBER \

Remplacez les éléments suivants :

  • QUOTA_PROJECT_ID: ID du projet du quota ou du projet de facturation.
  • ORCHESTRATOR_NAME: nom de l'orchestrateur de règles.
  • FOLDER_NUMBER: ID numérique du dossier dans lequel vous avez créé l'orchestrateur de stratégie.

Exemple

  gcloud --billing-project=my-quota-project beta compute os-config policy-orchestrators describe my-os-policy-orchestrator \
      --folder=123456 \

REST

Pour afficher les détails d'un orchestrateur de stratégie, envoyez une requête GET à la méthode folders.locations.global.policyOrchestrators.get.

GET https://osconfig.googleapis.com/v2beta/folders/FOLDER_NUMBER/locations/global/policyOrchestrators/ORCHESTRATOR_NAME
-H "x-goog-user-project: QUOTA_PROJECT_ID"

Remplacez les éléments suivants :

  • QUOTA_PROJECT_ID: ID du projet du quota ou du projet de facturation.
  • FOLDER_NUMBER: ID numérique du dossier dans lequel se trouve l'orchestrateur de règles.
  • ORCHESTRATOR_NAME: nom de l'orchestrateur de règles que vous souhaitez supprimer.

Le corps de la requête doit être vide.

Modifier un outil d'orchestration des règles

Vous pouvez modifier les outils d'orchestration des règles pour ajouter ou mettre à jour les attributions de règles d'OS, la portée de l'orchestrateur et les ressources.

Console

Pour modifier les paramètres d'un outil d'orchestration des règles, procédez comme suit:

  1. Dans la console Google Cloud, accédez à la page Règles d'OS.

    Accéder aux règles d'OS

  2. Cliquez sur le sélecteur de projet dans la barre d'action de la console Google Cloud, puis sélectionnez le dossier dans lequel vous souhaitez créer l'orchestrateur de règles.

  3. Cliquez sur Orchestrateurs de règles.

  4. Sélectionnez le nom de l'orchestrateur de règles que vous souhaitez modifier. La page Détails de l'orchestrateur s'ouvre.

  5. Cliquez sur Modifier.

  6. Dans la section Règles d'OS, importez le fichier de règle d'OS.

  7. Facultatif: Dans la section État, sélectionnez l'une des options suivantes pour spécifier le comportement de l'orchestrateur de règles:

    • ACTIVE: une fois créé, l'outil d'orchestration des règles prend des mesures immédiatement.
    • STOPPED: un outil d'orchestration des règles est créé dans cet état et n'effectue aucune action immédiatement. Vous pourrez modifier l'orchestrateur de règles ultérieurement pour modifier son état.

  8. Dans la section Champ d'application de l'orchestration, spécifiez les dossiers et les projets dans lesquels vous souhaitez déployer les règles d'OS. Vous ne devez saisir que les numéros de projet et de dossier dans ces champs. Par exemple, 123456, 7654321.

  9. Facultatif: Sélectionnez les zones contenant les VM auxquelles vous souhaitez appliquer les règles d'OS.

  10. Facultatif: dans la section Instances de VM cibles, spécifiez les VM cibles auxquelles vous souhaitez appliquer les règles d'OS.

    • Sélectionnez les familles de systèmes d'exploitation.

    • Vous pouvez filtrer davantage les VM en spécifiant des étiquettes d'inclusion et d'exclusion.

      Par exemple, vous pouvez sélectionner toutes les VM Ubuntu dans votre environnement de test et exclure celles qui exécutent Google Kubernetes Engine, en spécifiant les éléments suivants :

      • Famille d'OS : ubuntu
      • Inclure : env:test, env:staging
      • Exclure : goog-gke-node

  11. Spécifiez un plan de déploiement.

    • Spécifiez la taille de la vague (également appelé budget d'interruption). Exemple : 10%
    • Indiquez le temps d'attente. Par exemple, 15 minutes.

  12. Cliquez sur Enregistrer.

gcloud

Pour mettre à jour un orchestrateur de règles dans un dossier, procédez comme suit:

  1. Utilisez la commande beta os-config policy-orchestrators update pour modifier l'orchestrateur de règles dans un dossier spécifié.

      gcloud --billing-project=QUOTA_PROJECT_ID beta compute os-config policy-orchestrators update ORCHESTRATOR_NAME \
    --folder=FOLDER_NUMBER \
    --state=stopped

    Remplacez les éléments suivants :

    Exemple

      gcloud --billing-project=my-quota-project beta compute os-config policy-orchestrators update my-os-policy-orchestrator \
    --folder=123456 \
    --include-projects=5432134,4567890

REST

Pour mettre à jour un orchestrateur de règles dans un dossier, procédez comme suit et envoyez une requête PATCH à la méthode folders.locations.global.policyOrchestrators.patch.

Dans le corps de la requête, modifiez les spécifications d'attribution des règles de système d'exploitation.

    PATCH https://osconfig.googleapis.com/v2beta/folders/FOLDER_NUMBER/locations/global/policyOrchestrators/ORCHESTRATOR_NAME
    -H "x-goog-user-project: QUOTA_PROJECT_ID"

      {
        JSON_OS_POLICY_ORCHESTRATOR
      }

Remplacez les éléments suivants :

  • QUOTA_PROJECT_ID: ID du projet du quota ou du projet de facturation
  • FOLDER_NUMBER: ID numérique du dossier dans lequel se trouve l'orchestrateur de règles.
  • ORCHESTRATOR_NAME: nom de l'orchestrateur de stratégie que vous souhaitez modifier.
  • JSON_OS_POLICY_ORCHESTRATOR: objet de l'orchestrateur de règles au format JSON qui définit la portée de l'orchestrateur, la ressource orchestrée et l'état d'orchestration. Pour plus d'informations sur les paramètres et le format, consultez la page Resource: folders.locations.global.policyOrchestrators.

Supprimer un outil d'orchestration des règles

Pour supprimer un orchestrateur de règles et annuler tous les déploiements en cours, procédez comme suit:

Console

Pour supprimer un outil d'orchestration des règles, procédez comme suit:

  1. Dans la console Google Cloud, accédez à la page Règles d'OS.

    Accéder aux règles d'OS

  2. Cliquez sur le sélecteur de projet dans la barre d'action de la console Google Cloud, puis sélectionnez le dossier à partir duquel vous souhaitez créer l'orchestrateur de règles.

  3. Cliquez sur Orchestrateurs de règles.

  4. Sélectionnez le nom de l'orchestrateur de règles que vous souhaitez supprimer. La page Détails de l'orchestrateur s'ouvre.

  5. Cliquez sur Supprimer.

gcloud

Pour supprimer un outil d'orchestration des règles d'un dossier, procédez comme suit:

  1. Exécutez la commande beta os-config policy-orchestrators delete :

      gcloud --billing-project=QUOTA_PROJECT_IDbeta compute os-config policy-orchestrators delete ORCHESTRATOR_NAME \
    --folder=FOLDER_NUMBER \
    --policy-id=POLICY_ID

    Remplacez les éléments suivants :

    • QUOTA_PROJECT_ID: ID du projet du quota ou du projet de facturation.
    • ORCHESTRATOR_NAME: nom de l'orchestrateur de règles.
    • FOLDER_NUMBER: ID numérique du dossier dans lequel vous avez créé l'orchestrateur de stratégie.
    • POLICY_ID: ID attribué à l'orchestrateur de règles.

    Exemple

      gcloud --billing-project=my-quota-project beta compute os-config policy-orchestrators create my-os-policy-orchestrator \
    --folder=123456 \
    --policy-id=my-policy

REST

Pour supprimer un outil d'orchestration des règles dans un dossier, envoyez une requête DELETE à la méthode folders.locations.global.policyOrchestrators.delete:

DELETE https://osconfig.googleapis.com/v2beta/folders/FOLDER_NUMBER/locations/global/policyOrchestrators/ORCHESTRATOR_NAME
-H "x-goog-user-project: QUOTA_PROJECT_ID"

Remplacez les éléments suivants :

  • QUOTA_PROJECT_ID: ID du projet du quota ou du projet de facturation.
  • FOLDER_NUMBER: ID numérique du dossier dans lequel se trouve l'orchestrateur de règles.
  • ORCHESTRATOR_NAME: nom de l'orchestrateur de règles que vous souhaitez supprimer.

Étape suivante