Mengelola komponen bidang runtime

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

Version 1.1 (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. 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 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.

Membuat perubahan konfigurasi

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

Misalnya, untuk mengubah jumlah replika pada Pemroses pesan, ikuti langkah-langkah berikut:

1. Buka file YAML penggantian Anda. Pastikan untuk menggunakan file penggantian yang sama dengan 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 ke cluster:

   apigeectl apply -f ./my_overrides.yaml -c runtime

   Gunakan opsi -c jika Anda ingin membatasi update cluster ke satu komponen. Jika Anda menghapus flag -c, apigeectl akan menerapkan semua perubahan yang ditemukannya di file penggantian. Jika itu yang Anda inginkan, hapus flag -c saat menerapkan. Jika tidak, gunakan -c untuk menentukan komponen yang akan diupdate. Lihat juga Menerapkan konfigurasi untuk satu komponen.

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:

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:

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.

Menggunakan contoh yang telah ditentukan sebelumnya akan menimpa file

Saat pertama kali menginstal runtime hybrid, Apigee merekomendasikan agar Anda menggunakan salah satu pre-configured example overrides files. Contoh ini memberikan kumpulan properti konfigurasi lengkap untuk skenario penginstalan tertentu, misalnya untuk menyiapkan penginstalan produksi atau pengujian. Anda hanya perlu memberikan nilai yang sesuai untuk properti dan menerapkan file penggantian ke cluster. Lihat Membuat file penggantian untuk informasi selengkapnya.

Perlu diingat bahwa saat memulai, sebaiknya gunakan salah satu contoh file pengganti. 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 semuanya berfungsi, Anda dapat kembali kapan saja dan melakukan perubahan konfigurasi sesuai kebutuhan.

Tentang default konfigurasi

Apigee mempertahankan konfigurasi komponen default-nya 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 sebuah cluster, penggantian Anda akan digabungkan dengan default untuk membuat konfigurasi cluster Kubernetes lengkap. Lihat juga Menampilkan output konfigurasi gabungan.

Kode berikut menunjukkan konfigurasi default untuk komponen mart seperti yang ada di values.yaml. Perlu diperhatikan bahwa beberapa nilai memiliki default, sementara yang lain seperti sslCertPath dan sslKeyPath tidak. Anda harus memasukkan nilai yang tidak ada ini dalam file penggantian, seperti yang dijelaskan dalam langkah-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: "google/apigee-mart-server"
    tag: "1.0.0"
    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 nilai default komponen dan komponen tersebut belum ada dalam file penggantian, Anda dapat menyalin YAML dari values.yaml ke file penggantian dan mengubahnya di sana.

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

Contoh file penggantian

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.

Contoh berikut disertakan dalam direktori hybrid_root_dir/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 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.

Meng-output konfigurasi gabungan

Anda dapat menggunakan flag --dry-run dengan apigeectl untuk menampilkan file konfigurasi yang digabungkan tanpa benar-benar menerapkannya ke cluster Anda. Opsi ini berguna untuk men-debug masalah penginstalan karena menunjukkan dengan tepat apa yang akan diterapkan ke cluster. Anda juga sebaiknya membuat output konfigurasi dan menyimpannya dalam kontrol sumber sehingga Anda memiliki referensi resource yang diinstal dan dikonfigurasi dalam cluster.

Contoh:

apigeectl apply -f ./my_overrides.yaml --dry-run --print-yaml > apigee-hybrid.yaml

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

Gunakan opsi -f dengan apigeectl untuk menentukan lokasi dan nama file yang diganti. 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 sinkronisasi, mart, runtime, cassandra, dan udca. Pastikan untuk menentukan file penggantian yang sama dengan yang Anda gunakan untuk menginstal komponen runtime:

Contoh:

apigeectl delete -f ./my_overrides.yaml

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

apigeectl apply -c synchronizer -f ./my_overrides.yaml

Untuk informasi selengkapnya, lihat apigeectl.

Menghapus komponen tertentu

Jika Anda hanya ingin menghapus komponen tertentu, gunakan opsi -c dengan apigeectl delete. Pastikan untuk menentukan file pengganti yang sama dengan yang Anda gunakan untuk menginstal komponen runtime.

Misalnya, untuk menghapus komponen Synchronizer, gunakan perintah ini:

apigeectl delete -c synchronizer -f ./my_overrides.yaml

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

apigeectl apply -c synchronizer -f ./my_overrides.yaml

Untuk informasi selengkapnya, lihat apigeectl.

Hapus semua komponen

Untuk menghapus semua komponen cluster hybrid, 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 ./my_overrides.yaml --all

Untuk informasi selengkapnya, lihat apigeectl.