Mengelola komponen bidang runtime

Saat ini Anda melihat versi 1.15 dari dokumentasi Apigee hybrid. Untuk mengetahui informasi selengkapnya, lihat Versi yang didukung.

Version 1.15 

   Versi yang didukung:

• v1.16 (terbaru)                        
• v1.15                         
• v1.14                        
• Daftar versi yang didukung

   Versi yang tidak didukung:

• v1.13                         
• 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 akan memandu Anda dalam proses pembuatan file penggantian dan penerapan konfigurasi ke cluster. Jika ingin mengubah konfigurasi nanti, ubah file penggantian yang Anda buat dan terapkan kembali.

Melakukan perubahan konfigurasi

Untuk melakukan perubahan konfigurasi pada komponen bidang runtime hybrid, edit file penggantian dan gunakan Helm untuk mengupgrade diagram yang sesuai dengan komponen tersebut. Diagram berikut menunjukkan diagram mana yang sesuai dengan komponen hybrid Apigee:

Cakupan	Komponen	Diagram Helm
Operator Apigee	Operator Apigee	apigee-operator
Penyimpanan	Cassandra	apigee-datastore
Penyimpanan dalam memori	Redis	apigee-redis
Pelaporan	Logger Metrik	apigee-telemetry
Ingress	Gateway Ingress Apigee	apigee-ingress-manager
Organisasi	Agen Apigee Connect MART UDCA Watcher	apigee-org
Lingkungan	Runtime Sinkronisasi	apigee-env
Grup lingkungan	virtualhost	apigee-virtualhost

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

1. Buka file OVERRIDES.yaml. 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
   ...

Lihat:

• runtime.nodeSelector.key.
• runtime.nodeSelector.value.
• runtime.replicaCountMin.
• runtime.replicaCountMax.
3. Ubah properti jumlah replika sesuai kebutuhan. Contoh:

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

4. Upgrade lingkungan.

Anda harus menginstal satu lingkungan dalam satu waktu. Tentukan lingkungan dengan --set env=ENV_NAME.

Uji coba:

helm upgrade ENV_RELEASE_NAME apigee-env/ \
--install \
--namespace APIGEE_NAMESPACE \
--set env=ENV_NAME \
-f OVERRIDES_FILE \
--dry-run=server

• ENV_RELEASE_NAME adalah nama yang Anda gunakan sebelumnya untuk menginstal diagram apigee-env. Di hybrid v1.10, biasanya apigee-env-ENV_NAME. Di Hybrid v1.11 dan yang lebih baru, biasanya ENV_NAME.
• ENV_NAME adalah nama lingkungan yang Anda upgrade.
• OVERRIDES_FILE adalah file penggantian baru Anda untuk v.1.15.3
5. Upgrade diagram:

helm upgrade ENV_RELEASE_NAME apigee-env/ \
--install \
--namespace APIGEE_NAMESPACE \
--set env=ENV_NAME \
-f OVERRIDES_FILE

6. Verifikasi bahwa diagram sudah aktif dan berjalan dengan memeriksa status env yang sesuai:

kubectl -n APIGEE_NAMESPACE get apigeeenv

NAME                          STATE       AGE   GATEWAYTYPE
apigee-org1-dev-xxx            running     2d

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 tersebut akan diabaikan.

Cara menggunakan referensi konfigurasi

Referensi properti konfigurasi menggunakan notasi titik untuk mendeskripsikan elemen konfigurasi, dengan item pertama adalah nama elemen tingkat atas yang diikuti oleh properti dan properti turunan. Contoh:

ao.image.pullPolicy

Dalam file penggantian, properti diformat dalam YAML yang tepat. Untuk contoh di atas, elemen ao tingkat 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 ao.image.pullPolicy ke Always, temukan stanza YAML ini dalam file penggantian dan tetapkan sebagai berikut:

