Crea un'assegnazione dei criteri del sistema operativo

Utilizza i criteri del sistema operativo per mantenere configurazioni software coerenti nelle istanze di macchine virtuali (VM) Linux e Windows.

Prima di iniziare

• Esamina i criteri del sistema operativo e l'assegnazione dei criteri.
• Esamina le quote di OS Config.
• Se non l'hai ancora fatto, configura l'autenticazione. L'autenticazione è la procedura mediante la quale la tua identità viene verificata per l'accesso alle API e ai servizi Google Cloud. Per eseguire codice o esempi da un ambiente di sviluppo locale, puoi autenticarti su Compute Engine selezionando una delle seguenti opzioni:
  

  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.

  Terraform

  Per utilizzare gli esempi di Terraform in questa pagina in un ambiente di sviluppo locale, installa e inizializza gcloud CLI, quindi configura le Credenziali predefinite dell'applicazione con le tue credenziali utente.

  1. Install the Google Cloud CLI.

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

     gcloud init

  3. If you're using a local shell, then create local authentication credentials for your user account:

     gcloud auth application-default login

     You don't need to do this if you're using Cloud Shell.

  Per ulteriori informazioni, consulta Set up authentication for a local development environment.

  REST

  Per utilizzare gli esempi dell'API REST in questa pagina in un ambiente di sviluppo locale, utilizza le credenziali fornite a gcloud CLI.

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

  gcloud init

  Per ulteriori informazioni, consulta Eseguire l'autenticazione per l'utilizzo di REST nella documentazione sull'autenticazione di Google Cloud.

Sistemi operativi supportati

Per un elenco completo dei sistemi operativi e delle versioni che supportano i criteri del sistema operativo, consulta Dettagli del sistema operativo.

Autorizzazioni

Poiché puoi utilizzare i criteri del sistema operativo per installare e gestire i pacchetti software su una VM, la creazione e la gestione dei criteri del sistema operativo equivale a concedere l'accesso all'esecuzione di codice remoto su una VM. Quando configuri i criteri del sistema operativo, le autorizzazioni IAM vengono utilizzate per controllare l'accesso alle risorse dei criteri e le attività vengono registrate nei log di controllo.

I proprietari di un progetto hanno accesso completo per creare e gestire le assegnazioni dei criteri del sistema operativo. Per tutti gli altri utenti, devi concedere le autorizzazioni. Puoi concedere uno dei seguenti ruoli granulari:

• OSPolicyAssignment Admin (roles/osconfig.osPolicyAssignmentAdmin). Contiene le autorizzazioni per creare, eliminare, aggiornare, recuperare ed elencare le assegnazioni dei criteri del sistema operativo.
• Editor OSPolicyAssignment (roles/osconfig.osPolicyAssignmentEditor). Contiene le autorizzazioni per aggiornare, recuperare ed elencare le assegnazioni dei criteri del sistema operativo.
• Visualizzatore delle assegnazioni dei criteri del sistema operativo (roles/osconfig.osPolicyAssignmentViewer). Contiene le autorizzazioni per l'accesso di sola lettura per ottenere e elencare le assegnazioni dei criteri del sistema operativo.

    gcloud projects add-iam-policy-binding PROJECT_ID \
        --member user:USER_ID@gmail.com \
        --role roles/osconfig.osPolicyAssignmentAdmin

Crea un'assegnazione dei criteri del sistema operativo

Per creare ed eseguire il deployment di un'assegnazione dei criteri del sistema operativo, completa i seguenti passaggi:

1. Configura VM Manager.
2. Assegna le autorizzazioni richieste agli utenti.
3. Consulta la sezione Criteri del sistema operativo e assegnazione dei criteri.
4. Crea le risorse dei criteri del sistema operativo.

