Installazione di kf

Questo documento descrive come configurare un cluster GKE, quindi installare Kf e le relative dipendenze.

Prima di iniziare

Panoramica

Nota: al momento i cluster GKE Autopilot non sono in grado di eseguire Kf. Utilizza un cluster GKE Standard. Per ulteriori informazioni su queste modalità e su Autopilot, consulta la panoramica di Autopilot.

• Il cluster GKE deve soddisfare i seguenti requisiti:

  • Facoltativo, ma consigliato, il cluster deve essere dedicato a Kf. Ti consigliamo di installare solo Kf e le relative dipendenze per garantire la manutenzione della matrice di compatibilità.

  • Almeno quattro nodi. Se devi aggiungere nodi, consulta Ridimensionare un cluster.

  • Il tipo di macchina minimo che ha almeno quattro vCPU, ad esempio e2-standard-4. Se il tipo di macchina per il cluster non ha almeno quattro vCPU, modificalo come descritto in Eseguire la migrazione dei carichi di lavoro a tipi di macchine diversi.

  • Facoltativo, ma consigliato, registra il cluster in un canale di rilascio. Se hai una versione GKE statica, segui le istruzioni riportate in Registrare un cluster esistente in un canale di rilascio.

  • Workload Identity abilitata.

  • Artifact Registry abilitato.

  • Cloud Service Mesh (ASM).

  • Tekton installato. Consulta la matrice delle dipendenze per la versione.

  • Un account di servizio Google con la seguente policy IAM (le istruzioni per la creazione sono riportate di seguito):

    • roles/iam.serviceAccountAdmin
    • serviceAccount:${CLUSTER_PROJECT}.svc.id.goog[kf/controller] (per il membro serviceAccount:${CLUSTER_PROJECT}.svc.id.goog[kf/controller])

Nota: la sezione Liberare spazio contiene le istruzioni per eliminare il cluster.

Abilitare il supporto per Compute Engine

Accedi al tuo Google Cloud account. Se non hai mai utilizzato Google Cloud, crea un account per valutare il rendimento dei nostri prodotti in scenari reali. I nuovi clienti ricevono anche 300 $di crediti senza costi per l'esecuzione, il test e il deployment dei workload.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

1. Abilita l'API Compute Engine.

   Abilita l'API

Abilitare il supporto per Artifact Registry

1. Abilita l'API Artifact Registry.

   Abilita l'API Artifact Registry

Abilitare e configurare GKE

Prima di iniziare, assicurati di aver eseguito le seguenti attività:

• Abilita l'API Google Kubernetes Engine.
Abilita l'API Google Kubernetes Engine
• Se vuoi utilizzare Google Cloud CLI per questa attività, installala e poi inizializza gcloud CLI. Se hai già installato gcloud CLI, scarica l'ultima versione eseguendo il gcloud components update comando. Le versioni precedenti di gcloud CLI potrebbero non supportare l'esecuzione dei comandi in questo documento.
  Nota: per le installazioni esistenti di gcloud CLI assicurati di impostare la compute/region proprietà. Se utilizzi principalmente cluster zonali, imposta invece compute/zone. Se imposti una località predefinita, puoi evitare errori in gcloud CLI come il seguente: One of [--zone, --region] must be supplied: Please specify location. Potresti dover specificare la posizione in determinati comandi se la posizione del cluster è diversa da quella predefinita che hai impostato.

Creare e preparare un nuovo cluster GKE

Impostare le variabili di ambiente

Nota: esporta queste variabili di ambiente nel terminale o in Cloud Shell per far funzionare i comandi successivi. Se ti disconnetti dall'ambiente shell e ti riconnetti in un secondo momento, devi configurare di nuovo le variabili.

Nota: prima di configurare le variabili di ambiente, assicurati di controllare la matrice delle dipendenze nella pagina Download di Kf per la versione di Kf specificata.

Linux

export PROJECT_ID=YOUR_PROJECT_ID
export CLUSTER_PROJECT_ID=YOUR_PROJECT_ID
export CLUSTER_NAME=kf-cluster
export COMPUTE_ZONE=us-central1-a
export COMPUTE_REGION=us-central1
export CLUSTER_LOCATION=${COMPUTE_ZONE}
export NODE_COUNT=4
export MACHINE_TYPE=e2-standard-4
export NETWORK=default
export KF_VERSION=v2.3.2
export TEKTON_VERSION=v0.19.0

Windows PowerShell

Set-Variable -Name PROJECT_ID -Value YOUR_PROJECT_ID
Set-Variable -Name CLUSTER_PROJECT_ID -Value YOUR_PROJECT_ID
Set-Variable -Name CLUSTER_NAME -Value kf-cluster
Set-Variable -Name COMPUTE_ZONE -Value us-central1-a
Set-Variable -Name COMPUTE_REGION -Value us-central1
Set-Variable -Name CLUSTER_LOCATION -Value $COMPUTE_ZONE
Set-Variable -Name NODE_COUNT -Value 4
Set-Variable -Name MACHINE_TYPE -Value e2-standard-4
Set-Variable -Name NETWORK -Value default
Set-Variable -Name KF_VERSION -Value v2.3.0
Set-Variable -Name TEKTON_VERSION -Value v0.19.0

Creazione dell'account di servizio

Crea un account di servizio Google Cloud (GSA) che verrà associato a un account di servizio Kubernetes tramite Workload Identity. In questo modo non è necessario creare e inserire una chiave dell'account di servizio.

Nota: leggi e comprendi le implicazioni di sicurezza dell'utilizzo di Workload Identity nel documento Panoramica sulla sicurezza.

1. Crea il account di servizio che verrà utilizzato da Kf.

   gcloud iam service-accounts create ${CLUSTER_NAME}-sa \
     --project=${CLUSTER_PROJECT_ID} \
     --description="GSA for Kf ${CLUSTER_NAME}" \
     --display-name="${CLUSTER_NAME}"

2. Consenti al account di servizio di modificare la propria policy. Il controller Kf lo utilizzerà per aggiungere nuovi spazi dei nomi alla policy, consentendone il riutilizzo per Workload Identity.

   gcloud iam service-accounts add-iam-policy-binding ${CLUSTER_NAME}-sa@${CLUSTER_PROJECT_ID}.iam.gserviceaccount.com \
     --project=${CLUSTER_PROJECT_ID} \
     --role="roles/iam.serviceAccountAdmin" \
     --member="serviceAccount:${CLUSTER_NAME}-sa@${CLUSTER_PROJECT_ID}.iam.gserviceaccount.com"

3. Assegna il ruolo delle metriche di monitoraggio per l'accesso in scrittura a Cloud Monitoring.

   gcloud projects add-iam-policy-binding ${CLUSTER_PROJECT_ID} \
     --member="serviceAccount:${CLUSTER_NAME}-sa@${CLUSTER_PROJECT_ID}.iam.gserviceaccount.com" \
     --role="roles/monitoring.metricWriter"

4. Assegna il ruolo di logging per l'accesso in scrittura a Cloud Logging.

   gcloud projects add-iam-policy-binding ${CLUSTER_PROJECT_ID} \
     --member="serviceAccount:${CLUSTER_NAME}-sa@${CLUSTER_PROJECT_ID}.iam.gserviceaccount.com" \
     --role="roles/logging.logWriter"

Creare un cluster GKE

Nota: a scopo dimostrativo, queste istruzioni utilizzano un cluster zonale. Per i deployment di produzione, è consigliabile un cluster regionale.

gcloud container clusters create ${CLUSTER_NAME} \
  --project=${CLUSTER_PROJECT_ID} \
  --zone=${CLUSTER_LOCATION} \
  --num-nodes=${NODE_COUNT} \
  --machine-type=${MACHINE_TYPE} \
  --network=${NETWORK} \
  --addons=HttpLoadBalancing,HorizontalPodAutoscaling,NetworkPolicy \
  --enable-stackdriver-kubernetes \
  --enable-ip-alias \
  --enable-network-policy \
  --enable-autorepair \
  --enable-autoupgrade \
  --scopes=https://www.googleapis.com/auth/cloud-platform \
  --release-channel=regular \
  --workload-pool="${CLUSTER_PROJECT_ID}.svc.id.goog" \
  --service-account="${CLUSTER_NAME}-sa@${CLUSTER_PROJECT_ID}.iam.gserviceaccount.com"

Impostare regole firewall

Kf richiede l'apertura di alcune porte firewall. Il nodo master deve essere in grado di comunicare con i pod sulle porte 80, 443, 8080, 8443 e 6443.

Abilitare Workload Identity

Ora che hai un account di servizio e un cluster GKE, associa lo spazio dei nomi dell'identità del cluster al cluster.

gcloud iam service-accounts add-iam-policy-binding \
  "${CLUSTER_NAME}-sa@${CLUSTER_PROJECT_ID}.iam.gserviceaccount.com" \
  --project=${CLUSTER_PROJECT_ID} \
  --role="roles/iam.workloadIdentityUser" \
  --member="serviceAccount:${CLUSTER_PROJECT_ID}.svc.id.goog[kf/controller]"

Cluster GKE di destinazione

Configura l'accesso alla riga di comando kubectl eseguendo il comando seguente.

gcloud container clusters get-credentials ${CLUSTER_NAME} \
    --project=${CLUSTER_PROJECT_ID} \
    --zone=${CLUSTER_LOCATION}

Creare un repository Artifact Registry

1. Crea un registro Artifact Registry in cui archiviare le immagini container.

   gcloud artifacts repositories create ${CLUSTER_NAME} \
     --project=${CLUSTER_PROJECT_ID} \
     --repository-format=docker \
     --location=${COMPUTE_REGION}

2. Concedi al account di servizio l'autorizzazione sul repository Artifact Registry.

   gcloud artifacts repositories add-iam-policy-binding ${CLUSTER_NAME} \
     --project=${CLUSTER_PROJECT_ID} \
     --location=${COMPUTE_REGION} \
     --member="serviceAccount:${CLUSTER_NAME}-sa@${CLUSTER_PROJECT_ID}.iam.gserviceaccount.com" \
     --role='roles/artifactregistry.writer'

Installare le dipendenze software sul cluster

Nota: prima di installare qualsiasi elemento, assicurati di controllare la matrice delle dipendenze nella pagina Download di Kf per la versione di Kf specificata.

1. Installa Service Mesh.

   Nota: consulta la matrice delle dipendenze per la versione corretta.

2. Installa Tekton:

   Nota: consulta la matrice delle dipendenze per la versione corretta.

   kubectl apply -f "https://github.com/tektoncd/pipeline/releases/download/${TEKTON_VERSION}/release.yaml"

Installare Kf

1. Consulta Creare e preparare un cluster GKE per Kf per creare un cluster pronto per l'esecuzione di Kf.

2. Seleziona e annota la release di Kf che preferisci. Consulta la pagina Download di Kf per le versioni disponibili

   Nota: molti dei comandi in questa guida dipendono da queste variabili di ambiente. Se ti disconnetti dall'ambiente shell e ti riconnetti in un secondo momento, dovrai configurare di nuovo le variabili.

3. Installa l'interfaccia a riga di comando:

   Linux

   Verrà installato kf per tutti gli utenti del sistema. Segui le istruzioni nella scheda Cloud Shell per installarlo solo per te.

   gcloud storage cp gs://kf-releases/${KF_VERSION}/kf-linux /tmp/kf
   chmod a+x /tmp/kf
   sudo mv /tmp/kf /usr/local/bin/kf

   Mac

   Verrà installato kf per tutti gli utenti del sistema.

   gcloud storage cp gs://kf-releases/${KF_VERSION}/kf-darwin /tmp/kf
   chmod a+x /tmp/kf
   sudo mv /tmp/kf /usr/local/bin/kf

   Cloud Shell

   Se utilizzi bash, kf verrà installato sull'istanza Cloud Shell. Le istruzioni potrebbero dover essere modificate per altre shell.

   mkdir -p ~/bin
   gcloud storage cp gs://kf-releases/${KF_VERSION}/kf-linux ~/bin/kf
   chmod a+x ~/bin/kf
   echo "export PATH=$HOME/bin:$PATH" >> ~/.bashrc
   source ~/.bashrc

   Windows

   kf verrà scaricato nella directory corrente. Aggiungilo al percorso se vuoi chiamarlo da una directory diversa da quella corrente.

   gcloud storage cp gs://kf-releases/${KF_VERSION}/kf-windows.exe kf.exe

