Installazione di kf

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

Prima di iniziare

Panoramica

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

Requisiti del cluster GKE.

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

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

• Il tipo di macchina minimo con almeno quattro vCPU, come 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 in Registrare un cluster esistente in un canale di rilascio. se hai una versione GKE statica.

• Workload Identity abilitato.

Requisiti Kf. La matrice di dipendenza elenca le versioni specifiche.

• Artifact Registry.

• Cloud Service Mesh.

• Config Connector.

• Tekton per l'utilizzo da parte di Kf. Questo non è un servizio rivolto agli utenti.

• Un account di servizio Google dedicato.

Nota: la sezione Pulizia contiene istruzioni sull'eliminazione del cluster.

Abilita 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. Abilitare l'API Compute Engine.

   Abilita l'API

Abilita il supporto per 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 attività:

• Attiva l'API Google Kubernetes Engine.
Abilita l'API Google Kubernetes Engine
• Se vuoi utilizzare Google Cloud CLI per questa attività, install e poi inizializzare con gcloud CLI. Se hai già installato gcloud CLI, ottieni la versione più recente eseguendo gcloud components update.
  Nota: per gcloud CLI esistente di installazione, assicurati di impostare compute/region e compute/zone proprietà. Se imposti località predefinite, puoi evitare errori in gcloud CLI come i seguenti: One of [--zone, --region] must be supplied: Please specify location.

Preparare un nuovo cluster GKE e i servizi correlati

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 ti disconnetti dall'ambiente shell e ti riconetti in un secondo momento, devi configurare di nuovo le variabili.

Linux e Mac

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} # Replace ZONE with REGION to switch
export NODE_COUNT=4
export MACHINE_TYPE=e2-standard-4
export NETWORK=default

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 # Replace ZONE with REGION to switch
Set-Variable -Name NODE_COUNT -Value 4
Set-Variable -Name MACHINE_TYPE -Value e2-standard-4
Set-Variable -Name NETWORK -Value default

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 attentamente le implicazioni per la sicurezza derivanti dall'utilizzo di Workload Identity nel documento Panoramica sulla 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. Crea un nuovo ruolo IAM personalizzato.

   gcloud iam roles create serviceAccountUpdater \
   --project=${CLUSTER_PROJECT_ID} \
   --title "Service Account Updater" \
   --description "This role only updates members on a GSA" \
   --permissions iam.serviceAccounts.get,iam.serviceAccounts.getIamPolicy,iam.serviceAccounts.list,iam.serviceAccounts.setIamPolicy

3. 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 projects add-iam-policy-binding ${CLUSTER_PROJECT_ID} \
     --member="serviceAccount:${CLUSTER_NAME}-sa@${CLUSTER_PROJECT_ID}.iam.gserviceaccount.com" \
     --role="projects/${CLUSTER_PROJECT_ID}/roles/serviceAccountUpdater"

4. 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"

5. 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 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} \
  --disk-size "122" \
  --network=${NETWORK} \
  --addons HorizontalPodAutoscaling,HttpLoadBalancing,GcePersistentDiskCsiDriver \
  --enable-dataplane-v2 \
  --enable-stackdriver-kubernetes \
  --enable-ip-alias \
  --enable-autorepair \
  --enable-autoupgrade \
  --scopes 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 che alcune porte del firewall siano aperte. Il nodo master 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.

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

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

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 all'account di servizio l'autorizzazione 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: la matrice delle dipendenze sulla La pagina Download Kf contiene versioni bloccate per la versione Kf specificata.

1. Installa Cloud Service Mesh.

   1. Segui la guida all'installazione di Cloud Service Mesh.

2. Installa Config Connector.

   Nota: Config Connector è obbligatorio a partire da Kf v2.4.0.
   Avviso: non utilizzare il metodo del componente aggiuntivo GKE per installare Config Connector poiché non è supportato da Kf. Segui questa procedura di installazione personalizzata.

   1. Scarica il file tar dell'operatore Config Connector richiesto.

      Nota: conserva una copia del bundle di installazione perché ti serve questo bundle per disinstallare Config Connector.

   2. Estrai il file tar.

      tar zxvf release-bundle.tar.gz

   3. Installa l'operatore Config Connector nel cluster.

      kubectl apply -f operator-system/configconnector-operator.yaml

   4. Configura l'operatore Config Connector.

      1. Copia il seguente YAML in un file denominato configconnector.yaml:

         Avviso: sostituisci la variabile KF_SERVICE_ACCOUNT_NAME nel file YAML di seguito con l'account di servizio completo risolto da ${CLUSTER_NAME}-sa@${CLUSTER_PROJECT_ID}.iam.gserviceaccount.com

         # configconnector.yaml
         apiVersion: core.cnrm.cloud.google.com/v1beta1
         kind: ConfigConnector
         metadata:
           # the name is restricted to ensure that there is only one
           # ConfigConnector resource installed in your cluster
           name: configconnector.core.cnrm.cloud.google.com
         spec:
           mode: cluster
           googleServiceAccount: "KF_SERVICE_ACCOUNT_NAME" # Replace with the full service account resolved from ${CLUSTER_NAME}-sa@${CLUSTER_PROJECT_ID}.iam.gserviceaccount.com

      2. Applica la configurazione al cluster.

         kubectl apply -f configconnector.yaml

   5. Verifica che Config Connector sia completamente installato prima di continuare.

      • Config Connector esegue tutti i componenti in uno spazio dei nomi denominato cnrm-system. Verifica che i pod siano pronti eseguendo il seguente comando:

        Nota: l'avvio del pod del controller può richiedere diversi minuti, quindi questo comando potrebbe non funzionare immediatamente.

        kubectl wait -n cnrm-system --for=condition=Ready pod --all

      • Se Config Connector è installato correttamente, l'output sarà simile al seguente:

        pod/cnrm-controller-manager-0 condition met
        pod/cnrm-deletiondefender-0 condition met
        pod/cnrm-resource-stats-recorder-86858dcdc5-6lqzb condition met
        pod/cnrm-webhook-manager-58c799b8fb-kcznq condition met
        pod/cnrm-webhook-manager-58c799b8fb-n2zpx condition met

   6. Configura Workload Identity.

      kubectl annotate serviceaccount \
      --namespace cnrm-system \
      --overwrite \
      cnrm-controller-manager \
      iam.gke.io/gcp-service-account=${CLUSTER_NAME}-sa@${CLUSTER_PROJECT_ID}.iam.gserviceaccount.com

3. Installazione di Tekton:

   kubectl apply -f "https://storage.googleapis.com/tekton-releases/pipeline/previous/v0.23.0/release.yaml"

Installazione di kf

Nota: assicurati che il cluster soddisfi i requisiti descritti in Creare e preparare un cluster GKE per Kf.

1. Installa l'interfaccia a riga di comando Kf:

   Linux

   Questo comando installa l'interfaccia a riga di comando Kf per tutti gli utenti del sistema. Segui le nella scheda Cloud Shell per installarlo autonomamente.

   gcloud storage cp gs://kf-releases/v2.5.4/kf-linux /tmp/kf
   chmod a+x /tmp/kf
   sudo mv /tmp/kf /usr/local/bin/kf

   Mac

   Questo comando installa kf per tutti gli utenti del sistema.

   gcloud storage cp gs://kf-releases/v2.5.4/kf-darwin /tmp/kf
   chmod a+x /tmp/kf
   sudo mv /tmp/kf /usr/local/bin/kf

   Cloud Shell

   Questo comando installa kf sulla tua istanza di Cloud Shell se utilizzi bash, potrebbe essere necessario modificare le istruzioni per altre shell.

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

   Windows

   Questo comando scarica kf nella directory corrente. Aggiungila al percorso se vuoi chiamarla da un punto diverso dalla directory corrente.

   gcloud storage cp gs://kf-releases/v2.5.4/kf-windows.exe kf.exe

2. Installa l'operatore:

   kubectl apply -f "https://storage.googleapis.com/kf-releases/v2.5.4/operator.yaml"

3. Configura l'operatore per Kf:

   kubectl apply -f "https://storage.googleapis.com/kf-releases/v2.5.4/kfsystem.yaml"

4. Configura i secret e i valori predefiniti:

   export CONTAINER_REGISTRY=${COMPUTE_REGION}-docker.pkg.dev/${CLUSTER_PROJECT_ID}/${CLUSTER_NAME}
   
   kubectl patch \
   kfsystem kfsystem \
   --type='json' \
   -p="[{'op': 'replace', 'path': '/spec/kf', 'value': {'enabled': true, 'config': {'spaceContainerRegistry': '${CONTAINER_REGISTRY}', 'secrets':{'workloadidentity':{'googleserviceaccount':'${CLUSTER_NAME}-sa', 'googleprojectid':'${CLUSTER_PROJECT_ID}'}}}}}]"
   

Convalida l'installazione

  kf doctor --retries=20

Nota: questo comando ispeziona il cluster per garantire che Kf e le sue dipendenze siano installati e funzionino. Verrà eseguito fino a 20 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

Questa procedura dovrebbe rimuovere tutti i componenti creati nel Sezione Crea e prepara 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}