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. Saat Anda membuat cluster menggunakan salah satu alat tersebut, API menyimpan metadata tentang status cluster Anda di region Google Cloud yang Anda tentukan saat membuat cluster.
Metadata ini memungkinkan Anda mengelola siklus proses cluster menggunakan
alat standar. Jika ingin menggunakan alat ini untuk melihat detail cluster atau mengelola
siklus proses cluster yang dibuat menggunakan gkectl
, 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 dan dapat Anda kelola bersama-sama. Semua GKE di cluster VMware terdaftar ke fleet pada waktu
pembuatan cluster. Saat Anda membuat cluster menggunakan gkectl, cluster akan didaftarkan ke project Google Cloud yang Anda tentukan di kolom gkeConnect.projectID
dalam file konfigurasi cluster. Project ini
disebut sebagai
project host perangkat.
Untuk mempelajari perangkat lebih lanjut, termasuk kasus penggunaan, praktik terbaik, dan contoh,
lihat dokumentasi Pengelolaan perangkat.
Lihat cluster terdaftar
Semua cluster fleet Anda ditampilkan di halaman Cluster GKE di konsol. Keduanya memberikan ringkasan tentang seluruh fleet dan, untuk GKE di VMware, memungkinkan Anda melihat cluster mana yang dikelola oleh GKE On-Prem API.
Untuk melihat cluster fleet Anda:
-
Di konsol, buka halaman GKE clusters.
Buka halaman cluster GKE -
Pilih project Google Cloud.
- Jika VMware ditampilkan di kolom Type, berarti cluster akan dikelola oleh GKE On-Prem API.
- Jika External ditampilkan di kolom Type, cluster tidak dikelola oleh GKE On-Prem API.
![Daftar cluster GKE Enterprise](https://cloud.google.com/static/kubernetes-engine/distributed-cloud/vmware/docs/images/mixed-clusters-list.png?hl=id)
Persyaratan
- Cluster pengguna harus versi 1.11 atau yang lebih baru.
Cluster admin harus versi 1.13 atau yang lebih baru.
Jika Anda bukan pemilik project, setidaknya Anda harus diberi peran Identity and Access Management
roles/gkeonprem.admin
pada project. Untuk mengetahui detail tentang izin yang disertakan dalam peran ini, lihat peran lokal GKE dalam dokumentasi IAM.
Sebelum memulai
Siapkan gcloud CLI, jika diperlukan.
Jika Anda perlu menginstal gcloud CLI, baca dokumentasi gcloud CLI.
Update komponen gcloud CLI, jika diperlukan:
gcloud components update
Lakukan langkah-langkah berikut untuk mengaktifkan dan menggunakan GKE On-Prem API:
Aktifkan API di project Anda:
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 bagiangkeconnect
pada file konfigurasi cluster admin atau file konfigurasi cluster pengguna Anda.Jika Anda mendapatkan error
PERMISSION_DENIED
, periksa kembali project ID yang Anda masukkan. Jika project ID sudah benar, jalankangcloud auth login
untuk login ke Google Cloud CLI dengan akun yang memiliki akses ke project tersebut.Jika ini adalah pertama kalinya Anda mengaktifkan GKE On-Prem API dalam project, Anda 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 vmware clusters query-version-config \ --project=PROJECT_ID \ --location=REGION
Ganti
REGION
denganus-west1
atau wilayah lain yang didukung.
Jika organisasi Anda telah menyiapkan daftar yang diizinkan yang memungkinkan traffic dari Google API dan alamat lainnya melewati server proxy Anda, tambahkan baris berikut ke daftar yang diizinkan:
- gkeonprem.googleapis.com
- gkeonprem.mtls.googleapis.com
Berikut adalah nama layanan untuk GKE On-Prem API.
Mendaftarkan cluster pengguna
gcloud CLI
Pastikan untuk men-scroll jika diperlukan guna mengisi
placeholder ADMIN_CLUSTER_NAME
untuk
flag --admin-cluster-membership
.
gcloud container vmware 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 sepenuhnya yang secara unik mengidentifikasi cluster di Google Cloud.REGION
: Region Google Cloud tempat GKE On-Prem API menjalankan dan menyimpan metadata cluster. Tentukanus-west1
atau wilayah lain yang didukung. Region tidak dapat diubah setelah cluster didaftarkan.
gkectl
Lakukan langkah-langkah berikut di workstation admin Anda.
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. Tentukanus-west1
atau wilayah lain yang didukung. Region tidak dapat diubah setelah cluster didaftarkan.Update cluster:
gkectl update cluster --kubeconfig ADMIN_CLUSTER_KUBECONFIG --config USER_CLUSTER_CONFIG_FILE
Ganti kode berikut:
ADMIN_CLUSTER_KUBECONFIG
: jalur file kubeconfig cluster admin.USER_CLUSTER_CONFIG_FILE
: jalur file konfigurasi cluster pengguna Anda.
Mendaftarkan cluster admin
gcloud CLI
gcloud container vmware 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
danPROJECT_ID
digunakan untuk membentuk nama cluster yang ditentukan sepenuhnya untuk flag--admin-cluster-membership
.REGION
: Region Google Cloud tempat GKE On-Prem API menjalankan dan menyimpan metadata cluster. Tentukanus-west1
atau wilayah lain yang didukung. Sebaiknya gunakan region yang sama dengan yang dikonfigurasi distackdriver.clusterLocation
. Region tidak dapat diubah setelah cluster didaftarkan.
gkectl
Lakukan langkah-langkah berikut di workstation admin Anda.
Tambahkan bagian berikut ke file konfigurasi cluster admin:
gkeOnPremAPI: enabled:true location:REGION
Ganti
REGION
dengan region Google Cloud tempat GKE On-Prem API menjalankan dan menyimpan metadata cluster. Tentukanus-west1
atau wilayah lain yang didukung. Sebaiknya gunakan region yang sama dengan yang dikonfigurasi distackdriver.clusterLocation
. Region tidak dapat diubah setelah cluster didaftarkan.Update cluster:
gkectl update admin --kubeconfig ADMIN_CLUSTER_KUBECONFIG --config ADMIN_CLUSTER_CONFIG_FILE
Ganti kode berikut:
ADMIN_CLUSTER_KUBECONFIG
: jalur file kubeconfig cluster admin.ADMIN_CLUSTER_CONFIG_FILE
: jalur file konfigurasi cluster admin Anda.
Mendapatkan informasi tentang cluster Anda
Setelah cluster didaftarkan, Anda dapat menggunakan perintah berikut untuk mendapatkan informasi tentang cluster:
Cluster pengguna
- Untuk mendeskripsikan cluster pengguna:
gcloud container vmware clusters describe USER_CLUSTER_NAME \ --project=PROJECT_ID \ --location=REGION
- Untuk menampilkan daftar cluster pengguna:
gcloud container vmware clusters list \ --project=PROJECT_ID \ --location=-
Saat Anda menetapkan --location=-
, ini berarti mencantumkan semua cluster di semua region. Jika Anda perlu memperkecil daftar, tetapkan --location
ke region yang Anda tentukan saat mendaftarkan cluster.
Cluster Admin
- Untuk mendeskripsikan cluster admin:
gcloud container vmware admin-clusters describe ADMIN_CLUSTER_NAME \ --project=PROJECT_ID \ --location=REGION
- Untuk menampilkan daftar cluster admin Anda:
gcloud container vmware admin-clusters list \ --project=PROJECT_ID \ --location=-
Saat Anda menetapkan --location=-
, ini berarti mencantumkan semua cluster di semua region. Jika Anda perlu memperkecil 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 Google Cloud Console. Metode autentikasi yang Anda pilih juga akan mengontrol akses ke cluster dari command line. Untuk informasi selengkapnya, lihat referensi berikut: