GKE On-Prem API memungkinkan Anda mengelola siklus proses cluster lokal menggunakan
konsolGoogle Cloud , Google Cloud CLI, atau Terraform. Saat Anda membuat cluster dengan alat ini, API akan menyimpan metadata cluster di region Google Cloudyang Anda pilih. Jika Anda membuat cluster dengan gkectl, Anda harus mendaftarkannya di
GKE On-Prem API untuk melihat detail dan mengelola siklus prosesnya melalui antarmuka
ini.
Mendaftarkan cluster berbeda dengan mendaftarkannya ke fleet. Semua cluster Google Distributed Cloud otomatis mendaftar ke project host fleet saat dibuat. Di konsol Google Cloud , cluster terdaftar yang dikelola oleh GKE On-Prem API ditampilkan sebagai VMware di kolom Type, sedangkan cluster yang tidak terdaftar muncul sebagai External.
Melihat cluster terdaftar
Semua fleet cluster Anda ditampilkan di halaman cluster GKE di konsol. Hal ini memberi Anda ringkasan seluruh fleet dan, untuk Google Distributed Cloud, memungkinkan Anda melihat cluster mana yang dikelola oleh GKE On-Prem API.
Untuk melihat cluster fleet Anda:
-
Di konsol, buka halaman cluster GKE.
Buka cluster GKE -
Pilih project Google Cloud .
- Jika VMware ditampilkan di kolom Type, cluster dikelola oleh GKE On-Prem API.
- Jika External ditampilkan di kolom Type, cluster tidak dikelola oleh GKE On-Prem API.
Persyaratan
- Cluster pengguna harus versi 1.11 atau yang lebih tinggi.
Cluster admin harus versi 1.13 atau yang lebih tinggi.
Jika Anda bukan Project Owner, minimal Anda harus diberi peran Identity and Access Management
roles/gkeonprem.adminpada project. Untuk mengetahui detail tentang izin yang disertakan dalam peran ini, lihat Peran GKE on-prem dalam dokumentasi IAM.
Sebelum memulai
Siapkan gcloud CLI, jika diperlukan.
Jika Anda perlu menginstal gcloud CLI, lihat 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.comGanti
PROJECT_IDdengan project ID untuk project host fleet Anda. Ini adalah project ID yang dikonfigurasi di bagiangkeconnectpada file konfigurasi cluster admin atau file konfigurasi cluster pengguna.Jika Anda mendapatkan error
PERMISSION_DENIED, periksa kembali project ID yang Anda masukkan. Jika project ID sudah benar, jalankangcloud auth loginuntuk login ke Google Cloud CLI dengan akun yang memiliki akses ke project.Jika ini adalah pertama kalinya Anda mengaktifkan GKE On-Prem API di project, Anda harus melakukan inisialisasi API. Anda dapat melakukannya dengan memanggil perintah gcloud CLI yang menampilkan versi yang tersedia yang dapat Anda gunakan untuk membuat cluster:
gcloud container vmware clusters query-version-config \ --project=PROJECT_ID \ --location=REGIONGanti
REGIONdenganus-west1atau wilayah yang didukung.
Jika organisasi Anda telah menyiapkan daftar yang diizinkan yang memungkinkan traffic dari Google API dan alamat lain melewati server proxy, tambahkan hal berikut ke daftar yang diizinkan:
- gkeonprem.googleapis.com
- gkeonprem.mtls.googleapis.com
Ini adalah nama layanan untuk GKE On-Prem API.
Mendaftarkan cluster pengguna
gcloud CLI
Cantumkan keanggotaan fleet dari cluster yang terdaftar:
gcloud container fleet memberships list \ --project=PROJECT_IDGanti
PROJECT_IDdengan project ID untuk project host fleet Anda.Catat region tempat cluster admin yang mengelola cluster pengguna menjadi anggota karena Anda akan memerlukannya di langkah berikutnya.
Daftarkan cluster di GKE On-Prem API:
gcloud container vmware clusters enroll USER_CLUSTER_NAME \ --project=<var>PROJECT_ID</var> \ --admin-cluster-membership=projects/PROJECT_ID/locations/MEMBERSHIP_REGION/memberships/ADMIN_CLUSTER_NAME \ --location=REGIONGanti kode berikut:
USER_CLUSTER_NAME: nama cluster pengguna yang ingin Anda daftarkan.PROJECT_ID: project ID dari project host fleet Anda.MEMBERSHIP_REGION: region tempat cluster admin yang mengelola cluster pengguna menjadi anggota. Ini bisa berupaglobalatau region Google Cloud .ADMIN_CLUSTER_NAME: nama cluster admin yang mengelola cluster pengguna.ADMIN_CLUSTER_NAME,MEMBERSHIP_REGION, danPROJECT_IDmembentuk nama cluster yang ditentukan sepenuhnya untuk flag--admin-cluster-membership.REGION: region Google Cloud tempat GKE On-Prem API berjalan dan menyimpan metadata cluster. Tentukanus-west1atau wilayah yang didukung lainnya. 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:REGIONGanti
REGIONdengan region Google Cloud tempat GKE On-Prem API berjalan dan menyimpan metadata cluster. Tentukanus-west1atau wilayah 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
Cantumkan keanggotaan fleet dari cluster yang terdaftar:
gcloud container fleet memberships list \ --project=PROJECT_IDGanti
PROJECT_IDdengan project ID untuk project host fleet Anda.Catat region tempat cluster admin menjadi anggota karena Anda akan memerlukannya di langkah berikutnya.
Daftarkan cluster admin di GKE On-Prem API:
gcloud container vmware admin-clusters enroll ADMIN_CLUSTER_NAME \ --project=PROJECT_ID \ --admin-cluster-membership=projects/PROJECT_ID/locations/MEMBERSHIP_REGION/memberships/ADMIN_CLUSTER_NAME \ --location=REGION
Ganti kode berikut:
ADMIN_CLUSTER_NAME: nama cluster admin yang ingin Anda daftarkan.PROJECT_IDproject ID dari project host fleet Anda.MEMBERSHIP_REGION: region tempat cluster admin menjadi anggota. Ini dapat berupaglobalatau region Google Cloud .ADMIN_CLUSTER_NAME,MEMBERSHIP_REGION, danPROJECT_IDmembentuk nama cluster yang ditentukan sepenuhnya untuk flag--admin-cluster-membership.REGION: Google Cloud region tempat GKE On-Prem API berjalan dan menyimpan metadata cluster. Tentukanus-west1atau wilayah yang didukung lainnya. Sebaiknya gunakan region yang sama dengan yang dikonfigurasi distackdriver.clusterLocationdalam file konfigurasi cluster admin. 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:REGIONGanti
REGIONdengan region Google Cloud tempat GKE On-Prem API berjalan dan menyimpan metadata cluster. Tentukanus-west1atau wilayah 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 Anda:
Cluster pengguna
- Untuk mendeskripsikan cluster pengguna:
gcloud container vmware clusters describe USER_CLUSTER_NAME \ --project=PROJECT_ID \ --location=REGION
- Untuk mencantumkan cluster pengguna:
gcloud container vmware clusters list \ --project=PROJECT_ID \ --location=-
Jika Anda menetapkan --location=-, artinya semua cluster di semua region akan dicantumkan. Jika Anda perlu mempersempit 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 mencantumkan cluster admin Anda:
gcloud container vmware admin-clusters list \ --project=PROJECT_ID \ --location=-
Jika Anda menetapkan --location=-, artinya semua cluster di semua region akan dicantumkan. Jika Anda perlu mempersempit 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 konsolGoogle Cloud . Metode autentikasi yang Anda pilih juga mengontrol akses ke cluster dari command line. Untuk informasi selengkapnya, lihat referensi berikut: