Scrivi un modello di vincolo personalizzato

Questa pagina mostra come scrivere un modello di vincolo personalizzato e utilizzarlo per estendere Policy Controller se non riesci a trovare un modello di vincolo precompilato adatto alle tue esigenze.

I criteri di Policy Controller sono descritti utilizzando il framework dei vincoli OPA e sono scritti in Rego. Un criterio può valutare qualsiasi campo di un oggetto Kubernetes.

La scrittura di norme con Rego è una competenza specializzata. Per questo motivo, per impostazione predefinita viene installata una libreria di modelli di vincolo comuni. Probabilmente puoi richiamare questi modelli di vincolo durante la creazione dei vincoli. Se hai esigenze specifiche, puoi creare i tuoi modelli di vincolo.

I modelli di vincolo consentono di separare la logica di un criterio dai relativi requisiti specifici per il riutilizzo e la delega. Puoi creare vincoli utilizzando modelli di vincoli sviluppati da terze parti, ad esempio progetti open source, fornitori di software o esperti di regolamentazione.

Prima di iniziare

Installa Policy Controller.

Esempio di modello di vincolo

Di seguito è riportato un modello di vincolo di esempio che nega tutte le risorse il cui nome corrisponde a un valore fornito dall'autore del vincolo. Il resto della pagina esamina i contenuti del modello, evidenziando i concetti importanti nel corso della pagina.

Se utilizzi un repository strutturato, ti consigliamo di creare i vincoli nella directory cluster/.

apiVersion: templates.gatekeeper.sh/v1beta1
kind: ConstraintTemplate
metadata:
  name: k8sdenyname
spec:
  crd:
    spec:
      names:
        kind: K8sDenyName
      validation:
        # Schema for the `parameters` field
        openAPIV3Schema:
          properties:
            invalidName:
              type: string
  targets:
    - target: admission.k8s.gatekeeper.sh
      rego: |
        package k8sdenynames
        violation[{"msg": msg}] {
          input.review.object.metadata.name == input.parameters.invalidName
          msg := sprintf("The name %v is not allowed", [input.parameters.invalidName])
        }

Vincolo di esempio

Di seguito è riportato un vincolo di esempio che potresti implementare per negare tutte le risorse denominate policy-violation:

apiVersion: constraints.gatekeeper.sh/v1beta1
kind: K8sDenyName
metadata:
  name: no-policy-violation
spec:
  parameters:
    invalidName: "policy-violation"

Parti di un modello di vincolo

I modelli di vincolo sono costituiti da due parti importanti:

Lo schema del vincolo che vuoi che gli utenti creino. Lo schema di un modello di vincolo è archiviato nel campo crd.
Il codice sorgente Rego eseguito al momento della valutazione del vincolo. Il codice sorgente Rego per un modello viene archiviato nel campo targets.

Schema (campo `crd`)

Il campo CRD è un progetto per la creazione della definizione della risorsa personalizzata Kubernetes, che definisce la risorsa vincolo per il server API Kubernetes. Devi solo compilare i seguenti campi.

Campo	Descrizione
`spec.crd.spec.names.kind`	Il tipo del vincolo. Se è in minuscolo, il valore di questo campo deve essere uguale a `metadata.name`.
`spec.crd.spec.validation.openAPIV3Schema`	Schema per il campo `spec.parameters` della risorsa del vincolo (Policy Controller definisce automaticamente il resto dello schema del vincolo). Segue le stesse convenzioni di una normale risorsa CRD.

Il prefisso del modello di vincolo con il nome K8s è una convenzione che consente di evitare collisioni con altri tipi di modelli di vincolo, ad esempio i modelli Forseti che hanno come target le risorse Google Cloud.

Codice sorgente originale (campo `targets`)

Le seguenti sezioni forniscono ulteriori informazioni sul codice sorgente Rego.

Località

Il codice sorgente Rego viene archiviato nel campo spec.targets, dove targets è un array di oggetti del seguente formato:

{"target": "admission.k8s.gatekeeper.sh","rego": REGO_SOURCE_CODE, "libs": LIST_OF_REGO_LIBRARIES}

target: indica a Policy Controller quale sistema stiamo esaminando (in questo caso, Kubernetes); è consentita una sola voce in targets.
rego: il codice sorgente del vincolo.
libs: un elenco facoltativo di librerie di codice Rego reso disponibile per il modello di vincolo; ha lo scopo di semplificare l'utilizzo delle librerie condivise e non rientra nell'ambito di questo documento.

Codice sorgente

Di seguito è riportato il codice sorgente Rego per il vincolo precedente:

package k8sdenynames

violation[{"msg": msg}] {
   input.review.object.metadata.name == input.parameters.invalidName
   msg := sprintf("The name %v is not allowed", [input.parameters.invalidName])
}

Tieni presente quanto segue:

package k8sdenynames è richiesto da OPA (runtime di Rego). Il valore viene ignorato.
La regola di Rego richiamata da Policy Controller per verificare la presenza di violazioni si chiama violation. Se questa regola ha corrispondenze, si è verificata una violazione del vincolo.
La regola violation ha la firma violation[{"msg": "violation message for the user"}], dove il valore di "msg" è il messaggio di violazione che viene restituito all'utente.
I parametri forniti al vincolo sono resi disponibili nella parola chiave input.parameters.
request-under-test viene memorizzato sotto la parola chiave input.review.

