apigeectl

Anda saat ini melihat versi 1.2 dokumentasi Apigee Hybrid. This version is end of life. You should upgrade to a newer version. Untuk informasi selengkapnya, lihat Versi yang didukung.

Version 1.2 (unsupported)

   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 menginstal dan menyiapkan kubectl di mesin administrasi Kubernetes untuk menggunakan perintah apigeectl.

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 mengetahui 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 Kubenetes Anda. Gunakan tanda -c untuk menentukan satu atau beberapa komponen (dipisahkan koma). Jika Anda tidak menentukan flag -c, perintah apply akan menerapkan semua komponen ke cluster. CATATAN: Anda harus memanggil apigeectl init sebelum memanggil apigeectl apply.
check‑ready	Memeriksa status pod komponen campuran. Jika semua pod komponen sudah siap, pesan "Semua penampung siap" akan ditampilkan. Untuk pembuatan skrip otomatis, perhatikan bahwa perintah akan keluar dengan status 0 saat semua penampung siap. Jika ada setidaknya satu pod yang belum siap, perintah akan keluar dengan status 1. Jika Anda tidak menentukan flag -c, perintah check-ready akan berlaku untuk semua komponen dalam cluster.
delete	Menghapus komponen campuran dari cluster. Gunakan flag --all untuk menghapus SEMUA komponen. Jika Anda menghapus --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. Jika Anda tidak menentukan flag -c, perintah delete akan berlaku untuk semua komponen yang di-deploy di cluster.
help	Mencetak bantuan online.
init	Menerapkan konfigurasi untuk komponen prasyarat, seperti Deployment Istio dan Apigee, ke cluster. Gunakan tanda -c untuk menentukan satu atau beberapa komponen (dipisahkan koma).
version	Mencetak informasi versi CLI.

Flag apigeectl

Tabel berikut mencantumkan flag apigeectl:

Flag	Deskripsi
-c, --components	Menentukan satu komponen tempat perintah diterapkan. Jika Anda tidak menentukan tanda ini, perintah akan berlaku untuk semua komponen (seluruh deployment) dalam cluster. Nilai yang memungkinkan mencakup: cassandra logger mart metrics runtime synchronizer udca Contoh, -c cassandra Atau, untuk menentukan beberapa komponen, tambahkan nilai yang dipisahkan koma: -c cassandra, runtime
--dry-run	Menjalankan perintah yang ditentukan tanpa mengubah cluster. Gunakan dengan ‑‑print-yaml untuk menghasilkan spesifikasi objek yang dirender ke file.
‑f, ‑‑file‑override‑config	Menentukan file YAML yang berisi properti konfigurasi kustom untuk deployment campuran. 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 platform runtime.
-h, --help	Menampilkan bantuan untuk perintah.
--print-yaml	Mencetak output template konfigurasi ke stdout. Untuk contoh yang menggunakan flag ini, lihat Mencetak konfigurasi ke file.
-s, --settings	Menentukan konfigurasi yang diterapkan perintah. Saat ini, tanda ini hanya didukung untuk konfigurasi virtualhosts, yang merupakan bagian dari komponen runtime. Gunakan tanda ini jika Anda membuat perubahan pada properti virtualhosts, dan tidak ada yang lain. (Ditambahkan v1.2.0) 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 -c runtime

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-nya. 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 campuran ke cluster Kubernetes, gunakan perintah apply. Saat pertama kali Anda menjalankan apply, semua komponen runtime campuran akan dibuat di cluster Anda. Jika Anda membuat perubahan konfigurasi, jalankan ulang apply untuk hanya menerapkan perubahan atau gunakan -c untuk hanya menerapkan komponen tertentu.

Contoh berikut menerapkan konfigurasi untuk komponen platform 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 -c, seperti yang dijelaskan dalam flag apigeectl.

Contoh berikut hanya menerapkan konfigurasi untuk komponen Synchronizer:

apigeectl apply -c synchronizer -f my_overrides.yaml

Contoh berikut hanya menerapkan konfigurasi untuk Cassandra dan komponen runtime:

apigeectl apply -c cassandra,runtime -f my_overrides.yaml

Mencetak konfigurasi ke file

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

apigeectl apply -f my_overrides.yaml --dry-run --print-yaml > apigee-hybrid.yaml

CATATAN: Sebaiknya simpan salinan output YAML di kontrol sumber untuk referensi di masa mendatang. Namun, perlu diketahui bahwa file output berisi sandi dan secret yang mungkin tidak ingin Anda simpan.

Memeriksa status pod

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

apigeectl check-ready
All containers ready in namespace 'my-namespace'

Menghapus hybrid dari cluster

Contoh berikut hanya menghapus komponen runtime campuran ke cluster Kubernetes Anda. Untuk menghapus semuanya, gunakan flag --all.

CATATAN: Agar berhasil meng-uninstal, Anda harus menginstal kubectl versi 1.11.x atau yang lebih baru.

apigeectl delete -f my_overrides.yaml