Questa pagina mostra come modificare le risorse utilizzando
Policy Controller. È utile per eseguire operazioni come
l'impostazione di valori predefiniti. Ad esempio, potresti voler inserire un'etichetta per tutte le risorse in uno spazio dei nomi specifico oppure impostare il valore predefinito imagePullPolicy
di un pod su Always
, se non è già impostato.
Abilita mutazione
Console
Per attivare la mutazione, completa i seguenti passaggi:
- Nella console Google Cloud, vai alla pagina Criteri di GKE Enterprise nella sezione Gestione della postura.
- Nella tabella dei cluster della scheda Impostazioni, seleziona Modifica edit nella colonna Modifica configurazione.
- Espandi il menu Modifica configurazione di Policy Controller.
- Seleziona la casella di controllo Abilita webhook di mutazione.
- Seleziona Salva modifiche.
gcloud Policy Controller
Per abilitare la mutazione, esegui questo comando:
gcloud container fleet policycontroller update \
--memberships=MEMBERSHIP_NAME \
--mutation
Sostituisci MEMBERSHIP_NAME
con il nome dell'appartenenza del cluster registrato per abilitare la mutazione. Puoi specificare più abbonamenti separati da una virgola.
gcloud ConfigManagement
La mutazione deve essere abilitata impostando spec.policyController.mutation.enabled
su
true
nella risorsa config-management
:
apiVersion: configmanagement.gke.io/v1
kind: ConfigManagement
metadata:
name: config-management
spec:
policyController:
enabled: true
mutation:
enabled: true
Se utilizzi il comando gcloud CLI, devi utilizzare la versione alpha per abilitare la modifica, come mostrato nell'esempio seguente:
# apply-spec.yaml
applySpecVersion: 1
spec:
policyController:
enabled: true
mutationEnabled: true
Dopo aver creato il file apply-spec.yaml
, esegui questo comando per applicare la configurazione:
gcloud alpha container fleet config-management apply \
--membership=MEMBERSHIP_NAME \
--config=CONFIG_YAML_PATH \
--project=PROJECT_ID
Sostituisci quanto segue:
MEMBERSHIP_NAME
: il nome dell'appartenenza del cluster registrato con le impostazioni di Policy Controller che vuoi utilizzareCONFIG_YAML_PATH
: il percorso del fileapply-spec.yaml
PROJECT_ID
: il tuo ID progetto
Definizioni
- mutator: una risorsa Kubernetes che aiuta a configurare il comportamento di mutazione di Policy Controller.
- system: una disposizione composta da più mutatori
Esempio di mutazione
L'esempio seguente mostra un mutatore che imposta imagePullPolicy
per tutti i container in tutti i pod su Always
:
# set-image-pull-policy.yaml
apiVersion: mutations.gatekeeper.sh/v1alpha1
kind: Assign
metadata:
name: always-pull-image
spec:
applyTo:
- groups: [""]
kinds: ["Pod"]
versions: ["v1"]
location: "spec.containers[name: *].imagePullPolicy"
parameters:
assign:
value: "Always"
In questo esempio sono presenti i campi di metadati Kubernetes standard
(apiVersion
, kind
, metadata.name
), ma spec
è il luogo in cui viene configurato il comportamento
del mutatore.
spec.applyTo
associa il mutatore alle risorse specificate. Poiché stiamo modificando campi specifici di un oggetto, stiamo definendo implicitamente lo schema di quell'oggetto. Ad esempio, l'attuale mutatore non avrebbe senso se fosse applicato a una risorsa Namespace
. Per questo motivo, questo campo è obbligatorio affinché
Policy Controller sappia per quali schemi è pertinente questo mutatore.
GroupVersionKinds
mancanti in questo elenco non sono stati modificati.
spec.location
ci indica quale campo modificare. In questo caso, utilizziamo un glob (*
) per indicare che vogliamo modificare tutte le voci nell'elenco di container. Tieni presente che gli unici tipi di elenchi che possono essere attraversati dal campo location
sono gli elenchi di tipi di mappa ed è necessario specificare il campo chiave per la mappa. Gli elenchi di tipi di mappa sono un costrutto di Kubernetes. Maggiori dettagli sono disponibili
nella documentazione di Kubernetes.
spec.parameters.assign.value
è il valore da assegnare a location
.
Questo campo non è digitato e può avere qualsiasi valore, ma tieni presente che Kubernetes
convalida comunque la richiesta dopo la mutazione, quindi l'inserimento di valori con uno schema errato
per l'oggetto da modificare fa sì che la richiesta venga rifiutata.
Usa mutatori per i job
Se stai configurando un job o un CronJob, devi specificare separatamente la versione e il gruppo, come mostrato nell'esempio seguente:
applyTo:
- groups: ["batch"]
kind: ["Job"]
versions: ["v1"]
Quando utilizzi un mutatore per i job, i job esistenti non subiscono modifiche a meno che non vengano modificati. La modifica di un job attiva una richiesta al webhook di mutazione e ne provoca la mutazione.
Flusso di esecuzione
Forse il concetto più importante da comprendere sui webhook mutatori di Kubernetes è il loro criterio di reinvocazione, perché l'output di un mutatore potrebbe cambiare il comportamento di un altro mutatore. Ad esempio, se aggiungi un nuovo container collaterale, un mutatore che imposta il criterio pull dell'immagine per tutti i container ora dispone di un nuovo container da modificare.
In pratica, ciò significa che, per ogni richiesta specifica, il webhook di mutazione di Policy Controller potrebbe essere chiamato più di una volta.
Per ridurre la latenza, Policy Controller si riavvia per evitare ulteriori richieste HTTP. Ciò significa che i criteri di inserimento file collaterali e pull delle immagini hanno il risultato previsto.
La routine di mutazione di Policy Controller continuerà a richiamarsi fino a quando la risorsa "converge", il che significa che ulteriori iterazioni non hanno ulteriori effetti.
Sintassi della località
La sintassi della posizione utilizza la funzione di accesso punto (.
) per attraversare i campi. Nel caso degli elenchi con chiavi, gli utenti possono fare riferimento ai singoli oggetti in un elenco utilizzando la sintassi [<key>: <value>]
o a tutti gli oggetti nell'elenco utilizzando [<key>: *]
.
I valori e i campi possono essere racchiusi tra virgolette singole ('
) o doppie ("
). Questa operazione è necessaria se contengono caratteri speciali, come punti o spazi.
Nei valori tra virgolette, i caratteri speciali possono essere preceduti dal carattere di escape \
. "Use \" to escape and \\\" to escape"
diventa Use " to escape and \" to escape
.
Alcuni esempi per la risorsa v1/Pod
:
spec.priority
fa riferimento aspec.priority
spec.containers[name: "foo"].volumeMounts[mountPath: "/my/mount"].readOnly
fa riferimento al camporeadOnly
del montaggio/my/mount
del containerfoo
.spec.containers[name: *].volumeMounts[mountPath: "/my/mount"].readOnly
fa riferimento al camporeadOnly
del montaggio/my/mount
di tutti i container.
Se fai riferimento a una località che attualmente non esiste su una risorsa, la località viene creata per impostazione predefinita. Questo comportamento può essere configurato tramite il test del percorso.
Test del percorso
Come è possibile eseguire il default, in cui evitare di modificare un valore
già esistente? Forse vogliamo impostare /secure-mount
come di sola lettura per tutti i container,
ma non vogliamo creare un /secure-mount
se non ne esiste già uno. Possiamo eseguire una di queste operazioni tramite il test del percorso.
Ecco un esempio che evita la modifica di imagePullPolicy
se già
impostato:
# set-image-pull-policy.yaml
apiVersion: mutations.gatekeeper.sh/v1alpha1
kind: Assign
metadata:
name: always-pull-image
spec:
applyTo:
- groups: [""]
kinds: ["Pod"]
versions: ["v1"]
location: "spec.containers[name: *].imagePullPolicy"
parameters:
assign:
value: "Always"
pathTests:
- subPath: "spec.containers[name: *].imagePullPolicy"
condition: "MustNotExist"
Ecco un altro esempio che evita di creare un container sidecar
vuoto
se non esiste già:
# set-image-pull-policy.yaml
apiVersion: mutations.gatekeeper.sh/v1alpha1
kind: Assign
metadata:
name: always-pull-image
spec:
applyTo:
- groups: [""]
kinds: ["Pod"]
versions: ["v1"]
location: 'spec.containers[name: "sidecar"].imagePullPolicy'
parameters:
assign:
value: "Always"
pathTests:
- subPath: 'spec.containers[name: "sidecar"]'
condition: "MustExist"
Se necessario, è possibile specificare più test del percorso.
subPath
deve essere un prefisso di (o uguale a) location
.
Gli unici valori validi per condition
sono MustExist
e MustNotExist
.
Corrispondenza
I mutatori consentono inoltre la corrispondenza, utilizzando gli stessi criteri dei vincoli.
Mutatori
Attualmente esistono due tipi di mutatori: Assign
e AssignMetadata
.
Assegna
Assign
può modificare qualsiasi valore al di fuori del campo metadata
di una risorsa.
Poiché tutti gli elementi GroupVersionKinds
hanno uno schema univoco, devono essere associati a un insieme
di GroupVersionKinds
specifico.
che ha il seguente schema:
apiVersion: mutations.gatekeeper.sh/v1alpha1
kind: Assign
metadata:
name: always-pull-image
spec:
applyTo:
- groups: [""]
kinds: ["Pod"]
versions: ["v1"]
match:
kinds: # redundant because of `applyTo`, but left in for consistency
- apiGroups: ["*"]
kinds: ["*"]
namespaces: ["my-namespace"]
scope: "Namespaced" # or "Cluster"
excludedNamespaces: ["some-other-ns"]
labelSelector:
matchLabels:
mutate: "yes"
matchExpressions:
- key: "my-label"
operator: "In" # or, "NotIn", "Exists", or "DoesNotExist"
values: ["my-value"]
namespaceSelector:
matchLabels:
mutate: "yes"
matchExpressions:
- key: "my-label"
operator: "In" # or, "NotIn", "Exists", or "DoesNotExist"
values: ["my-value"]
location: "spec.containers[name: *].imagePullPolicy"
parameters:
pathTests:
- subPath: 'spec.containers[name: "sidecar"]' # must be a prefix of `location`
condition: "MustExist" # or "MustNotExist"
- subPath: "spec.containers[name: *].imagePullPolicy"
condition: "MustNotExist"
assign:
value: "Always" # any type can go here, not just a string
AssignMetadata
AssignMetadata
può aggiungere nuove etichette di metadati. Non può modificare il valore
delle etichette dei metadati esistenti. Altrimenti, sarebbe possibile scrivere un sistema
di mutatori che si ricorreranno all'infinito, causando il timeout delle richieste.
Poiché tutte le risorse condividono lo stesso schema metadata
, non è necessario
specificare a quale risorsa si applica un AssignMetadata
.
Inoltre, dato che AssignMetadata
non può fare così tanto, il suo schema è un po' più semplice.
apiVersion: mutations.gatekeeper.sh/v1alpha1
kind: AssignMetadata
metadata:
name: set-team-name
spec:
match:
kinds:
- apiGroups: ["*"]
kinds: ["*"]
namespaces: ["my-namespace"]
scope: "Namespaced" # or "Cluster"
excludedNamespaces: ["some-other-ns"]
labelSelector:
matchLabels:
mutate: "yes"
matchExpressions:
- key: "my-label"
operator: "In" # or, "NotIn", "Exists", or "DoesNotExist"
values: ["my-value"]
namespaceSelector:
matchLabels:
mutate: "yes"
matchExpressions:
- key: "my-label"
operator: "In" # or, "NotIn", "Exists", or "DoesNotExist"
values: ["my-value"]
location: "metadata.labels.team" # must start with `metadata.labels`
parameters:
assign:
value: "Always" # any type can go here, not just a string
Best practice
Avvertenze relative a Kubernetes
Nella documentazione di Kubernetes sono elencate alcune considerazioni importanti sull'uso dei webhook di mutazione. Poiché Policy Controller funziona come webhook di ammissione Kubernetes, questi consigli sono validi in questo caso.
La sintassi di mutazione di Policy Controller è progettata per facilitare la conformità ai problemi operativi relativi ai webhook di mutazione, inclusa l'idempotenza.
Scrittura dei mutatori
Atomicità
È buona norma rendere ogni mutatore il più autosufficiente possibile. Poiché Kubernetes è a coerenza finale, un mutatore non dovrebbe fare affidamento su un secondo mutatore per essere riconosciuto per svolgere il suo lavoro correttamente. Ad esempio, quando aggiungi un file collaterale, aggiungi l'intero file collaterale, non costruirlo in modo frammentario utilizzando più mutatori.
Convalida
Se vuoi applicare una condizione, è una buona idea che il mutatore abbia un vincolo corrispondente. In questo modo, puoi assicurarti che le richieste in violazione vengano rifiutate e che nel controllo vengano rilevate violazioni preesistenti.
Recupero di emergenza
La mutazione è implementata come webhook mutante di Kubernetes. Può essere arrestato
come se fosse il webhook di convalida,
ma la risorsa pertinente è un MutatingWebhookConfiguration
denominato
gatekeeper-mutating-webhook-configuration
.
Passaggi successivi
- Per spiegazioni ed esempi relativi alla mutazione di Gatekeeper, consulta la documentazione open source