5. Per creare e implementare l'assegnazione dei criteri del sistema operativo, utilizza uno dei seguenti metodi:

   Console

   Per creare ed eseguire il deployment di un'assegnazione dei criteri del sistema operativo, completa i seguenti passaggi:

   1. Sul client locale, crea o scarica un criterio del sistema operativo. Deve essere un file JSON o YAML. Per ulteriori informazioni sulla creazione di criteri del sistema operativo o per visualizzare criteri del sistema operativo di esempio, consulta Criteri del sistema operativo.

   2. Nella console Google Cloud, vai alla pagina Norme del sistema operativo.

      Vai ai criteri del sistema operativo

   3. Fai clic su Crea assegnazione criterio del sistema operativo.

   4. Nella sezione ID assegnazione, fornisci un nome per l'assegnazione del criterio OS. Consulta Convenzione di denominazione delle risorse.

   5. Nella sezione Criteri del sistema operativo, carica il file dei criteri del sistema operativo.

   6. Nella sezione Istanze VM di destinazione, specifica le VM di destinazione.

      • Seleziona la zona contenente le VM a cui vuoi applicare il criterio.
      • Seleziona le famiglie di sistemi operativi.
      • (Facoltativo) Puoi filtrare ulteriormente le VM specificando le etichette di inclusione e esclusione.

      Ad esempio, puoi selezionare tutte le VM Ubuntu nel tuo ambiente di test ed escludere quelle su cui è in esecuzione Google Kubernetes Engine specificando quanto segue:

      • Famiglia di sistemi operativi: ubuntu
      • Sono inclusi: env:test, env:staging
      • Escludi: goog-gke-node

      

   7. Specifica un piano di implementazione.

      • Specifica la dimensione dell'ondata (detta anche budget di interruzione). Ad esempio, 10%.
      • Specifica il tempo di attesa. Ad esempio, 15 minuti.

        

   8. Fai clic su Avvia implementazione.

   gcloud

   Per creare e implementare un'assegnazione dei criteri del sistema operativo in una zona, completa i seguenti passaggi:

   1. Crea una risorsa di assegnazione dei criteri del sistema operativo in formato JSON o YAML. Questo file definisce i criteri del sistema operativo da applicare alle VM, le VM target a cui applicare i criteri e la frequenza di implementazione a cui applicare i criteri del sistema operativo. Per ulteriori informazioni su questo file e sugli esempi di assegnazione, consulta Assegnazione dei criteri del sistema operativo.

   2. Utilizza il comando os-config os-policy-assignments create per creare e implementare l'assegnazione del criterio del sistema operativo in una posizione specificata.

      gcloud compute os-config os-policy-assignments create OS_POLICY_ASSIGNMENT_ID \
         --location=ZONE \
         --file=OS_POLICY_ASSIGNMENT_FILE \
         --async
      

      Sostituisci quanto segue:

      • OS_POLICY_ASSIGNMENT_ID: il nome dell'assegnazione del criterio del sistema operativo. Consulta la Convenzione di denominazione delle risorse.
      • ZONE: la zona in cui creare l'assegnazione dei criteri del sistema operativo.
      • OS_POLICY_ASSIGNMENT_FILE: il percorso assoluto del file di assegnazione dei criteri del sistema operativo che hai creato nel passaggio precedente.

      Esempio

      gcloud compute os-config os-policy-assignments create my-os-policy-assignment \
          --location=asia-south1-a \
          --file=/downloads/assignment-config.yaml \
          --async
      

      L'output è simile al seguente:

      Create request issued for: [my-os-policy-assignment]
      Check operation [projects/384123488288/locations/asia-south1-a/osPolicyAssignments/my-os-policy-assignment/operations/fb2011d6-61de-46f1-afdb-bc96bdb3fbaa] for status.
      

   3. Prendi nota del nome risorsa completo per l'operazione. Nell'esempio precedente, il nome risorsa completo è:

      projects/384123488288/locations/asia-south1-a/osPolicyAssignments/my-os-policy-assignment/operations/fb2011d6-61de-46f1-afdb-bc96bdb3fbaa
      

      Puoi utilizzare questo nome completo della risorsa per ottenere i dettagli di un'implementazione o per annullarla. Consulta la sezione Implementazioni.

   Terraform

   Per creare un'assegnazione dei criteri del sistema operativo, utilizza la google_os_config_os_policy_assignment risorsa.

   L'esempio seguente verifica se il server web Apache è in esecuzione sulle VM CentOS.

   resource "google_os_config_os_policy_assignment" "my_os_policy_assignment" {
   
     name        = "my-os-policy-assignment"
     location    = "us-west1-a"
     description = "An OS policy assignment that verifies if the Apache web server is running on CentOS VMs."
   
     instance_filter {
       # filter to select VMs
       all = false
   
       exclusion_labels {
         labels = {
           label-one = "goog-gke-node"
         }
       }
   
       inclusion_labels {
         labels = {
           env = "test",
         }
       }
   
       inventories {
         os_short_name = "centos"
         os_version    = "7*"
       }
     }
   
     os_policies {
       #list of OS policies to be applied to VMs
       id   = "apache-always-up-policy"
       mode = "ENFORCEMENT"
   
       resource_groups { #list of resource groups for the policy
         resources {
           id = "ensure-apache-is-up"
   
           exec {
             validate {
               interpreter = "SHELL"
               script      = "if systemctl is-active --quiet httpd; then exit 100; else exit 101; fi"
             }
   
             enforce {
               interpreter = "SHELL"
               script      = "systemctl start httpd && exit 100"
             }
           }
         }
   
         inventory_filters {
           os_short_name = "centos"
           os_version    = "7*"
         }
       }
   
       allow_no_resource_group_match = false #OS policy compliance status
       description                   = "An OS policy that verifies if the Apache web server is running on Linux VMs."
     }
   
     rollout {
       #define rollout parameters
       disruption_budget {
         fixed = 1
       }
       min_wait_duration = "3.5s"
     }
   }

   Per scoprire come applicare o rimuovere una configurazione Terraform, consulta Comandi Terraform di base.

   REST

   Per creare un'assegnazione dei criteri del sistema operativo sul client locale, completa i seguenti passaggi:

   1. Crea un'assegnazione dei criteri del sistema operativo. Deve essere un file JSON. Per maggiori informazioni sulla creazione di assegnazioni dei criteri del sistema operativo o per visualizzarne di di esempio, consulta Assegnazione dei criteri del sistema operativo.

      Se vuoi utilizzare l'assegnazione dei criteri relativi al sistema operativo YAML di esempio, devi convertirla in JSON.

   2. Nell'API, crea una richiesta POST al metodo projects.locations.osPolicyAssignments.create.

      Nel corpo della richiesta, incolla le specifiche di assegnazione dei criteri del sistema operativo del passaggio precedente.

      POST https://osconfig.googleapis.com/v1/projects/PROJECT_ID/locations/ZONE/OSPolicyAssignments?osPolicyAssignmentId=OS_POLICY_ASSIGNMENT_ID
      
      {
       JSON_OS_POLICY
      }
      

      Sostituisci quanto segue:

      • PROJECT_ID: il tuo ID progetto
      • OS_POLICY_ASSIGNMENT_ID: nome dell'assegnazione del criterio del sistema operativo
      • JSON_OS_POLICY: le specifiche dell'assegnazione dei criteri del sistema operativo create nel passaggio precedente. Deve essere in formato JSON. Per ulteriori informazioni sui parametri e sul formato, consulta Resource: OSPolicyAssignment.
      • ZONE: la zona in cui creare l'assegnazione dei criteri del sistema operativo

      Esempio

      Ad esempio, per creare un'assegnazione dei criteri del sistema operativo per l'osservabilità di Google Cloud che installa agenti di monitoraggio e registrazione sulle VM selezionate utilizzando l'assegnazione dei criteri del sistema operativo di esempio, completa i seguenti passaggi:

      1. Converti l'esempio in JSON
      2. Effettua la seguente richiesta:

      POST https://osconfig.googleapis.com/v1/projects/PROJECT_ID/locations/ZONE/OSPolicyAssignments?osPolicyAssignmentId=OS_POLICY_ASSIGNMENT_ID
      
      {
        "osPolicies": [
          {
            "id": "setup-repo-and-install-package-policy",
            "mode": "ENFORCEMENT",
            "resourceGroups": [
              {
                "resources": [
                  {
                    "id": "setup-repo",
                    "repository": {
                      "yum": {
                        "id": "google-cloud-monitoring",
                        "displayName": "Google Cloud Monitoring Agent Repository",
                        "baseUrl": "https://packages.cloud.google.com/yum/repos/google-cloud-monitoring-el8-x86_64-all",
                        "gpgKeys": [
                          "https://packages.cloud.google.com/yum/doc/yum-key.gpg",
                          "https://packages.cloud.google.com/yum/doc/rpm-package-key.gpg"
                        ]
                      }
                    }
                  },
                  {
                    "id": "install-pkg",
                    "pkg": {
                      "desiredState": "INSTALLED",
                      "yum": {
                        "name": "stackdriver-agent"
                      }
                    }
                  }
                ]
              }
            ]
          }
        ],
        "instanceFilter": {
          "inclusionLabels": [
            {
              "labels": {
                "used_for": "testing"
              }
            }
          ]
        },
        "rollout": {
          "disruptionBudget": {
            "fixed": 10
          },
          "minWaitDuration": {
            "seconds": 300
          }
        }
      }
      

