apigeectl

Anda saat ini melihat versi 1.11 dari Dokumentasi Apigee Hybrid. Untuk mengetahui informasi selengkapnya, lihat Versi yang didukung.

Version 1.11 

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. Sebagai informasi tentang cara mendownload dan menginstal apigeectl, lihat Download dan instal apigeectl.

Catatan: Anda harus memiliki kubectl diinstal dan disiapkan di mesin administrasi Kubernetes untuk menggunakan perintah apigeectl.

Cakupan untuk menerapkan apigeectl

Dengan menggunakan flag apigeectl, Anda mengontrol cakupan 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 Synchronizer UDCA	‑‑all‑envs ‑‑env
Organisasi	Agen Apigee Connect MART Watcher	‑‑org
Pelaporan	Logger Metrics	‑‑telemetry

sintaksis apigeectl

apigeectl [command] [flags]

Dengan keterangan:

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

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

perintah apigeectl

Tabel berikut mencantumkan perintah apigeectl:

Perintah	Deskripsi
apply	Menerapkan konfigurasi untuk runtime hybrid Apigee ke cluster Kubernetes Anda. apigeectl apply tanpa tanda akan menerapkan perubahan pada 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 melakukan penginstalan baru atau upgrade, Anda harus memanggil apigeectl init sebelum memanggil apigeectl apply.
check‑ready	Memeriksa status pod komponen hybrid. Jika semua pod komponen sudah siap, pesan "Semua container siap" adalah {i>output<i}. Untuk pembuatan skrip otomatis, perhatikan bahwa perintah keluar dengan status 0 jika semua container sudah siap. Bila ada setidaknya satu pod 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 (untuk contoh, apigeectl delete ‑‑all -f overrides.yaml) juga akan menghapus mencadangkan data untuk semua snapshot volume CSI. Menghapus komponen hybrid dari cluster. Menggunakan tanda ‑‑all untuk menghapus SEMUA komponen. Jika Anda menghapus ‑‑all, hanya komponen khusus Apigee komponen dihapus (komponen yang diinstal dengan apigeectl init tidak dihapus). Komponen khusus Apigee adalah komponen yang diinstal dengan perintah apply. apigeectl delete tanpa tanda opsional apa pun menerapkan delete kepada semua komponen yang di-deploy di cluster tersebut. apigeectl diagnostic delete ‑f OVERRIDES_FILE menghapus namespace apigee‑diagnostic yang dibuat oleh apigeectl diagnostic. ‑f / Tanda ‑‑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 mengetahui informasi selengkapnya, lihat Meng-uninstal runtime hybrid.
diagnostic	Memanggil kolektor Diagnostik, yang mengambil data diagnostik di Kubernetes komponen instance hybrid Apigee sesuai permintaan dan menyimpannya di penyimpanan Google Cloud bucket. Kolektor diagnostik memerlukan bucket Google Cloud Storage bernama, yaitu akun layanan dengan peran Storage Admin, dan stanza diagnostic: yang ditambahkan ke File overrides. Lihat: Menggunakan Diagnostik kolektor Properti konfigurasi referensi: diagnostic Saat Anda memanggil Kolektor diagnostik, tindakan ini akan membuat "apigee‑diagnostic" Namespace Kubernetes. 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 atau lingkungan tertentu dalam organisasi yang ditentukan. Nama yang dienkode sertakan nama komponen dengan nama organisasi yang di-hash dan jika menggunakan Tanda ‑‑env, nama lingkungan yang di-hash. Apigee Hybrid membuat nama dengan hash organisasi dan lingkungan untuk dapat menghindari konflik namespace. Anda harus menggunakan ‑‑org org‑name atau kedua ‑‑org org‑name dengan ‑‑env env‑name flag 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 (untuk contoh, apigeectl delete ‑‑all -f overrides.yaml) juga akan menghapus mencadangkan data 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.
‑‑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 dari 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 diterapkan ke komponen cakupan lingkungan, yakni apigee-runtime, apigee-synchronizer, dan apigee-udca. ‑‑env harus digunakan dengan tanda ‑‑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 untuk deployment hybrid. Nilai defaultnya adalah ./overrides.yaml. File pengganti diperlukan untuk apply, Perintah 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 diterapkan 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 penanda ini, lihat Mencetak konfigurasi ke file.
‑‑redis	Menerapkan konfigurasi ke cakupan penyimpanan data dalam memori (Redis).
‑‑restore	Memulihkan Cassandra ke snapshot yang disimpan sebelumnya yang ditentukan oleh Properti snapshotTimestamp dalam konfigurasi restore file overrides.yaml. Cadangan dipulihkan dari bucket Cloud Storage atau server jarak jauh berdasarkan konfigurasi backup di file overrides.yaml. Untuk informasi selengkapnya, lihat Memulihkan region dari cadangan.
‑s ‑‑settings virtualhosts	Menentukan konfigurasi tempat perintah diterapkan. Sekarang, tanda ini hanya didukung untuk konfigurasi virtualhosts, yang merupakan bagian dari komponen runtime. Gunakan penanda ini jika Anda membuat perubahan pada virtualhosts properti, dan tidak melakukan apa pun lain. Misalnya, jika Anda membuat perubahan pada konfigurasi virtualhosts dalam file penggantian, terapkan 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 {i>std err<i}. int adalah bilangan bulat yang menetapkan tingkat verbositas. int diperlukan dengan ‑‑v. Opsi ini berperilaku identik dengan opsi kubectl ‑‑v. Catatan: Opsi ini menggantikan ‑‑verbose yang tidak digunakan lagi .

Perintah apigeectl menggunakan kubectl di belakang layar untuk melakukan pekerjaannya. Opsi perintah apigeectl (apply dan delete, dan penggunaan file konfigurasi YAML, mirip dengan pasangan kubectl-nya. Untuk mempelajari lebih lanjut cara objek dikelola di cluster Kubernetes, baca 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 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 Anda menjalankan apply semua komponen runtime hybrid dibuat di cluster Anda. Jika Anda membuat perubahan konfigurasi, jalankan kembali apply untuk menerapkan perubahan saja atau menggunakan tanda untuk menerapkan perubahan pada cakupannya saja.

Contoh berikut menerapkan konfigurasi untuk bidang runtime hybrid komponen 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 Anda melakukan {i>debugging<i} pada masalah instalasi, ada baiknya Anda mencetak seluruh konfigurasi cluster ke file sehingga Anda dapat memeriksa konfigurasi setelan. Flag ‑‑print‑yaml dicetak konfigurasi hybrid ke {i>stdout<i}, dan flag ‑‑dry‑run memungkinkan untuk dijalankan tanpa membuat perubahan pada cluster.

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

Catatan: Sebaiknya simpan salinan {i>output<i} YAML dalam kontrol sumber untuk referensi di masa mendatang. Tetapi perhatikan bahwa file {i>output<i} 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 campuran dari cluster

Untuk mengetahui detailnya, lihat Meng-uninstal runtime hybrid.