apigeectl

Saat ini Anda melihat versi 1.10 dari dokumentasi Apigee Hybrid. Untuk mengetahui informasi selengkapnya, lihat Versi yang didukung.

Version 1.10 

Versi yang didukung:

• v1.13 (terbaru)                        
• v1.12                         
• v1.11                         
• Daftar versi yang didukung

Versi yang tidak didukung:

• v1.10                                      
• v1.9                                         
• v1.8                                         
• v1.7                                         
• v1.6                                         
• v1.5                                         
• v1.4                                         
• v1.3                                         
• v1.2                                         
• v1.1                                         

apigeectl adalah antarmuka command line (CLI) untuk menginstal dan mengelola Apigee Hybrid di cluster Kubernetes. Untuk mengetahui informasi tentang cara mendownload dan menginstal apigeectl, lihat Mendownload dan menginstal apigeectl.

Catatan: Anda harus sudah menginstal kubectl dan menyiapkan di mesin administrasi Kubernetes untuk menggunakan perintah apigeectl.

Cakupan untuk menerapkan apigeectl

Dengan menggunakan apigeectl flag, Anda mengontrol cakupan mana saja tempat perintah menerapkan perubahan konfigurasi. Untuk ringkasan cakupan dalam runtime hybrid Apigee, lihat Ringkasan konfigurasi layanan runtime.

Cakupan	Komponen	Flag apigeectl
Penyimpanan	Cassandra	‑‑datastore
Penyimpanan dalam memori	Redis	‑‑redis
Lingkungan	Runtime Sinkronisasi UDCA	‑‑all‑envs ‑‑env
Organisasi	Agen Apigee Connect MART Watcher	‑‑org
Pelaporan	Logger Metrik	‑‑telemetry

sintaksis apigeectl

apigeectl [command] [flags]

Dengan keterangan:

• command: Menentukan operasi yang ingin Anda lakukan. Untuk mengetahui daftar lengkap perintah, lihat perintah apigeectl.

• flags: Menentukan parameter perintah. Untuk daftar lengkap flag, lihat flag apigeectl.

perintah apigeectl

Tabel berikut mencantumkan perintah apigeectl:

Perintah	Deskripsi
apply	Menerapkan konfigurasi untuk komponen runtime Apigee Hybrid ke cluster Kubernetes Anda. apigeectl apply tanpa flag akan menerapkan perubahan ke semua komponen dalam cluster. flag apigeectl: ‑‑all‑envs, ‑‑datastore, ‑‑dry‑run, ‑‑env, ‑f, ‑‑file‑override‑config, ‑‑help, ‑‑org, ‑‑print‑yaml, ‑‑redis, ‑‑settings virtualhosts, ‑‑telemetry, ‑‑v Catatan: Setelah penginstalan baru atau upgrade, Anda harus memanggil apigeectl init sebelum memanggil apigeectl apply.
check‑ready	Memeriksa status pod komponen campuran. Saat semua pod komponen sudah siap, output pesan "All container ready" akan muncul. Untuk pembuatan skrip otomatis, perhatikan bahwa perintah akan keluar dengan status 0 saat container sudah siap. Jika setidaknya ada satu pod yang belum siap, perintah akan keluar dengan status 1. flag apigeectl: ‑f, ‑‑file‑override‑config, ‑‑help, ‑‑v
delete	Peringatan: Menggunakan perintah apigeectl delete dengan flag ‑‑all (misalnya apigeectl delete ‑‑all -f overrides.yaml) juga akan menghapus data cadangan untuk semua snapshot volume CSI. Menghapus komponen hybrid dari cluster. Gunakan flag ‑‑all untuk menghapus SEMUA komponen. Jika Anda menghilangkan ‑‑all, hanya komponen khusus Apigee yang akan dihapus (komponen yang diinstal dengan apigeectl init tidak akan dihapus). Komponen khusus Apigee adalah komponen yang diinstal dengan perintah apply. apigeectl delete tanpa flag opsional akan menerapkan perintah delete ke semua komponen yang di-deploy di cluster. apigeectl diagnostic delete ‑f OVERRIDES_FILE menghapus namespace apigee‑diagnostic yang dibuat oleh apigeectl diagnostic. Flag ‑f/ ‑‑file‑override‑config diperlukan dengan apigeectl diagnostic delete flag apigeectl: ‑‑all, ‑‑all‑envs, ‑‑datastore, ‑‑env, ‑f, ‑‑file‑override‑config, ‑‑help, ‑‑org, ‑‑redis, ‑‑telemetry, ‑‑v Untuk informasi selengkapnya, lihat Meng-uninstal runtime hybrid.
diagnostic	Memanggil kolektor Diagnostik, yang merekam data diagnostik pada komponen Kubernetes dari instance hybrid Apigee on demand dan menyimpannya di bucket Google Cloud Storage. Kolektor diagnostik memerlukan bucket penyimpanan Google Cloud bernama, akun layanan dengan peran Storage Admin, dan stanza diagnostic: yang ditambahkan ke file overrides Anda. Lihat: Menggunakan kolektor Diagnostik Referensi properti konfigurasi: diagnostic Saat Anda memanggil kolektor Diagnostik, ia akan membuat namespace Kubernetes "apigee‑diagnostic". Anda harus menghapusnya dengan apigeectl diagnostic delete sebelum memanggil kolektor diagnostik lagi. Panggil kolektor Diagnostik: apigeectl diagnostic ‑f OVERRIDES_FILE Hapus kolektor diagnostik: apigeectl diagnostic delete ‑f OVERRIDES_FILE flag apigeectl: ‑‑file‑override‑config
encode	Menampilkan daftar nama yang dienkode dari semua ApigeeDeployment untuk organisasi tertentu atau lingkungan yang ditentukan dalam organisasi yang ditentukan. Nama yang dienkode mencakup nama komponen dengan nama organisasi yang di-hash dan, jika menggunakan tanda ‑‑env, nama lingkungan yang di-hash. Apigee Hybrid menciptakan nama yang di-hash untuk organisasi dan lingkungan agar dapat menghindari konflik namespace. Anda harus menggunakan ‑‑org org‑name atau ‑‑org org‑name dengan tanda ‑‑env env‑name dengan encode. Contoh: ./apigeectl encode ‑‑org hybrid‑example List of ApigeeDeployments are: apigee‑connect‑agent‑hybrid‑example‑6a82f8a apigee‑mart‑hybrid‑example‑6a82f8a apigee‑watcher‑hybrid‑example‑6a82f8a ./apigeectl encode ‑‑org hybrid‑example ‑‑env example‑env List of ApigeeDeployments are: apigee‑runtime‑hybrid‑example‑example‑env‑9e87e2d apigee‑synchronizer‑hybrid‑example‑example‑env‑9e87e2d apigee‑udca‑hybrid‑example‑example‑env‑9e87e2d flag apigeectl: ‑‑env, ‑‑org
help	Mencetak bantuan online.
init	Menginstal Operator dan CRD Apigee di namespace sistem apigee. Jalankan apigeectl init setelah penginstalan baru atau upgrade sebelum menjalankan apigeectl apply. flag apigeectl: ‑f, ‑‑file‑override‑config, ‑‑help, ‑‑v
version	Mencetak informasi versi CLI. flag apigeectl: ‑‑help