Implementazioni

Le assegnazioni dei criteri del sistema operativo vengono implementate in base a una frequenza di implementazione. Ciò significa che le assegnazioni che hanno come target un insieme di VM possono essere implementate gradualmente e non vengono applicate immediatamente a tutte le VM. Le modifiche vengono implementate gradualmente per darti la possibilità di intervenire e annullare un'implementazione se le nuove modifiche causano regressioni.

Quando le chiamate ai metodi di un'API potrebbero richiedere molto tempo per essere completate, l'API restituisce un'operazione a lunga esecuzione (LRO). Per ulteriori informazioni sulle operazioni a lungo termine, consulta Operazioni a lungo termine.

L'API OS Config crea un LRO ogni volta che crei, aggiorni o elimini un'assegnazione di criteri del sistema operativo. Ogni LRO restituisce una risorsa dell'operazione. Questa risorsa dell'operazione è simile alla seguente:

Create request issued for: [my-os-policy-assignment]
Check operation [projects/384123488288/locations/asia-south1-a/osPolicyAssignments/my-os-policy-assignment/operations/fb2011d6-61de-46f1-afdb-bc96bdb3fbaa] for status.

Ogni operazione di creazione, aggiornamento o eliminazione genera anche una nuova revisione dell'assegnazione dei criteri del sistema operativo. Per visualizzare le revisioni di un'assegnazione dei criteri del sistema operativo, consulta Elenca le revisioni dell'assegnazione dei criteri del sistema operativo.

