Questa pagina è stata tradotta dall'API Cloud Translation.

Convalida le app in base ai criteri aziendali in una pipeline CI

Se la tua organizzazione utilizza Policy Controller per gestire i criteri nei vari cluster della versione Google Kubernetes Engine (GKE) Enterprise, puoi convalidare la configurazione del deployment di un'app nella relativa pipeline di integrazione continua (CI). Questo tutorial mostra come ottenere questo risultato. La convalida dell'app è utile se sei uno sviluppatore che crea una pipeline CI per un'app o se sei uno sviluppatore di piattaforme che crea un modello di pipeline CI per più team di app.

I criteri sono una parte importante della sicurezza e della conformità di un'organizzazione. Policy Controller consente all'organizzazione di gestire questi criteri a livello centrale e dichiarativo per tutti i cluster. In qualità di sviluppatore, puoi sfruttare la natura centralizzata e dichiarativa di questi criteri. Puoi utilizzare queste caratteristiche per convalidare la tua app in base a questi criteri il prima possibile nel flusso di lavoro di sviluppo. Conoscere le violazioni dei criteri nella pipeline CI, invece che durante il deployment, presenta due vantaggi principali: ti consente di passare alla sicurezza solo e restringe il ciclo di feedback, riducendo i tempi e i costi necessari per risolvere tali violazioni.

Questo tutorial utilizza Cloud Build come strumento di CI e un repository GitHub di esempio contenente criteri per le dimostrazioni.

Risorse

Questo tutorial utilizza diversi strumenti Kubernetes. Questa sezione spiega cosa sono questi strumenti, in che modo interagiscono tra loro e se è possibile sostituirli con qualcos'altro.

Gli strumenti utilizzati in questo tutorial includono i seguenti:

Policy Controller: si basa sul progetto open source Open Policy Agent - Gatekeeper. Policy Controller applica i criteri relativi agli oggetti creati in un cluster Kubernetes (ad esempio, impedendo l'utilizzo di un'opzione specifica o applicando l'utilizzo di un'etichetta specifica). Questi criteri sono chiamati vincoli. I vincoli sono definiti come risorse personalizzate di Kubernetes. Policy Controller è disponibile come parte della versione Google Kubernetes Engine (GKE) Enterprise, ma per la tua implementazione puoi utilizzare Open Policy Agent - Gatekeeper invece di Policy Controller.
GitHub: in questo tutorial utilizziamo GitHub per ospitare i repository Git: uno per un'app di esempio e uno che contiene i vincoli per Policy Controller. Per semplicità, i due repository sono cartelle diverse in un unico repository Git. In realtà, si tratta di repository diverse. Puoi utilizzare qualsiasi soluzione Git.
Cloud Build: Cloud Build è la soluzione CI di Google Cloud. In questo tutorial lo useremo per eseguire i test di convalida. Sebbene i dettagli dell'implementazione possano variare da un sistema CI all'altro, i concetti descritti in questo tutorial possono essere utilizzati con qualsiasi sistema CI basato su container.
Kustomize: Kustomize è uno strumento di personalizzazione per le configurazioni di Kubernetes. Funziona prendendo le configurazioni "di base" e applicandovi le personalizzazioni. Consente di adottare un approccio DRY (non ripetere) alle configurazioni di Kubernetes. Con Kustomize, puoi mantenere gli elementi comuni a tutti i tuoi ambienti nelle configurazioni di base e creare personalizzazioni in base all'ambiente. In questo tutorial, conserviamo le configurazioni Kustomize nel repository di app e "creiamo" (ad esempio, applichiamo le personalizzazioni) le configurazioni nella pipeline CI. Puoi utilizzare i concetti descritti in questo tutorial con qualsiasi strumento che generi configurazioni Kubernetes pronte per essere applicate a un cluster (ad esempio, il comando helm template).
Kpt: Kpt è uno strumento per creare flussi di lavoro per le configurazioni Kubernetes. Kpt consente di recuperare, visualizzare, personalizzare, aggiornare, convalidare e applicare configurazioni Kubernetes. Poiché funziona con file Git e YAML, è compatibile con la maggior parte degli strumenti esistenti dell'ecosistema Kubernetes. In questo tutorial utilizziamo kpt nella pipeline CI per recuperare i vincoli dal repository anthos-config-management-samples e convalidare le configurazioni di Kubernetes rispetto a questi vincoli.

Pipeline

La pipeline CI utilizzata in questo tutorial è mostrata nel seguente diagramma:

Pipeline CI per Policy Controller

La pipeline viene eseguita in Cloud Build e i comandi vengono eseguiti in una directory contenente una copia del repository dell'app di esempio. La pipeline inizia generando le configurazioni Kubernetes finali con Kustomize. Successivamente, recupera i vincoli in base ai quali eseguire la convalida dal repository anthos-config-management-samples utilizzando kpt. Infine, usa Kpt per convalidare le configurazioni Kubernetes rispetto ai vincoli. Per raggiungere quest'ultimo passaggio, utilizziamo una funzione di configurazione specifica denominata gatekeeper che esegue questa convalida. In questo tutorial attivi la pipeline CI manualmente, ma in realtà la configurerai per essere eseguita dopo un git push nel repository Git.

Obiettivi

Eseguire una pipeline CI per un'app di esempio con Cloud Build.
Osserva che la pipeline non funziona a causa di una violazione delle norme.
Modifica il repository di app di esempio in modo che rispetti le norme.
Esegui di nuovo la pipeline CI.

Costi

Questo tutorial utilizza i seguenti componenti fatturabili di Google Cloud:

Cloud Build
Versione Google Kubernetes Engine (GKE) Enterprise

Per generare una stima dei costi in base all'utilizzo previsto, utilizza il Calcolatore prezzi.

Al termine di questo tutorial, potrai evitare la fatturazione continua eliminando le risorse che hai creato. Per maggiori dettagli, consulta la sezione Pulizia.

Prima di iniziare

Seleziona o crea un progetto Google Cloud. Nella console Google Cloud, vai alla pagina Gestisci risorse:

Vai a Gestisci risorse
Attiva la fatturazione per il progetto.
Per eseguire i comandi elencati in questo tutorial, apri Cloud Shell:

Vai a Cloud Shell
Esegui gcloud config get-value project in Cloud Shell.

Se il comando non restituisce l'ID del progetto appena selezionato, configura Cloud Shell in modo che utilizzi il tuo progetto:
```
gcloud config set project PROJECT_ID
```
Sostituisci PROJECT_ID con l'ID progetto.
In Cloud Shell, abilita l'API Cloud Build richiesta:
```
gcloud services enable cloudbuild.googleapis.com
```

Convalida le configurazioni dell'app di esempio

In questa sezione eseguirai una pipeline CI con Cloud Build per un repository di app di esempio. Questa pipeline convalida la configurazione di Kubernetes disponibile nel repository di app di esempio rispetto ai vincoli disponibili in un repository anthos-config-management-samples.

Per convalidare le configurazioni dell'app:

In Cloud Shell, clona il repository dell'app di esempio:

git clone https://github.com/GoogleCloudPlatform/anthos-config-management-samples.git

Eseguire la pipeline CI con Cloud Build. I log della build vengono visualizzati direttamente in Cloud Shell.

cd anthos-config-management-samples/ci-app/app-repo
gcloud builds submit .

La pipeline che esegui è definita nel file di seguito.

steps:
- id: 'Prepare config'
  # This step builds the final manifests for the app
  # using kustomize and the configuration files
  # available in the repository.
  name: 'gcr.io/google.com/cloudsdktool/cloud-sdk'
  entrypoint: '/bin/sh'
  args: ['-c', 'mkdir hydrated-manifests && kubectl kustomize config/prod > hydrated-manifests/prod.yaml']
- id: 'Download policies'
  # This step fetches the policies from the Anthos Config Management repository
  # and consolidates every resource in a single file.
  name: 'gcr.io/kpt-dev/kpt'
  entrypoint: '/bin/sh'
  args: ['-c', 'kpt pkg get https://github.com/GoogleCloudPlatform/anthos-config-management-samples.git/ci-app/acm-repo/cluster@main constraints
                  && kpt fn source constraints/ hydrated-manifests/ > hydrated-manifests/kpt-manifests.yaml']
- id: 'Validate against policies'
  # This step validates that all resources comply with all policies.
  name: 'gcr.io/kpt-fn/gatekeeper:v0.2'
  args: ['--input', 'hydrated-manifests/kpt-manifests.yaml']

In Policy Controller, i vincoli sono istanze di modelli di vincoli. I modelli di vincolo contengono il codice Rego effettivo utilizzato per implementare il vincolo. La funzione gcr.io/kpt-fn/gatekeeper richiede sia il modello di vincolo sia le definizioni del vincolo per funzionare. Il repository di criteri di esempio contiene entrambi i criteri, ma in realtà possono essere archiviati in posizioni diverse. Usa il comando kpt pkg get in base alle esigenze per scaricare sia i modelli che i vincoli di vincolo.

Questo tutorial utilizza gcr.io/kpt-fn/gatekeeper con Cloud Build per convalidare le risorse, ma puoi usare altre due alternative:

Utilizza la funzione gcr.io/kpt-fn/gatekeeper con kpt:

kpt fn eval hydrated-manifests/kpt-manifests.yaml --image gcr.io/kpt-fn/gatekeeper:v0.2

Utilizza lo strumento a riga di comando gator:

gator test -f hydrated-manifests/kpt-manifests.yaml

Dopo alcuni minuti, osserva che la pipeline ha esito negativo e restituisce il seguente errore:

[...]
Step #2 - "Validate against policies": [error] apps/v1/Deployment/nginx-deployment : Deployment objects should have an 'owner' label indicating who created them.
Step #2 - "Validate against policies": violatedConstraint: deployment-must-have-owner
Finished Step #2 - "Validate against policies"
2022/05/11 18:55:18 Step Step #2 - "Validate against policies" finished
2022/05/11 18:55:19 status changed to "ERROR"
ERROR
ERROR: build step 2 "gcr.io/kpt-fn/gatekeeper:v0.2" failed: exit status 1
2022/05/11 18:55:20 Build finished with ERROR status

Il vincolo che la configurazione sta violando è definito nel file seguente. È una risorsa personalizzata di Kubernetes chiamata K8sRequiredLabels.

apiVersion: constraints.gatekeeper.sh/v1beta1
kind: K8sRequiredLabels
metadata:
  name: deployment-must-have-owner
spec:
  match:
    kinds:
      - apiGroups: ["apps"]
        kinds: ["Deployment"]
  parameters:
    labels:
      - key: "owner"
    message: "Deployment objects should have an 'owner' label indicating who created them."

Per il modello di vincolo corrispondente a questo vincolo, consulta requiredlabels.yaml su GitHub.

Crea autonomamente la configurazione completa di Kubernetes e osserva che l'etichetta owner è effettivamente mancante. Per creare la configurazione:
```
kubectl kustomize config/prod
```

Correggi l'app per renderla conforme alle norme aziendali

In questa sezione, correggerai la violazione delle norme utilizzando Kustomize:

In Cloud Shell, aggiungi una sezione commonLabels al file Kustomization di base:

cat <<EOF >> config/base/kustomization.yaml
commonLabels:
  owner: myself
EOF

Crea la configurazione completa di Kubernetes e osserva che ora è presente l'etichetta owner:
```
kubectl kustomize config/prod
```

Esegui di nuovo la pipeline CI con Cloud Build:

gcloud builds submit .

La pipeline ora riesce con il seguente output:

[...]
Step #2 - "Validate against policies": [RUNNING] "gcr.io/kpt-fn/gatekeeper:v0"
Step #2 - "Validate against policies": [PASS] "gcr.io/kpt-fn/gatekeeper:v0"
[...]

Esegui la pulizia

Attenzione: l'eliminazione di un progetto ha i seguenti effetti:

L'intero contenuto del progetto viene eliminato. Se hai utilizzato un progetto esistente per le attività in questo documento, quando lo elimini elimini anche qualsiasi altro lavoro svolto nel progetto.
Gli ID progetto personalizzati non sono più disponibili. Quando hai creato questo progetto, potresti aver creato un ID progetto personalizzato che vuoi utilizzare in futuro. Per conservare gli URL che utilizzano l'ID progetto, ad esempio un URL appspot.com, elimina le risorse selezionate all'interno del progetto anziché eliminare l'intero progetto.

Se intendi esplorare più architetture, tutorial o guide rapide, puoi riutilizzare i progetti ed evitare così di superare i limiti di quota.

Nella console Google Cloud, vai alla pagina Gestisci risorse.
Vai a Gestisci risorse
Nell'elenco dei progetti, seleziona il progetto che vuoi eliminare, quindi fai clic su Elimina.
Nella finestra di dialogo, digita l'ID del progetto e fai clic su Chiudi per eliminare il progetto.

Passaggi successivi

Per altre architetture di riferimento, diagrammi e best practice, esplora il Cloud Architecture Center.