Configurare un criterio utilizzando l'API REST

Questa pagina fornisce istruzioni per configurare un criterio di Autorizzazione binaria utilizzando l'API REST. In alternativa, puoi eseguire queste attività anche utilizzando Google Cloud CLI o la console Google Cloud. Questo passaggio fa parte della configurazione di Autorizzazione binaria.

Panoramica

Un criterio è un insieme di regole che regolano il deployment di una o più immagini container.

Quando configuri un criterio utilizzando l'API REST, inserisci i valori in un formato JSON la cui struttura è identica alla struttura YAML utilizzata nelle interazioni di gcloud con il servizio. Per ulteriori informazioni, consulta la pagina di riferimento sui criteri YAML.

Per configurare un criterio è necessario:

  • Esporta un file JSON dei criteri
  • Aggiungi altre immagini esenti (facoltativo)
  • Impostare la regola predefinita
  • Aggiungi eventuali regole specifiche per il cluster (facoltativo)
  • Importa il file JSON dei criteri

La maggior parte dei criteri reali controlla se tutti gli attetori richiesti hanno verificato che un'immagine container è pronta per il deployment. In questo caso, devi anche creare attestatori quando configuri il criterio.

Imposta il progetto predefinito

Imposta il progetto Google Cloud predefinito se non lo hai già fatto:

PROJECT_ID=PROJECT_ID
gcloud config set project ${PROJECT_ID}

dove PROJECT_ID è l'ID del tuo progetto.

Esporta il criterio

Questa sezione riguarda GKE, cluster GKE, Cloud Run e Cloud Service Mesh.

Esporta il criterio in un file JSON sul tuo sistema locale:

curl \
    -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
    -H "x-goog-user-project: ${PROJECT_ID}" \
    "https://binaryauthorization.googleapis.com/v1/projects/${PROJECT_ID}/policy" \
    -o "/tmp/policy.json"

Per impostazione predefinita, il file ha i seguenti contenuti:

{
  "name": "projects/PROJECT_ID/policy",
  "globalPolicyEvaluationMode": "ENABLE",
  "defaultAdmissionRule": {
    "evaluationMode": "ALWAYS_ALLOW",
    "enforcementMode": "ENFORCED_BLOCK_AND_AUDIT_LOG"
  }
}

Gestisci immagini esenti

Questa sezione riguarda GKE, cluster GKE, Cloud Run e Cloud Service Mesh.

Un'immagine esente è un'immagine container esente dalle regole dei criteri. Autorizzazione binaria consente sempre il deployment di immagini esenti.

Puoi specificare le immagini esenti elencando i relativi percorsi del registro in admissionWhitelistPatterns. Il percorso può fare riferimento a Container Registry o a un altro registro di immagini. L'applicatore elabora le immagini esenti in admissionWhitelistPatterns dopo quelle esenti dalla modalità di valutazione dei criteri di sistema.

Per aggiungere un'immagine esente, aggiungi un nodo namePattern in un elenco admissionWhitelistPatterns nel file JSON del criterio:

{
  "name": "projects/PROJECT_ID/policy",
  "admissionWhitelistPatterns": [
    {
      "namePattern": "MATCHING_PATTERN"
    }
  ],
  ...
}

dove MATCHING_PATTERN è il percorso di una singola immagine nel registro per corrispondenza esatta o di qualsiasi immagine corrispondente a un pattern utilizzando il simbolo del carattere jolly (*, **).

Cloud Run

Questa sezione riguarda Cloud Run.

Non puoi specificare direttamente i nomi delle immagini che contengono un tag. Ad esempio, non puoi specificare IMAGE_PATH:latest.