flag apigeectl

Tabel berikut mencantumkan flag apigeectl:

Tanda	Deskripsi
‑‑all	Peringatan: Menggunakan perintah apigeectl delete dengan flag ‑‑all (misalnya apigeectl delete ‑‑all -f overrides.yaml) juga akan menghapus data cadangan untuk semua snapshot volume CSI. Khusus delete: Menghapus seluruh penginstalan hybrid Apigee, kecuali ASM (Istio) dan pengelola sertifikat dari cluster Anda.
‑‑all‑envs	Menerapkan perintah apigeectl ke semua lingkungan di bawah organisasi yang ditentukan dalam file konfigurasi penggantian Anda.
‑‑datastore	Menerapkan konfigurasi ke cakupan datastore (Cassandra).
‑‑dry‑run	Menjalankan perintah yang ditentukan tanpa mengubah cluster. Gunakan dengan ‑‑print‑yaml untuk menghasilkan spesifikasi objek yang dirender ke file. ‑‑dry‑run harus digunakan dengan salah satu dari dua nilai berikut, bergantung pada versi kubectl yang Anda jalankan. Gunakan gcloud version untuk memeriksa versi kubectl: kubectl versi 1.17.x atau yang lebih lama: ‑‑dry‑run=true kubectl versi 1.18.x atau yang lebih baru: ‑‑dry‑run=client
‑‑env env‑name	Menerapkan konfigurasi ke lingkungan yang ditentukan. Tanda ini akan menerapkan konfigurasi ke komponen cakupan lingkungan apigee‐runtime, apigee‐synchronizer, dan apigee‐udca. ‑‑env harus digunakan dengan flag ‑‑org. Contoh: apigeectl apply ‑‑org hybrid‑example ‑‑env example‑env \ ‑f overrides/overrides.yaml
‑f ‑‑file‑override‑config	Menentukan file YAML yang berisi properti konfigurasi kustom untuk deployment hybrid. Nilai defaultnya adalah ./overrides.yaml. File penggantian diperlukan untuk perintah apply, check‑ready, delete, dan init. Anda harus menentukan jalur lengkap dengan tanda ini. Untuk informasi selengkapnya, lihat Mengelola komponen bidang runtime.
‑h ‑‑help	Menampilkan bantuan untuk perintah.
‑‑org	Menerapkan konfigurasi ke organisasi yang ditentukan. Tanda ini akan menerapkan konfigurasi ke komponen cakupan organisasi apigee‐connect‐agent, apigee‐mart, dan apigee‐watcher. Catatan: Saat menggunakan ‑‑org dengan encode, Anda harus menyertakan ID organisasi. Contoh: apigeectl encode ‑‑org example‑org
‑‑print‑yaml	Mencetak output template konfigurasi ke stdout. Untuk contoh yang menggunakan tanda ini, lihat Mencetak konfigurasi ke file.
‑‑redis	Menerapkan konfigurasi ke cakupan penyimpanan data dalam memori (Redis).
‑‑restore	Memulihkan Cassandra ke snapshot tersimpan sebelumnya yang ditentukan oleh properti snapshotTimestamp dalam konfigurasi restore dari file overrides.yaml. Cadangan dipulihkan dari bucket Cloud Storage atau server jarak jauh berdasarkan konfigurasi backup dalam file overrides.yaml. Untuk informasi selengkapnya, lihat Memulihkan region dari cadangan.
‑s ‑‑settings virtualhosts	Menentukan konfigurasi yang menerapkan perintah. Saat ini, flag ini hanya didukung untuk konfigurasi virtualhosts, yang merupakan bagian dari komponen runtime. Gunakan tanda ini jika Anda membuat perubahan pada properti virtualhosts, dan bukan pada hal lainnya. Misalnya, jika Anda membuat perubahan pada konfigurasi virtualhosts di file penggantian, terapkan perubahan tersebut ke cluster dengan perintah ini: apigeectl apply ‑f my‑overrides.yaml ‑‑settings virtualhosts \ ‑‑org example‑org ‑‑env example‑env
‑‑telemetry	Menerapkan konfigurasi untuk komponen telemetri seperti apigee-logger dan apigee-metrics.
‑‑v int	Mencetak log panjang ke std err. int adalah bilangan bulat yang menetapkan tingkat panjang. int diperlukan dengan ‑‑v. Opsi ini berperilaku sama dengan opsi kubectl ‑‑v. Catatan: Opsi ini menggantikan opsi ‑‑verbose yang sudah tidak digunakan lagi.

Perintah apigeectl menggunakan kubectl di balik layar untuk melakukan tugasnya. Opsi perintah apigeectl (apply dan delete, serta penggunaan file konfigurasi YAML, mirip dengan opsi kubectl. Untuk mempelajari lebih lanjut cara objek dikelola di cluster Kubernetes, lihat topik berikut:

• Pengelolaan Imperatif Objek Kubernetes Menggunakan File Konfigurasi
• Ringkasan kubectl

Contoh

Melakukan inisialisasi konfigurasi cluster

Terapkan konfigurasi komponen prasyarat ke cluster Anda dengan init. Anda harus menjalankan perintah init sebelum apply.

apigeectl init ‑f my_overrides.yaml

Menerapkan konfigurasi cluster

Untuk menerapkan konfigurasi hybrid ke cluster Kubernetes Anda, gunakan perintah apply. Saat pertama kali menjalankan apply, semua komponen runtime hybrid dibuat di cluster Anda. Jika Anda membuat perubahan konfigurasi, jalankan kembali apply untuk menerapkan perubahan saja atau gunakan flag untuk menerapkan perubahan pada cakupan tertentu saja.

Contoh berikut menerapkan konfigurasi untuk komponen bidang runtime hybrid ke cluster Anda:

apigeectl apply ‑f my_overrides.yaml

Menerapkan konfigurasi untuk satu komponen

Untuk membatasi perintah apply ke komponen tertentu, gunakan flag yang dijelaskan dalam flag apigeectl.

Contoh berikut hanya menerapkan konfigurasi untuk komponen Cassandra:

apigeectl apply ‑‑datastore ‑f my_overrides.yaml

Mencetak konfigurasi ke file

Jika men-debug masalah penginstalan, sebaiknya Anda mencetak seluruh konfigurasi cluster ke file agar dapat memeriksa setelan konfigurasi. Flag ‑‑print‑yaml mencetak konfigurasi hybrid ke stdout, dan flag ‑‑dry‑run memungkinkan perintah berjalan tanpa membuat perubahan apa pun pada cluster.

apigeectl apply ‑f my_overrides.yaml ‑‑dry‑run=client ‑‑print‑yaml > apigee‑hybrid.yaml

Catatan: Sebaiknya simpan salinan output YAML di kontrol sumber untuk digunakan sebagai referensi pada masa mendatang. Namun, perlu diperhatikan bahwa file output berisi sandi dan rahasia yang mungkin tidak ingin Anda simpan.

Memeriksa status pod

Contoh berikut memeriksa status pod yang di-deploy ke cluster Anda:

apigeectl check‑ready ‑f overrides/overrides.yaml
All containers ready in namespace 'my-namespace'

Menghapus hybrid dari cluster

Untuk mengetahui detailnya, lihat Meng-uninstal runtime hybrid.