Mengelola komponen bidang runtime

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

Version 1.8 (unsupported)

   Supported versions:

• v1.15 (latest)                        
• v1.14                        
• v1.13                         
• List of supported versions

   Unsupported versions:

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

Topik ini menjelaskan cara mengonfigurasi dan mengelola komponen bidang runtime Apigee Hybrid.

Tentang file penggantian

Saat pertama kali menginstal runtime hybrid ke dalam cluster, Anda harus membuat file penggantian konfigurasi. File ini memungkinkan Anda memberikan nilai properti yang diperlukan untuk menginstal hybrid, seperti nama project Google, nama organisasi, detail lingkungan, file sertifikat, dan sebagainya. Anda juga dapat mengganti nilai default tertentu untuk sebagian besar komponen hybrid dalam file penggantian. Untuk daftar lengkap properti yang dapat dikonfigurasi, lihat Referensi properti konfigurasi.

Langkah-langkah penginstalan hybrid menjelaskan proses pembuatan file penggantian dan penerapan konfigurasi ke cluster. Jika Anda ingin mengubah konfigurasi nanti, ubah file penggantian yang Anda buat dan terapkan kembali. Lihat Melakukan perubahan konfigurasi.

Melakukan perubahan konfigurasi

Untuk membuat perubahan konfigurasi pada komponen bidang runtime hybrid, edit file penggantian Anda dan terapkan perubahan dengan apigeectl. Untuk daftar lengkap properti yang dapat dikonfigurasi, lihat Referensi properti konfigurasi.

Misalnya, untuk mengaktifkan komponen logger, perbarui file penggantian dan terapkan kembali:

1. Buka file penggantian Anda. Pastikan untuk menggunakan file penggantian yang sama yang digunakan untuk menginstal runtime hybrid ke dalam cluster.
2. Temukan elemen logger dalam file. Contoh:

   ...
   logger:
     enabled: false
   ...

3. Ubah nilai properti menjadi true:

   ...
     logger:
     enabled: true
   ...

4. Gunakan apigeectl untuk menerapkan perubahan pada cluster:

   $APIGEECTL_HOME/apigeectl apply -f $HYBRID_FILES/overrides/OVERRIDES.yaml --telemetry

   Flag --telemetry memberi tahu apigeectl untuk hanya mengupdate komponen logger. Untuk informasi tentang parameter cakupan, seperti --telemetry, lihat Cakupan untuk menerapkan apigeectl.

Properti konfigurasi mana yang dapat Anda ubah?

Anda dapat menemukan daftar lengkap properti yang dapat dikonfigurasi di Referensi properti konfigurasi. Referensi hanya mencantumkan properti yang dapat Anda ubah; jika Anda mencoba mengubah properti yang tidak ada dalam referensi, perubahan akan diabaikan.

Cara menggunakan referensi konfigurasi

Referensi properti konfigurasi menggunakan notasi titik untuk mendeskripsikan elemen konfigurasi, dengan item pertama adalah nama elemen tingkat teratas yang diikuti dengan properti dan properti turunan. Contoh:

authz.image.pullPolicy

Dalam file penggantian, properti diformat dalam YAML yang tepat. Untuk contoh di atas, elemen authz tingkat atas diberi indentasi ke kiri dan properti sub-elemen diberi indentasi di bawahnya. Selain itu, YAML memerlukan titik dua di akhir setiap elemen dan sub-elemen.

Misalnya, untuk menyetel properti authz.image.pullPolicy ke Always, temukan stanza YAML ini dalam file penggantian dan tetapkan seperti berikut:

authz:
  image:
    pullPolicy: Always

Sebagai contoh lain, properti cassandra.auth.admin.password (seperti yang tercantum dalam Referensi properti konfigurasi) digunakan untuk menetapkan sandi admin Cassandra. Untuk mengubahnya, temukan YAML berikut dalam file penggantian dan tetapkan seperti berikut:

cassandra:
  auth:
    admin:
      password: abc123

Ingat, Referensi properti konfigurasi menjelaskan semua properti yang dapat Anda tetapkan pada komponen bidang runtime hybrid. Ikuti pola yang dijelaskan di atas untuk mengubah elemen ini dalam file penggantian sebelum menerapkan perubahan ke cluster Anda.

Tentang default konfigurasi

Apigee mempertahankan konfigurasi komponen defaultnya dalam file $HYBRID_FILES/config/values.yaml. File ini menentukan default, jika memungkinkan, untuk setiap komponen hybrid.

File penggantian Anda mengikuti struktur YAML yang sama dengan values.yaml; namun, file penggantian hanya menyertakan subset properti konfigurasi yang ditemukan di values.yaml. Ingat, tidak semua properti dapat diedit. Saat Anda menerapkan konfigurasi ke cluster, penggantian Anda akan digabungkan dengan setelan default untuk membuat konfigurasi cluster Kubernetes yang lengkap.

Jika Anda ingin mengubah default komponen dan komponen tersebut belum ada dalam file penggantian, Anda dapat menyalin YAML-nya dari values.yaml ke dalam file penggantian dan mengubahnya di sana.

Jangan pernah mengedit values.yaml secara langsung; selalu gunakan file penggantian untuk menentukan properti konfigurasi Anda.

Menggunakan file penggantian sampel yang telah ditentukan sebelumnya

Apigee menyediakan serangkaian file penggantian contoh untuk membantu memandu Anda menyiapkan deployment hybrid. Sebaiknya Anda menyalin dan mengubah file penggantian yang paling sesuai dengan persyaratan penginstalan Anda.

Saat memulai, sebaiknya gunakan salah satu contoh file penggantian. Contoh ini memberikan semua setelan konfigurasi yang Anda butuhkan untuk menyiapkan cluster yang berfungsi, termasuk komentar yang menjelaskan nilai yang perlu Anda berikan. Setelah semuanya berfungsi, Anda dapat kembali nanti dan melakukan perubahan konfigurasi sesuai kebutuhan.

Contoh berikut disertakan dalam direktori $APIGEECTL_HOME/examples:

Contoh mengganti file	Deskripsi
overrides-small.yaml	Contoh ini ideal untuk memulai dengan cepat. Menggunakan footprint minimum yang direkomendasikan untuk memulai komponen runtime hybrid. Konfigurasi contoh ini mengandalkan setelan dan nilai default sebanyak mungkin. Semua replika minimum ditetapkan ke 1.
overrides-medium.yaml	Contoh ini adalah titik awal yang baik untuk lingkungan pengujian dan QA. Komponen individual telah diberi tingkat resource yang lebih tinggi untuk menangani traffic tambahan. Cassandra menggunakan disk SSD untuk performa. Di lingkungan ini, sebaiknya pengguna menginstal komponen stateful dan stateless di node terpisah. Lihat Mengonfigurasi node khusus.
overrides-large.yaml	Contoh ini adalah titik awal yang baik untuk lingkungan berperforma tinggi seperti praproduksi dan produksi. Contoh ini mencakup properti untuk menyetel kunci enkripsi, sandi, dan lainnya. Setiap komponen memiliki minimal dua replika.
private-overrides.yaml	Contoh ini mengilustrasikan cara menggunakan image dari repositori image pribadi. Lihat Menggunakan repositori image pribadi.

Anotasi kustom

Anotasi adalah peta kunci/nilai yang digunakan untuk melampirkan metadata ke pod Kubernetes. Anda dapat membuat anotasi kustom untuk properti komponen hybrid berikut yang tercantum dalam Referensi properti konfigurasi:

• cassandra
• connectAgent
• logger
• mart
• metrics
• runtime
• synchronizer
• udca
• watcher

Untuk menambahkan anotasi pasangan nama/nilai kustom, buka file penggantian dan tambahkan stanza annotations untuk komponen terkait, lalu terapkan perubahan dengan apigeectl. Contoh:

runtime:
  annotations:
    businessunit: "bu1"

Menggunakan uji coba untuk menguji perubahan konfigurasi

Anda dapat menggunakan flag --dry-run dengan apigeectl untuk menguji file konfigurasi penggantian tanpa benar-benar menerapkannya ke cluster. Opsi ini berguna untuk men-debug masalah penginstalan karena opsi ini menunjukkan dengan tepat apa yang akan diterapkan ke cluster.

Di Apigee Hybrid, sintaksis flag --dry-run bergantung pada versi kubectl yang Anda jalankan. Periksa versi kubectl dengan perintah berikut:

kubectl version

kubectl versi 1.17 dan yang lebih lama:

$APIGEECTL_HOME/apigeectl init -f $HYBRID_FILES/overrides/OVERRIDES.yaml --dry-run=true

kubectl versi 1.18 dan yang lebih baru:

  $APIGEECTL_HOME/apigeectl init -f $HYBRID_FILES/overrides/OVERRIDES.yaml --dry-run=client

Perhatian: Perlu diketahui bahwa output konfigurasi berisi informasi sandi dan rahasia.

Buat beberapa file penggantian sesuai kebutuhan

Anda dapat membuat beberapa file penggantian, yang masing-masing memenuhi persyaratan tertentu. Misalnya, Anda mungkin memiliki file penggantian yang menyesuaikan cluster untuk produksi, dan file lain untuk membuat cluster untuk pengujian. Kemudian, Anda dapat mengelola file ini di sistem kontrol sumber Anda.

Gunakan perintah apigeectl apply untuk menerapkan file penggantian ke cluster. Contoh:

$APIGEECTL_HOME/apigeectl apply  -f $HYBRID_FILES/overrides/test_env_override.yaml

Menghapus komponen runtime

Perintah apigeectl delete menyediakan flag yang memungkinkan Anda menghapus semua atau sebagian komponen runtime hybrid yang diinstal. Untuk mengetahui detail penggunaan perintah, lihat halaman referensi apigeectl. Lihat juga Meng-uninstal runtime hybrid.

Menghapus lingkungan

Untuk menghapus lingkungan sepenuhnya, Anda harus menghapus bidang runtime (lokal) dan pengelolaan (cloud). Untuk mengetahui detailnya, lihat Menghapus lingkungan.