Referensi asmcli
Halaman ini menjelaskan argumen yang tersedia untuk asmcli.
Opsi
Mengidentifikasi cluster Anda memiliki opsi berikut untuk mengidentifikasi cluster:
GKE saja
-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 zona tunggal) 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 TLS bersama sertifikat. Tentukan
mesh_cauntuk menggunakan certificate authority Cloud Service Mesh (certificate authority Cloud Service Mesh),gcp_casuntuk menggunakan Certificate Authority Service, ataucitadeluntuk menggunakan Istio CA. Cloud Service Mesh terkelola tidak mendukung Istio CA. Lihat hal berikut untuk mengetahui informasi tambahan:--channel ANTHOS_SERVICE_MESH_CHANNELGunakan
--channeldengan 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 GKE Autopilot.--co|--custom_overlay OVERLAY_FILEGunakan
--custom_overlydengan nama file YAML (disebut sebagai file overlay) yang berisi resource kustomIstioOperatoruntuk mengonfigurasi bidang kontrol dalam cluster. Anda menentukan file overlay untuk mengaktifkan fitur yang tidak diaktifkan secara default. Cloud Service Mesh terkelola tidak mendukungIstioOperatorAPI, sehingga Anda tidak dapat menggunakan--custom_overlayuntuk mengonfigurasi bidang kontrol terkelola.asmcliharus dapat menemukan file overlay, sehingga file tersebut harus berada di direktori yang sama denganasmcli, atau Anda dapat menentukan jalur relatif. Untuk menambahkan beberapa file, tentukan--co|--custom_overlaydan nama file, misalnya:--co overlay_file1.yaml --co overlay_file2.yaml --co overlay_file3.yaml--hub-registration-extra-flags HUB_REGISTRATION_EXTRA_FLAGSJika menggunakan cluster Amazon EKS terlampir, gunakan
--hub-registration-extra-flagsuntuk mendaftarkan cluster ke fleet jika belum terdaftar.-k|--key_file FILE_PATHFile kunci untuk akun layanan. Abaikan opsi ini jika Anda tidak menggunakan akun layanan.
--network_id NETWORK_IDGunakan
--network_iduntuk menetapkan labeltopology.istio.io/networkyang diterapkan ke namespaceistio-system. Untuk GKE,--network_idsecara default ditetapkan ke nama jaringan untuk cluster. Untuk lingkungan lain,defaultakan digunakan.-o|--option OVERLAY_FILENama file overlay (tanpa ekstensi
.yaml) yangasmclididownload dari repositorianthos-service-meshuntuk mengaktifkan fitur opsional. Anda memerlukan konektivitas internet untuk menggunakan--option. Opsi--optiondan--custom_overlayserupa, tetapi memiliki perilaku yang sedikit berbeda:Gunakan
--custom_overlayjika Anda perlu mengubah setelan dalam file overlay.Gunakan
--optionuntuk mengaktifkan fitur yang tidak memerlukan perubahan pada file overlay, misalnya, untuk mengonfigurasi kebijakan audit untuk layanan Anda.
Untuk menambahkan beberapa file, tentukan
-o|--optiondan nama file, misalnya:-o option_file1 -o option_file2 -o option_file3-D|--output_dir DIR_PATHJika tidak ditentukan,
asmcliakan membuat direktori sementara tempat file dan konfigurasi yang diperlukan untuk menginstal Cloud Service Mesh didownload. Tentukan flag--output-diruntuk menentukan jalur relatif ke direktori yang akan digunakan. Setelah selesai, direktori yang ditentukan akan berisiasmdan subdirektoriistio-1.31.1-asm.19. Direktoriasmberisi konfigurasi untuk penginstalan. Direktoriistio-1.31.1-asm.19berisi konten file penginstalan yang diekstrak, yang berisiistioctl, contoh, dan manifes. Jika Anda menentukan--output-dirdan direktori sudah berisi file yang diperlukan,asmcliakan menggunakan file tersebut, bukan mendownloadnya lagi.--platform PLATFORM {gcp|multicloud}Platform atau penyedia cluster Kubernetes. Secara default ditetapkan ke
gcp(untuk cluster GKE). Untuk semua platform lain, gunakanmulticloud.-r|--revision_name REVISION NAMELabel revisi adalah key-value pair yang ditetapkan pada bidang kontrol. Kunci label revisi selalu
istio.io/rev. Secara default,asmclimenetapkan nilai untuk label revisi berdasarkan versi Cloud Service Mesh, misalnya:asm-1311-19. Sertakan opsi ini jika Anda ingin mengganti nilai default dan menentukan nilai Anda sendiri. ArgumenREVISION NAMEharus berupa label DNS-1035. Artinya, nama 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
gcloudsaat ini akan digunakan. Jika Anda 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: Sertifikat perantara--ca_key FILE_PATH: Kunci untuk sertifikat perantara--root_cert FILE_PATH: Sertifikat root--cert_chain FILE_PATH: Rantai sertifikat
Untuk mengetahui informasi selengkapnya, lihat Memasukkan Sertifikat CA yang ada.
Flag pengaktifan
Flag yang dimulai dengan --enable memungkinkan asmcli mengaktifkan Google API yang diperlukan, menetapkan izin Identity and Access Management (IAM) yang diperlukan, dan mengupdate cluster Anda. Jika mau, Anda dapat
mengupdate project dan cluster 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- Mengizinkan
asmclimelakukan semua tindakan pengaktifan individual yang dijelaskan di bawah. --enable_cluster_roles- Mengizinkan
asmclimencoba mengikat akun Google Cloud pengguna atau layanan yang menjalankanasmclike perancluster-admindi cluster Anda.asmclimenentukan akun pengguna dari perintahgcloud config get core/account. Jika Anda menjalankanasmclisecara lokal dengan akun pengguna, pastikan Anda memanggil perintahgcloud auth loginsebelum menjalankanasmcli. Jika Anda perlu mengubah akun pengguna, jalankangcloud config set core/account GCP_EMAIL_ADDRESSperintah dengan GCP_EMAIL_ADDRESS adalah akun yang Anda gunakan untuk login Google Cloud. --enable_cluster_labels- Mengizinkan
asmclimenetapkan label cluster yang diperlukan . --enable_gcp_componentsMengizinkan
asmclimengaktifkan layanan dan komponen terkelola berikut yang diperlukan Google Cloud :Workload Identity, yang memungkinkan aplikasi GKE mengakses layanan Google Cloud dengan aman.
--enable_gcp_apisMengizinkan
asmclimengaktifkan semua Google API yang diperlukan.--enable_gcp_iam_roles--enable_meshconfig_initMengizinkan skrip menginisialisasi endpoint meshconfig atas nama Anda. Tersirat oleh
--enable_gcp_componentsdan--managed.--enable_namespace_creationMengizinkan
asmclimembuat namespaceistio-systemroot.--enable_registrationMengizinkan
asmclimendaftarkan cluster ke project tempat cluster berada. Jika Anda tidak menyertakan flag ini, ikuti langkah-langkah di Mendaftarkan cluster untuk mendaftarkan cluster secara manual. Perhatikan bahwa tidak seperti flag pengaktifan lainnya,--enable_registrationhanya disertakan dalam--enable_allsaat Anda menentukan opsi (seperti--option hub-meshca) yang memerlukan pendaftaran cluster. Jika tidak, Anda harus menentukan flag ini secara terpisah.
Flag lainnya
--dry_run- Mencetak perintah, tetapi tidak menjalankannya.
--fleet_id- Mendaftarkan cluster ke fleet menggunakan project ID host fleet. Flag ini diperlukan untuk cluster non-Google Cloud GKE. Jika tidak disediakan untuk
Google Cloud cluster, flag ini akan ditetapkan secara default ke project ID cluster. Anda dapat menjalankan
asmcli installbersama dengan--fleet_idsebelum penginstalan, atau sebagai bagian dari penginstalan dengan meneruskan flag--enable-registrationdan--fleet-id. Setelan ini tidak dapat diubah setelah dikonfigurasi. --managed- Menyediakan bidang kontrol terkelola jarak jauh, bukan menginstal bidang kontrol dalam cluster.
--offline- Melakukan 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- Menjalankan validasi, tetapi tidak mengupdate project atau cluster dan tidak menginstal Cloud Service Mesh. Flag ini tidak kompatibel dengan
flag pengaktifan.
asmcliakan dihentikan dengan error jika Anda menentukan--only_validatedengan flag pengaktifan apa pun. --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 akan masuk ke stdout.
asmcliakan melewati semua validasi dan penyiapan saat Anda menentukan flag ini. --disable_canonical_service- Secara default,
asmclimen-deploy pengontrol Canonical Service ke cluster Anda. Jika Anda tidak inginasmclimen-deploy pengontrol, tentukan--disable_canonical_service. Untuk mengetahui informasi selengkapnya, lihat Mengaktifkan dan menonaktifkan pengontrol Canonical Service. -h|--help- Menampilkan pesan bantuan yang menjelaskan opsi dan flag, lalu keluar.
--use_managed_cni- Menggunakan CNI terkelola. Jika flag ini tidak diteruskan,
asmcliakan menerapkan manifes CNI statis. --use_vpcsc- Jika organisasi Anda menerapkan
Kontrol Layanan VPC untuk project Anda, Anda harus
mengonfigurasi Cloud Service Mesh terkelola dengan flag
--use_vpcsc. Jika tidak, penginstalan akan gagal dalam kontrol keamanan. -v|--verbose- Saat
asmcliberjalan, perintah akan mencetak perintah yang akan dijalankan berikutnya. Dengan flag--verbose,asmclijuga mencetak perintah setelah eksekusi. --version- Mencetak versi
asmcli, lalu keluar. Jika Anda tidak memiliki versi terbaru, Anda dapat mendownload versi terbaru dariasmcli_1.31.
Langkah berikutnya
Pelajari cara menyiapkan mesh multi-cluster:
Jika mesh Anda sepenuhnya terdiri dari cluster GKE, lihat Menyiapkan mesh multi-cluster di GKE.
Jika mesh Anda terdiri dari cluster di luar Google Cloud, lihat Menyiapkan mesh multi-cluster di luar Google Cloud.