GKE On-Prem API adalah API yang dihosting Google Cloud dan dapat Anda gunakan untuk
siklus proses cluster lokal dengan menggunakan alat standar:
Konsol Google Cloud, Google Cloud CLI, atau Terraform. Saat Anda membuat
cluster menggunakan salah satu alat tersebut, API tersebut menyimpan metadata tentang
di region Google Cloud yang Anda tentukan saat membuat cluster.
Dengan metadata ini, Anda dapat mengelola siklus proses cluster menggunakan
{i>tool<i} standar. Jika Anda ingin menggunakan alat ini untuk melihat detail cluster atau mengelola
siklus proses cluster yang dibuat menggunakan gkectl
, Anda harus
daftarkan cluster di GKE On-Prem API.
Terminologi
Dengan mendaftarkan cluster, Anda dapat mengelola siklus proses cluster dengan 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
secara
bersamaan. Semua cluster Google Distributed Cloud terdaftar ke fleet di cluster
waktu pembuatan. Saat Anda membuat cluster menggunakan gkectl, cluster
terdaftar ke project Google Cloud yang Anda tentukan dalam
Kolom gkeConnect.projectID
di file konfigurasi cluster. Project ini
disebut sebagai
project host perangkat.
Untuk mempelajari lebih lanjut perangkat, termasuk kasus penggunaan, praktik terbaik, dan contoh,
lihat dokumentasi Pengelolaan perangkat.
Lihat cluster terdaftar
Semua cluster fleet Anda ditampilkan di Cluster GKE halaman di konsol. Keduanya memberi Anda gambaran umum tentang seluruh fleet, dan untuk Google Distributed Cloud, memungkinkan Anda melihat cluster mana dan dikelola oleh GKE On-Prem API.
Untuk melihat cluster fleet Anda:
-
Di konsol, buka halaman GKE clusters.
Buka cluster GKE -
Pilih project Google Cloud.
- Jika VMware ditampilkan di kolom Type, cluster ini dikelola oleh GKE On-Prem API.
- Jika Eksternal ditampilkan di kolom Jenis, berarti cluster tidak dapat ditampilkan. dan dikelola oleh GKE On-Prem API.
Persyaratan
- Cluster pengguna harus versi 1.11 atau yang lebih baru.
Cluster admin harus versi 1.13 atau yang lebih baru.
Setidaknya, jika Anda bukan pemilik project, Anda harus diberi Identity and Access Management peran
roles/gkeonprem.admin
di project. Untuk detail tentang izin termasuk dalam peran ini, lihat Peran lokal GKE 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.com
Ganti
PROJECT_ID
dengan project ID project host fleet Anda. Ini adalah project ID yang dikonfigurasi di Bagiangkeconnect
dari 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 benar, jalankangcloud auth login
untuk login ke Google Cloud CLI dengan akun yang memiliki akses ke proyek.Jika ini adalah pertama kalinya Anda mengaktifkan GKE On-Prem API dalam proyek, Anda perlu melakukan inisialisasi API. Anda bisa melakukannya dengan memanggil perintah gcloud CLI yang menampilkan yang dapat digunakan untuk membuat cluster:
gcloud container vmware clusters query-version-config \ --project=PROJECT_ID \ --location=REGION
Ganti
REGION
denganus-west1
atau yang lain wilayah yang didukung.
Jika organisasi Anda telah menyiapkan daftar yang diizinkan yang memungkinkan traffic dari Google API dan alamat lainnya melewati server proxy Anda, tambahkan 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 untuk mengisi
Placeholder ADMIN_CLUSTER_NAME
untuk
tanda --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 dari nama cluster yang sepenuhnya ditetapkan, yang secara unik mengidentifikasi cluster di Google Cloud.REGION
: Region Google Cloud tempat GKE On-Prem API berjalan dan menyimpan metadata cluster. Tentukanus-west1
atau lainnya wilayah 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 di tempat GKE On-Prem API dijalankan dan menyimpan metadata cluster. Menentukanus-west1
atau lainnya 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 admin file kubeconfig cluster.USER_CLUSTER_CONFIG_FILE
: jalur pengguna Anda file konfigurasi cluster 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 project host fleet Anda.ADMIN_CLUSTER_NAME
danPROJECT_ID
digunakan untuk membentuk nama cluster yang ditentukan sepenuhnya untuk--admin-cluster-membership
penanda.REGION
: Region Google Cloud tempat GKE On-Prem API berjalan dan menyimpan metadata cluster. Tentukanus-west1
atau lainnya wilayah yang didukung. Sebaiknya gunakan region yang sama dengan yang dikonfigurasi distackdriver.clusterLocation
. Wilayah tidak dapat diubah setelah sudah terdaftar.
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 di tempat GKE On-Prem API dijalankan dan menyimpan metadata cluster. Menentukanus-west1
atau lainnya wilayah yang didukung. Sebaiknya gunakan region yang sama dengan yang dikonfigurasi distackdriver.clusterLocation
. Wilayah tidak dapat diubah setelah cluster sudah terdaftar.Update cluster:
gkectl update admin --kubeconfig ADMIN_CLUSTER_KUBECONFIG --config ADMIN_CLUSTER_CONFIG_FILE
Ganti kode berikut:
ADMIN_CLUSTER_KUBECONFIG
: jalur admin file kubeconfig cluster.ADMIN_CLUSTER_CONFIG_FILE
: jalur admin Anda file konfigurasi cluster 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 menampilkan daftar cluster pengguna:
gcloud container vmware clusters list \ --project=PROJECT_ID \ --location=-
Saat Anda menetapkan --location=-
, itu berarti membuat daftar semua cluster dalam semua
region. Jika Anda perlu memperkecil daftar, tetapkan --location
ke region
yang ditentukan 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=-
, itu berarti membuat daftar semua cluster dalam semua
region. Jika Anda perlu memperkecil daftar, tetapkan --location
ke region
yang ditentukan saat mendaftarkan cluster.
Hubungkan ke cluster
Setelah cluster didaftarkan dengan GKE On-Prem API, Anda harus memilih dan mengonfigurasi metode otentikasi sehingga Anda dapat mengelola cluster dari Konsol Google Cloud Anda. Metode otentikasi yang Anda pilih juga mengontrol akses ke cluster dari command line. Untuk informasi selengkapnya, lihat referensi berikut: