Menginstal Kf

Dokumen ini menjelaskan cara menyiapkan cluster GKE, lalu menginstal Kf dan dependensinya.

Sebelum memulai

Ringkasan

Catatan: Cluster GKE Autopilot saat ini tidak dapat menjalankan Kf. Gunakan cluster GKE Standard. Untuk informasi selengkapnya tentang mode ini, dan mempelajari Autopilot lebih lanjut, lihat Ringkasan Autopilot.

• Cluster GKE Anda harus memenuhi persyaratan berikut:

  • Opsional, tetapi direkomendasikan, cluster harus dikhususkan untuk Kf. Sebaiknya Anda hanya menginstal Kf dan dependensinya untuk memastikan matriks kompatibilitas dipertahankan.

  • Minimal empat node. Jika Anda perlu menambahkan node, lihat Mengubah ukuran cluster.

  • Jenis mesin minimum yang memiliki minimal empat vCPU, seperti e2-standard-4. Jika jenis mesin untuk cluster Anda tidak memiliki setidaknya empat vCPU, ubah jenis mesin seperti yang dijelaskan dalam Memigrasikan workload ke jenis mesin yang berbeda.

  • Opsional, tetapi direkomendasikan, daftarkan cluster di saluran rilis. Ikuti petunjuk di Mendaftarkan cluster yang ada di saluran rilis jika Anda memiliki versi GKE statis.

  • Workload Identity diaktifkan.

  • Artifact Registry diaktifkan.

  • Cloud Service Mesh (ASM).

  • Tekton diinstal. Lihat Matriks dependensi untuk versi tersebut.

  • Akun Layanan Google dengan kebijakan IAM berikut (petunjuk pembuatan ditautkan di bawah):

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

Mengaktifkan dukungan untuk 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. Aktifkan Compute Engine API.

   Mengaktifkan API

Mengaktifkan dan mengonfigurasi GKE

Sebelum memulai, pastikan Anda telah menjalankan tugas berikut:

• Aktifkan Google Kubernetes Engine API.
Aktifkan Google Kubernetes Engine API
• Jika ingin menggunakan Google Cloud CLI untuk tugas ini, instal lalu lakukan inisialisasi gcloud CLI. Jika sebelumnya Anda telah menginstal gcloud CLI, dapatkan versi terbaru dengan menjalankan gcloud components update.
  Catatan: Untuk penginstalan gcloud CLI yang ada, pastikan untuk menyetel properti compute/region dan compute/zone. Dengan menyetel lokasi default, Anda dapat menghindari error di gcloud CLI yang seperti ini: One of [--zone, --region] must be supplied: Please specify location.

Membuat dan menyiapkan cluster GKE baru

Menyiapkan variabel lingkungan

Catatan: Ekspor variabel lingkungan ini di terminal atau Cloud Shell Anda agar perintah berikutnya berfungsi. Jika Anda memutuskan koneksi dari lingkungan shell dan terhubung kembali nanti, Anda perlu menyiapkan variabel lagi.

Catatan: Sebelum menyiapkan variabel lingkungan, pastikan untuk memeriksa matriks dependensi di halaman Download Kf untuk versi Kf tertentu.

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.1.0
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.1.0
Set-Variable -Name TEKTON_VERSION -Value v0.19.0

Penyiapan akun layanan

Buat akun layanan GCP (GSA) yang akan dikaitkan dengan Akun Layanan Kubernetes melalui Workload Identity. Hal ini mencegah Anda perlu membuat dan memasukkan kunci akun layanan.

Catatan: Harap baca dan pahami implikasi keamanan penggunaan Workload Identity dalam dokumen Ringkasan Keamanan.

1. Buat akun layanan yang akan digunakan Kf.

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

2. Izinkan akun layanan mengubah kebijakannya sendiri. Pengontrol Kf akan menggunakannya untuk menambahkan ruang (nama) baru ke kebijakan, yang memungkinkan penggunaan kembali untuk 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. Berikan peran metrik pemantauan untuk akses tulis ke 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. Berikan peran logging untuk akses tulis ke 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"

Membuat cluster GKE

Catatan: Untuk tujuan demonstrasi, petunjuk ini menggunakan cluster zonal. Untuk deployment produksi, sebaiknya gunakan cluster regional.

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"

Menetapkan aturan firewall

Kf memerlukan beberapa port firewall untuk dibuka. Node master harus dapat berkomunikasi dengan pod di port 80, 443, 8080, 8443, dan 6443.

Aktifkan Workload Identity

Setelah Anda memiliki akun layanan dan cluster GKE, kaitkan namespace identitas cluster dengan 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 target

Konfigurasikan akses command line kubectl dengan menjalankan perintah berikut.

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

Membuat repositori Artifact Registry

1. Buat Artifact Registry untuk menyimpan image container.

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

2. Berikan izin akun layanan di repositori Artifact Registry.

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

3. Konfigurasi autentikasi lokal Anda.

   gcloud auth configure-docker ${COMPUTE_REGION}-docker.pkg.dev

Menginstal dependensi software di cluster

Catatan: Sebelum menginstal apa pun, pastikan untuk memeriksa matriks dependensi di halaman Download Kf untuk versi Kf tertentu.

1. Instal Service Mesh.

   Catatan: Lihat Matriks dependensi untuk mengetahui versi yang benar.

2. Instal Tekton:

   Catatan: Lihat Matriks dependensi untuk mengetahui versi yang benar.

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

Menginstal Kf

1. Lihat Membuat dan menyiapkan cluster GKE untuk Kf untuk membuat cluster yang siap menjalankan Kf.

2. Pilih dan catat rilis Kf yang diinginkan. Lihat halaman Download Kf untuk mengetahui versi yang tersedia

   Catatan: Banyak perintah dalam panduan ini bergantung pada variabel lingkungan ini. Jika Anda memutuskan koneksi dari lingkungan shell dan terhubung kembali nanti, Anda harus menyiapkan variabel lagi.

3. Menginstal CLI:

   Linux

   Tindakan ini akan menginstal kf untuk semua pengguna di sistem. Ikuti petunjuk di tab Cloud Shell untuk menginstalnya hanya untuk Anda.

   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

   Tindakan ini akan menginstal kf untuk semua pengguna di sistem.

   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

   Tindakan ini akan menginstal kf di instance Cloud Shell Anda jika Anda menggunakan bash, petunjuk mungkin perlu diubah untuk shell lainnya.

   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

   Tindakan ini akan mendownload kf ke direktori saat ini. Tambahkan ke jalur jika Anda ingin memanggilnya dari mana saja selain direktori saat ini.

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

4. Instal komponen server:

   Linux dan Mac

   Tindakan ini akan mendownload kf.yaml ke direktori saat ini.

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

   Windows

   Tindakan ini akan mendownload kf.yaml ke direktori saat ini.

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

5. Siapkan 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. Menyiapkan default Kf, nilai ini dapat diubah nanti. Contoh di bawah menggunakan template domain dengan penyedia DNS karakter pengganti untuk memberi setiap Ruang nama domainnya sendiri:

   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. Validasi penginstalan:

   kf doctor --retries 10

   Catatan: Perintah ini akan memeriksa cluster untuk memastikan Kf dan dependensinya diinstal dan berfungsi. Proses ini akan berjalan hingga 10 kali untuk memberi cluster Kubernetes waktu untuk merekonsiliasi, dan akan menghasilkan serangkaian hasil PASS. Jika status untuk komponen apa pun menghasilkan FAIL setelah percobaan ulang, lihat halaman Pemecahan Masalah Kf.