Se vuoi indicare nomi immagine che contengono tag, devi specificare il nome utilizzando un carattere jolly, come segue:

  • * per tutte le versioni di una singola immagine, ad esempio us-docker.pkg.dev/myproject/container/hello@*
  • ** per tutte le immagini in un progetto; ad esempio, us-docker.pkg.dev/myproject/**

Puoi utilizzare i nomi dei percorsi per specificare un digest nel formato IMAGE_PATH@DIGEST.

Modalità di valutazione dei criteri di sistema

Questa sezione riguarda i cluster GKE e GKE.

La modalità di valutazione dei criteri di sistema è un'impostazione di un criterio che fa sì che Autorizzazione binaria valuti un criterio di sistema prima di valutare il criterio configurato. Google gestisce il criterio di sistema, che esclude un elenco di immagini di sistema gestite da Google utilizzate da GKE. Le immagini elencate nel criterio di sistema non vengono bloccate dall'applicazione dei criteri. Se non abiliti l'impostazione, devi gestire autonomamente l'elenco delle immagini esenti. Scopri come gestire le immagini esenti.

Puoi visualizzare i contenuti del criterio di sistema utilizzando il seguente comando:

gcloud alpha container binauthz policy export-system-policy

Per abilitare la modalità di valutazione dei criteri di sistema, aggiungi il seguente nodo di primo livello al file JSON dei criteri:

"globalPolicyEvaluationMode": "ENABLE"

Per disabilitare la modalità di valutazione dei criteri di sistema, aggiungi quanto segue:

"globalPolicyEvaluationMode": "DISABLE"

Puoi esportare il criterio di sistema associato a una regione specifica, come segue:

gcloud alpha container binauthz policy export-system-policy \
  --location=REGION > /tmp/policy.yaml

Sostituisci REGION con la regione associata al criterio di sistema che vuoi esportare (o "globale"). Alcuni esempi sono: asia-east1, europe-west1 e us-central1.

Se ometti --location o specifichi --location=global, il comando restituisce un criterio di sistema da una regione nell'ultimo gruppo di regioni per ricevere gli aggiornamenti. Poiché la maggior parte delle modifiche al criterio di sistema sono aggiunte, l'output mostra l'insieme di immagini di sistema attualmente consentite in tutte le regioni.

Impostare la regola predefinita

Questa sezione riguarda GKE, cluster GKE, Cloud Run e Cloud Service Mesh.

Una regola è la parte di un criterio che definisce i vincoli che le immagini container devono passare prima di poterne eseguire il deployment. A ogni richiesta di ammissione è associato un cluster GKE. Se una richiesta non corrisponde a una regola specifica per il cluster, viene utilizzata la regola predefinita.

La regola predefinita è definita nel nodo defaultAdmissionRule del criterio. Per ulteriori informazioni sulle parti di questa regola, consulta ADMISSION_RULE nel riferimento YAML dei criteri. Per esempi di regole predefinite, consulta Esempi di criteri.

Per impostare la regola predefinita, modifica il nodo defaultAdmissionRule nel file JSON del criterio come richiesto:

  "defaultAdmissionRule": {
    "evaluationMode": "EVAL_MODE",
    "enforcementMode": "ENFORCEMENT_MODE"
    requireAttestationsBy: [
      ATTESTOR,
      ...
    ]
  }

dove:

  • EVAL_MODE specifica il tipo di vincolo valutato da Autorizzazione binaria prima di consentire il deployment di un'immagine container.
  • ENFORCEMENT_MODE specifica l'azione intrapresa se un'immagine container non è conforme ai vincoli definiti nella regola.
  • ATTESTOR specifica gli attestatori (se richiesti) che devono firmare un'immagine container prima di poterne eseguire il deployment. Utilizza il percorso completo per l'attestatore nel formato projects/PROJECT_ID/attestors/ATTESTOR_NAME.

Se la regola verifica se tutti gli attestatori richiesti hanno firmato un'immagine container, devi creare attestatori prima di completare questo passaggio.

Imposta regole specifiche per il cluster (facoltativo)

Questa sezione riguarda i cluster GKE e GKE.

Un cluster può anche avere una o più regole specifiche del cluster. Questo tipo di regola si applica solo al cluster GKE specificato. Se un cluster non ha regole proprie, viene utilizzata la regola predefinita. Le regole specifiche per i cluster sono una parte facoltativa di un criterio.

Le regole specifiche per il cluster sono definite nei nodi clusterAdmissionRules nel file JSON dei criteri. Per ulteriori informazioni sulle parti di questa regola, consulta ADMISSION_RULE nel riferimento YAML dei criteri. Ad esempio, vedi Utilizzare una regola specifica per il cluster in Criteri di esempio.

Per aggiungere una regola specifica per il cluster:

Aggiungi un nodo clusterAdmissionRules nel file JSON del criterio:

"clusterAdmissionRules": {
    "us-central1-a.test-cluster": {
      "evaluationMode": "REQUIRE_ATTESTATION",
      "requireAttestationsBy": [
        "ATTESTOR",
        ...
      ],
      "enforcementMode": "ENFORCED_BLOCK_AND_AUDIT_LOG"
    }
  },

dove CLUSTER_SPECIFIER è l'ID risorsa del cluster a cui si applica la regola.

  • Per GKE, i cluster collegati a GKE e GKE su AWS, il formato è CLUSTER_LOCATION.CLUSTER_NAME, ad esempio us-central1-a.test-cluster.
  • Per GKE on Bare Metal e GKE on VMware, il formato è FLEET_MEMBERSHIP_LOCATION.FLEET_MEMBERSHIP_ID, ad esempio global.test-membership.

Le altre proprietà sono descritte nella sezione Impostare la regola predefinita, precedente in questa guida. Consulta Criteri di esempio per un esempio di regola specifica per il cluster.

Se la regola verifica se tutti gli attestatori richiesti hanno firmato un'immagine container, devi creare attestatori prima di completare questo passaggio.

Importa il file JSON dei criteri

Questa sezione riguarda GKE, cluster GKE, Cloud Run e Cloud Service Mesh.

Importa di nuovo il file JSON del criterio in Autorizzazione binaria inserendo quanto segue:

curl -X PUT \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
    -H "x-goog-user-project: ${PROJECT_ID}" \
    --data-binary @/tmp/policy.json  \
    "https://binaryauthorization.googleapis.com/v1/projects/${PROJECT_ID}/policy"

Passaggi successivi