Mengonfigurasi cluster untuk dikelola oleh GKE On-Prem API

GKE On-Prem API adalah API yang dihosting Google Cloud dan dapat Anda gunakan untuk mengelola siklus proses cluster lokal menggunakan alat standar: Konsol Google Cloud, Google Cloud CLI, atau Terraform. Jika Anda membuat cluster menggunakan salah satu alat ini, API akan menyimpan metadata tentang status cluster Anda di region Google Cloud yang Anda tentukan saat membuat cluster. Dengan metadata ini, Anda dapat mengelola siklus proses cluster menggunakan alat standar. Jika ingin menggunakan alat ini untuk melihat detail cluster atau mengelola siklus proses cluster yang dibuat menggunakan bmctl, Anda harus mendaftarkan cluster di GKE On-Prem API.

Terminologi

Dengan mendaftarkan cluster, Anda dapat mengelola siklus proses cluster menggunakan konsol, gcloud CLI, atau Terraform.

Mendaftarkan cluster adalah proses terpisah untuk mendaftarkan cluster ke fleet. Armada adalah pengelompokan cluster Kubernetes yang logis yang dapat Anda kelola bersama. Semua cluster GKE pada Bare Metal didaftarkan ke fleet pada waktu pembuatan cluster. Saat Anda membuat cluster menggunakan bmctl, cluster tersebut akan didaftarkan ke project Google Cloud yang Anda tentukan di kolom gkeConnect.projectID pada file konfigurasi cluster. Project ini disebut sebagai project host armada. Untuk mempelajari fleet lebih lanjut, termasuk kasus penggunaan, praktik terbaik, dan contoh, lihat dokumentasi Pengelolaan perangkat.

Lihat cluster terdaftar

Semua cluster fleet Anda akan ditampilkan di halaman Cluster GKE Enterprise dan Cluster GKE di konsol. Ini memberi Anda ringkasan tentang seluruh fleet Anda dan, untuk GKE pada Bare Metal, memungkinkan Anda melihat cluster mana yang dikelola oleh GKE On-Prem API.

Untuk melihat cluster fleet Anda:

  1. Di konsol, buka halaman cluster GKE Enterprise.
    Buka halaman cluster GKE Enterprise
  2. Pilih project Google Cloud.
    • Jika Bare metal ditampilkan di kolom Type, berarti cluster dikelola oleh GKE On-Prem API.
    • Jika External ditampilkan di kolom Type, berarti cluster tidak dikelola oleh GKE On-Prem API.
Daftar cluster GKE Enterprise

Persyaratan

  • Hanya cluster pengguna dan admin yang dapat didaftarkan dengan GKE On-Prem API. Mendaftarkan cluster hybrid dan mandiri tidak didukung.

  • Versi 1.13 atau yang lebih tinggi.

  • Jika Anda bukan pemilik project, setidaknya Anda harus diberi peran Identity and Access Management roles/gkeonprem.admin di project tersebut. Untuk mengetahui detail tentang izin yang disertakan dalam peran ini, lihat peran lokal GKE dalam dokumentasi IAM.

Sebelum memulai

  1. Siapkan gcloud CLI, jika perlu.

    1. Jika Anda perlu menginstal gcloud CLI, baca dokumentasi gcloud CLI. Update komponen gcloud CLI, jika diperlukan:

      gcloud components update

  2. Pastikan GKE On-Prem API diaktifkan dalam project. Untuk mengaktifkan API, jalankan perintah berikut:

    gcloud services enable \
    --project PROJECT_ID \
    gkeonprem.googleapis.com

    Ganti PROJECT_ID dengan project ID project host fleet Anda. Ini adalah project ID yang dikonfigurasi di bagian gkeconnect dari file konfigurasi cluster Anda.

    Jika Anda mendapatkan error PERMISSION_DENIED, periksa kembali project ID yang Anda masukkan. Jika project ID sudah benar, jalankan gcloud auth login untuk login ke Google Cloud CLI dengan akun yang memiliki akses ke project.

  3. Jika ini adalah pertama kalinya Anda mengaktifkan GKE On-Prem API di project, Anda mungkin perlu melakukan inisialisasi API. Anda dapat melakukannya dengan memanggil perintah gcloud CLI yang menampilkan versi yang tersedia, yang dapat digunakan untuk membuat cluster:

    gcloud container bare-metal clusters query-version-config \
    --project=PROJECT_ID \
    --location=REGION

    Ganti REGION dengan us-west1 atau wilayah lain yang didukung.

  4. Jika organisasi Anda telah menyiapkan daftar yang diizinkan yang memungkinkan traffic dari Google API dan alamat lainnya melewati server proxy Anda, tambahkan kode berikut ke daftar yang diizinkan:

    • gkeonprem.googleapis.com
    • gkeonprem.mtls.googleapis.com

    Ini adalah nama layanan untuk GKE On-Prem API.

Mendaftarkan cluster

Jika cluster Anda menggunakan versi 1.15.3 atau yang lebih tinggi, Anda dapat menggunakan alat command line bmctl untuk mendaftarkan cluster.

Mendaftarkan cluster pengguna

gcloud CLI

Pastikan men-scroll ke atas jika perlu guna mengisi placeholder ADMIN_CLUSTER_NAME untuk tanda --admin-cluster-membership.

gcloud container bare-metal clusters enroll USER_CLUSTER_NAME  \
    --project=PROJECT_ID \
    --admin-cluster-membership=projects/PROJECT_ID/locations/global/memberships/ADMIN_CLUSTER_NAME \
    --location=REGION

Ganti kode berikut:

  • USER_CLUSTER_NAME: Nama cluster pengguna yang ingin Anda daftarkan.

  • PROJECT_ID Project ID dari project host fleet Anda.

  • ADMIN_CLUSTER_NAME: Cluster admin yang mengelola cluster pengguna. Nama cluster admin adalah segmen terakhir dari nama cluster yang ditentukan secara lengkap, yang secara unik mengidentifikasi cluster di Google Cloud.

  • REGION: Region Google Cloud tempat GKE On-Prem API menjalankan dan menyimpan metadata cluster. Tentukan us-west1 atau wilayah lain yang didukung. Region tidak dapat diubah setelah cluster didaftarkan.

bmctl 1.15.3+

Lakukan langkah-langkah berikut di workstation admin Anda.

  1. Tambahkan bagian berikut ke file konfigurasi cluster pengguna:

    gkeOnPremAPI:
  enabled:true
  location: REGION

    Ganti REGION dengan region Google Cloud tempat GKE On-Prem API menjalankan dan menyimpan metadata cluster. Tentukan us-west1 atau wilayah lain yang didukung. Region tidak dapat diubah setelah cluster didaftarkan.

  2. Update cluster:

    bmctl update cluster -c USER_CLUSTER_NAME \
  --kubeconfig ADMIN_CLUSTER_KUBECONFIG

    Ganti kode berikut:

    • USER_CLUSTER_NAME: nama cluster pengguna yang akan diperbarui.

    • ADMIN_CLUSTER_KUBECONFIG: jalur file kubeconfig cluster admin.

Mendaftarkan cluster admin

gcloud CLI

Pastikan men-scroll ke atas jika perlu guna mengisi placeholder ADMIN_CLUSTER_NAME untuk tanda --admin-cluster-membership.

gcloud container bare-metal admin-clusters enroll ADMIN_CLUSTER_NAME \
    --project=PROJECT_ID \
    --admin-cluster-membership=projects/PROJECT_ID/locations/global/memberships/ADMIN_CLUSTER_NAME \
    --location=REGION

Ganti kode berikut:

  • ADMIN_CLUSTER_NAME: Nama cluster admin yang ingin Anda daftarkan.

  • PROJECT_ID Project ID dari project host fleet Anda.

    ADMIN_CLUSTER_NAME dan PROJECT_ID digunakan untuk membentuk nama cluster yang ditentukan sepenuhnya untuk tanda --admin-cluster-membership.

  • REGION: Region Google Cloud tempat GKE On-Prem API menjalankan dan menyimpan metadata cluster. Tentukan us-west1 atau wilayah lain yang didukung. Region tidak dapat diubah setelah cluster didaftarkan.

bmctl 1.15.3+

Lakukan langkah-langkah berikut di workstation admin Anda.

  1. Tambahkan bagian berikut ke file konfigurasi cluster pengguna:

    gkeOnPremAPI:
  enabled:true
  location: REGION

    Ganti REGION dengan region Google Cloud tempat GKE On-Prem API menjalankan dan menyimpan metadata cluster. Tentukan us-west1 atau wilayah lain yang didukung. Region tidak dapat diubah setelah cluster didaftarkan.

  2. Update cluster:

    bmctl update cluster -c ADMIN_CLUSTER_NAME \
--kubeconfig ADMIN_CLUSTER_KUBECONFIG

    Ganti kode berikut:

    • ADMIN_CLUSTER_NAME: nama cluster admin yang akan diperbarui.

    • ADMIN_CLUSTER_KUBECONFIG: jalur file kubeconfig cluster admin.

Mendapatkan informasi tentang cluster Anda

Setelah cluster terdaftar, Anda dapat menggunakan perintah berikut untuk mendapatkan informasi tentang cluster Anda:

Cluster pengguna

  • Untuk menggambarkan cluster pengguna:
gcloud container bare-metal clusters describe USER_CLUSTER_NAME \
    --project=PROJECT_ID \
    --location=REGION
  • Untuk membuat daftar cluster pengguna:
gcloud container bare-metal clusters list \
    --project=PROJECT_ID \
    --location=-

Jika Anda menetapkan --location=-, artinya Anda mencantumkan semua cluster di semua region. Jika Anda perlu menentukan cakupan dalam daftar, tetapkan --location ke region yang Anda tentukan saat mendaftarkan cluster.

Cluster admin

  • Untuk menggambarkan cluster admin:
gcloud container bare-metal admin-clusters describe ADMIN_CLUSTER_NAME \
    --project=PROJECT_ID \
    --location=REGION
  • Untuk menampilkan daftar cluster admin:
gcloud container bare-metal admin-clusters list \
    --project=PROJECT_ID \
    --location=-

Jika Anda menetapkan --location=-, artinya Anda mencantumkan semua cluster di semua region. Jika Anda perlu menentukan cakupan dalam daftar, tetapkan --location ke region yang Anda tentukan saat mendaftarkan cluster.

Hubungkan ke cluster

Setelah cluster didaftarkan dengan GKE On-Prem API, Anda harus memilih dan mengonfigurasi metode autentikasi agar dapat mengelola cluster dari Konsol Google Cloud. Metode autentikasi yang Anda pilih juga mengontrol akses ke cluster dari command line. Untuk informasi selengkapnya, lihat referensi berikut: