In questo tutorial, aggiungerai al repository configurazioni Kustomize che fanno riferimento ai grafici Helm, quindi utilizzerai Config Sync per sincronizzare il cluster con il repository.
Quando utilizzi Config Sync, il rendering delle configurazioni Kustomize e dei grafici Helm che posizioni nel repository Git viene eseguito automaticamente. Il rendering automatico offre i seguenti vantaggi:
Non hai più bisogno di una pipeline di idratazione esterna. Senza il rendering automatico, devi eseguire manualmente il rendering delle configurazioni utilizzando Kustomize e Helm sulla tua workstation oppure impostare un passaggio per attivare il processo di idratazione nei tuoi sistemi CI. Con il rendering automatico, Config Sync gestisce l'esecuzione.
I costi di manutenzione sono ridotti. Senza il rendering automatico, devi gestire un repository Git con le configurazioni Kustomize originali e i grafici Helm e un altro repository Git con l'output generato dall'idratazione esterna. Poi devi configurare Config Sync per sincronizzarlo dal repository Git. Con il rendering automatico, devi gestire solo un repository con le configurazioni originali.
Il tuo flusso di lavoro di sviluppo è semplificato. Senza il rendering automatico, le modifiche apportate alle configurazioni originali devono essere esaminate due volte prima di essere unite: una volta nel repository originale e di nuovo nel repository sottoposto a rendering. Con il rendering automatico, le configurazioni sottoposte a rendering vengono generate tramite Config Sync e devi solo esaminare le modifiche apportate alle configurazioni originali.
Obiettivi
- Configura il tuo repository con configurazioni Kustomize che fanno riferimento a un grafico Helm pronto per l'uso per cert-manager. cert-manager è uno strumento per Kubernetes che ti aiuta a gestire i certificati.
- Visualizza in anteprima e convalida le configurazioni che crei.
- Utilizza Config Sync per eseguire automaticamente il rendering del grafico e sincronizzare il cluster con il repository.
- Verifica che l'installazione sia andata a buon fine.
Costi
In questo documento vengono utilizzati i seguenti componenti fatturabili di Google Cloud:
Per generare una stima dei costi in base all'utilizzo previsto,
utilizza il Calcolatore prezzi.
Una volta completate le attività descritte in questo documento, puoi evitare la fatturazione continua eliminando le risorse che hai creato. Per ulteriori informazioni, consulta la pagina Pulizia.
Prima di iniziare
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Assicurati che la fatturazione sia attivata per il tuo progetto Google Cloud.
- Crea o assicurati di avere accesso a un cluster che soddisfi i requisiti per Config Sync e utilizzi le seguenti impostazioni di Config Sync:
- Utilizza un repository non strutturato.
- Le API
RootSync
eRepoSync
sono abilitate. spec.override.enableShellInRendering
è impostato sutrue
per consentire a Config Sync di supportare il pull delle basi remote da repository pubblici durante il processo di rendering.
- Registra il cluster in un parco risorse.
- Installa lo strumento a riga di comando
nomos
. Se hai già installato lo strumentonomos
, assicurati di eseguirne l'upgrade alla versione 1.9.0 o successiva. - Installa Helm.
È utile anche avere familiarità con Git, Kustomize e Helm.
Configura il repository
Le attività seguenti mostrano come preparare un repository Git con configurazioni che combinano le configurazioni Kustomize con i grafici Helm:
Crea o assicurati di avere accesso a un repository Git. Poiché il repository utilizza Kustomize e Helm, dovrebbe essere un repository non strutturato.
Nella radice del repository Git, crea un file denominato
kustomization.yaml
e incolla al suo interno il codice seguente:# ./kustomization.yaml resources: - base patches: - path: ignore-deployment-mutation-patch.yaml target: kind: Deployment
Questo file è un overlay Kustomize che punta alla base Kustomize. Questo overlay include una patch per la base del grafico Helm che aggiunge l'annotazione
client.lifecycle.config.k8s.io/mutation: ignore
a tutti gli oggetti Deployment. L'annotazione fa sì che Config Sync ignori tutte le modifiche in conflitto a questo oggetto nel cluster dopo la sua creazione.Nel tuo repository Git, crea una directory denominata
base
:mkdir base
Nella directory
base
, crea un altro file denominatokustomization.yaml
e incolla al suo interno il codice seguente:# ./base/kustomization.yaml helmCharts: - name: cert-manager repo: https://charts.jetstack.io version: v1.5.3 releaseName: my-cert-manager namespace: cert-manager
Questo file è la base Kustomize, che esegue il rendering del grafico Helm remoto.
Torna alla radice del repository Git, crea un file denominato
ignore-deployment-mutation-patch.yaml
e incolla al suo interno il codice seguente:# ./ignore-deployment-mutation-patch.yaml apiVersion: apps/v1 kind: Deployment metadata: name: any annotations: client.lifecycle.config.k8s.io/mutation: ignore
Questo file è una patch applicata al grafico Helm di base. Aggiunge l'annotazione
client.lifecycle.config.k8s.io/mutation: ignore
a tutti i deployment nella directory di base.Esegui il commit delle modifiche nel repository:
git add . git commit -m 'Set up manifests.' git push
Il repository di esempio presenta un esempio dell'aspetto di un repository di questo tipo.
Visualizzare in anteprima e convalidare le configurazioni sottoposte a rendering
Prima che Config Sync esegua il rendering delle configurazioni e le sincronizzi con il cluster, assicurati che siano accurate eseguendo nomos hydrate
per visualizzare l'anteprima della configurazione visualizzata ed eseguendo nomos vet
per verificare che il formato sia corretto.
Esegui questo comando
nomos hydrate
con i seguenti flag:nomos hydrate \ --source-format=unstructured \ --output=OUTPUT_DIRECTORY
In questo comando:
--source-format=unstructured
consente anomos hydrate
di lavorare su un repository non strutturato. Poiché utilizzi le configurazioni Kustomize e i grafici Helm, devi usare un repository non strutturato e aggiungere questo flag.--output=OUTPUT_DIRECTORY
consente di definire un percorso alle configurazioni visualizzate. SostituisciOUTPUT_DIRECTORY
con la posizione in cui vuoi salvare l'output.
Controlla la sintassi e la validità delle tue configurazioni eseguendo
nomos vet
con i seguenti flag:nomos vet \ --source-format=unstructured \ --keep-output=true \ --output=OUTPUT_DIRECTORY
In questo comando:
--source-format=unstructured
consente anomos vet
di lavorare su un repository non strutturato.--keep-output=true
salva le configurazioni sottoposte a rendering.--output=OUTPUT_DIRECTORY
è il percorso delle configurazioni visualizzate.
Configura la sincronizzazione dal repository Git
Ora che hai creato un repository con le configurazioni che vuoi utilizzare, puoi configurare la sincronizzazione dal cluster al repository. Se hai già installato Config Sync, vai a Verificare lo stato della sincronizzazione.
Nella console Google Cloud, abilita l'API GKE Hub.
- Nella console Google Cloud, vai alla pagina Configurazione nella sezione Funzionalità.
Fai clic su add Installa Config Sync.
Seleziona Upgrade automatici per consentire a Config Sync di eseguire l'upgrade automatico delle versioni.
In Opzioni di installazione, seleziona Installa Config Sync su singoli cluster.
Nella tabella Cluster disponibili, seleziona
cs-cluster
e fai clic su Installa Config Sync. Nella scheda Impostazioni, dovresti vedere lo stato dics-cluster
come Abilitato dopo alcuni minuti.Nella dashboard di Config Sync, fai clic su Esegui il deployment del pacchetto.
Nella tabella Seleziona cluster per il deployment dei pacchetti, seleziona
cs-cluster
e fai clic su Continua.Lascia selezionato Pacchetto ospitato su Git e fai clic su Continua.
Nel campo Nome pacchetto, inserisci
sample-repository
.Nel campo URL repository, inserisci
https://github.com/GoogleCloudPlatform/anthos-config-management-samples
.Nel campo Percorso, inserisci
config-sync-quickstart/multirepo/root
.Lascia invariati i valori predefiniti di tutti gli altri campi.
Fai clic su Esegui il deployment del pacchetto.
Dopo alcuni minuti, dovresti vedere Sincronizzato nella colonna Stato sincronizzazione per
cs-cluster
.
Verifica l'installazione
Dopo aver installato e configurato Config Sync, puoi verificare che l'installazione sia stata completata correttamente.
Verifica che non siano presenti altri errori utilizzando
nomos status
:nomos status
Output di esempio:
*CLUSTER_NAME -------------------- <root> https:/github.com/GoogleCloudPlatform/anthos-config-management-samples.git/helm-component/manifests@init SYNCED fd17dd5a
Verifica che il componente Helm sia stato installato correttamente:
kubectl get all -n cert-manager
Output di esempio:
NAME READY STATUS RESTARTS AGE pod/my-cert-manager-54f5ccf74-wfzs4 1/1 Running 0 10m pod/my-cert-manager-cainjector-574bc8678c-rh7mq 1/1 Running 0 10m pod/my-cert-manager-webhook-7454f4c77d-rkct8 1/1 Running 0 10m NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE service/my-cert-manager ClusterIP 10.76.9.35 <none> 9402/TCP 10m service/my-cert-manager-webhook ClusterIP 10.76.11.205 <none> 443/TCP 10m NAME READY UP-TO-DATE AVAILABLE AGE deployment.apps/my-cert-manager 1/1 1 1 10m deployment.apps/my-cert-manager-cainjector 1/1 1 1 10m deployment.apps/my-cert-manager-webhook 1/1 1 1 10m NAME DESIRED CURRENT READY AGE replicaset.apps/my-cert-manager-54f5ccf74 1 1 1 10m replicaset.apps/my-cert-manager-cainjector-574bc8678c 1 1 1 10m replicaset.apps/my-cert-manager-webhook-7454f4c77d 1 1 1 10m
Esegui la pulizia
Per evitare che al tuo Account Google Cloud vengano addebitati costi relativi alle risorse utilizzate in questo tutorial, elimina il progetto che contiene le risorse oppure mantieni il progetto ed elimina le singole risorse.
Elimina il progetto
- Nella console Google Cloud, vai alla pagina Gestisci risorse.
- Nell'elenco dei progetti, seleziona il progetto che vuoi eliminare, quindi fai clic su Elimina.
- Nella finestra di dialogo, digita l'ID del progetto e fai clic su Chiudi per eliminare il progetto.
Elimina singole risorse
Elimina i manifest nel repository
Per evitare l'eliminazione accidentale, Config Sync non consente di rimuovere tutti gli spazi dei nomi o le risorse con ambito cluster in un singolo commit. Segui queste istruzioni per disinstallare normalmente il componente e rimuovere lo spazio dei nomi in commit separati:
Rimuovi il componente cert-manager dal tuo repository:
git rm -rf manifests/cert-manager \ && git commit -m "uninstall cert-manager" \ && git push origin BRANCH
Sostituisci
BRANCH
con il ramo in cui hai creato il repository.Elimina lo spazio dei nomi cert-manager:
git rm manifests/namespace-cert-manager.yaml \ && git commit -m "remove the cert-manager namespace" \ && git push origin BRANCH
Verifica che lo spazio dei nomi cert-manager non esista:
kubectl get namespace cert-namespace
Output di esempio:
Error from server (NotFound): namespaces "cert-namespace" not found
Elimina il cluster
Per eliminare il cluster, completa questi comandi:
Console
Per eliminare un cluster utilizzando la console Google Cloud, completa le seguenti attività:
Nella console Google Cloud, vai alla pagina GKE.
Accanto al cluster da eliminare, fai clic su more_vert Azioni e poi su delete Elimina.
Quando ti viene chiesto di confermare, fai di nuovo clic su Elimina.
gcloud
Per eliminare un cluster utilizzando Google Cloud CLI, esegui questo comando:
gcloud container clusters delete CLUSTER_NAME
Per saperne di più, consulta la documentazione di gcloud container clusters delete
.
Passaggi successivi
- Scopri di più sull'utilizzo di repository non strutturati.
- Esplora le architetture di riferimento, i diagrammi e le best practice su Google Cloud. Visita il nostro Cloud Architecture Center.