Mengelola komponen bidang runtime

Anda sedang melihat versi 1.8 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)

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                                         

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

Tentang file penggantian

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

Langkah-langkah penginstalan hybrid menjelaskan proses pembuatan file pengganti dan menerapkan konfigurasi Anda ke sebuah cluster. Jika Anda ingin mengubah konfigurasi di lain waktu, mengubah file pengganti yang Anda buat dan menerapkannya kembali. Lihat Membuat perubahan konfigurasi.

Membuat perubahan konfigurasi

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

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

1. Buka file penggantian. Pastikan untuk menggunakan file pengganti yang sama dengan yang yang digunakan untuk menginstal runtime hybrid ke dalam cluster.
2. Temukan elemen logger dalam file tersebut. 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. Sebagai 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 di Referensi properti konfigurasi. Referensi tersebut hanya mencantumkan properti yang dapat Anda ubah; jika Anda mencoba mengubah properti yang tidak ada dalam perubahan tersebut akan diabaikan.

Cara menggunakan referensi konfigurasi

Referensi properti konfigurasi menggunakan notasi titik untuk menjelaskan elemen konfigurasi, di mana item pertama adalah nama elemen tingkat atas diikuti dengan properti dan properti turunan. Contoh:

authz.image.pullPolicy

Dalam file pengganti, properti diformat dalam YAML yang benar. Untuk contoh di atas, elemen authz tingkat atas diindentasi kiri dan properti sub-elemen dijorokkan di bawahnya. Selain itu, YAML memerlukan tanda titik dua pada akhir setiap elemen dan sub-elemen.

Misalnya, untuk menyetel properti authz.image.pullPolicy ke Always, cari stanza YAML ini dalam file pengganti dan setel sebagai berikut:

authz:
  image:
    pullPolicy: Always

Untuk contoh lain, properti cassandra.auth.admin.password (seperti tercantum dalam Referensi properti konfigurasi) digunakan untuk menetapkan Cassandra {i>password<i} admin. Untuk mengubahnya, cari YAML berikut dalam file pengganti dan atur data tersebut sebagai berikut:

cassandra:
  auth:
    admin:
      password: abc123

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

Tentang default konfigurasi

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

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

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

Jangan pernah edit values.yaml directly; selalu gunakan file pengganti untuk menentukan properti konfigurasi.

Menggunakan file penggantian sampel yang telah ditentukan sebelumnya

Apigee menyediakan serangkaian contoh file penggantian untuk memandu Anda dalam menyiapkan deployment hybrid. Ini adalah praktik yang baik untuk menyalin dan mengubah file pengganti yang paling cocok dengan persyaratan penginstalan Anda.

Saat memulai, sebaiknya gunakan salah satu mengganti file contoh. Contoh tersebut memberikan semua pengaturan konfigurasi yang Anda butuhkan untuk menyiapkan , termasuk komentar yang menjelaskan nilai mana yang perlu Anda berikan. Setelah berbagai aktivitas bekerja, Anda selalu dapat kembali lagi nanti, lalu buat perubahan konfigurasi sesuai kebutuhan.

Contoh berikut disertakan dalam direktori $APIGEECTL_HOME/examples:

Contoh file penggantian	Deskripsi
overrides-small.yaml	Sampel ini ideal untuk memulai dengan cepat. Menggunakan jejak minimum yang direkomendasikan untuk memulai komponen runtime hybrid. Contoh konfigurasi ini bergantung pada sebanyak mungkin pada setelan dan nilai default. Semua replika minimum ditetapkan ke 1.
overrides-medium.yaml	Contoh ini merupakan titik awal yang baik untuk lingkungan pengujian dan UM (Uji Mutu). Komponen individual telah diberikan tingkat sumber daya yang lebih tinggi untuk menangani lalu lintas tambahan. Cassandra menggunakan Disk SSD untuk performa. Di lingkungan ini, sebaiknya pengguna menginstal komponen stateful dan stateless pada node terpisah. Lihat Konfigurasi node khusus.
overrides-large.yaml	Contoh ini merupakan titik awal yang baik untuk lingkungan berperforma tinggi seperti praproduksi dan produksi. Contoh ini menyertakan properti untuk setelan kunci enkripsi, {i>password<i}, dan lainnya. Setiap komponen memiliki batas minimum yaitu 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:

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

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 tanda --dry-run dengan apigeectl untuk menguji akan mengganti file konfigurasi tanpa benar-benar menerapkannya ke cluster Anda. Opsi ini berguna untuk men-debug masalah penginstalan karena menunjukkan dengan tepat apa yang akan diterapkan pada cluster.

Di Apigee Hybrid, sintaksis tanda --dry-run bergantung pada versi kubectl Anda sedang menjalankan. 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 konfigurasi output berisi sandi dan informasi rahasia.

Buat beberapa file penggantian sesuai kebutuhan

Anda dapat membuat beberapa file penggantian, yang masing-masingnya melayani persyaratan. Misalnya, Anda mungkin memiliki file pengganti yang menyesuaikan cluster Anda untuk produksi, dan satu lagi untuk membuat cluster untuk pengujian. Anda kemudian dapat mempertahankan di sistem kontrol sumber Anda.

Gunakan perintah apigeectl apply untuk menerapkan penggantian file 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 akan menghapus semua atau sebagian komponen runtime hybrid yang terinstal. Untuk mengetahui detailnya, terkait penggunaan perintah, lihat halaman referensi apigeectl. Lihat juga Meng-uninstal runtime hybrid.

Menghapus lingkungan

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