4. Installa i componenti del server:

   Linux e Mac

   kf.yaml verrà scaricato nella directory corrente.

   gcloud storage cp gs://kf-releases/${KF_VERSION}/kf.yaml /tmp/kf.yaml
   kubectl apply -f /tmp/kf.yaml

   Windows

   kf.yaml verrà scaricato nella directory corrente.

   gcloud storage cp gs://kf-releases/${KF_VERSION}/kf.yaml kf.yaml
   kubectl apply -f kf.yaml

5. Configura i secret:

   export WI_ANNOTATION=iam.gke.io/gcp-service-account=${CLUSTER_NAME}-sa@${CLUSTER_PROJECT_ID}.iam.gserviceaccount.com
   
   kubectl annotate serviceaccount controller ${WI_ANNOTATION} \
   --namespace kf \
   --overwrite
   
   echo "{\"apiVersion\":\"v1\",\"kind\":\"ConfigMap\",\"metadata\":{\"name\":\"config-secrets\", \"namespace\":\"kf\"},\"data\":{\"wi.googleServiceAccount\":\"${CLUSTER_NAME}-sa@${CLUSTER_PROJECT_ID}.iam.gserviceaccount.com\"}}" | kubectl apply -f -

6. Configura i valori predefiniti di Kf. Questi valori possono essere modificati in un secondo momento. L'esempio seguente utilizza modelli di dominio con un provider DNS con caratteri jolly per fornire a ogni spazio il proprio nome di dominio:

   export CONTAINER_REGISTRY=${COMPUTE_REGION}-docker.pkg.dev/${CLUSTER_PROJECT_ID}/${CLUSTER_NAME}
   export DOMAIN='$(SPACE_NAME).$(CLUSTER_INGRESS_IP).nip.io'
   
   kubectl patch configmaps config-defaults \
   -n=kf \
   -p="{\"data\":{\"spaceContainerRegistry\":\"${CONTAINER_REGISTRY}\",\"spaceClusterDomains\":\"- domain: ${DOMAIN}\"}}"

7. Verifica l'installazione:

   kf doctor --retries 10

   Nota: questo comando ispezionerà il cluster per assicurarsi che Kf e le relative dipendenze siano installati e funzionanti. Verrà eseguito fino a 10 volte per dare al cluster Kubernetes il tempo di riconciliarsi e dovrebbe generare una serie di risultati PASS. Se lo stato di un componente restituisce FAIL dopo i tentativi, consulta la pagina Risoluzione dei problemi di Kf.

Liberare spazio

Questi passaggi dovrebbero rimuovere tutti i componenti creati nella sezione Creare e preparare un nuovo cluster GKE.

1. Elimina il service account Google:

   gcloud iam service-accounts delete ${CLUSTER_NAME}-sa@${CLUSTER_PROJECT_ID}.iam.gserviceaccount.com

2. Elimina le associazioni delle policy IAM:

   gcloud projects remove-iam-policy-binding ${CLUSTER_PROJECT_ID} \
     --member="serviceAccount:${CLUSTER_NAME}-sa@${CLUSTER_PROJECT_ID}.iam.gserviceaccount.com" \
     --role="roles/storage.admin"
   
   gcloud projects remove-iam-policy-binding ${CLUSTER_PROJECT_ID} \
     --member="serviceAccount:${CLUSTER_NAME}-sa@${CLUSTER_PROJECT_ID}.iam.gserviceaccount.com" \
     --role="roles/iam.serviceAccountAdmin"
   
   gcloud projects remove-iam-policy-binding ${CLUSTER_PROJECT_ID} \
     --member="serviceAccount:${CLUSTER_NAME}-sa@${CLUSTER_PROJECT_ID}.iam.gserviceaccount.com" \
     --role="roles/monitoring.metricWriter"

3. Elimina il repository di immagini container:

   gcloud artifacts repositories delete ${CLUSTER_NAME} \
     --location=${COMPUTE_REGION}

4. Elimina il cluster GKE:

   gcloud container clusters delete ${CLUSTER_NAME} --zone ${CLUSTER_LOCATION}