Installazione di kf

Questo documento descrive come configurare un cluster GKE e 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 assicurarti che la matrice di compatibilità venga mantenuta.

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

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

  • Facoltativo, ma consigliato: registra il cluster in un canale di rilascio. Segui le istruzioni riportate nella sezione Registrazione di un cluster esistente in un canale di rilascio se hai una versione GKE statica.

  • Workload Identity abilitato.

  • Artifact Registry abilitato.

  • Cloud Service Mesh (ASM).

  • Tekton installato. Consulta la matrice di dipendenza per la versione.

  • Un account di servizio Google con il seguente criterio IAM (istruzioni per la creazione disponibili di seguito):

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

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

Attivare il supporto per Compute Engine

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

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

   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

3. Make sure that billing is enabled for your Google Cloud project.

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

   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

5. Make sure that billing is enabled for your Google Cloud project.

6. Abilita l'API Compute Engine.

   Abilita l'API

Attivare il supporto di Artifact Registry

1. Abilita l'API Artifact Registry.

   Abilita l'API Artifact Registry

Attiva e configura GKE

Prima di iniziare, assicurati di aver eseguito le seguenti operazioni:

• Attiva l'API Google Kubernetes Engine.
Attiva l'API Google Kubernetes Engine
• Se vuoi utilizzare Google Cloud CLI per questa attività, installa e poi inizializza gcloud CLI. Se hai già installato gcloud CLI, ottieni la versione più recente eseguendo gcloud components update.
  Nota: per le installazioni esistenti di gcloud CLI, assicurati di impostare le proprietà compute/region e compute/zone. Se imposti le posizioni predefinite, puoi evitare errori in gcloud CLI come il seguente: One of [--zone, --region] must be supplied: Please specify location.

Crea e prepara un nuovo cluster GKE

Configura le variabili di ambiente

Nota: esporta queste variabili di ambiente nel terminale o in Cloud Shell per consentire il funzionamento dei comandi successivi. Se disconnetti l'ambiente shell e ti riconetti 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

Configurazione 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 iniettare una chiave dell'account di servizio.

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

1. Crea l'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 all'account di servizio di modificare il proprio criterio. Il controller Kf lo utilizzerà per aggiungere nuovi spazi (name) al criterio, consentendo 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 di monitoraggio delle metriche 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"

Crea un cluster GKE

Nota: a scopo dimostrativo, queste istruzioni utilizzano un cluster zonale. Per i deployment in produzione, è consigliato 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"

Imposta regole firewall

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

Abilita Workload Identity

Ora che hai un account di servizio e un cluster GKE, associa allo spazio dei nomi dell'identità del cluster il 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 seguente comando.

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

Crea un repository Artifact Registry

1. Crea un Artifact Registry per archiviare le immagini container.

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

2. Concedi l'autorizzazione all'account di servizio nel 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'

Installa le dipendenze software sul cluster

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

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"

Installazione di kf

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

2. Seleziona e prendi nota della release di Kf che ti interessa. 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 riconetti in un secondo momento, dovrai configurare di nuovo le variabili.

3. Installa l'interfaccia a riga di comando:

   Linux

   In questo modo, kf verrà installato 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

   In questo modo, kf verrà installato 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, verrà installato kf sulla tua istanza Cloud Shell. È possibile che le istruzioni debbano 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

   Verrà scaricato kf nella directory corrente. Aggiungila al percorso se vuoi chiamarla da un punto diverso dalla directory corrente.

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

4. Installa i componenti del server:

   Linux e Mac

   Verrà scaricato il file kf.yaml nella directory corrente.

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

   Windows

   Verrà scaricato il file kf.yaml 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, che possono essere modificati in un secondo momento. L'esempio seguente utilizza modelli di dominio con un provider DNS 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. Convalida l'installazione:

   kf doctor --retries 10

   Nota: questo comando ispeziona il cluster per verificare che Kf e le sue dipendenze siano installati e funzionanti. Verrà eseguito fino a 10 volte per dare al cluster Kubernetes il tempo di eseguire la riconciliazione e dovrebbe generare una serie di risultati PASS. Se lo stato di un componente risulta FAIL dopo i tentativi di ripetizione, consulta la pagina Risoluzione dei problemi di Knowledge Factory.

Esegui la pulizia

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

1. Elimina l'account di servizio Google:

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

2. Elimina le associazioni dei criteri 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}