referensi asmcli
Ringkasan
asmcli
adalah alat yang disediakan Google yang dapat Anda gunakan untuk menginstal atau mengupgrade Cloud Service Mesh. Jika Anda mengizinkannya, asmcli
akan mengonfigurasi project dan cluster Anda sebagai berikut:
- Memberi Anda izin Identity and Access Management (IAM) yang diperlukan di project Google Cloud Anda.
- Aktifkan Google API yang diperlukan di project Google Cloud Anda.
- Berikan label pada cluster yang mengidentifikasi mesh.
- Buat akun layanan yang memungkinkan komponen bidang data, seperti proxy file bantuan, mengakses data dan resource project Anda dengan aman.
- Daftarkan cluster ke fleet jika belum terdaftar.
Cukup sertakan flag --enable_all
saat menjalankan asmcli
untuk mengizinkannya mengonfigurasi project dan cluster Anda. Untuk mengetahui informasi selengkapnya tentang opsi dan flag asmcli
, lihat referensi asmcli
.
Selanjutnya, asmcli
mengonfigurasi file YAML dengan informasi project dan cluster Anda.
File konfigurasi ini diperlukan untuk menginstal bidang kontrol Cloud Service Mesh.
Jika Anda baru menggunakan Cloud Service Mesh dan Istio, lanjutkan ke Platform yang didukung. Bagian berikutnya ditujukan untuk membantu Cloud Service Mesh yang sudah ada melakukan upgrade ke 1.20.
Transisi ke asmcli
asmcli
menggantikan istioctl install
dan install_asm
. Meskipun Anda masih dapat menggunakan alat lama di Cloud Service Mesh 1.11, kami menghentikannya dan tidak akan lagi didukung di Cloud Service Mesh 1.12 dan yang lebih baru.
Harap update skrip dan alat Anda untuk menggunakan asmcli
.
Semua cluster harus terdaftar ke fleet. Lihat Persyaratan perangkat untuk mengetahui detailnya.
Bertransisi dari install_asm
Jika Anda sudah terbiasa dengan install_asm
, asmcli
serupa, tetapi dengan
perbedaan penting berikut:
Anda menggunakan
asmcli install
untuk penginstalan dan upgrade baru. Tidak ada opsi--mode
seperti padainstall_asm
. Saat Anda menjalankanasmcli install
, sistem ini akan memeriksa apakah ada bidang kontrol yang ada di cluster. Jika bidang kontrol belum ada,asmcli
akan menginstal Cloud Service Mesh. Jika cluster memiliki bidang kontrol yang sudah ada (baik bidang kontrol Cloud Service Mesh atau bidang kontrol Istio open source):Jika label revisi di bidang kontrol yang ada tidak cocok dengan label revisi untuk bidang kontrol baru,
asmcli
akan melakukan upgrade canary.Jika label revisi bidang kontrol sama,
asmcli
akan melakukan upgrade yang diterapkan.
Sebagian besar opsi dan flag
asmcli
berperilaku sama seperti untukinstall_asm
.
Bertransisi dari istioctl install
Jika Anda sudah terbiasa dengan istioctl install
, jika biasanya meneruskan file YAML IstioOperator
melalui argumen command line -f
untuk mengonfigurasi bidang kontrol, Anda dapat meneruskan file tersebut ke asmcli
menggunakan opsi --custom_overlay
. Dalam dokumentasi Cloud Service Mesh, kami menyebut file ini sebagai file overlay.
Platform yang didukung
Penginstalan Cloud Service Mesh pada daftar Platform yang didukung dapat dikonfigurasi atau diupgrade oleh asmcli
.
Namun, tidak semua fitur tersedia pada platform di luar Google Cloud. Untuk mengetahui detailnya, lihat Fitur yang didukung bidang kontrol dalam cluster.
Referensi asmcli
Bagian ini menjelaskan argumen yang tersedia untuk asmcli
.
Opsi
Mengidentifikasi cluster Anda memiliki opsi berikut untuk mengidentifikasi cluster:
Khusus GKE
-p|--project_id CLUSTER_PROJECT_ID
- Project ID tempat cluster dibuat.
-n|--cluster_name CLUSTER_NAME
- Nama cluster.
-l|--cluster_location CLUSTER_LOCATION
- Zona (untuk cluster satu zona) atau region (untuk cluster regional) tempat cluster dibuat.
Semua platform
--kubeconfig KUBECONFIG_FILE
Jalur lengkap ke file kubeconfig. Variabel lingkungan $PWD
tidak berfungsi di sini.
--ctx|--context KUBE_CONTEXT
Konteks kubeconfig yang akan digunakan. Jika tidak ditentukan,
asmcli
akan menggunakan konteks default.
-c|--ca {mesh_ca|gcp_cas|citadel}
Certificate authority (CA) yang akan digunakan untuk mengelola sertifikat TLS bersama. Tentukan
mesh_ca
untuk menggunakan certificate authority Cloud Service Mesh (certificate authority Cloud Service Mesh),gcp_cas
untuk menggunakan Certificate Authority Service, ataucitadel
untuk menggunakan Istio CA. Mesh Layanan Cloud Terkelola tidak mendukung Istio CA. Lihat informasi tambahan berikut:--channel CLOUD_SERVICE_MESH_CHANNEL
Gunakan
--channel
dengan saluran rilis Cloud Service Mesh tertentu untuk menyediakan revisi Bidang Kontrol yang terkait dengan saluran rilis tersebut. Misalnya,--channel rapid
,--channel regular
, dan--channel stable
. Flag ini diperlukan saat mengonfigurasi fitur Cloud Service Mesh tertentu di cluster Autopilot GKE.
Opsi --channel
tidak lagi didukung untuk Managed Cloud Service Mesh seperti yang disebutkan dalam Catatan Rilis CSM.
Saluran rilis ditentukan berdasarkan saluran rilis cluster GKE Anda.
Untuk mengetahui informasi selengkapnya, lihat Saluran rilis Managed Cloud Service Mesh.
--co|--custom_overlay OVERLAY_FILE
- Gunakan
--custom_overly
dengan nama file YAML (disebut sebagai file overlay) yang berisi resource kustomIstioOperator
untuk mengonfigurasi bidang kontrol dalam cluster. Anda menentukan file overlay untuk mengaktifkan fitur yang tidak diaktifkan secara default. Mesh Layanan Cloud Terkelola tidak mendukungIstioOperator
API, sehingga Anda tidak dapat menggunakan--custom_overlay
untuk mengonfigurasi bidang kontrol yang dikelola.asmcli
harus dapat menemukan file overlay, sehingga harus berada di direktori yang sama denganasmcli
, atau Anda dapat menentukan jalur relatif. Untuk menambahkan beberapa file, tentukan--co|--custom_overlay
dan nama file, misalnya:--co overlay_file1.yaml --co overlay_file2.yaml --co overlay_file3.yaml
--hub-registration-extra-flags HUB_REGISTRATION_EXTRA_FLAGS
- Jika menggunakan cluster Amazon EKS yang terpasang, gunakan
--hub-registration-extra-flags
untuk mendaftarkan cluster ke fleet jika belum terdaftar. -k|--key_file FILE_PATH
- File kunci untuk akun layanan. Hapus opsi ini jika Anda tidak menggunakan akun layanan.
--network_id NETWORK_ID
- Gunakan
--network_id
untuk menetapkan labeltopology.istio.io/network
yang diterapkan ke namespaceistio-system
. Untuk GKE,--network_id
ditetapkan secara default ke nama jaringan untuk cluster. Untuk lingkungan lain,default
akan digunakan. -o|--option OVERLAY_FILE
Nama file overlay (tanpa ekstensi
.yaml
) yang didownloadasmcli
dari repositorianthos-service-mesh
untuk mengaktifkan fitur opsional. Anda memerlukan konektivitas internet untuk menggunakan--option
. Opsi--option
dan--custom_overlay
serupa, tetapi memiliki perilaku yang sedikit berbeda:Gunakan
--custom_overlay
saat Anda perlu mengubah setelan di file overlay.Gunakan
--option
untuk mengaktifkan fitur yang tidak memerlukan perubahan pada file overlay, misalnya, untuk mengonfigurasi kebijakan audit bagi layanan Anda.
Untuk menambahkan beberapa file, tentukan
-o|--option
dan nama file, misalnya:-o option_file1 -o option_file2 -o option_file3
-D|--output_dir DIR_PATH
Jika tidak ditentukan,
asmcli
akan membuat direktori sementara tempatnya mendownload file dan konfigurasi yang diperlukan untuk menginstal Cloud Service Mesh. Tentukan flag--output-dir
untuk menentukan jalur relatif ke direktori yang akan digunakan. Setelah selesai, direktori yang ditentukan akan berisi subdirektoriasm
danistio-1.20.4-asm.0
. Direktoriasm
berisi konfigurasi untuk penginstalan. Direktoriistio-1.20.4-asm.0
berisi konten yang diekstrak dari file penginstalan, yang berisiistioctl
, contoh, dan manifes. Jika Anda menentukan--output-dir
dan direktori sudah berisi file yang diperlukan,asmcli
akan menggunakan file tersebut, bukan mendownloadnya lagi.--platform PLATFORM {gcp|multicloud}
Platform atau penyedia cluster Kubernetes. Setelan defaultnya adalah
gcp
(untuk cluster GKE). Untuk semua penggunaan platform lain,multicloud
.-r|--revision_name REVISION NAME
Label revisi adalah pasangan nilai kunci yang ditetapkan di bidang kontrol. Kunci label revisi selalu
istio.io/rev
. Secara default,asmcli
menetapkan nilai untuk label revisi berdasarkan versi Cloud Service Mesh, misalnya:asm-1204-0
. Sertakan opsi ini jika Anda ingin mengganti nilai default dan menentukan nilai Anda sendiri. ArgumenREVISION NAME
harus berupa label DNS-1035. Artinya, nama tersebut harus:- berisi maksimal 63 karakter
- hanya berisi karakter alfanumerik huruf kecil atau '-'
- diawali dengan karakter alfabet
- diakhiri dengan karakter alfanumerik
Ekspresi reguler yang digunakan untuk validasi adalah: '[a-z]([-a-z0-9]*[a-z0-9])?'
-s|--service_account ACCOUNT
- Nama akun layanan yang digunakan untuk menginstal Cloud Service Mesh. Jika tidak ditentukan, akun pengguna aktif dalam konfigurasi
gcloud
saat ini akan digunakan. Jika perlu mengubah akun pengguna aktif, jalankan gcloud auth login.
Opsi untuk sertifikat kustom Istio CA
Jika Anda menentukan --ca citadel
dan menggunakan CA kustom, sertakan
opsi berikut:
--ca_cert FILE_PATH
: Intermediate certificate--ca_key FILE_PATH
: Kunci untuk intermediate certificate--root_cert FILE_PATH
: Root certificate--cert_chain FILE_PATH
: Rantai sertifikat
Untuk informasi selengkapnya, lihat Menyertakan Sertifikat CA yang sudah ada.
Tanda pengaktifan
Tanda yang dimulai dengan --enable
memungkinkan asmcli
mengaktifkan Google API yang diperlukan, menetapkan izin Identity and Access Management (IAM) yang diperlukan, dan memperbarui cluster Anda. Jika ingin, Anda dapat mengupdate project dan mengelompokkan sendiri sebelum menjalankan asmcli
. Semua flag pengaktifan tidak kompatibel dengan
asmcli validate
. Jika Anda menentukan flag pengaktifan saat menjalankan
asmcli validate
, perintah akan dihentikan dengan error.
-e|--enable_all
- Izinkan
asmcli
untuk melakukan semua tindakan pengaktifan individual yang dijelaskan di bawah. --enable_cluster_roles
- Izinkan
asmcli
untuk mencoba mengikat pengguna atau akun layanan Google Cloud yang menjalankanasmcli
ke perancluster-admin
di cluster Anda.asmcli
menentukan akun pengguna dari perintahgcloud config get core/account
. Jika Anda menjalankanasmcli
secara lokal dengan akun pengguna, pastikan Anda memanggil perintahgcloud auth login
sebelum menjalankanasmcli
. Jika Anda perlu mengubah akun pengguna, jalankan perintahgcloud config set core/account GCP_EMAIL_ADDRESS
dengan GCP_EMAIL_ADDRESS adalah akun yang Anda gunakan untuk login ke Google Cloud. --enable_cluster_labels
- Izinkan
asmcli
untuk menetapkan label cluster yang diperlukan. --enable_gcp_components
Izinkan
asmcli
untuk mengaktifkan layanan dan komponen yang dikelola Google Cloud berikut:Workload Identity, yang memungkinkan aplikasi GKE mengakses layanan Google Cloud dengan aman.
--enable_gcp_apis
Izinkan
asmcli
untuk mengaktifkan semua Google API yang diperlukan.--enable_gcp_iam_roles
Izinkan
asmcli
untuk menetapkan izin IAM yang diperlukan.--enable_meshconfig_init
Izinkan skrip untuk melakukan inisialisasi endpoint meshconfig atas nama Anda. Disimpulkan oleh
--enable_gcp_components
dan--managed
.--enable_namespace_creation
Izinkan
asmcli
untuk membuat namespaceistio-system
root.--enable_registration
Izinkan
asmcli
untuk mendaftarkan cluster ke project tempat cluster tersebut berada. Jika Anda tidak menyertakan tanda ini, ikuti langkah-langkah di bagian Mendaftarkan cluster untuk mendaftarkan cluster secara manual. Perlu diperhatikan bahwa tidak seperti flag pengaktifan lainnya,--enable_registration
hanya disertakan dalam--enable_all
saat Anda menentukan opsi (seperti--option hub-meshca
) yang memerlukan pendaftaran cluster. Jika tidak, Anda perlu menentukan tanda ini secara terpisah.
Tanda lainnya
--dry_run
- Mencetak perintah, tetapi tidak menjalankannya.
--fleet_id
- Daftarkan cluster ke fleet menggunakan project ID host fleet. Flag ini diperlukan untuk cluster non-Google Cloud. Jika tidak disediakan untuk cluster Google Cloud, setelan defaultnya adalah project ID cluster. Anda dapat menjalankan
asmcli install
bersama dengan--fleet_id
sebelum penginstalan, atau sebagai bagian dari penginstalan dengan meneruskan flag--enable-registration
dan--fleet-id
. Setelan ini tidak dapat diubah setelah dikonfigurasi. --managed
- Sediakan bidang kontrol jarak jauh yang terkelola, bukan menginstal satu bidang dalam cluster.
--offline
- Lakukan penginstalan offline menggunakan paket yang telah didownload sebelumnya di direktori output. Jika direktori tidak ditentukan atau tidak berisi file yang diperlukan, skrip akan keluar dengan error.
--only_enable
- Melakukan langkah-langkah yang ditentukan untuk menyiapkan pengguna/cluster saat ini, tetapi tidak menginstal apa pun.
--only_validate
- Jalankan validasi, tetapi jangan update project atau cluster dan jangan instal
Cloud Service Mesh. Flag ini tidak kompatibel dengan
flag pengaktif.
asmcli
dihentikan dengan error jika Anda menentukan--only_validate
dengan flag pengaktifan. --print_config
- Alih-alih menginstal Cloud Service Mesh, cetak semua YAML yang dikompilasi ke output standar (stdout). Semua output lainnya ditulis ke error standar (stderr), meskipun biasanya menuju ke stdout.
asmcli
melewati semua validasi dan penyiapan saat Anda menentukan tanda ini. --disable_canonical_service
- Secara default,
asmcli
men-deploy pengontrol Layanan Kanonis ke cluster Anda. Jika Anda tidak inginasmcli
men-deploy pengontrol, tentukan--disable_canonical_service
. Untuk informasi selengkapnya, lihat Mengaktifkan dan menonaktifkan pengontrol Layanan Kanonis. -h|--help
- Tampilkan pesan bantuan yang menjelaskan opsi serta tanda dan keluar.
--use_managed_cni
- Menggunakan CNI terkelola. Jika flag ini
tidak diteruskan,
asmcli
akan menerapkan manifes CNI statis. --use_vpcsc
- Jika organisasi Anda menerapkan Kontrol Layanan VPC untuk project, Anda harus mengonfigurasi Cloud Service Mesh terkelola dengan flag
--use_vpcsc
. Jika tidak, penginstalan akan gagal dalam kontrol keamanan. -v|--verbose
- Saat
asmcli
berjalan, ia mencetak perintah yang akan dijalankan berikutnya. Dengan flag--verbose
,asmcli
juga mencetak perintah setelah dieksekusi. --version
- Cetak versi
asmcli
dan keluar. Jika tidak memiliki versi terbaru, Anda dapat mendownloadasmcli_1.20
versi terbaru.