Kustomize è uno strumento di trasformazione di configurazione di Kubernetes che consente di personalizzare i file YAML senza modelli, lasciando i file originali invariati. Kustomize può anche generare risorse come ConfigMap e Secret da altre rappresentazioni. Kustomize è stato creato per l'API Kubernetes, quindi può comprendere e modificare gli oggetti in stile Kubernetes.
Se vuoi usare i grafici Helm con Config Sync, esistono due metodi supportati: eseguire il rendering di Helm tramite Kustomize o utilizzare l'API Helm. In questa pagina vengono descritti i requisiti per il rendering dei grafici Helm tramite Kustomize. Per ulteriori informazioni sull'utilizzo dell'API Helm, consulta Sincronizzazione dei grafici Helm da Artifact Registry.
Quando utilizzi Kustomize per eseguire il rendering dei grafici Helm, si applicano le seguenti differenze:
- I registri Helm privati e basati su OCI non sono supportati. Con l'API Helm sono supportati i registri privati e basati su OCI.
- I valori Helm possono essere gestiti nella fonte attendibile. Con l'API Helm, i valori vengono gestiti come parte dell'API RootSync o RepoSync.
- È supportato il rendering di più grafici Helm in un oggetto RootSync o RepoSync. Con l'API Helm, puoi eseguire il rendering di un solo grafico Helm in un oggetto RootSync o RepoSync.
Requisiti di Config Sync per Kustomize
Per eseguire automaticamente il rendering delle configurazioni Kustomize e dei grafici Helm, assicurati che l'ambiente Config Sync soddisfi i seguenti requisiti:
- Utilizza una fonte di dati non strutturata. Il rendering automatico non è supportato per le origini gerarchiche.
- Per attivare il processo di rendering, la tua fonte attendibile deve avere un
file di configurazione di Kustomization (
kustomization.yaml
,kustomization.yml
oKustomization
) nella radice della directory. Se la directory principale non ha un file di configurazione di Kustomization, Config Sync sincronizza le configurazioni così come sono senza alcun rendering. - Includi le tue configurazioni nel file
kustomization.yaml
. Se non includi questi file di configurazione, le configurazioni non vengono sincronizzate con il cluster.
Esegui il rendering dei grafici Helm tramite Kustomize
Questa sezione spiega come eseguire il rendering dei grafici Helm tramite Kustomize. Le versioni Helm e Kustomize in bundle elencano le versioni Kustomize e Helm in bundle con la versione corrispondente di Config Sync.
Campi del grafico Helm
Puoi aggiungere i seguenti campi del grafico Helm ai file kustomization.yaml
per supportare il rendering dei grafici Helm tramite Kustomize:
Campo | Descrizione |
---|---|
helmGlobals |
Parametri applicati a tutti i grafici Helm |
helmGlobals.chartHome
|
Accetta una stringa. Un percorso, relativo alla radice di Kustomization, di una directory contenente una sottodirectory per ogni grafico da includere nella Kustomization. Il valore predefinito di questo campo è charts . |
helmGlobals.configHome
|
Accetta una stringa. Definisce un valore che Kustomize deve passare a Helm con la
variabile di ambiente HELM_CONFIG_HOME . Kustomize non tenta di leggere o scrivere questa directory. Se omesso, viene utilizzato TMP_DIR/helm , dove TMP_DIR è una directory temporanea creata da Kustomize per Helm. |
helmCharts
|
Un array di parametri del grafico Helm |
helmCharts.name
|
Accetta una stringa. Il nome del grafico. Questo campo è obbligatorio. |
helmCharts.version
|
Accetta una stringa. La versione del grafico |
helmCharts.repo
|
Accetta una stringa. L'URL utilizzato per individuare il grafico |
helmCharts.releaseName
|
Accetta una stringa. Sostituisce RELEASE_NAME nell'output del modello di grafico |
helmCharts.namespace
|
Accetta una stringa. Imposta lo spazio dei nomi di destinazione per una release (.Release.Namespace nel modello) |
helmCharts.valuesInline
|
Valori da utilizzare al posto dei valori predefiniti associati al grafico |
helmCharts.valuesFile
|
Accetta una stringa. ValuesFile è un percorso locale o un URL remoto di un file di valori da utilizzare al posto dei valori predefiniti che accompagnano il grafico. I valori predefiniti sono in CHART_HOME/NAME/values.yaml . |
helmCharts.valuesMerge
|
Accetta merge , override , (default)
o replace . ValuesMerge specifica come trattare ValuesInline
rispetto ai valori. |
helmCharts.includeCRDs
|
Accetta true o false . Specifica se Helm deve generare anche CustomResourceDefinitions. Il valore predefinito è false . |
Architettura di esempio per le configurazioni Kustomize
L'esempio seguente mostra come impostare la tua fonte attendibile per utilizzare le configurazioni Kustomize con rendering automatico. Questa
directory include tre overlay (team-a
, team-b
e team-c
) che
riferiscono alla stessa base.
Il seguente diagramma mostra la struttura delle directory:
├── base
│ ├── kustomization.yaml
│ ├── namespace.yaml
│ ├── networkpolicy.yaml
│ ├── rolebinding.yaml
│ └── role.yaml
├── kustomization.yaml
├── README.md
├── team-a
│ └── kustomization.yaml
├── team-b
│ └── kustomization.yaml
└── team-c
└── kustomization.yaml
Il seguente file kustomization.yaml
si trova nella radice della fonte attendibile e contiene riferimenti ai tre overlay:
# ./kustomization.yaml
resources:
- team-a
- team-b
- team-c
Il seguente kustomize.yaml
si trova nella directory team-a
ed è l'overlay
di team-a
:
# ./team-a/kustomization.yaml
namespace: team-a
resources:
- ../base
patches:
- target:
kind: RoleBinding
name: team-admin-rolebinding
patch: |-
- op: replace
path: /subjects/0/name
value: team-a-admin@mydomain.com
- target:
kind: Namespace
name: default
patch: |-
- op: replace
path: /metadata/name
value: team-a
Il seguente kustomization.yaml
si trova nella directory base
ed è la base Kustomize:
# ./base/kustomization.yaml
resources:
- namespace.yaml
- rolebinding.yaml
- role.yaml
- networkpolicy.yaml
Puoi esplorare un repository di esempio nella directory configurazione di criteri specifici dello spazio dei nomi in GitHub.
Visualizza un grafico Helm remoto
Config Sync supporta il rendering dei grafici Helm remoti sui cluster che hanno accesso pubblico a internet.
Il seguente kustomization.yaml
esegue il rendering di un cert-manager remoto impostando i seguenti campi helmCharts
:
# ./kustomization.yaml
...
helmCharts:
- name: cert-manager
repo: https://charts.jetstack.io
version: v1.5.3
releaseName: my-cert-manager
namespace: cert-manager
...
Visualizza un grafico Helm locale
Config Sync supporta il rendering dei grafici Helm locali. Per utilizzare una versione personalizzata di un grafico Helm, puoi estrarre la versione rilasciata dal grafico Helm (ad esempio, ArtifactHub), apportare modifiche localmente, quindi eseguire il push delle modifiche alla tua fonte di riferimento.
Il seguente kustomization.yaml
esegue il rendering di un grafico cert-manager
locale. La directory predefinita per i grafici Helm è charts
e, poiché questo grafico è inserito nella directory charts
, non è necessario specificare .helmCharts.repo
o .helmCharts.version
.
# ./kustomization.yaml
...
helmCharts:
- name: cert-manager
releaseName: my-cert-manager
namespace: cert-manager
...
Eseguire il rendering di più grafici Helm
Config Sync supporta il rendering di più grafici Helm in un file kustomization.yaml
, indipendentemente dal fatto che il grafico sia remoto o locale.
Il seguente kustomization.yaml
esegue il rendering di un grafico Helm locale (cert-manager
):
# ./kustomization.yaml
...
helmCharts:
- name: cert-manager
releaseName: my-cert-manager
namespace: cert-manager
- name: prometheus
repo: https://prometheus-community.github.io/helm-charts
version: 14.3.0
releaseName: my-prometheus
namespace: monitoring
...
Passaggi successivi
- Utilizzare Config Sync con Kustomize e Helm
- Utilizzare Config Sync in più ambienti con rendering automatico