Quando Config Sync gestisce un oggetto cluster, controlla l'oggetto e l'insieme di configurazioni nel repository che influiscono sull'oggetto e assicura che siano sincronizzati. Questo argomento descrive come iniziare a gestire un oggetto esistente e come interrompere la gestione di un oggetto attualmente gestito senza eliminare l'oggetto.
Un oggetto in un cluster è gestito da Config Sync se presenta l'annotazione configmanagement.gke.io/managed: enabled
e la relativa annotazione configsync.gke.io/resource-id
, che monitora le informazioni su gruppo, tipo, spazio dei nomi e nome dell'oggetto, è corretta.
Il formato dell'annotazione configsync.gke.io/resource-id
è
GROUP_KIND_NAMESPACE_NAME
per un oggetto con ambito a livello di spazio dei nomi e
GROUP_KIND_NAME
per un oggetto con ambito cluster.
Il seguente diagramma di flusso descrive alcune situazioni in cui un oggetto diventa gestito o non gestito:
Il grafico contiene tre flussi separati: 1) inizia a gestire un oggetto, 2) interrompi la gestione di un oggetto ed 3) elimina un oggetto gestito.
- Voglio iniziare a gestire un oggetto. L'oggetto ha un manifest? Oppure, in altre parole,
l'oggetto ha una configurazione nel repository?
- No: crea una configurazione
per l'oggetto. Config Sync imposta l'annotazione
configmanagement.gke.io/managed: enabled
, imposta l'annotazioneconfigsync.gke.io/resource-id
in modo che corrisponda all'oggetto e inizia a gestirlo. - Sì: la configurazione imposta la seguente annotazione?
configmanagement.gke.io/managed: disabled
- No: l'oggetto è gestito per impostazione predefinita.
- Sì: modifica la configurazione per rimuovere
l'annotazione
configmanagement.gke.io/managed: disabled
. Quando la modifica viene inviata al repository di origine, Config Sync rileva la modifica, applica l'annotazioneconfigmanagement.gke.io/managed: enabled
e l'annotazioneconfigsync.gke.io/resource-id
e applica la configurazione.
- No: crea una configurazione
per l'oggetto. Config Sync imposta l'annotazione
- Voglio smettere di gestire un oggetto ma non eliminarlo.
- Modifica la configurazione dell'oggetto nel repository e imposta l'annotazione
configmanagement.gke.io/managed: disabled
. Quando viene rilevata la modifica alla configurazione, Config Sync smette di gestire l'oggetto.
- Modifica la configurazione dell'oggetto nel repository e imposta l'annotazione
- Voglio interrompere la gestione di un oggetto ed eliminarlo.
- Elimina la configurazione dell'oggetto dal repository. Quando elimini una configurazione per un oggetto precedentemente gestito, Config Sync elimina l'oggetto da tutti i cluster o gli spazi dei nomi a cui si applica la configurazione.
Oltre all'annotazione configmanagement.gke.io/managed: enabled
e
all'annotazione configsync.gke.io/resource-id
,
Config Sync applica l'etichetta app.kubernetes.io/managed-by: configmanagement.gke.io
a tutti gli oggetti che gestisce. Questa etichetta consente di elencare facilmente
tutti gli oggetti tramite Config Sync.
Perché non applicare l'annotazione manualmente?
Config Sync utilizza un modello dichiarativo per applicare le modifiche alla configurazione ai cluster leggendo la configurazione desiderata dal repository.
Se provi ad applicare l'annotazione manualmente (utilizzando il comando kubectl
o l'API Kubernetes), Config Sync esegue automaticamente l'override del manuale con i contenuti del repository.
Prima di iniziare
I seguenti esempi si basano su Inizia a utilizzare Config Sync. Prima di iniziare con i passaggi seguenti, segui la guida rapida e completa tutti i passaggi prima di esplorare e testare l'installazione di Config Sync.
Elenco di tutti gli oggetti gestiti
Per elencare tutti gli oggetti gestiti da Config Sync su un determinato cluster o spazio dei nomi, utilizza un selettore di etichette come il seguente:
kubectl get object-type -n namespace -l "app.kubernetes.io/managed-by=configmanagement.gke.io"
Per elencare tutti gli oggetti non gestiti da Config Sync, utilizza un selettore di etichette come il seguente:
kubectl get object-type -n namespace -l "app.kubernetes.io/managed-by!=configmanagement.gke.io"
Ad esempio, questo comando elenca le associazioni RoleBinding nello spazio dei nomi gamestore
che
sono gestite da Config Sync:
kubectl get rolebindings -n gamestore \ -l "app.kubernetes.io/managed-by=configmanagement.gke.io"
L'output è simile al seguente:
NAME ROLE AGE
configsync.gke.io:ns-reconciler ClusterRole/configsync.gke.io:ns-reconciler 34h
gamestore-admin ClusterRole/admin 34h
gamestore-webstore-admin ClusterRole/webstore-admin 34h
Questo comando elenca i RoleBinding nello spazio dei nomi kube-system
che non sono gestiti da Config Sync:
kubectl get rolebindings -n kube-system \ -l "app.kubernetes.io/managed-by!=configmanagement.gke.io"
L'output è simile al seguente:
NAME AGE
fluentd-gcp-scaler-binding 2d21h
gce:cloud-provider 2d21h
heapster-binding 2d21h
metrics-server-auth-reader 2d21h
system::leader-locking-kube-controller-manager 2d21h
system::leader-locking-kube-scheduler 2d21h
system:controller:bootstrap-signer 2d21h
system:controller:cloud-provider 2d21h
system:controller:token-cleaner 2d21h
Inizia a gestire un oggetto esistente
Prima di installare Config Sync, puoi creare una configurazione per un oggetto Kubernetes esistente, ad esempio uno spazio dei nomi già esistente nel cluster.
Tuttavia, questa configurazione viene ignorata a meno che l'oggetto non abbia l'annotazione configmanagement.gke.io/managed: enabled
e l'annotazione configsync.gke.io/resource-id
corretta. Per un oggetto esistente, devi applicare l'annotazione manualmente.
In particolare, per gli spazi dei nomi, Config Sync applica configurazioni che creano nuovi oggetti all'interno di uno spazio dei nomi non annotato e applica le annotazioni configmanagement.gke.io/managed: enabled
e configsync.gke.io/resource-id
a questi oggetti. Tuttavia, Config Sync si rifiuta di modificare o rimuovere da un cluster gli oggetti con ambito cluster non annotati. Questo è illustrato nel diagramma in Utilizzo delle configurazioni nel tempo.
L'esempio seguente mostra come gestire un oggetto Role esistente. Per prima cosa, crei un ruolo manualmente, quindi inizi a gestirlo con Config Sync.
Crea il ruolo
myrole
nello spazio dei nomigamestore
:kubectl create role -n gamestore myrole --verb=get --resource=pods
Visualizza le autorizzazioni concesse dal ruolo
myrole
:kubectl describe role -n gamestore myrole
Name: myrole Labels: <none> Annotations: <none> PolicyRule: Resources Non-Resource URLs Resource Names Verbs --------- ----------------- -------------- ----- pods [] [] [get]
Il ruolo ha l'autorizzazione solo per
get
pod.A questo punto, il ruolo esiste nel cluster, ma Config Sync non ne è a conoscenza.
- In un terminale, vai al clone locale del tuo repository.
Utilizza il seguente comando per creare un manifest YAML per
myrole
e salvalo in un nuovo file denominatogamestore-myrole.yaml
.kubectl get role myrole -n gamestore -o yaml > gamestore-myrole.yaml
Modifica il file
gamestore-myrole.yaml
.- Rimuovi tutti i campi sotto la chiave
metadata
, trannename
enamespace
. - Aggiungi il verbo
list
dopoget
nel campo dell'elencorules.verbs
.
Salva le modifiche. Il file risultante ha i seguenti contenuti:
apiVersion: rbac.authorization.k8s.io/v1 kind: Role metadata: name: myrole namespace: gamestore rules: - apiGroups: - "" resources: - pods verbs: - get - list
- Rimuovi tutti i campi sotto la chiave
Esegui il commit della modifica nel repository.
Attendi qualche istante affinché l'operatore ConfigManagement rilevi il commit. Per verificare che il ruolo
myrole
sia ora gestito da Config Sync, esegui di nuovokubectl describe
.kubectl describe role myrole -n gamestore
Osserva l'annotazione configmanagement.gke.io/managed: enabled
, che
indica che l'oggetto è gestito da Config Sync, e l'annotazione
configsync.gke.io/resource-id
, che monitora le informazioni su gruppo, tipo, spazio dei nomi e nome. Nota anche le annotazioni che mostrano il percorso e il nome del file nel repository che hanno causato la modifica più recente alla configurazione dell'oggetto e l'hash Git che rappresenta il commit.
Name: myrole
Labels: app.kubernetes.io/managed-by=configmanagement.gke.io
configsync.gke.io/declared-version=v1
Annotations: config.k8s.io/owning-inventory: config-management-system_root-sync
configmanagement.gke.io/cluster-name: my-cluster
configmanagement.gke.io/managed: enabled
configmanagement.gke.io/source-path: config-sync-quickstart/multirepo/root/gamestore-myrole.yaml
configmanagement.gke.io/token: 747b843a7ddbd945c0616034a935cf648b58e7b5
configsync.gke.io/declared-fields: {"f:rules":{}}
configsync.gke.io/git-context: {"repo":"https://github.com/GoogleCloudPlatform/anthos-config-management-samples","branch":"main","rev":"HEAD"}
configsync.gke.io/manager: :root
configsync.gke.io/resource-id: rbac.authorization.k8s.io_role_gamestore_myrole
PolicyRule:
Resources Non-Resource URLs Resource Names Verbs
--------- ----------------- -------------- -----
pods [] [] [get list]
Interrompi la gestione di un oggetto gestito
Questo esempio mostra come interrompere la gestione di un oggetto attualmente gestito da Config Sync, come il ruolo myrole
in Iniziare a gestire un oggetto esistente.
Modifica il file
config-sync-quickstart/multirepo/root/rolebinding-gamestore-webstore-admin.yaml
nel clone locale del tuo repository e aggiungi una sezioneannotations:
corrispondente al testo in grassetto riportato di seguito:kind: RoleBinding apiVersion: rbac.authorization.k8s.io/v1 metadata: annotations: configmanagement.gke.io/managed: disabled name: gamestore-webstore-admin namespace: gamestore subjects: - kind: ServiceAccount name: ns-reconciler-gamestore namespace: config-management-system roleRef: kind: ClusterRole name: webstore-admin apiGroup: rbac.authorization.k8s.io
Salva il file.
Crea un commit Git con le tue modifiche ed esegui il push del commit nel repository.
Attendi qualche istante affinché Config Sync rilevi e applichi il nuovo commit.
Utilizza il seguente comando per verificare che le annotazioni e le etichette dell'associazione RoleBinding
gamestore-webstore-admin
siano entrambe vuote. Config Sync non imposta l'annotazioneconfigmanagement.gke.io/managed
sudisabled
nell'oggetto.kubectl get rolebinding gamestore-webstore-admin -n gamestore -o yaml
apiVersion: rbac.authorization.k8s.io/v1 metadata: annotations: name: gamestore-webstore-admin namespace: gamestore subjects: - kind: ServiceAccount name: ns-reconciler-gamestore namespace: config-management-system roleRef: kind: ClusterRole name: webstore-admin apiGroup: rbac.authorization.k8s.io
Dopo aver verificato che l'oggetto è ora disabilitato, puoi rimuovere la configurazione dal repository e verificare che l'oggetto non gestito non venga eliminato dallo spazio dei nomi. Se vuoi gestire nuovamente l'oggetto, devi aggiungere di nuovo la relativa configurazione al repository. Per questo motivo potresti voler annullare la gestione degli oggetti e lasciare le relative configurazioni nel repository.
Ora che l'oggetto non è gestito, non viene creato né ricreato su cluster nuovi o esistenti e non viene rimosso anche se esiste. Per riprendere la gestione di un oggetto che in precedenza avevi interrotto, vedi Riprendi la gestione di un oggetto precedentemente non gestito nel prossimo esempio.
Riprendi la gestione di un oggetto non gestito in precedenza
Questo esempio mostra come riprendere la gestione di un oggetto rimosso in precedenza dalla gestione, come in Interrompere la gestione di un oggetto esistente. Presuppone che tu non abbia rimosso la configurazione di RoleBinding di gamestore-webstore-admin
.
Se hai eliminato la RoleBinding
gamestore-webstore-admin
dal tuo repository nell'ultimo commit, segui questi passaggi.Usa
git revert
per ripristinare l'ultimo commit:git revert HEAD~1
Ti viene chiesto di confermare l'operazione di ripristino.
Esegui il push del commit di ripristino nel repository.
git push
Modifica il file
config-sync-quickstart/multirepo/root/rolebinding-gamestore-webstore-admin.yaml
nel clone locale del repository e rimuovi l'annotazioneconfigmanagement.gke.io/managed: disabled
. Salva il file.Esegui il commit e il push della modifica. Config Sync esegue quanto segue:
- Rileva la modifica
- Applica l'annotazione
configmanagement.gke.io/managed: enabled
e l'annotazioneconfigsync.gke.io/resource-id
. L'oggetto è ora gestito. - Applica la configurazione, come accadrebbe con qualsiasi oggetto gestito.
Per verificare che l'oggetto sia ora gestito, elencane le annotazioni:
kubectl get rolebinding gamestore-webstore-admin -n gamestore -o yaml
apiVersion: rbac.authorization.k8s.io/v1 kind: RoleBinding metadata: annotations: configmanagement.gke.io/cluster-name: my-cluster configmanagement.gke.io/managed: enabled configsync.gke.io/resource-id: rbac.authorization.k8s.io_rolebinding_gamestore_gamestore-webstore-admin ...
Interrompi la gestione di uno spazio dei nomi
Puoi smettere di gestire uno spazio dei nomi come smetti di gestire qualsiasi tipo di oggetto. Se vuoi interrompere la gestione di altre risorse all'interno dello spazio dei nomi, segui questi passaggi:
Aggiungi l'annotazione
configmanagement.gke.io/managed:disabled
alla configurazione dello spazio dei nomi e a tutte le configurazioni nello stesso spazio dei nomi. Tutti gli oggetti nello spazio dei nomi devono avere questa annotazione.Esegui il commit e il push delle modifiche al repository. Attendi che l'operatore si sincronizzi con il repository.
Elimina le risorse non gestite dal repository.
Se esistono configurazioni per configurazioni gestite all'interno di una directory dello spazio dei nomi non gestito, gli errori dei log del riconciliatore, mentre le altre configurazioni continuano a sincronizzarsi normalmente.
Elimina risorse gestite
Se rimuovi una singola risorsa da una fonte attendibile, quell'oggetto viene eliminato dal cluster alla successiva sincronizzazione di Config Sync dall'origine attendibile. In alternativa, in Config Sync 1.16.0 e versioni successive, puoi abilitare la propagazione dell'eliminazione, che consente di eliminare gli oggetti in blocco.
Eliminare singoli oggetti
Con il comportamento predefinito di Config Sync, quando rimuovi un oggetto da un'origine attendibile, questo oggetto viene eliminato dal cluster quando Config Sync si sincronizza dalla fonte attendibile.
Esistono diversi modi per controllare lo stato di Config Sync o di quelli di oggetti specifici:
- Usa
nomos status
. - Utilizza
kubectl
per esaminare le risorse. - Usa il comando
gcloud alpha anthos config sync resources
. - Utilizza la dashboard di Config Sync.
Eliminare oggetti in blocco
Per impostazione predefinita, l'eliminazione di un sistema RootSync o RepoSync fa sì che Config Sync abbandoni gli oggetti applicati in precedenza dalla fonte attendibile. In Config Sync 1.16.0 e versioni successive, puoi abilitare la propagazione dell'eliminazione per eliminare tutti gli oggetti applicati in precedenza.
Quando abiliti la propagazione dell'eliminazione su un oggetto RootSync o RepoSync e quindi elimini l'oggetto, Config Sync elimina automaticamente ogni oggetto gestito da tale oggetto RootSync o RepoSync.
La propagazione dell'eliminazione può semplificare la pulizia delle risorse, ad esempio se stai eseguendo la migrazione a un nuovo spazio dei nomi o cluster, esegui la pulizia dopo una demo o un esperimento o se disinstalli un'applicazione.
Opzioni di propagazione dell'eliminazione
La propagazione delazione è disabilitata per impostazione predefinita. Per abilitare la propagazione dell'eliminazione, aggiungi l'annotazione configsync.gke.io/deletion-propagation-policy: Foreground
all'oggetto RootSync o RepoSync, come nell'esempio seguente:
# example-rootsync.yaml
apiVersion: configsync.gke.io/v1beta1
kind: RootSync
metadata:
name: example-rootsync
namespace: config-management-system
annotations:
configsync.gke.io/deletion-propagation-policy: Foreground
spec:
sourceType: git
sourceFormat: unstructured
git:
repo: https://github.com/GoogleCloudPlatform/anthos-config-management-samples
branch: init
dir: config-sync-quickstart/multirepo/root
auth: none
period: 30s
In alternativa, puoi aggiornare una risorsa RootSync o RepoSync esistente per utilizzare la propagazione dell'eliminazione eseguendo questo comando:
RootSync
kubectl patch RootSync ROOTSYNC_NAME \
--namespace config-management-system \
--type merge \
--patch '{"metadata":{"annotations":{"configsync.gke.io/deletion-propagation-policy":"Foreground"}}}'
Sostituisci ROOTSYNC_NAME
con il nome della RootSync che
vuoi aggiornare.
RepoSync
kubectl patch RepoSync REPOSYNC_NAME \
--namespace config-management-system \
--type merge \
--patch '{"metadata":{"annotations":{"configsync.gke.io/deletion-propagation-policy":"Foreground"}}}'
Sostituisci REPOSYNC_NAME
con il nome del RepoSync che
vuoi aggiornare.
Per disabilitare la propagazione dell'eliminazione, rimuovi l'annotazione o modifica il valore in configsync.gke.io/deletion-propagation-policy: Orphan
:
RootSync
kubectl patch RootSync ROOTSYNC_NAME \
--namespace config-management-system \
--type merge \
--patch '{"metadata":{"annotations":{"configsync.gke.io/deletion-propagation-policy":"Orphan"}}}'
Sostituisci ROOTSYNC_NAME
con il nome della RootSync che
vuoi aggiornare.
RepoSync
kubectl patch RepoSync REPOSYNC_NAME \
--namespace config-management-system \
--type merge \
--patch '{"metadata":{"annotations":{"configsync.gke.io/deletion-propagation-policy":"Orphan"}}}'
Propaga eliminazione oggetto
Questo esempio mostra come applicare la propagazione dell'eliminazione a un oggetto RootSync o RepoSync e quindi eliminare RootSync o RepoSync per eliminare tutti gli oggetti gestiti da RootSync o RepoSync.
RootSync
Applica l'annotazione a un oggetto RootSync per abilitare la propagazione dell'eliminazione:
kubectl patch RootSync example-rootsync \ --namespace config-management-system \ --type merge \ --patch '{"metadata":{"annotations":{"configsync.gke.io/deletion-propagation-policy":"Foreground"}}}'
Elimina l'oggetto RootSync e attendi che Config Sync lo elimini:
kubectl delete RootSync example-rootsync --namespace config-management-system --wait
L'eliminazione di RootSync può richiedere alcuni minuti.
RepoSync
Applica l'annotazione a un oggetto RepoSync per abilitare la propagazione dell'eliminazione:
kubectl patch RepoSync example-reposync \ --namespace example-namespace \ --type merge \ --patch '{"metadata":{"annotations":{"configsync.gke.io/deletion-propagation-policy":"Foreground"}}}'
Elimina l'oggetto RepoSync e attendi che Config Sync lo elimini:
kubectl delete RepoSync example-reposync --namespace example-namespace --wait
L'eliminazione di RepoSync può richiedere alcuni minuti.
Impedisci l'eliminazione di oggetti Kubernetes
Dopo aver rimosso un oggetto Kubernetes da un repository Git gestito da Config Sync, questo oggetto viene eliminato anche dal cluster quando il nuovo commit viene sincronizzato con il cluster.
Se vuoi impedire a Config Sync di eliminare l'oggetto quando la sua configurazione viene rimossa dal repository Git, puoi seguire questi passaggi:
Aggiungi l'annotazione
client.lifecycle.config.k8s.io/deletion: detach
alla configurazione degli oggetti nel repository Git.Esegui il commit e il push della modifica nel repository Git.
Attendi che la modifica venga sincronizzata con il cluster.
Dopo aver completato questi passaggi, Config Sync non eliminerà l'oggetto dal cluster quando la sua configurazione viene rimossa dal repository Git, ma l'oggetto può ancora essere eliminato da altri client.
Ignorare un oggetto nella fonte attendibile
Potresti volere che Config Sync ignori un oggetto nella tua fonte attendibile. Ad esempio, una configurazione della funzione kpt non dovrebbe mai essere applicata al cluster.
Per gli oggetti che vuoi che Config Sync ignori, aggiungi all'oggetto l'annotazione config.kubernetes.io/local-config: "true"
. Dopo aver aggiunto l'annotazione, Config Sync ignora
l'oggetto come se fosse rimosso dalla fonte attendibile. Le risorse con
l'annotazione local-config
impostata su un valore diverso da "false"
vengono trattate
come se fosse impostata su "true"
e vengono ignorate.