La parola chiave input.review ha i seguenti campi.

Campo	Descrizione
`uid`	L'ID univoco per questa richiesta specifica; non è disponibile durante l'audit.
`kind`	Le informazioni relative al tipo per `object-under-test`. Il formato è il seguente: `kind`: il tipo di risorsa `group`: il gruppo di risorse `version`: la versione della risorsa
`name`	Il nome della risorsa. Potrebbe essere vuoto se l'utente si basa sul server API per generare il nome su una richiesta CREATE.
`namespace`	Lo spazio dei nomi della risorsa (non fornito per le risorse con ambito cluster).
`operation`	L'operazione richiesta (ad esempio CREATE o UPDATE); non è disponibile durante il controllo.
`userInfo`	Le informazioni dell'utente che ha inviato la richiesta; non sono disponibili durante il controllo. Ha il seguente formato: `username`: l'utente che effettua la richiesta `uid`: l'UID dell'utente `groups`: un elenco di gruppi di cui l'utente è membro `extra`: qualsiasi informazione aggiuntiva sull'utente fornita da Kubernetes
`object`	L'oggetto che l'utente sta tentando di modificare o creare.
`oldObject`	Lo stato originale dell'oggetto; è disponibile solo per le operazioni di UPDATE.
`dryRun`	Se questa richiesta è stata richiamata con `kubectl --dry-run`; non è disponibile durante il controllo.

Scrivi modelli di vincoli di riferimento

I modelli di vincolo referenziale sono modelli che consentono all'utente di vincolare un oggetto rispetto ad altri oggetti. Un esempio potrebbe essere "non consentire la creazione di un pod prima che sia nota l'esistenza di un Ingress corrispondente". Un altro esempio potrebbe essere "non consentire a due servizi di avere lo stesso nome host".

Policy Controller consente di scrivere vincoli di riferimento osservando il server API per un insieme di risorse fornite dall'utente. Quando una risorsa viene modificata, Policy Controller la memorizza nella cache localmente in modo che possa essere facilmente indicata dal codice sorgente Rego. Policy Controller rende questa cache disponibile sotto la parola chiave data.inventory.

Le risorse con ambito cluster vengono memorizzate nella cache nella seguente posizione:

data.inventory.cluster["GROUP_VERSION"]["KIND"]["NAME"]

Ad esempio, un Nodo denominato my-favorite-node si trova in

data.inventory.cluster["v1"]["Node"]["my-favorite-node"]

Le risorse con ambito di spazio dei nomi vengono memorizzate nella cache qui:

data.inventory.namespace["NAMESPACE"]["GROUP_VERSION"]["KIND"]["NAME"]

Ad esempio, un ConfigMap denominato production-variables nello spazio dei nomi shipping-prod si trova in

data.inventory.namespace["shipping-prod"]["v1"]["ConfigMap"]["production-variables"]

L'intero contenuto dell'oggetto è archiviato in questa posizione della cache ed è possibile consultarlo nel codice sorgente Rego come ritieni opportuno.

Ulteriori informazioni su Rego

Le informazioni precedenti forniscono le funzionalità esclusive di Policy Controller che semplificano la scrittura di vincoli sulle risorse Kubernetes in Rego. Un tutorial completo su come scrivere in Rego non rientra nell'ambito di questa guida. Tuttavia, la documentazione di Open Policy Agent contiene informazioni sulla sintassi e sulle funzionalità del linguaggio Rego stesso.

Installa il modello di vincolo

Dopo aver creato il modello di vincolo, utilizza kubectl apply per applicarlo e Policy Controller si occuperà di importarlo. Assicurati di controllare il campo status del modello di vincolo per assicurarti che non siano presenti errori che lo confermano. Se l'importazione viene eseguita, il campo status dovrebbe mostrare created: true e il valore observedGeneration indicato nel campo status dovrebbe essere uguale al campo metadata.generation.

Dopo aver importato il modello, puoi applicare i vincoli come descritto in Creazione di vincoli.

Rimuovi un modello di vincolo

Per rimuovere un modello di vincolo:

Verifica che nessun vincolo che vuoi conservare utilizzi il modello di vincolo:
```
kubectl get TEMPLATE_NAME
```
Se si verifica un conflitto di denominazione tra il nome del modello di vincolo e un oggetto diverso nel cluster, utilizza il seguente comando:
```
kubectl get TEMPLATE_NAME.constraints.gatekeeper.sh
```

Rimuovi il modello di vincolo:

kubectl delete constrainttemplate CONSTRAINT_TEMPLATE_NAME

Quando rimuovi un modello di vincolo, non puoi più creare vincoli che fanno riferimento a questo modello.

Passaggi successivi

Scopri di più su Policy Controller.
Visualizza la documentazione di riferimento della libreria dei modelli di vincolo.
Scopri come utilizzare i vincoli anziché i PodSecurityPolicies.