Mengelola komponen bidang runtime

Saat ini Anda melihat versi 1.6 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.6 (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. Untuk mengetahui daftar komponen bidang runtime yang dapat Anda konfigurasi, lihat Ringkasan konfigurasi layanan runtime.

Tentang file penggantian

Saat pertama kali menginstal runtime hybrid ke dalam cluster, Anda harus membuat file penggantian konfigurasi. File ini memungkinkan Anda mengganti nilai konfigurasi default sesuai kebutuhan, mengonfigurasi lingkungan, mereferensikan sertifikat TLS dan kunci akun layanan, menetapkan kumpulan node Kubernetes ke komponen hybrid tertentu, dan sebagainya.

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.

Melakukan perubahan konfigurasi

Untuk membuat perubahan konfigurasi pada komponen bidang runtime hybrid, edit file penggantian Anda dan terapkan perubahan dengan apigeectl.

Misalnya, untuk mengubah jumlah replika di Message processor, ikuti langkah-langkah berikut:

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

   ...
   runtime:
     nodeSelector:
       key: cloud.google.com/gke-nodepool
       value: apigee-runtime
     replicaCountMin: 1
     replicaCountMax: 2
   ...

3. Ubah properti jumlah replika sesuai kebutuhan. Contoh:

   ...
   runtime:
     nodeSelector:
       key: cloud.google.com/gke-nodepool
       value: apigee-runtime
     replicaCountMin: 2
     replicaCountMax: 4
   ...

4. Gunakan apigeectl untuk menerapkan perubahan pada cluster:

   apigeectl apply -f ./OVERRIDES.yaml --org --env ENV_NAME

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.

Menggunakan file penggantian contoh yang telah ditentukan sebelumnya

Saat pertama kali menginstal runtime hybrid, Apigee merekomendasikan agar Anda menggunakan salah satu file penggantian contoh yang telah dikonfigurasi sebelumnya. Contoh ini memberikan kumpulan lengkap properti konfigurasi untuk skenario penginstalan tertentu, seperti untuk menyiapkan penginstalan produksi atau pengujian. Yang perlu Anda lakukan adalah memberikan nilai yang sesuai untuk properti dan menerapkan file penggantian ke cluster Anda. Lihat Langkah 7: Konfigurasi runtime hybrid untuk mengetahui informasi selengkapnya.

Ingatlah bahwa 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.

Tentang default konfigurasi

Apigee mempertahankan konfigurasi komponen defaultnya dalam file HYBRID_ROOT_DIR/config/values.yaml. File penggantian Anda mengikuti struktur YAML yang sama dengan values.yaml.

File penggantian biasanya 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. Lihat juga Menguji konfigurasi yang digabungkan.

Kode berikut menunjukkan konfigurasi default untuk komponen mart seperti yang ada di values.yaml. Perhatikan bahwa beberapa nilai memiliki default, sementara nilai lainnya seperti sslCertPath dan sslKeyPath tidak. Anda harus memberikan nilai yang hilang ini dalam file penggantian, seperti yang dijelaskan dalam langkah penginstalan. Jika Anda ingin mengubah salah satu nilai default, pastikan nilai tersebut dapat diedit dengan memeriksa Referensi properti konfigurasi.

...
mart:
  replicaCountMin: 2
  replicaCountMax: 4
  targetCPUUtilizationPercentage: 75
  terminationGracePeriodSeconds: 30
  sslCertPath:
  sslKeyPath:
  hostAlias:
  nodeSelector:
    key:
    value:
  revision: blue
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-mart-server"
    tag: "1.3.6"
    pullPolicy: IfNotPresent
  resources:
    requests:
      cpu: 500m
      memory: 512Mi
  initCheckCF:
    resources:
      requests:
        cpu: 10m
  livenessProbe:
    timeoutSeconds: 1
    failureThreshold: 12
    periodSeconds: 5
    initialDelaySeconds: 15
  readinessProbe:
    timeoutSeconds: 1
    successThreshold: 1
    failureThreshold: 2
    periodSeconds: 5
    initialDelaySeconds: 15
  metricsURL: "/v1/server/metrics"
  cwcAppend: |
...

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.

Contoh mengganti file

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.

Contoh berikut disertakan dalam direktori HYBRID_ROOT_DIR/examples:

Contoh mengganti file	Deskripsi
overrides-small.yaml	Contoh ini sangat cocok 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.

Anotasi kustom

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

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

Untuk menambahkan anotasi kustom, tambahkan stanza ke file OVERRIDES.yaml untuk komponen masing-masing.

Contoh berikut menggambarkan cara anotasi dapat ditentukan dalam pod runtime:

runtime:
  annotations:
    businessunit: "bu1"

Menguji konfigurasi gabungan

Anda dapat menggunakan tanda --dry-run dengan apigeectl untuk menguji file konfigurasi gabungan tanpa benar-benar menerapkannya ke cluster Anda. Opsi ini berguna untuk men-debug masalah penginstalan karena opsi ini menunjukkan dengan tepat apa yang akan diterapkan ke cluster. Sebaiknya juga uji konfigurasi dan simpan di kontrol sumber sehingga Anda memiliki referensi resource yang diinstal dan dikonfigurasi di 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 overrides/OVERRIDES.yaml --dry-run=true

kubectl versi 1.18 dan yang lebih baru:

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

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

Untuk informasi selengkapnya, lihat apigeectl.

Buat beberapa file penggantian sesuai kebutuhan

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

Gunakan opsi -f dengan apigeectl untuk menentukan lokasi dan nama file penggantian. Contoh:

apigeectl apply  -f ./test_env_override.yaml

Untuk informasi selengkapnya, lihat apigeectl.

Menghapus komponen bidang runtime khusus hybrid

Untuk menghapus komponen bidang runtime khusus hybrid dari cluster Anda, gunakan perintah apigeectl delete. Komponen ini mencakup synchronizer, mart, runtime, cassandra, dan udca. Pastikan untuk menentukan file penggantian yang sama dengan yang Anda gunakan untuk menginstal komponen runtime:

Contoh:

apigeectl delete -f ./OVERRIDES.yaml

Anda dapat menggunakan perintah apigeectl apply untuk membuat ulang komponen tertentu atau komponen:

apigeectl apply --org --env ENV_NAME -f ./OVERRIDES.yaml

Untuk informasi selengkapnya, lihat apigeectl.

Menghapus komponen tertentu

Misalnya, untuk menghapus komponen synchronizer, gunakan perintah ini:

apigeectl delete --org --env ENV_NAME -f ./OVERRIDES.yaml

Kemudian, Anda dapat menggunakan perintah apigeectl apply untuk membuat ulang komponen:

apigeectl apply --org --env ENV_NAME -f ./OVERRIDES.yaml

Untuk informasi selengkapnya, lihat apigeectl.

Menghapus semua komponen

Untuk menghapus semua komponen cluster hybrid Anda, termasuk yang dibuat oleh perintah apigeectl init, gunakan perintah apigeectl delete dengan flag --all. Pastikan untuk menentukan file penggantian yang sama dengan yang Anda gunakan untuk menginstal komponen runtime:

Contoh:

apigeectl delete -f ./OVERRIDES.yaml --all

Untuk informasi selengkapnya, lihat apigeectl.