Utilizzare un repository gerarchico

Questa pagina descrive in che modo Config Sync legge le configurazioni da una fonte attendibile gerarchica e applica automaticamente la configurazione risultante ai tuoi cluster.

Se vuoi una maggiore flessibilità strutturale (ad esempio, vuoi creare sottocartelle di risorse), puoi creare una fonte attendibile non strutturata. Le fonti di verità non strutturate sono consigliate per la maggior parte dei casi d'uso. Se utilizzi già una fonte attendibile gerarchica, puoi convertirla in una fonte attendibile non strutturata.

Per capire come Config Sync utilizza un repository gerarchico, è utile conoscere i repository Git e l'interfaccia a riga di comando di git.

Struttura della directory

Per le origini gerarchiche, Config Sync sfrutta le strutture simili a filesystem e utilizza la directory per determinare a quali cluster o spazi dei nomi è pertinente una configurazione.

namespaces/

La directory namespaces/ contiene le configurazioni per gli spazi dei nomi e gli oggetti con ambito di spazio dei nomi. La struttura all'interno di namespaces/ è il meccanismo che gestisce l'eredità dello spazio dei nomi. Puoi limitare gli spazi dei nomi che possono ereditare una configurazione utilizzando un NamespaceSelector.

cluster/

La directory cluster/ contiene configurazioni che si applicano a interi cluster anziché agli spazi dei nomi. Per impostazione predefinita, qualsiasi configurazione nella directory cluster/ si applica a tutti i cluster registrati in Config Sync. Puoi limitare i cluster su cui può influire una configurazione utilizzando un ClusterSelector.

clusterregistry/

La directory clusterregistry/ è facoltativa e contiene le configurazioni per ClusterSelectors. I selettori di cluster limitano i cluster a cui si applica una configurazione e vengono richiamati nelle configurazioni presenti nelle directory cluster/ e namespaces/.

system/

La directory system/ contiene le configurazioni per l'operatore.

Esempio di origine attendibile gerarchica

La seguente struttura di directory mostra come utilizzare una fonte attendibile gerarchica di Config Sync per configurare un cluster Kubernetes condiviso da due team diversi, team-1 e team-2.

  • Ogni team ha il proprio spazio dei nomi Kubernetes, account di servizio Kubernetes, quote di risorse, criteri di rete, associazioni di ruoli.
  • L'amministratore del cluster configura un criterio in namespaces/limit-range.yaml per limitare le allocazioni delle risorse (a pod o container) in entrambi gli spazi dei nomi.
  • L'amministratore del cluster configura anche i ClusterRole e i ClusterRoleBindings.

Una fonte gerarchica Config Sync valida deve includere tre sottodirectory: cluster/, namespaces/ e system/.

La directory cluster/ contiene configurazioni che si applicano a interi cluster (come ClusterRole, ClusterRoleBinding), anziché agli spazi dei nomi.

La directory namespaces/ contiene le configurazioni per gli oggetti dello spazio dei nomi e per gli oggetti con ambito di spazio dei nomi. Ogni sottodirectory di namespaces/ include le configurazioni per un oggetto dello spazio dei nomi e tutti gli oggetti con ambito nello spazio dei nomi all'interno dello spazio dei nomi. Il nome di una sottodirectory deve essere uguale al nome dell'oggetto dello spazio dei nomi. Gli oggetti con ambito di spazio dei nomi che devono essere creati in ogni spazio dei nomi possono essere inseriti direttamente in namespaces/ (ad esempio, namespaces/limit-range.yaml).

La directory system/ contiene le configurazioni per l'operatore ConfigManagement.

├── cluster
│   ├── clusterrolebinding-namespace-reader.yaml
│   ├── clusterrole-namespace-reader.yaml
│   ├── clusterrole-secret-admin.yaml
│   └── clusterrole-secret-reader.yaml
├── namespaces
│   ├── limit-range.yaml
│   ├── team-1
│   │   ├── namespace.yaml
│   │   ├── network-policy-default-deny-egress.yaml
│   │   ├── resource-quota-pvc.yaml
│   │   ├── rolebinding-secret-reader.yaml
│   │   └── sa.yaml
│   └── team-2
│       ├── namespace.yaml
│       ├── network-policy-default-deny-all.yaml
│       ├── resource-quota-pvc.yaml
│       ├── rolebinding-secret-admin.yaml
│       └── sa.yaml
├── README.md
└── system
    └── repo.yaml

Utilizza l'eredità dello spazio dei nomi e gli spazi dei nomi astratti

Con una fonte di verità gerarchica, puoi utilizzare il concetto di eredità dello spazio dei nomi per applicare automaticamente le configurazioni a gruppi di spazi dei nomi in tutti i cluster in cui esistono (o dovrebbero esistere).

L'eredità dello spazio dei nomi si applica alla directory namespaces/ del repository gerarchico e a tutte le relative sottodirectory. Le configurazioni in altre directory del repository, ad esempio cluster/, non sono soggette all'eredità.

In una fonte di verità gerarchica, la directory namespaces/ può contenere due diversi tipi di sottodirectory:

  • Una directory dello spazio dei nomi contiene una configurazione per uno spazio dei nomi. Il nome del file contenente la configurazione non è importante, ma la configurazione deve avere kind: Namespace. Una directory dello spazio dei nomi può contenere anche configurazioni per altri tipi di oggetti Kubernetes. Una directory dello spazio dei nomi non può contenere sottodirectory. Una configurazione dello spazio dei nomi rappresenta uno spazio dei nomi effettivo in un cluster.

  • Una directory dello spazio dei nomi astratta contiene directory dello spazio dei nomi. Può anche contenere configurazioni per altri oggetti Kubernetes, ma non può contenere direttamente una configurazione per uno spazio dei nomi. Una directory dello spazio dei nomi astratta non rappresenta un oggetto in un cluster Kubernetes, ma le sue directory dello spazio dei nomi di primo livello sì.

Per contribuire ad assicurarti che le origini dello spazio dei nomi e degli spazi dei nomi astratti abbiano il tipo corretto di configurazioni e struttura, l'errore KNV1003: IllegalNamespaceSubdirectoryError segnala un problema.

Le configurazioni in una directory dello spazio dei nomi si applicano solo a quello spazio dei nomi. Tuttavia, le configurazioni in una directory dello spazio dei nomi astratto vengono applicate a tutte le directory degli spazi dei nomi discendenti di questo spazio dei nomi astratto (o agli spazi dei nomi discendenti che corrispondono a NamespaceSelector di una configurazione, se presente).

L'eredità di una configurazione nella directory namespaces/ si basa in gran parte sulla sua posizione all'interno dell'albero della directory nella fonte attendibile. Per capire quali configurazioni vengono applicate a un determinato spazio dei nomi in un determinato cluster, puoi sfogliare il repository di esempi di ereditarietà dello spazio dei nomi.

Spazi dei nomi con limitazioni

config-management-system è uno spazio dei nomi con limitazioni. Non puoi utilizzarlo come directory dello spazio dei nomi astratto. Puoi definire uno spazio dei nomi config-management-system, ma l'unico tipo di risorsa consentito per lo spazio dei nomi config-management-system è RootSync.

Apportare modifiche alla fonte attendibile

Quando apporti una modifica alla tua origine attendibile che crea o elimina directory dei namespace dalla directory namespaces/, potresti ottenere risultati imprevisti a seconda dell'azione:

  • Creazione di una directory: quando una gerarchia namespaces/ valida viene impegnata nell'origine attendibile, Config Sync crea gli spazi dei nomi e poi gli oggetti Kubernetes in questi spazi per ogni configurazione che la directory dello spazio dei nomi contiene o eredita.
  • Eliminazione di una directory: l'eliminazione di una directory dello spazio dei nomi è un'operazione distruttiva. Lo spazio dei nomi e i relativi contenuti vengono eliminati su ogni cluster gestito da Config Sync in cui esiste lo spazio dei nomi. Se elimini una directory dello spazio dei nomi astratto contenente directory di spazi dei nomi discendenti, tutti questi spazi dei nomi e i relativi contenuti vengono eliminati da ogni cluster gestito da Config Sync.

  • Rinominare una directory: la ridenominazione di una directory dello spazio dei nomi comporta un'eliminazione, seguita da una creazione ed è considerata un'operazione distruttiva. La ridenominazione di una directory del nome di spazio astratto non ha alcun effetto visibile all'esterno.

  • Spostamento di una directory: lo spostamento di uno spazio dei nomi o di una directory di spazi dei nomi astratti all'interno di namespaces/ non comporta l'eliminazione dello spazio dei nomi o degli oggetti al suo interno, tranne nel caso in cui lo spazio dei nomi inizi o interrompa l'ereditarietà di una configurazione da una directory di spazi dei nomi astratti, a causa di una modifica della relativa gerarchia.

Passaggi successivi