Mengelola komponen bidang runtime

Saat ini Anda sedang melihat versi 1.8 dokumentasi hybrid Apigee. This version is end of life. You should upgrade to a newer version. Untuk informasi lebih lanjut, lihat Versi yang didukung.

Version 1.8 (unsupported)

Versi yang didukung:

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

Versi yang tidak didukung:

• 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 mengetahui daftar lengkap properti yang dapat dikonfigurasi, lihat Referensi properti konfigurasi.

Langkah-langkah penginstalan hybrid memandu proses pembuatan file penggantian dan menerapkan konfigurasi Anda ke cluster. Jika nanti Anda ingin mengubah konfigurasi, ubah file penggantian yang telah dibuat, lalu terapkan kembali. Lihat Membuat perubahan konfigurasi.

Membuat perubahan konfigurasi

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

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

1. Buka file penggantian. Pastikan untuk menggunakan file penggantian yang sama dengan yang digunakan untuk menginstal runtime hybrid ke 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 ke cluster:

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

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

Properti konfigurasi mana yang dapat Anda ubah?

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

Cara menggunakan referensi konfigurasi

Referensi properti konfigurasi menggunakan notasi titik untuk menjelaskan elemen konfigurasi, dengan item pertama adalah nama elemen tingkat atas 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 level atas diindentasi kiri dan properti sub-elemen diindentasi di bawahnya. Selain itu, YAML memerlukan titik dua di akhir setiap elemen dan sub-elemen.

Misalnya, untuk menetapkan properti authz.image.pullPolicy ke Always, cari stanza YAML ini di file penggantian dan tetapkan sebagai berikut:

authz:
  image:
    pullPolicy: Always

Untuk contoh lain, properti cassandra.auth.admin.password (seperti yang tercantum dalam Referensi properti konfigurasi) digunakan untuk menetapkan sandi admin Cassandra. Untuk mengubahnya, cari YAML berikut di file penggantian dan setel sebagai 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 di file penggantian sebelum menerapkan perubahan pada cluster Anda.

Tentang default konfigurasi

Apigee mempertahankan konfigurasi komponen default-nya dalam file $HYBRID_FILES/config/values.yaml. File ini menetapkan nilai default, jika memungkinkan, untuk setiap komponen hibrid.

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

Jika ingin mengubah nilai default komponen dan komponen tersebut belum ada dalam file penggantian, Anda dapat menyalin YAML 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 contoh file penggantian yang telah ditentukan sebelumnya

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

Saat memulai, sebaiknya gunakan salah satu contoh file. Contoh di atas menyediakan semua setelan konfigurasi yang Anda perlukan untuk menyiapkan cluster yang berfungsi, termasuk komentar yang menjelaskan nilai mana yang perlu Anda berikan. Setelah berfungsi, Anda dapat kembali lagi nanti dan melakukan perubahan konfigurasi sesuai kebutuhan.

Contoh berikut disertakan dalam direktori $APIGEECTL_HOME/examples:

Contoh file penggantian	Deskripsi
overrides-small.yaml	Contoh ini ideal untuk memulai dengan cepat. Proses ini menggunakan jejak minimum yang direkomendasikan untuk memulai komponen runtime hybrid. Contoh konfigurasi ini sangat mengandalkan setelan dan nilai default. Semua replika minimum ditetapkan ke 1.
overrides-medium.yaml	Contoh ini merupakan titik awal yang baik untuk pengujian dan lingkungan UM (Uji Mutu). Masing-masing komponen 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 pada node terpisah. Lihat Mengonfigurasi node khusus.
overrides-large.yaml	Contoh ini merupakan titik awal yang bagus 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 campuran 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 masing-masing, 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 menunjukkan dengan tepat apa yang akan diterapkan ke cluster.

Pada 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-masingnya melayani persyaratan tertentu. Misalnya, Anda mungkin memiliki file penggantian yang menyesuaikan cluster Anda untuk produksi, dan file lain untuk membuat cluster untuk pengujian. Selanjutnya, Anda dapat mempertahankan file ini dalam sistem kontrol sumber.

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 subkumpulan komponen runtime hybrid yang terinstal. Untuk penjelasan selengkapnya tentang penggunaan perintah, lihat halaman referensi apigeectl. Lihat juga Meng-uninstal hybrid runtime.

Menghapus lingkungan

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