Puoi utilizzare Google Cloud CLI per ottenere i dettagli di un rollout o per annullarlo.

Visualizzare i dettagli di un'implementazione

Per ottenere i dettagli di un'implementazione, utilizza il comando os-config os-policy-assignments operations describe.

gcloud compute os-config os-policy-assignments operations describe FULLY_QUALIFIED_OPERATION_NAME

Sostituisci FULLY_QUALIFIED_OPERATION_NAME con il nome della risorsa completa per l'operazione restituita dall'operazione di creazione, aggiornamento o eliminazione.

Esempio

gcloud compute os-config os-policy-assignments operations describe \
    projects/384123488288/locations/asia-south1-a/osPolicyAssignments/my-os-policy-assignment/operations/fb2011d6-61de-46f1-afdb-bc96bdb3fbaa

done: true
metadata:
  '@type': type.googleapis.com/google.cloud.osconfig.$$api-version$$.OSPolicyAssignmentOperationMetadata
  apiMethod: CREATE
  osPolicyAssignment: projects/3841234882888/locations/asia-south1-a/osPolicyAssignments/my-os-policy-assignment@cfb78790-41d8-40d1-b8a1-1eaf6011b909
  rolloutStartTime: '2021-04-15T00:53:52.963569Z'
  rolloutState: SUCCEEDED
  rolloutUpdateTime: '2021-04-15T00:53:53.094041Z'
name: projects/3841234882888/locations/asia-south1-a/osPolicyAssignments/my-os-policy-assignment/operations/cfb78790-41d8-40d1-b8a1-1eaf6011b909
response:
  '@type': type.googleapis.com/google.cloud.osconfig.$$api-version$$.OSPolicyAssignment
  baseline: true
  description: My test policy
  instanceFilter:
    inclusionLabels:
    - labels:
        label-key-not-targeting-instances: label-value-not-targeting-instances
  name: projects/3841234882888/locations/asia-south1-a/osPolicyAssignments/my-os-policy-assignment
  osPolicies:
  - id: q-test-policy
    mode: ENFORCEMENT
    resourceGroups:
    - osFilter:
        osShortName: centos
        osVersion: '7'
      resources:
      - id: add-repo
        repository:
          yum:
            baseUrl: https://packages.cloud.google.com/yum/repos/google-cloud-ops-agent-el7-x86_64-all

Annullare un'implementazione

gcloud compute os-config os-policy-assignments operations cancel FULLY_QUALIFIED_OPERATION_NAME

gcloud compute os-config os-policy-assignments operations cancel \
    projects/384123488288/locations/asia-south1-a/osPolicyAssignments/my-os-policy-assignment/operations/fb2011d6-61de-46f1-afdb-bc96bdb3fbaa

Passaggi successivi

• Scopri di più sui criteri del sistema operativo.
• Gestisci le assegnazioni dei criteri del sistema operativo.