ao:
  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, 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 bidang runtime hybrid. Ikuti pola yang dijelaskan di atas untuk mengubah elemen ini dalam file penggantian sebelum menerapkan perubahan ke cluster.

Menggunakan file penggantian contoh yang telah ditentukan

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

Ingatlah bahwa saat memulai, sebaiknya gunakan salah satu contoh file penggantian. Contoh ini menyediakan semua setelan konfigurasi yang Anda perlukan 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 default untuk membuat konfigurasi cluster Kubernetes yang lengkap. Lihat juga Menguji konfigurasi gabungan.

Kode berikut menunjukkan konfigurasi default untuk komponen mart seperti yang ditemukan di values.yaml. Perhatikan bahwa beberapa nilai memiliki default, sementara nilai lainnya seperti sslCertPath dan sslKeyPath tidak. Anda harus memberikan nilai yang tidak ada ini dalam file penggantian, seperti yang dijelaskan dalam langkah-langkah penginstalan. Jika ingin mengubah salah satu nilai default, pastikan nilai tersebut dapat diedit dengan memeriksa di 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.15.3"
    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 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.

Anotasi kustom

Anotasi adalah peta kunci/nilai 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 yang sesuai.

Contoh berikut mengilustrasikan cara menentukan anotasi di runtime pod:

runtime:
  annotations:
    businessunit: "bu1"

Menguji konfigurasi gabungan

Anda dapat menggunakan flag --dry-run untuk menguji file konfigurasi gabungan tanpa benar-benar menerapkannya ke cluster. 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.

kubectl apply -k  apigee-operator/etc/crds/default/
      

helm upgrade operator apigee-operator/ \
  --install \
  --namespace APIGEE_NAMESPACE \
  --atomic \
  -f OVERRIDES_FILE.yaml \
  --dry-run=server

helm upgrade ingress-manager apigee-ingress-manager/ /
  --install \
  --namespace APIGEE_NAMESPACE \
  --atomic \
  -f OVERRIDES_FILE.yaml \
  --dry-run=server

Membuat 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 lain untuk membuat cluster pengujian. Kemudian, Anda dapat mempertahankan file ini di sistem kontrol sumber.

Contoh:

helm upgrade test-1-env apigee-env/ \
  --namespace APIGEE_NAMESPACE \
  --atomic \
  --set env=test-1-env \
  -f test-1-env-overrides.yaml

Catatan: Jika Anda melihat error yang menyatakan Error: UPGRADE FAILED: "test-1-env" has no deployed releases, ganti upgrade dengan install dan coba perintah lagi.

Menghapus komponen bidang runtime khusus hybrid

Komponen bidang runtime mencakup synchronizer, mart, runtime, cassandra, dan udca.

Untuk menghapus komponen bidang runtime khusus hybrid dari cluster, gunakan perintah helm delete. Pastikan untuk menentukan file penggantian yang sama dengan yang Anda gunakan untuk menginstal komponen runtime.

Contoh:

Dengan Helm, Anda harus menghapus setiap komponen satu per satu. Misalnya, untuk menghapus komponen cassandra, gunakan perintah berikut:

helm -n APIGEE_NAMESPACE delete datastore

Pada contoh di atas, komponen datastore diinstal dengan nama "datastore". Jika Anda Anda menginstalnya dengan nama yang berbeda, Anda harus memberikan nama tersebut untuk menghapus komponen. Misalnya, jika Anda menginstal diagram apigee-datastore dengan helm install my-cassandra-storage apigee-datastore/. Anda akan menghapusnya dengan perintah berikut:

helm delete -n apigee my-cassandra-storage

Untuk membuat ulang komponen atau komponen tertentu (grup lingkungan dalam contoh ini):

helm upgrade ENV_GROUP apigee-virtualhost/ \
  --install \
  --namespace APIGEE_NAMESPACE \
  --atomic \
  --set envgroup=ENV_GROUP_NAME \
  -f OVERRIDES_FILE.yaml