Mengelola komponen bidang runtime

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

Tentang file penggantian

Saat pertama kali menginstal runtime campuran 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 campuran 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 penerapan konfigurasi Anda 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 campuran, 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, perbarui file penggantian dan terapkan kembali:

  1. Buka file penggantian Anda. Pastikan untuk menggunakan file penggantian yang sama dengan yang digunakan untuk menginstal runtime campuran 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 ke 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 atas, diikuti dengan properti dan properti turunan. Contoh:

authz.image.pullPolicy

Dalam file penggantian, properti diformat dalam YAML yang sesuai. Untuk contoh di atas, elemen authz level atas diindentasi ke 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, temukan baris YAML ini dalam file penggantian dan tetapkan sebagai 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 sebagai berikut:

cassandra:
  auth:
    admin:
      password: abc123

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

Tentang default konfigurasi

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

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

Menggunakan file penggantian contoh yang telah ditentukan sebelumnya

Apigee menyediakan sekumpulan contoh file penggantian untuk membantu memandu Anda dalam menyiapkan deployment campuran. Sebaiknya salin dan ubah file penggantian yang paling cocok dengan persyaratan penginstalan Anda.

Contoh berikut disertakan dalam direktori $APIGEECTL_HOME/examples:

Contoh file penggantian Deskripsi
overrides-small.yaml Contoh ini ideal untuk memulai dengan cepat. Fitur ini menggunakan jejak minimum yang direkomendasikan untuk memulai komponen runtime campuran. Konfigurasi contoh ini bergantung sebanyak mungkin pada setelan dan nilai default. Semua replika minimum ditetapkan ke 1.
overrides-medium.yaml Contoh ini adalah titik awal yang baik untuk lingkungan pengujian dan QA. Setiap komponen telah diberi resource tingkat lebih tinggi untuk menangani traffic tambahan. Cassandra menggunakan disk SSD untuk performa. Dalam 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 menetapkan kunci enkripsi, sandi, dan lainnya. Setiap komponen memiliki minimal dua replika.
private-overrides.yaml Contoh ini mengilustrasikan cara menggunakan gambar dari repositori gambar 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:

Untuk menambahkan anotasi pasangan nama/nilai kustom, buka file penggantian dan tambahkan stanza annotations untuk masing-masing komponen, 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.

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

Membuat beberapa file penggantian sesuai kebutuhan

Anda dapat membuat beberapa file penggantian, dengan masing-masing file 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.

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 campuran yang diinstal. Untuk mengetahui detail tentang penggunaan perintah, lihat halaman referensi apigeectl. Lihat juga Meng-uninstal runtime campuran.

Menghapus lingkungan

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