Menentukan penggantian konfigurasi
Penginstal Apigee hybrid menggunakan setelan default untuk banyak setelan. Namun, ada beberapa setelan yang tidak memiliki nilai default. Anda harus memberikan nilai untuk setelan ini, seperti yang dijelaskan berikutnya.
Sebelum memulai
Sebaiknya tinjau skenario berikut untuk menentukan apakah Anda ingin mengonfigurasi cluster untuk skenario tersebut. Konfigurasi ini bersifat opsional.
- Jika Anda berencana menginstal hybrid di beberapa region, baca Deployment multi-region sebelum melanjutkan.
- Apigee Hybrid menyediakan sandi default untuk pengguna Cassandra. Apigee merekomendasikan untuk mengubah sandi pengguna default. Lihat Mengonfigurasi TLS untuk Cassandra untuk mengetahui detailnya.
- Jika Anda ingin mengonfigurasi setelan penyimpanan dan heap untuk Cassandra, lihat Mengonfigurasi setelan penyimpanan dan heap.
- Seperti yang dijelaskan dalam Bagian 1: Penyiapan Project dan Organisasi--Langkah 1: Aktifkan API, Untuk skenario penginstalan produksi, konfigurasi penyimpanan persistent solid state disk (SSD) untuk Cassandra. Apigee tidak mendukung penggunaan SSD lokal untuk Apigee Hybrid. Untuk detailnya, lihat Menambahkan penyimpanan SSD untuk deployment produksi.
Mengonfigurasi cluster
Berdasarkan konvensi, penggantian konfigurasi ditulis dalam file bernama overrides.yaml
yang biasanya disimpan di direktori $APIGEE_HELM_CHARTS_HOME
Anda.
- Buat file baru bernama
overrides.yaml
di direktori$APIGEE_HELM_CHARTS_HOME
Anda.overrides.yaml
menyediakan konfigurasi untuk penginstalan Apigee hybrid unik Anda. File penggantian pada langkah ini memberikan konfigurasi dasar untuk penginstalan runtime hybrid dengan footprint kecil, yang cocok untuk penginstalan pertama Anda. - Di
overrides.yaml
, tambahkan nilai properti yang diperlukan, seperti yang ditunjukkan di bawah. Deskripsi mendetail setiap properti disediakan di bawah.Pastikan file
overrides.yaml
memiliki struktur dan sintaksis berikut.Pilih tab untuk jenis autentikasi akun layanan yang Anda gunakan dalam penginstalan: Langkah 4: Buat akun layanan.
- Kunci akun layanan di Secret Kubernetes: Secret Kubernetes
- File kunci JSON akun layanan: File JSON
- Kunci akun layanan di Vault: Vault
- Workload Identity Federation for GKE: WIF for GKE
- Workload Identity Federation: WIF di platform lain
Untuk ringkasan berbagai opsi autentikasi, lihat Metode autentikasi akun layanan di Apigee hybrid.
Pilih tab untuk penginstalan, produksi, Produksi, atau non-produksi (penginstalan demo, evaluasi, atau proof-of-concept), Non-prod, bergantung pada pilihan Anda di Langkah 4: Buat akun layanan.
Untuk penginstalan di lingkungan produksi, lihat persyaratan penyimpanan untuk database Cassandra di Mengonfigurasi Cassandra untuk produksi.
Secret Kubernetes
Produksi
Template
instanceID: UNIQUE_INSTANCE_IDENTIFIER namespace: APIGEE_NAMESPACE # Usually "apigee" gcp: projectID: PROJECT_ID region: ANALYTICS_REGION k8sCluster: name: CLUSTER_NAME region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster. org: ORG_NAME # Required for Enhanced per-environment proxy limits: enhanceProxyLimits: true # Required if using data residency with hybrid: contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com envs: - name: ENVIRONMENT_NAME serviceAccountSecretRefs: synchronizer: SYNCHRONIZER_SERVICE_ACCOUNT_SECRET # For example: "apigee-synchronizer-svc-account" runtime: RUNTIME_SERVICE_ACCOUNT_SECRET # For example: "apigee-runtime-svc-account" udca: UDCA_SERVICE_ACCOUNT_SECRET # For example: "apigee-udca-svc-account" cassandra: hostNetwork: false # Set to false for single region installations and for multi-region # installations with connectivity between pods in different clusters, # like GKE. # Set to true for multi-region installations with no communication # between pods in different clusters, for example Google Distributed # Cloud on VMware or bare metal, GKE on AWS, AKS, EKS, and OpenShift. # See Multi-region deployment: Prerequisites replicaCount:
3 # Use multiples of 3 for production. # See Configure Cassandra for production for guidelines. storage: storageSize: 500Gi resources: requests: cpu: 7 memory: 15Gi maxHeapSize: 8192M heapNewSize: 1200M # Minimum storage requirements for a production environment. # See Configure Cassandra for production. ingressGateways: - name: INGRESS_NAME # maximum 17 characters. replicaCountMin: 2 replicaCountMax: 10 svcAnnotations: # optional. If you are on AKS, see Known issue #260772383 SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE virtualhosts: - name: ENVIRONMENT_GROUP_NAME selector: app: apigee-ingressgateway ingress_name: INGRESS_NAME sslCertPath: PATH_TO_CERT_FILE sslKeyPath: PATH_TO_KEY_FILE mart: serviceAccountRef: MART_SERVICE_ACCOUNT_SECRET # For example: "apigee-mart-svc-account" connectAgent: serviceAccountRef: MART_SERVICE_ACCOUNT_SECRET # Use the same secret for mart and connectAgent # For example: "apigee-mart-svc-account" logger: enabled: true # enabled by default # See apigee-logger in Service accounts and roles used by hybrid components. serviceAccountRef: LOGGER_SERVICE_ACCOUNT_SECRET # For example: "apigee-logger-svc-account" metrics: serviceAccountRef: METRICS_SERVICE_ACCOUNT_SECRET # For example: "apigee-metrics-svc-account" udca: serviceAccountRef: UDCA_SERVICE_ACCOUNT_SECRET # For example: "apigee-udca-svc-account" watcher: serviceAccountRef: WATCHER_SERVICE_ACCOUNT_SECRET # For example: "apigee-watcher-svc-account" # Required if using Monetization for Apigee hybrid (v1.15.1 and later) runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.1" # Must be 1.15.1 or higher. mintTaskScheduler: # Required for Monetization for Apigee hybrid serviceAccountRef: MINT_TASK_SCHEDULER_SERVICE_ACCOUNT_SECRET # For example: "apigee-mint-task-scheduler-svc-account" # If using message payloads larger than 10MB. # See configure large message payload support: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Gi Nilai dalam red, bold italics adalah nilai properti yang harus Anda berikan. Anda dapat mengedit nilainya di halaman ini. Objek ini dijelaskan dalam tabel di bawah.
Tabel berikut menjelaskan setiap nilai properti yang harus Anda berikan dalam file penggantian. Untuk mengetahui informasi selengkapnya, lihat Referensi properti konfigurasi.
Variabel Deskripsi UNIQUE_INSTANCE_
IDENTIFIERString unik untuk mengidentifikasi instance ini. ID dapat berupa kombinasi huruf dan angka hingga 63 karakter.
Anda dapat membuat beberapa organisasi dalam cluster yang sama, tetapi
instanceID
harus sama untuk semua organisasi dalam cluster Kubernetes yang sama.Lihat
instanceID
.APIGEE_NAMESPACE Namespace Kubernetes untuk komponen hybrid Apigee Anda.
Nilai defaultnya adalah
apigee
.Lihat
namespace
.PROJECT_ID Mengidentifikasi project Google Cloud tempat apigee-logger
danapigee-metrics
mengirim data mereka. Ini adalah nilai yang ditetapkan ke variabel lingkunganPROJECT_ID
.Lihat
gcp.projectID
.ANALYTICS_REGION Di GKE, Anda harus menetapkan nilai ini ke region yang sama dengan tempat cluster berjalan. Di semua platform lainnya, pilih wilayah analisis yang paling dekat dengan cluster Anda yang memiliki dukungan Analytics (lihat tabel di Bagian 1, Langkah 2: Buat organisasi). Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
ANALYTICS_REGION
sebelumnya.Lihat
gcp.region
.CLUSTER_NAME Nama cluster Kubernetes Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan CLUSTER_NAME
.Lihat
k8sCluster.name
.CLUSTER_LOCATION Region tempat cluster berjalan. Ini adalah region tempat Anda membuat cluster di Langkah 1: Buat cluster. Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
CLUSTER_LOCATION
sebelumnya.Lihat
k8sCluster.location
.ORG_NAME ID organisasi hybrid Apigee Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan ORG_NAME
.Lihat
org
.CONTROL_PLANE_
LOCATIONWajib diisi jika Anda menggunakan Residensi data dengan penginstalan hybrid Apigee. Ini adalah lokasi tempat konten inti pelanggan seperti paket proxy disimpan. Untuk mengetahui daftarnya, lihat Region bidang kontrol API Apigee yang tersedia. Nilai ini ditetapkan ke variabel lingkungan CONTROL_PLANE_LOCATION
di Langkah 2: Buat organisasi.Lihat
contractProvider
.ENVIRONMENT_NAME Gunakan nama yang sama dengan yang Anda gunakan saat membuat lingkungan di UI, seperti yang dijelaskan dalam Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Lihat
envs[].name
.ENVIRONMENT_GROUP_
NAMENama grup lingkungan tempat lingkungan Anda ditetapkan. Ini adalah grup yang Anda buat di Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Ini adalah nilai yang ditetapkan ke variabel lingkungan ENV_GROUP
.Lihat
virtualhosts[].name
.INGRESS_NAME Nama gateway ingress Apigee untuk deployment Anda. Nama ini dapat berupa nama apa pun yang memenuhi persyaratan berikut: - Memiliki panjang maksimum 17 karakter
- Hanya berisi karakter alfanumerik huruf kecil, '-', atau '.'
- Diawali dengan karakter alfanumerik
- Diakhiri dengan karakter alfanumerik
Lihat:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEMasukkan jalur dan nama file kunci TLS dan sertifikat yang ditandatangani sendiri yang Anda buat sebelumnya di Langkah 6: Buat sertifikat TLS. File ini harus berada di direktori APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Contoh:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Lihat:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opsional). Ini adalah key-value pair yang menyediakan anotasi untuk layanan ingress default Anda. Platform cloud Anda menggunakan anotasi untuk membantu mengonfigurasi penginstalan hybrid, misalnya menyetel jenis load balancer ke internal atau eksternal. Anotasi bervariasi dari satu platform ke platform lainnya. Lihat dokumentasi platform Anda untuk mengetahui anotasi wajib dan yang disarankan.
Beri komentar atau hapus bagian ini jika Anda tidak menggunakannya.
<component>_
SERVICE_ACCOUNT_
SECRETNama secret Kubernetes yang Anda buat untuk kunci akun layanan di Langkah 5: Siapkan autentikasi akun layanan. Nama default secret yang disarankan dalam panduan ini adalah:
Produksi
apigee-cassandra-svc-account
apigee-logger-svc-account
apigee-mart-svc-account
apigee-metrics-svc-account
apigee-mint-task-scheduler-svc-account
apigee-runtime-svc-account
apigee-synchronizer-svc-account
apigee-udca-svc-account
apigee-watcher-svc-account
Non-prod
apigee-non-prod-svc-account
Lihat:
-
envs[].serviceAccountSecretRefs.synchronizer
. -
envs[].serviceAccountSecretRefs.runtime
. -
envs[].serviceAccountSecretRefs.udca
. -
logger.serviceAccountRef
. -
connectAgent.serviceAccountRef
. -
mart.serviceAccountRef
. -
metrics.serviceAccountRef
. -
mintTaskScheduler.serviceAccountRef
. -
udca.serviceAccountRef
. -
watcher.serviceAccountRef
.
Contoh
instanceID: "my_hybrid_example" namespace: "apigee" gcp: projectID: my-project region: us-central1 k8sCluster: name: hybrid-env region: us-central1 org: my-project enhanceProxyLimits: true contractProvider: https://us-apigee.googleapis.com envs: - name: prod-env serviceAccountSecretRefs: synchronizer: "apigee-synchronizer-svc-account" runtime: "apigee-runtime-svc-account" udca: "apigee-udca-svc-account" cassandra: hostNetwork: false replicaCount: 3 storage: storageSize: 500Gi resources: requests: cpu: 7 memory: 15Gi maxHeapSize: 8192M heapNewSize: 1200M ingressGateways: - name: my-ingress-1 replicaCountMin: 2 replicaCountMax: 10 virtualhosts: - name: example-env-group selector: app: apigee-ingressgateway ingress_name: my-ingress-1 sslCertPath: certs/keystore.pem sslKeyPath: certs/keystore.key mart: serviceAccountRef: "apigee-mart-svc-account" connectAgent: serviceAccountRef: "apigee-mart-svc-account" logger: enabled: true serviceAccountRef: "apigee-logger-svc-account" metrics: serviceAccountRef: "apigee-metrics-svc-account" udca: serviceAccountRef: "apigee-udca-svc-account" watcher: serviceAccountRef: "apigee-watcher-svc-account" # Monetization for Apigee hybrid runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.1" mintTaskScheduler: serviceAccountRef: apigee-mint-task-scheduler-svc-account # For message payloads larger than 10MB: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Gi
Tabel berikut menjelaskan setiap nilai properti yang harus Anda berikan dalam file penggantian. Untuk mengetahui informasi selengkapnya, lihat Referensi properti konfigurasi.
Variabel Deskripsi UNIQUE_INSTANCE_
IDENTIFIERString unik untuk mengidentifikasi instance ini. ID dapat berupa kombinasi huruf dan angka hingga 63 karakter.
Anda dapat membuat beberapa organisasi dalam cluster yang sama, tetapi
instanceID
harus sama untuk semua organisasi dalam cluster Kubernetes yang sama.Lihat
instanceID
.APIGEE_NAMESPACE Namespace Kubernetes untuk komponen hybrid Apigee Anda.
Nilai defaultnya adalah
apigee
.Lihat
namespace
.PROJECT_ID Mengidentifikasi project Google Cloud tempat apigee-logger
danapigee-metrics
mengirim data mereka. Ini adalah nilai yang ditetapkan ke variabel lingkunganPROJECT_ID
.Lihat
gcp.projectID
.ANALYTICS_REGION Di GKE, Anda harus menetapkan nilai ini ke region yang sama dengan tempat cluster berjalan. Di semua platform lainnya, pilih wilayah analisis yang paling dekat dengan cluster Anda yang memiliki dukungan Analytics (lihat tabel di Bagian 1, Langkah 2: Buat organisasi). Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
ANALYTICS_REGION
sebelumnya.Lihat
gcp.region
.CLUSTER_NAME Nama cluster Kubernetes Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan CLUSTER_NAME
.Lihat
k8sCluster.name
.CLUSTER_LOCATION Region tempat cluster berjalan. Ini adalah region tempat Anda membuat cluster di Langkah 1: Buat cluster. Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
CLUSTER_LOCATION
sebelumnya.Lihat
k8sCluster.location
.ORG_NAME ID organisasi hybrid Apigee Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan ORG_NAME
.Lihat
org
.CONTROL_PLANE_
LOCATIONWajib diisi jika Anda menggunakan Residensi data dengan penginstalan hybrid Apigee. Ini adalah lokasi tempat konten inti pelanggan seperti paket proxy disimpan. Untuk mengetahui daftarnya, lihat Region bidang kontrol API Apigee yang tersedia. Nilai ini ditetapkan ke variabel lingkungan CONTROL_PLANE_LOCATION
di Langkah 2: Buat organisasi.Lihat
contractProvider
.ENVIRONMENT_NAME Gunakan nama yang sama dengan yang Anda gunakan saat membuat lingkungan di UI, seperti yang dijelaskan dalam Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Lihat
envs[].name
.ENVIRONMENT_GROUP_
NAMENama grup lingkungan tempat lingkungan Anda ditetapkan. Ini adalah grup yang Anda buat di Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Ini adalah nilai yang ditetapkan ke variabel lingkungan ENV_GROUP
.Lihat
virtualhosts[].name
.INGRESS_NAME Nama gateway ingress Apigee untuk deployment Anda. Nama ini dapat berupa nama apa pun yang memenuhi persyaratan berikut: - Memiliki panjang maksimum 17 karakter
- Hanya berisi karakter alfanumerik huruf kecil, '-', atau '.'
- Diawali dengan karakter alfanumerik
- Diakhiri dengan karakter alfanumerik
Lihat:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEMasukkan jalur dan nama file kunci TLS dan sertifikat yang ditandatangani sendiri yang Anda buat sebelumnya di Langkah 6: Buat sertifikat TLS. File ini harus berada di direktori APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Contoh:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Lihat:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opsional). Ini adalah key-value pair yang menyediakan anotasi untuk layanan ingress default Anda. Platform cloud Anda menggunakan anotasi untuk membantu mengonfigurasi penginstalan hybrid, misalnya menyetel jenis load balancer ke internal atau eksternal. Anotasi bervariasi dari satu platform ke platform lainnya. Lihat dokumentasi platform Anda untuk mengetahui anotasi wajib dan yang disarankan.
Beri komentar atau hapus bagian ini jika Anda tidak menggunakannya.
<component>_
SERVICE_ACCOUNT_
SECRETNama secret Kubernetes yang Anda buat untuk kunci akun layanan di Langkah 5: Siapkan autentikasi akun layanan. Nama default secret yang disarankan dalam panduan ini adalah:
Produksi
apigee-cassandra-svc-account
apigee-logger-svc-account
apigee-mart-svc-account
apigee-metrics-svc-account
apigee-mint-task-scheduler-svc-account
apigee-runtime-svc-account
apigee-synchronizer-svc-account
apigee-udca-svc-account
apigee-watcher-svc-account
Non-prod
apigee-non-prod-svc-account
Lihat:
-
envs[].serviceAccountSecretRefs.synchronizer
. -
envs[].serviceAccountSecretRefs.runtime
. -
envs[].serviceAccountSecretRefs.udca
. -
logger.serviceAccountRef
. -
connectAgent.serviceAccountRef
. -
mart.serviceAccountRef
. -
metrics.serviceAccountRef
. -
mintTaskScheduler.serviceAccountRef
. -
udca.serviceAccountRef
. -
watcher.serviceAccountRef
.
Non-prod
Template
instanceID: UNIQUE_INSTANCE_IDENTIFIER namespace: APIGEE_NAMESPACE # Usually "apigee" gcp: projectID: PROJECT_ID region: ANALYTICS_REGION k8sCluster: name: CLUSTER_NAME region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster. org: ORG_NAME # Required for Enhanced per-environment proxy limits: enhanceProxyLimits: true # Required if using data residency with hybrid: contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com envs: - name: ENVIRONMENT_NAME serviceAccountSecretRefs: synchronizer: NON_PROD_SERVICE_ACCOUNT_SECRET # For example: "apigee-non-prod-svc-account" runtime: NON_PROD_SERVICE_ACCOUNT_SECRET # For example: "apigee-non-prod-svc-account" udca: NON_PROD_SERVICE_ACCOUNT_SECRET # For example: "apigee-non-prod-svc-account" cassandra: hostNetwork: false # Set to false for single region installations and for multi-region # installations with connectivity between pods in different clusters, # like GKE. # Set to true for multi-region installations with no communication # between pods in different clusters, for example Google Distributed # Cloud on VMware or bare metal, GKE on AWS, AKS, EKS, and OpenShift. # See Multi-region deployment: Prerequisites replicaCount: 1 # Use 1 for non-prod installations and multiples of 3 for production. # See Configure Cassandra for production for guidelines. ingressGateways: - name: INGRESS_NAME # maximum 17 characters. replicaCountMin: 2 replicaCountMax: 10 svcAnnotations: # optional. If you are on AKS, see Known issue #260772383 SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE virtualhosts: - name: ENVIRONMENT_GROUP_NAME selector: app: apigee-ingressgateway ingress_name: INGRESS_NAME sslCertPath: PATH_TO_CERT_FILE sslKeyPath: PATH_TO_KEY_FILE mart: serviceAccountRef: NON_PROD_SERVICE_ACCOUNT_SECRET # For example: "apigee-non-prod-svc-account" connectAgent: serviceAccountRef: NON_PROD_SERVICE_ACCOUNT_SECRET # Use the same secret for mart and connectAgent # For example: "apigee-non-prod-svc-account" logger: enabled: true # enabled by default # See apigee-logger in Service accounts and roles used by hybrid components. serviceAccountRef: NON_PROD_SERVICE_ACCOUNT_SECRET # For example: "apigee-non-prod-svc-account" metrics: serviceAccountRef: NON_PROD_SERVICE_ACCOUNT_SECRET # For example: "apigee-non-prod-svc-account" udca: serviceAccountRef: NON_PROD_SERVICE_ACCOUNT_SECRET # For example: "apigee-non-prod-svc-account" watcher: serviceAccountRef: NON_PROD_SERVICE_ACCOUNT_SECRET # For example: "apigee-non-prod-svc-account" # Required if using Monetization for Apigee hybrid (v1.15.1 and later) runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.1" # Must be 1.15.1 or higher. mintTaskScheduler: # Required for Monetization for Apigee hybrid serviceAccountRef: NON_PROD_SERVICE_ACCOUNT_SECRET # For example: "apigee-non-prod-svc-account" # If using message payloads larger than 10MB. # See configure large message payload support: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Gi
Nilai dalam red, bold italics adalah nilai properti yang harus Anda berikan. Anda dapat mengedit nilainya di halaman ini. Objek ini dijelaskan dalam tabel di bawah.
Tabel berikut menjelaskan setiap nilai properti yang harus Anda berikan dalam file penggantian. Untuk mengetahui informasi selengkapnya, lihat Referensi properti konfigurasi.
Variabel Deskripsi UNIQUE_INSTANCE_
IDENTIFIERString unik untuk mengidentifikasi instance ini. ID dapat berupa kombinasi huruf dan angka hingga 63 karakter.
Anda dapat membuat beberapa organisasi dalam cluster yang sama, tetapi
instanceID
harus sama untuk semua organisasi dalam cluster Kubernetes yang sama.Lihat
instanceID
.APIGEE_NAMESPACE Namespace Kubernetes untuk komponen hybrid Apigee Anda.
Nilai defaultnya adalah
apigee
.Lihat
namespace
.PROJECT_ID Mengidentifikasi project Google Cloud tempat apigee-logger
danapigee-metrics
mengirim data mereka. Ini adalah nilai yang ditetapkan ke variabel lingkunganPROJECT_ID
.Lihat
gcp.projectID
.ANALYTICS_REGION Di GKE, Anda harus menetapkan nilai ini ke region yang sama dengan tempat cluster berjalan. Di semua platform lainnya, pilih wilayah analisis yang paling dekat dengan cluster Anda yang memiliki dukungan Analytics (lihat tabel di Bagian 1, Langkah 2: Buat organisasi). Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
ANALYTICS_REGION
sebelumnya.Lihat
gcp.region
.CLUSTER_NAME Nama cluster Kubernetes Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan CLUSTER_NAME
.Lihat
k8sCluster.name
.CLUSTER_LOCATION Region tempat cluster berjalan. Ini adalah region tempat Anda membuat cluster di Langkah 1: Buat cluster. Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
CLUSTER_LOCATION
sebelumnya.Lihat
k8sCluster.location
.ORG_NAME ID organisasi hybrid Apigee Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan ORG_NAME
.Lihat
org
.CONTROL_PLANE_
LOCATIONWajib diisi jika Anda menggunakan Residensi data dengan penginstalan hybrid Apigee. Ini adalah lokasi tempat konten inti pelanggan seperti paket proxy disimpan. Untuk mengetahui daftarnya, lihat Region bidang kontrol API Apigee yang tersedia. Nilai ini ditetapkan ke variabel lingkungan CONTROL_PLANE_LOCATION
di Langkah 2: Buat organisasi.Lihat
contractProvider
.ENVIRONMENT_NAME Gunakan nama yang sama dengan yang Anda gunakan saat membuat lingkungan di UI, seperti yang dijelaskan dalam Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Lihat
envs[].name
.ENVIRONMENT_GROUP_
NAMENama grup lingkungan tempat lingkungan Anda ditetapkan. Ini adalah grup yang Anda buat di Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Ini adalah nilai yang ditetapkan ke variabel lingkungan ENV_GROUP
.Lihat
virtualhosts[].name
.INGRESS_NAME Nama gateway ingress Apigee untuk deployment Anda. Nama ini dapat berupa nama apa pun yang memenuhi persyaratan berikut: - Memiliki panjang maksimum 17 karakter
- Hanya berisi karakter alfanumerik huruf kecil, '-', atau '.'
- Diawali dengan karakter alfanumerik
- Diakhiri dengan karakter alfanumerik
Lihat:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEMasukkan jalur dan nama file kunci TLS dan sertifikat yang ditandatangani sendiri yang Anda buat sebelumnya di Langkah 6: Buat sertifikat TLS. File ini harus berada di direktori APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Contoh:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Lihat:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opsional). Ini adalah key-value pair yang menyediakan anotasi untuk layanan ingress default Anda. Platform cloud Anda menggunakan anotasi untuk membantu mengonfigurasi penginstalan hybrid, misalnya menyetel jenis load balancer ke internal atau eksternal. Anotasi bervariasi dari satu platform ke platform lainnya. Lihat dokumentasi platform Anda untuk mengetahui anotasi wajib dan yang disarankan.
Beri komentar atau hapus bagian ini jika Anda tidak menggunakannya.
<component>_
SERVICE_ACCOUNT_
SECRETNama secret Kubernetes yang Anda buat untuk kunci akun layanan di Langkah 5: Siapkan autentikasi akun layanan. Nama default secret yang disarankan dalam panduan ini adalah:
Produksi
apigee-cassandra-svc-account
apigee-logger-svc-account
apigee-mart-svc-account
apigee-metrics-svc-account
apigee-mint-task-scheduler-svc-account
apigee-runtime-svc-account
apigee-synchronizer-svc-account
apigee-udca-svc-account
apigee-watcher-svc-account
Non-prod
apigee-non-prod-svc-account
Lihat:
-
envs[].serviceAccountSecretRefs.synchronizer
. -
envs[].serviceAccountSecretRefs.runtime
. -
envs[].serviceAccountSecretRefs.udca
. -
logger.serviceAccountRef
. -
connectAgent.serviceAccountRef
. -
mart.serviceAccountRef
. -
metrics.serviceAccountRef
. -
mintTaskScheduler.serviceAccountRef
. -
udca.serviceAccountRef
. -
watcher.serviceAccountRef
.
Contoh
instanceID: "my_hybrid_example" namespace: "apigee" gcp: projectID: my-project region: us-central1 k8sCluster: name: hybrid-env region: us-central1 org: my-project enhanceProxyLimits: true contractProvider: https://us-apigee.googleapis.com envs: - name: test serviceAccountSecretRefs: synchronizer: "apigee-non-prod-svc-account" runtime: "apigee-non-prod-svc-account" udca: "apigee-non-prod-svc-account" cassandra: hostNetwork: false replicaCount: 1 ingressGateways: - name: my-ingress-1 replicaCountMin: 2 replicaCountMax: 10 virtualhosts: - name: example-env-group selector: app: apigee-ingressgateway ingress_name: my-ingress-1 sslCertPath: certs/keystore.pem sslKeyPath: certs/keystore.key mart: serviceAccountRef: "apigee-non-prod-svc-account" connectAgent: serviceAccountRef: "apigee-non-prod-svc-account" logger: enabled: true serviceAccountRef: "apigee-non-prod-svc-account" metrics: serviceAccountRef: "apigee-non-prod-svc-account" udca: serviceAccountRef: "apigee-non-prod-svc-account" watcher: serviceAccountRef: "apigee-non-prod-svc-account" # Monetization for Apigee hybrid runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.1" mintTaskScheduler: serviceAccountRef: apigee-non-prod-svc-account # For message payloads larger than 10MB: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Gi
Tabel berikut menjelaskan setiap nilai properti yang harus Anda berikan dalam file penggantian. Untuk mengetahui informasi selengkapnya, lihat Referensi properti konfigurasi.
Variabel Deskripsi UNIQUE_INSTANCE_
IDENTIFIERString unik untuk mengidentifikasi instance ini. ID dapat berupa kombinasi huruf dan angka hingga 63 karakter.
Anda dapat membuat beberapa organisasi dalam cluster yang sama, tetapi
instanceID
harus sama untuk semua organisasi dalam cluster Kubernetes yang sama.Lihat
instanceID
.APIGEE_NAMESPACE Namespace Kubernetes untuk komponen hybrid Apigee Anda.
Nilai defaultnya adalah
apigee
.Lihat
namespace
.PROJECT_ID Mengidentifikasi project Google Cloud tempat apigee-logger
danapigee-metrics
mengirim data mereka. Ini adalah nilai yang ditetapkan ke variabel lingkunganPROJECT_ID
.Lihat
gcp.projectID
.ANALYTICS_REGION Di GKE, Anda harus menetapkan nilai ini ke region yang sama dengan tempat cluster berjalan. Di semua platform lainnya, pilih wilayah analisis yang paling dekat dengan cluster Anda yang memiliki dukungan Analytics (lihat tabel di Bagian 1, Langkah 2: Buat organisasi). Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
ANALYTICS_REGION
sebelumnya.Lihat
gcp.region
.CLUSTER_NAME Nama cluster Kubernetes Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan CLUSTER_NAME
.Lihat
k8sCluster.name
.CLUSTER_LOCATION Region tempat cluster berjalan. Ini adalah region tempat Anda membuat cluster di Langkah 1: Buat cluster. Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
CLUSTER_LOCATION
sebelumnya.Lihat
k8sCluster.location
.ORG_NAME ID organisasi hybrid Apigee Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan ORG_NAME
.Lihat
org
.CONTROL_PLANE_
LOCATIONWajib diisi jika Anda menggunakan Residensi data dengan penginstalan hybrid Apigee. Ini adalah lokasi tempat konten inti pelanggan seperti paket proxy disimpan. Untuk mengetahui daftarnya, lihat Region bidang kontrol API Apigee yang tersedia. Nilai ini ditetapkan ke variabel lingkungan CONTROL_PLANE_LOCATION
di Langkah 2: Buat organisasi.Lihat
contractProvider
.ENVIRONMENT_NAME Gunakan nama yang sama dengan yang Anda gunakan saat membuat lingkungan di UI, seperti yang dijelaskan dalam Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Lihat
envs[].name
.ENVIRONMENT_GROUP_
NAMENama grup lingkungan tempat lingkungan Anda ditetapkan. Ini adalah grup yang Anda buat di Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Ini adalah nilai yang ditetapkan ke variabel lingkungan ENV_GROUP
.Lihat
virtualhosts[].name
.INGRESS_NAME Nama gateway ingress Apigee untuk deployment Anda. Nama ini dapat berupa nama apa pun yang memenuhi persyaratan berikut: - Memiliki panjang maksimum 17 karakter
- Hanya berisi karakter alfanumerik huruf kecil, '-', atau '.'
- Diawali dengan karakter alfanumerik
- Diakhiri dengan karakter alfanumerik
Lihat:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEMasukkan jalur dan nama file kunci TLS dan sertifikat yang ditandatangani sendiri yang Anda buat sebelumnya di Langkah 6: Buat sertifikat TLS. File ini harus berada di direktori APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Contoh:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Lihat:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opsional). Ini adalah key-value pair yang menyediakan anotasi untuk layanan ingress default Anda. Platform cloud Anda menggunakan anotasi untuk membantu mengonfigurasi penginstalan hybrid, misalnya menyetel jenis load balancer ke internal atau eksternal. Anotasi bervariasi dari satu platform ke platform lainnya. Lihat dokumentasi platform Anda untuk mengetahui anotasi wajib dan yang disarankan.
Beri komentar atau hapus bagian ini jika Anda tidak menggunakannya.
<component>_
SERVICE_ACCOUNT_
SECRETNama secret Kubernetes yang Anda buat untuk kunci akun layanan di Langkah 5: Siapkan autentikasi akun layanan. Nama default secret yang disarankan dalam panduan ini adalah:
Produksi
apigee-cassandra-svc-account
apigee-logger-svc-account
apigee-mart-svc-account
apigee-metrics-svc-account
apigee-mint-task-scheduler-svc-account
apigee-runtime-svc-account
apigee-synchronizer-svc-account
apigee-udca-svc-account
apigee-watcher-svc-account
Non-prod
apigee-non-prod-svc-account
Lihat:
-
envs[].serviceAccountSecretRefs.synchronizer
. -
envs[].serviceAccountSecretRefs.runtime
. -
envs[].serviceAccountSecretRefs.udca
. -
logger.serviceAccountRef
. -
connectAgent.serviceAccountRef
. -
mart.serviceAccountRef
. -
metrics.serviceAccountRef
. -
mintTaskScheduler.serviceAccountRef
. -
udca.serviceAccountRef
. -
watcher.serviceAccountRef
.
File JSON
Produksi
Template
Nilai dalam red, bold italics adalah nilai properti yang harus Anda berikan. Anda dapat mengedit nilainya di halaman ini. Objek ini dijelaskan dalam tabel di bawah.
instanceID: UNIQUE_INSTANCE_IDENTIFIER namespace: APIGEE_NAMESPACE # Usually "apigee" gcp: projectID: PROJECT_ID region: ANALYTICS_REGION k8sCluster: name: CLUSTER_NAME region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster. org: ORG_NAME # Required for Enhanced per-environment proxy limits: enhanceProxyLimits: true # Required if using data residency with hybrid: contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com envs: - name: ENVIRONMENT_NAME serviceAccountPaths: # Provide the path relative to the apigee-env chart directory. synchronizer: SYNCHRONIZER_SERVICE_ACCOUNT_FILEPATH # For example: "PROJECT_ID-apigee-synchronizer.json" runtime: RUNTIME_SERVICE_ACCOUNT_FILEPATH # For example: "PROJECT_ID-apigee-runtime.json" udca: UDCA_SERVICE_ACCOUNT_FILEPATH # For example: "PROJECT_ID-apigee-udca.json" cassandra: hostNetwork: false # Set to false for single region installations and for multi-region # installations with connectivity between pods in different clusters, # like GKE. # Set to true for multi-region installations with no communication # between pods in different clusters, for example Google Distributed # Cloud on VMware or bare metal, GKE on AWS, AKS, EKS, and OpenShift. # See Multi-region deployment: Prerequisites replicaCount:
3 # Use multiples of 3 for production. # See Configure Cassandra for production for guidelines. storage: storageSize: 500Gi resources: requests: cpu: 7 memory: 15Gi maxHeapSize: 8192M heapNewSize: 1200M # Minimum storage requirements for a production environment. # See Configure Cassandra for production. ingressGateways: - name: INGRESS_NAME # maximum 17 characters. replicaCountMin: 2 replicaCountMax: 10 svcAnnotations: # optional. If you are on AKS, see Known issue #260772383 SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE virtualhosts: - name: ENVIRONMENT_GROUP_NAME selector: app: apigee-ingressgateway ingress_name: INGRESS_NAME sslCertPath: PATH_TO_CERT_FILE sslKeyPath: PATH_TO_KEY_FILE logger: enabled: true # enabled by default # See apigee-logger in Service accounts and roles used by hybrid components. serviceAccountPath: LOGGER_SERVICE_ACCOUNT_FILEPATH # Provide the path relative to the apigee-F chart directory. # For example: "PROJECT_ID-apigee-logger.json" mart: serviceAccountPath: MART_SERVICE_ACCOUNT_FILEPATH # Provide the path relative to the apigee-org chart directory. # For example: "PROJECT_ID-apigee-mart.json" connectAgent: serviceAccountPath: MART_SERVICE_ACCOUNT_FILEPATH # Use the same service account for mart and connectAgent # Provide the path relative to the apigee-org chart directory. # For example: "PROJECT_ID-apigee-mart.json" metrics: serviceAccountPath: METRICS_SERVICE_ACCOUNT_FILEPATH # Provide the path relative to the apigee-telemetry chart directory. # For example: "PROJECT_ID-apigee-metrics.json" udca: serviceAccountPath: UDCA_SERVICE_ACCOUNT_FILEPATH # Provide the path relative to the apigee-telemetry chart directory. # For example: "PROJECT_ID-apigee-udca.json" watcher: serviceAccountPath: WATCHER_SERVICE_ACCOUNT_FILEPATH # Provide the path relative to the apigee-telemetry chart directory. # For example: "PROJECT_ID-apigee-watcher.json" # Required if using Monetization for Apigee hybrid (v1.15.1 and later) runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.1" # Must be 1.15.1 or higher. mintTaskScheduler: # Required for Monetization for Apigee hybrid serviceAccountPath: MINT_TASK_SCHEDULER_SERVICE_ACCOUNT_FILEPATH # Provide the path relative to the apigee-org chart directory. # For example: "PROJECT_ID-apigee-mint-task-scheduler.json" # If using message payloads larger than 10MB. # See configure large message payload support: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Gi Tabel berikut menjelaskan setiap nilai properti yang harus Anda berikan dalam file penggantian. Untuk mengetahui informasi selengkapnya, lihat Referensi properti konfigurasi.
Variabel Deskripsi UNIQUE_INSTANCE_
IDENTIFIERString unik untuk mengidentifikasi instance ini. ID dapat berupa kombinasi huruf dan angka hingga 63 karakter.
Anda dapat membuat beberapa organisasi dalam cluster yang sama, tetapi
instanceID
harus sama untuk semua organisasi dalam cluster Kubernetes yang sama.Lihat
instanceID
.APIGEE_NAMESPACE Namespace Kubernetes untuk komponen hybrid Apigee Anda.
Nilai defaultnya adalah
apigee
.Lihat
namespace
.PROJECT_ID Mengidentifikasi project Google Cloud tempat apigee-logger
danapigee-metrics
mengirim data mereka. Ini adalah nilai yang ditetapkan ke variabel lingkunganPROJECT_ID
.Lihat
gcp.projectID
.ANALYTICS_REGION Di GKE, Anda harus menetapkan nilai ini ke region yang sama dengan tempat cluster berjalan. Di semua platform lainnya, pilih wilayah analisis yang paling dekat dengan cluster Anda yang memiliki dukungan Analytics (lihat tabel di Bagian 1, Langkah 2: Buat organisasi). Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
ANALYTICS_REGION
sebelumnya.Lihat
gcp.region
.CLUSTER_NAME Nama cluster Kubernetes Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan CLUSTER_NAME
.Lihat
k8sCluster.name
.CLUSTER_LOCATION Region tempat cluster berjalan. Ini adalah region tempat Anda membuat cluster di Langkah 1: Buat cluster. Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
CLUSTER_LOCATION
sebelumnya.Lihat
k8sCluster.location
.ORG_NAME ID organisasi hybrid Apigee Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan ORG_NAME
.Lihat
org
.CONTROL_PLANE_
LOCATIONWajib diisi jika Anda menggunakan Residensi data dengan penginstalan hybrid Apigee. Ini adalah lokasi tempat konten inti pelanggan seperti paket proxy disimpan. Untuk mengetahui daftarnya, lihat Region bidang kontrol API Apigee yang tersedia. Nilai ini ditetapkan ke variabel lingkungan CONTROL_PLANE_LOCATION
di Langkah 2: Buat organisasi.Lihat
contractProvider
.ENVIRONMENT_NAME Gunakan nama yang sama dengan yang Anda gunakan saat membuat lingkungan di UI, seperti yang dijelaskan dalam Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Lihat
envs[].name
.ENVIRONMENT_GROUP_
NAMENama grup lingkungan tempat lingkungan Anda ditetapkan. Ini adalah grup yang Anda buat di Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Ini adalah nilai yang ditetapkan ke variabel lingkungan ENV_GROUP
.Lihat
virtualhosts[].name
.INGRESS_NAME Nama gateway ingress Apigee untuk deployment Anda. Nama ini dapat berupa nama apa pun yang memenuhi persyaratan berikut: - Memiliki panjang maksimum 17 karakter
- Hanya berisi karakter alfanumerik huruf kecil, '-', atau '.'
- Diawali dengan karakter alfanumerik
- Diakhiri dengan karakter alfanumerik
Lihat:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEMasukkan jalur dan nama file kunci TLS dan sertifikat yang ditandatangani sendiri yang Anda buat sebelumnya di Langkah 6: Buat sertifikat TLS. File ini harus berada di direktori APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Contoh:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Lihat:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opsional). Ini adalah key-value pair yang menyediakan anotasi untuk layanan ingress default Anda. Platform cloud Anda menggunakan anotasi untuk membantu mengonfigurasi penginstalan hybrid, misalnya menyetel jenis load balancer ke internal atau eksternal. Anotasi bervariasi dari satu platform ke platform lainnya. Lihat dokumentasi platform Anda untuk mengetahui anotasi wajib dan yang disarankan.
Beri komentar atau hapus bagian ini jika Anda tidak menggunakannya.
<component>_
SERVICE_ACCOUNT_
FILEPATHJalur dan nama file akun file JSON akun layanan di direktori diagram yang sesuai. Berikan nama dengan jalur yang terkait dengan direktori diagram. Contoh: - Jika file
my-project-apigee-synchronizer.json
berada di direktori diagramapigee-env/
, Anda hanya perlu memberikan nama file, seperti:synchronizer: "FILE_NAME.json"
- Jika file berada di direktori
apigee-env/service-accounts/
, Anda akan menentukan jalur relatif:synchronizer: "service-accounts/FILE_NAME.json"
Untuk lingkungan non-produksi, nama akun layanan tunggal adalah
PROJECT_ID-non-prod.json
secara default.Untuk lingkungan produksi, nama file kunci akun layanan yang Anda buat dengan alat
create-service-account
di Langkah 4: Buat akun layanan.Anda dapat melihat file akun layanan di setiap direktori diagram yang sesuai.
Nama default direktori dan diagram yang sesuai untuk akun layanan adalah:
Produksi
Nama file akun layanan Direktori diagram PROJECT_ID-apigee-cassandra.json
apigee-datastore/
PROJECT_ID-apigee-mart.json
apigee-org/
PROJECT_ID-apigee-metrics.json
apigee-telemetry/
PROJECT_ID-apigee-mint-task-scheduler.json
apigee-org/
PROJECT_ID-apigee-runtime.json
apigee-env/
PROJECT_ID-apigee-synchronizer.json
apigee-env/
PROJECT_ID-apigee-udca.json
apigee-org/
PROJECT_ID-apigee-watcher.json
apigee-org/
Non-prod
Nama file akun layanan Direktori diagram PROJECT_ID-non-prod.json
apigee-datastore/
apigee-org/
apigee-telemetry/
Lihat:
-
envs[].serviceAccountPaths.synchronizer
. -
envs[].serviceAccountPaths.runtime
. -
envs[].serviceAccountPaths.udca
. -
logger.serviceAccountPath
. -
connectAgent.serviceAccountPath
. -
mart.serviceAccountPath
. -
metrics.serviceAccountPath
. -
mintTaskScheduler.serviceAccountPath
. -
udca.serviceAccountPath
. -
watcher.serviceAccountPath
.
Contoh
instanceID: "my_hybrid_example" namespace: "apigee" gcp: projectID: my-project region: us-central1 k8sCluster: name: hybrid-env region: us-central1 org: my-project enhanceProxyLimits: true contractProvider: https://us-apigee.googleapis.com envs: - name: prod-env serviceAccountPaths: synchronizer: "my-project-apigee-synchronizer.json" runtime: "my-project-apigee-runtime.json" udca: "my-project-apigee-udca.json" cassandra: hostNetwork: false replicaCount: 3 storage: storageSize: 500Gi resources: requests: cpu: 7 memory: 15Gi maxHeapSize: 8192M heapNewSize: 1200M ingressGateways: - name: my-ingress-1 replicaCountMin: 2 replicaCountMax: 10 virtualhosts: - name: example-env-group selector: app: apigee-ingressgateway ingress_name: my-ingress-1 sslCertPath: certs/keystore.pem sslKeyPath: certs/keystore.key logger: enabled: true serviceAccountPath: "my-project-apigee-logger.json" mart: serviceAccountPath: "my-project-apigee-mart.json" connectAgent: serviceAccountPath: "my-project-apigee-mart.json" metrics: serviceAccountPath: "my-project-apigee-metrics.json" udca: serviceAccountPath: "my-project-apigee-udca.json" watcher: serviceAccountPath: "my-project-apigee-watcher.json" # Monetization for Apigee hybrid runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.1" mintTaskScheduler: serviceAccountPath: my-project-apigee-mint-task-scheduler.json" # For message payloads larger than 10MB: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Gi
Tabel berikut menjelaskan setiap nilai properti yang harus Anda berikan dalam file penggantian. Untuk mengetahui informasi selengkapnya, lihat Referensi properti konfigurasi.
Variabel Deskripsi UNIQUE_INSTANCE_
IDENTIFIERString unik untuk mengidentifikasi instance ini. ID dapat berupa kombinasi huruf dan angka hingga 63 karakter.
Anda dapat membuat beberapa organisasi dalam cluster yang sama, tetapi
instanceID
harus sama untuk semua organisasi dalam cluster Kubernetes yang sama.Lihat
instanceID
.APIGEE_NAMESPACE Namespace Kubernetes untuk komponen hybrid Apigee Anda.
Nilai defaultnya adalah
apigee
.Lihat
namespace
.PROJECT_ID Mengidentifikasi project Google Cloud tempat apigee-logger
danapigee-metrics
mengirim data mereka. Ini adalah nilai yang ditetapkan ke variabel lingkunganPROJECT_ID
.Lihat
gcp.projectID
.ANALYTICS_REGION Di GKE, Anda harus menetapkan nilai ini ke region yang sama dengan tempat cluster berjalan. Di semua platform lainnya, pilih wilayah analisis yang paling dekat dengan cluster Anda yang memiliki dukungan Analytics (lihat tabel di Bagian 1, Langkah 2: Buat organisasi). Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
ANALYTICS_REGION
sebelumnya.Lihat
gcp.region
.CLUSTER_NAME Nama cluster Kubernetes Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan CLUSTER_NAME
.Lihat
k8sCluster.name
.CLUSTER_LOCATION Region tempat cluster berjalan. Ini adalah region tempat Anda membuat cluster di Langkah 1: Buat cluster. Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
CLUSTER_LOCATION
sebelumnya.Lihat
k8sCluster.location
.ORG_NAME ID organisasi hybrid Apigee Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan ORG_NAME
.Lihat
org
.CONTROL_PLANE_
LOCATIONWajib diisi jika Anda menggunakan Residensi data dengan penginstalan hybrid Apigee. Ini adalah lokasi tempat konten inti pelanggan seperti paket proxy disimpan. Untuk mengetahui daftarnya, lihat Region bidang kontrol API Apigee yang tersedia. Nilai ini ditetapkan ke variabel lingkungan CONTROL_PLANE_LOCATION
di Langkah 2: Buat organisasi.Lihat
contractProvider
.ENVIRONMENT_NAME Gunakan nama yang sama dengan yang Anda gunakan saat membuat lingkungan di UI, seperti yang dijelaskan dalam Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Lihat
envs[].name
.ENVIRONMENT_GROUP_
NAMENama grup lingkungan tempat lingkungan Anda ditetapkan. Ini adalah grup yang Anda buat di Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Ini adalah nilai yang ditetapkan ke variabel lingkungan ENV_GROUP
.Lihat
virtualhosts[].name
.INGRESS_NAME Nama gateway ingress Apigee untuk deployment Anda. Nama ini dapat berupa nama apa pun yang memenuhi persyaratan berikut: - Memiliki panjang maksimum 17 karakter
- Hanya berisi karakter alfanumerik huruf kecil, '-', atau '.'
- Diawali dengan karakter alfanumerik
- Diakhiri dengan karakter alfanumerik
Lihat:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEMasukkan jalur dan nama file kunci TLS dan sertifikat yang ditandatangani sendiri yang Anda buat sebelumnya di Langkah 6: Buat sertifikat TLS. File ini harus berada di direktori APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Contoh:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Lihat:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opsional). Ini adalah key-value pair yang menyediakan anotasi untuk layanan ingress default Anda. Platform cloud Anda menggunakan anotasi untuk membantu mengonfigurasi penginstalan hybrid, misalnya menyetel jenis load balancer ke internal atau eksternal. Anotasi bervariasi dari satu platform ke platform lainnya. Lihat dokumentasi platform Anda untuk mengetahui anotasi wajib dan yang disarankan.
Beri komentar atau hapus bagian ini jika Anda tidak menggunakannya.
<component>_
SERVICE_ACCOUNT_
FILEPATHJalur dan nama file akun file JSON akun layanan di direktori diagram yang sesuai. Berikan nama dengan jalur yang terkait dengan direktori diagram. Contoh: - Jika file
my-project-apigee-synchronizer.json
berada di direktori diagramapigee-env/
, Anda hanya perlu memberikan nama file, seperti:synchronizer: "FILE_NAME.json"
- Jika file berada di direktori
apigee-env/service-accounts/
, Anda akan menentukan jalur relatif:synchronizer: "service-accounts/FILE_NAME.json"
Untuk lingkungan non-produksi, nama akun layanan tunggal adalah
PROJECT_ID-non-prod.json
secara default.Untuk lingkungan produksi, nama file kunci akun layanan yang Anda buat dengan alat
create-service-account
di Langkah 4: Buat akun layanan.Anda dapat melihat file akun layanan di setiap direktori diagram yang sesuai.
Nama default direktori dan diagram yang sesuai untuk akun layanan adalah:
Produksi
Nama file akun layanan Direktori diagram PROJECT_ID-apigee-cassandra.json
apigee-datastore/
PROJECT_ID-apigee-mart.json
apigee-org/
PROJECT_ID-apigee-metrics.json
apigee-telemetry/
PROJECT_ID-apigee-mint-task-scheduler.json
apigee-org/
PROJECT_ID-apigee-runtime.json
apigee-env/
PROJECT_ID-apigee-synchronizer.json
apigee-env/
PROJECT_ID-apigee-udca.json
apigee-org/
PROJECT_ID-apigee-watcher.json
apigee-org/
Non-prod
Nama file akun layanan Direktori diagram PROJECT_ID-non-prod.json
apigee-datastore/
apigee-org/
apigee-telemetry/
Lihat:
-
envs[].serviceAccountPaths.synchronizer
. -
envs[].serviceAccountPaths.runtime
. -
envs[].serviceAccountPaths.udca
. -
logger.serviceAccountPath
. -
connectAgent.serviceAccountPath
. -
mart.serviceAccountPath
. -
metrics.serviceAccountPath
. -
mintTaskScheduler.serviceAccountPath
. -
udca.serviceAccountPath
. -
watcher.serviceAccountPath
.
Non-prod
Template
Nilai dalam red, bold italics adalah nilai properti yang harus Anda berikan. Anda dapat mengedit nilainya di halaman ini. Objek ini dijelaskan dalam tabel di bawah.
instanceID: UNIQUE_INSTANCE_IDENTIFIER namespace: APIGEE_NAMESPACE # Usually "apigee" gcp: projectID: PROJECT_ID region: ANALYTICS_REGION k8sCluster: name: CLUSTER_NAME region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster. org: ORG_NAME # Required for Enhanced per-environment proxy limits: enhanceProxyLimits: true # Required if using data residency with hybrid: contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com envs: - name: ENVIRONMENT_NAME serviceAccountPaths: # Provide the path relative to the apigee-env chart directory. synchronizer: NON_PROD_SERVICE_ACCOUNT_FILEPATH # For example: "PROJECT_ID-apigee-non-prod.json" runtime: NON_PROD_SERVICE_ACCOUNT_FILEPATH # For example: "PROJECT_ID-apigee-non-prod.json" udca: NON_PROD_SERVICE_ACCOUNT_FILEPATH # For example: "PROJECT_ID-apigee-non-prod.json" cassandra: hostNetwork: false # Set to false for single region installations and for multi-region # installations with connectivity between pods in different clusters, # like GKE. # Set to true for multi-region installations with no communication # between pods in different clusters, for example Google Distributed # Cloud on VMware or bare metal, GKE on AWS, AKS, EKS, and OpenShift. # See Multi-region deployment: Prerequisites replicaCount: 1 # Use 1 for non-prod installations and multiples of 3 for production. # See Configure Cassandra for production for guidelines. ingressGateways: - name: INGRESS_NAME # maximum 17 characters. replicaCountMin: 2 replicaCountMax: 10 svcAnnotations: # optional. If you are on AKS, see Known issue #260772383 SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE virtualhosts: - name: ENVIRONMENT_GROUP_NAME selector: app: apigee-ingressgateway ingress_name: INGRESS_NAME sslCertPath: PATH_TO_CERT_FILE sslKeyPath: PATH_TO_KEY_FILE mart: serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH # Provide the path relative to the apigee-org chart directory. # For example: "PROJECT_ID-apigee-non-prod.json" connectAgent: serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH # Use the same service account for mart and connectAgent # Provide the path relative to the apigee-org chart directory. # For example: "PROJECT_ID-apigee-non-prod.json" logger: enabled: true # enabled by default # See apigee-logger in Service accounts and roles used by hybrid components. serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH # Provide the path relative to the apigee-F chart directory. # For example: "PROJECT_ID-apigee-non-prod.json" metrics: serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH # Provide the path relative to the apigee-telemetry chart directory. # For example: "PROJECT_ID-apigee-non-prod.json" udca: serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH # Provide the path relative to the apigee-telemetry chart directory. # For example: "PROJECT_ID-apigee-non-prod.json" watcher: serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH # Provide the path relative to the apigee-telemetry chart directory. # For example: "PROJECT_ID-apigee-non-prod.json" # Required if using Monetization for Apigee hybrid (v1.15.1 and later) runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.1" # Must be 1.15.1 or higher. mintTaskScheduler: # Required for Monetization for Apigee hybrid serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH # Provide the path relative to the apigee-org chart directory. # For example: "PROJECT_ID-apigee-non-prod.json" # If using message payloads larger than 10MB. # See configure large message payload support: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Gi
Tabel berikut menjelaskan setiap nilai properti yang harus Anda berikan dalam file penggantian. Untuk mengetahui informasi selengkapnya, lihat Referensi properti konfigurasi.
Variabel Deskripsi UNIQUE_INSTANCE_
IDENTIFIERString unik untuk mengidentifikasi instance ini. ID dapat berupa kombinasi huruf dan angka hingga 63 karakter.
Anda dapat membuat beberapa organisasi dalam cluster yang sama, tetapi
instanceID
harus sama untuk semua organisasi dalam cluster Kubernetes yang sama.Lihat
instanceID
.APIGEE_NAMESPACE Namespace Kubernetes untuk komponen hybrid Apigee Anda.
Nilai defaultnya adalah
apigee
.Lihat
namespace
.PROJECT_ID Mengidentifikasi project Google Cloud tempat apigee-logger
danapigee-metrics
mengirim data mereka. Ini adalah nilai yang ditetapkan ke variabel lingkunganPROJECT_ID
.Lihat
gcp.projectID
.ANALYTICS_REGION Di GKE, Anda harus menetapkan nilai ini ke region yang sama dengan tempat cluster berjalan. Di semua platform lainnya, pilih wilayah analisis yang paling dekat dengan cluster Anda yang memiliki dukungan Analytics (lihat tabel di Bagian 1, Langkah 2: Buat organisasi). Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
ANALYTICS_REGION
sebelumnya.Lihat
gcp.region
.CLUSTER_NAME Nama cluster Kubernetes Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan CLUSTER_NAME
.Lihat
k8sCluster.name
.CLUSTER_LOCATION Region tempat cluster berjalan. Ini adalah region tempat Anda membuat cluster di Langkah 1: Buat cluster. Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
CLUSTER_LOCATION
sebelumnya.Lihat
k8sCluster.location
.ORG_NAME ID organisasi hybrid Apigee Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan ORG_NAME
.Lihat
org
.CONTROL_PLANE_
LOCATIONWajib diisi jika Anda menggunakan Residensi data dengan penginstalan hybrid Apigee. Ini adalah lokasi tempat konten inti pelanggan seperti paket proxy disimpan. Untuk mengetahui daftarnya, lihat Region bidang kontrol API Apigee yang tersedia. Nilai ini ditetapkan ke variabel lingkungan CONTROL_PLANE_LOCATION
di Langkah 2: Buat organisasi.Lihat
contractProvider
.ENVIRONMENT_NAME Gunakan nama yang sama dengan yang Anda gunakan saat membuat lingkungan di UI, seperti yang dijelaskan dalam Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Lihat
envs[].name
.ENVIRONMENT_GROUP_
NAMENama grup lingkungan tempat lingkungan Anda ditetapkan. Ini adalah grup yang Anda buat di Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Ini adalah nilai yang ditetapkan ke variabel lingkungan ENV_GROUP
.Lihat
virtualhosts[].name
.INGRESS_NAME Nama gateway ingress Apigee untuk deployment Anda. Nama ini dapat berupa nama apa pun yang memenuhi persyaratan berikut: - Memiliki panjang maksimum 17 karakter
- Hanya berisi karakter alfanumerik huruf kecil, '-', atau '.'
- Diawali dengan karakter alfanumerik
- Diakhiri dengan karakter alfanumerik
Lihat:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEMasukkan jalur dan nama file kunci TLS dan sertifikat yang ditandatangani sendiri yang Anda buat sebelumnya di Langkah 6: Buat sertifikat TLS. File ini harus berada di direktori APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Contoh:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Lihat:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opsional). Ini adalah key-value pair yang menyediakan anotasi untuk layanan ingress default Anda. Platform cloud Anda menggunakan anotasi untuk membantu mengonfigurasi penginstalan hybrid, misalnya menyetel jenis load balancer ke internal atau eksternal. Anotasi bervariasi dari satu platform ke platform lainnya. Lihat dokumentasi platform Anda untuk mengetahui anotasi wajib dan yang disarankan.
Beri komentar atau hapus bagian ini jika Anda tidak menggunakannya.
<component>_
SERVICE_ACCOUNT_
FILEPATHJalur dan nama file akun file JSON akun layanan di direktori diagram yang sesuai. Berikan nama dengan jalur yang terkait dengan direktori diagram. Contoh: - Jika file
my-project-apigee-synchronizer.json
berada di direktori diagramapigee-env/
, Anda hanya perlu memberikan nama file, seperti:synchronizer: "FILE_NAME.json"
- Jika file berada di direktori
apigee-env/service-accounts/
, Anda akan menentukan jalur relatif:synchronizer: "service-accounts/FILE_NAME.json"
Untuk lingkungan non-produksi, nama akun layanan tunggal adalah
PROJECT_ID-non-prod.json
secara default.Untuk lingkungan produksi, nama file kunci akun layanan yang Anda buat dengan alat
create-service-account
di Langkah 4: Buat akun layanan.Anda dapat melihat file akun layanan di setiap direktori diagram yang sesuai.
Nama default direktori dan diagram yang sesuai untuk akun layanan adalah:
Produksi
Nama file akun layanan Direktori diagram PROJECT_ID-apigee-cassandra.json
apigee-datastore/
PROJECT_ID-apigee-mart.json
apigee-org/
PROJECT_ID-apigee-metrics.json
apigee-telemetry/
PROJECT_ID-apigee-mint-task-scheduler.json
apigee-org/
PROJECT_ID-apigee-runtime.json
apigee-env/
PROJECT_ID-apigee-synchronizer.json
apigee-env/
PROJECT_ID-apigee-udca.json
apigee-org/
PROJECT_ID-apigee-watcher.json
apigee-org/
Non-prod
Nama file akun layanan Direktori diagram PROJECT_ID-non-prod.json
apigee-datastore/
apigee-org/
apigee-telemetry/
Lihat:
-
envs[].serviceAccountPaths.synchronizer
. -
envs[].serviceAccountPaths.runtime
. -
envs[].serviceAccountPaths.udca
. -
logger.serviceAccountPath
. -
connectAgent.serviceAccountPath
. -
mart.serviceAccountPath
. -
metrics.serviceAccountPath
. -
mintTaskScheduler.serviceAccountPath
. -
udca.serviceAccountPath
. -
watcher.serviceAccountPath
.
Contoh
instanceID: "my_hybrid_example" namespace: "apigee" gcp: projectID: my-project region: us-central1 k8sCluster: name: hybrid-env region: us-central1 org: my-project enhanceProxyLimits: true contractProvider: https://us-apigee.googleapis.com envs: - name: test serviceAccountPaths: synchronizer: "hybrid-example-apigee-non-prod.json" runtime: "hybrid-example-apigee-non-prod.json" udca: "hybrid-example-apigee-non-prod.json" cassandra: hostNetwork: false replicaCount: 1 ingressGateways: - name: my-ingress-1 replicaCountMin: 2 replicaCountMax: 10 virtualhosts: - name: example-env-group selector: app: apigee-ingressgateway ingress_name: my-ingress-1 sslCertPath: certs/keystore.pem sslKeyPath: certs/keystore.key mart: serviceAccountPath: "my-project-apigee-non-prod.json" connectAgent: serviceAccountPath: "my-project-apigee-non-prod.json" logger: enabled: true serviceAccountPath: "my-project-apigee-non-prod.json" metrics: serviceAccountPath: "my-project-apigee-non-prod.json" udca: serviceAccountPath: "my-project-apigee-non-prod.json" watcher: serviceAccountPath: "my-project-apigee-non-prod.json" # Monetization for Apigee hybrid runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.1" mintTaskScheduler: serviceAccountPath: my-project-apigee-non-prod.json" # For message payloads larger than 10MB: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Gi
Tabel berikut menjelaskan setiap nilai properti yang harus Anda berikan dalam file penggantian. Untuk mengetahui informasi selengkapnya, lihat Referensi properti konfigurasi.
Variabel Deskripsi UNIQUE_INSTANCE_
IDENTIFIERString unik untuk mengidentifikasi instance ini. ID dapat berupa kombinasi huruf dan angka hingga 63 karakter.
Anda dapat membuat beberapa organisasi dalam cluster yang sama, tetapi
instanceID
harus sama untuk semua organisasi dalam cluster Kubernetes yang sama.Lihat
instanceID
.APIGEE_NAMESPACE Namespace Kubernetes untuk komponen hybrid Apigee Anda.
Nilai defaultnya adalah
apigee
.Lihat
namespace
.PROJECT_ID Mengidentifikasi project Google Cloud tempat apigee-logger
danapigee-metrics
mengirim data mereka. Ini adalah nilai yang ditetapkan ke variabel lingkunganPROJECT_ID
.Lihat
gcp.projectID
.ANALYTICS_REGION Di GKE, Anda harus menetapkan nilai ini ke region yang sama dengan tempat cluster berjalan. Di semua platform lainnya, pilih wilayah analisis yang paling dekat dengan cluster Anda yang memiliki dukungan Analytics (lihat tabel di Bagian 1, Langkah 2: Buat organisasi). Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
ANALYTICS_REGION
sebelumnya.Lihat
gcp.region
.CLUSTER_NAME Nama cluster Kubernetes Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan CLUSTER_NAME
.Lihat
k8sCluster.name
.CLUSTER_LOCATION Region tempat cluster berjalan. Ini adalah region tempat Anda membuat cluster di Langkah 1: Buat cluster. Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
CLUSTER_LOCATION
sebelumnya.Lihat
k8sCluster.location
.ORG_NAME ID organisasi hybrid Apigee Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan ORG_NAME
.Lihat
org
.CONTROL_PLANE_
LOCATIONWajib diisi jika Anda menggunakan Residensi data dengan penginstalan hybrid Apigee. Ini adalah lokasi tempat konten inti pelanggan seperti paket proxy disimpan. Untuk mengetahui daftarnya, lihat Region bidang kontrol API Apigee yang tersedia. Nilai ini ditetapkan ke variabel lingkungan CONTROL_PLANE_LOCATION
di Langkah 2: Buat organisasi.Lihat
contractProvider
.ENVIRONMENT_NAME Gunakan nama yang sama dengan yang Anda gunakan saat membuat lingkungan di UI, seperti yang dijelaskan dalam Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Lihat
envs[].name
.ENVIRONMENT_GROUP_
NAMENama grup lingkungan tempat lingkungan Anda ditetapkan. Ini adalah grup yang Anda buat di Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Ini adalah nilai yang ditetapkan ke variabel lingkungan ENV_GROUP
.Lihat
virtualhosts[].name
.INGRESS_NAME Nama gateway ingress Apigee untuk deployment Anda. Nama ini dapat berupa nama apa pun yang memenuhi persyaratan berikut: - Memiliki panjang maksimum 17 karakter
- Hanya berisi karakter alfanumerik huruf kecil, '-', atau '.'
- Diawali dengan karakter alfanumerik
- Diakhiri dengan karakter alfanumerik
Lihat:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEMasukkan jalur dan nama file kunci TLS dan sertifikat yang ditandatangani sendiri yang Anda buat sebelumnya di Langkah 6: Buat sertifikat TLS. File ini harus berada di direktori APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Contoh:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Lihat:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opsional). Ini adalah key-value pair yang menyediakan anotasi untuk layanan ingress default Anda. Platform cloud Anda menggunakan anotasi untuk membantu mengonfigurasi penginstalan hybrid, misalnya menyetel jenis load balancer ke internal atau eksternal. Anotasi bervariasi dari satu platform ke platform lainnya. Lihat dokumentasi platform Anda untuk mengetahui anotasi wajib dan yang disarankan.
Beri komentar atau hapus bagian ini jika Anda tidak menggunakannya.
<component>_
SERVICE_ACCOUNT_
FILEPATHJalur dan nama file akun file JSON akun layanan di direktori diagram yang sesuai. Berikan nama dengan jalur yang terkait dengan direktori diagram. Contoh: - Jika file
my-project-apigee-synchronizer.json
berada di direktori diagramapigee-env/
, Anda hanya perlu memberikan nama file, seperti:synchronizer: "FILE_NAME.json"
- Jika file berada di direktori
apigee-env/service-accounts/
, Anda akan menentukan jalur relatif:synchronizer: "service-accounts/FILE_NAME.json"
Untuk lingkungan non-produksi, nama akun layanan tunggal adalah
PROJECT_ID-non-prod.json
secara default.Untuk lingkungan produksi, nama file kunci akun layanan yang Anda buat dengan alat
create-service-account
di Langkah 4: Buat akun layanan.Anda dapat melihat file akun layanan di setiap direktori diagram yang sesuai.
Nama default direktori dan diagram yang sesuai untuk akun layanan adalah:
Produksi
Nama file akun layanan Direktori diagram PROJECT_ID-apigee-cassandra.json
apigee-datastore/
PROJECT_ID-apigee-mart.json
apigee-org/
PROJECT_ID-apigee-metrics.json
apigee-telemetry/
PROJECT_ID-apigee-mint-task-scheduler.json
apigee-org/
PROJECT_ID-apigee-runtime.json
apigee-env/
PROJECT_ID-apigee-synchronizer.json
apigee-env/
PROJECT_ID-apigee-udca.json
apigee-org/
PROJECT_ID-apigee-watcher.json
apigee-org/
Non-prod
Nama file akun layanan Direktori diagram PROJECT_ID-non-prod.json
apigee-datastore/
apigee-org/
apigee-telemetry/
Lihat:
-
envs[].serviceAccountPaths.synchronizer
. -
envs[].serviceAccountPaths.runtime
. -
envs[].serviceAccountPaths.udca
. -
logger.serviceAccountPath
. -
connectAgent.serviceAccountPath
. -
mart.serviceAccountPath
. -
metrics.serviceAccountPath
. -
mintTaskScheduler.serviceAccountPath
. -
udca.serviceAccountPath
. -
watcher.serviceAccountPath
.
Vault
Produksi
Template
Nilai dalam red, bold italics adalah nilai properti yang harus Anda berikan. Anda dapat mengedit nilainya di halaman ini. Objek ini dijelaskan dalam tabel di bawah.
instanceID: UNIQUE_INSTANCE_IDENTIFIER namespace: APIGEE_NAMESPACE # Usually "apigee" gcp: projectID: PROJECT_ID region: ANALYTICS_REGION k8sCluster: name: CLUSTER_NAME region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster. org: ORG_NAME serviceAccountSecretProviderClass: apigee-orgsakeys-spc # Required for Enhanced per-environment proxy limits: enhanceProxyLimits: true # Required if using data residency with hybrid: contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com envs: - name: ENVIRONMENT_NAME serviceAccountSecretProviderClass: apigee-envsakeys-ENVIRONMENT_NAME-spc cassandra: hostNetwork: false # Set to false for single region installations and for multi-region # installations with connectivity between pods in different clusters, # like GKE. # Set to true for multi-region installations with no communication # between pods in different clusters, for example Google Distributed # Cloud on VMware or bare metal, GKE on AWS, AKS, EKS, and OpenShift. # See Multi-region deployment: Prerequisites replicaCount:
3 # Use multiples of 3 for production. # See Configure Cassandra for production for guidelines. storage: storageSize: 500Gi resources: requests: cpu: 7 memory: 15Gi maxHeapSize: 8192M heapNewSize: 1200M # Minimum storage requirements for a production environment. # See Configure Cassandra for production. ingressGateways: - name: INGRESS_NAME # maximum 17 characters. replicaCountMin: 2 replicaCountMax: 10 svcAnnotations: # optional. If you are on AKS, see Known issue #260772383 SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE virtualhosts: - name: ENVIRONMENT_GROUP_NAME selector: app: apigee-ingressgateway ingress_name: INGRESS_NAME sslCertPath: PATH_TO_CERT_FILE sslKeyPath: PATH_TO_KEY_FILE logger: enabled: true # enabled by default # See apigee-logger in Service accounts and roles used by hybrid components. # Required if using Monetization for Apigee hybrid (v1.15.1 and later) runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.1" # Must be 1.15.1 or higher. # If using message payloads larger than 10MB. # See configure large message payload support: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Gi Tabel berikut menjelaskan setiap nilai properti yang harus Anda berikan dalam file penggantian. Untuk mengetahui informasi selengkapnya, lihat Referensi properti konfigurasi.
Variabel Deskripsi UNIQUE_INSTANCE_
IDENTIFIERString unik untuk mengidentifikasi instance ini. ID dapat berupa kombinasi huruf dan angka hingga 63 karakter.
Anda dapat membuat beberapa organisasi dalam cluster yang sama, tetapi
instanceID
harus sama untuk semua organisasi dalam cluster Kubernetes yang sama.Lihat
instanceID
.APIGEE_NAMESPACE Namespace Kubernetes untuk komponen hybrid Apigee Anda.
Nilai defaultnya adalah
apigee
.Lihat
namespace
.PROJECT_ID Mengidentifikasi project Google Cloud tempat apigee-logger
danapigee-metrics
mengirim data mereka. Ini adalah nilai yang ditetapkan ke variabel lingkunganPROJECT_ID
.Lihat
gcp.projectID
.ANALYTICS_REGION Di GKE, Anda harus menetapkan nilai ini ke region yang sama dengan tempat cluster berjalan. Di semua platform lainnya, pilih wilayah analisis yang paling dekat dengan cluster Anda yang memiliki dukungan Analytics (lihat tabel di Bagian 1, Langkah 2: Buat organisasi). Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
ANALYTICS_REGION
sebelumnya.Lihat
gcp.region
.CLUSTER_NAME Nama cluster Kubernetes Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan CLUSTER_NAME
.Lihat
k8sCluster.name
.CLUSTER_LOCATION Region tempat cluster berjalan. Ini adalah region tempat Anda membuat cluster di Langkah 1: Buat cluster. Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
CLUSTER_LOCATION
sebelumnya.Lihat
k8sCluster.location
.ORG_NAME ID organisasi hybrid Apigee Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan ORG_NAME
.Lihat
org
.CONTROL_PLANE_
LOCATIONWajib diisi jika Anda menggunakan Residensi data dengan penginstalan hybrid Apigee. Ini adalah lokasi tempat konten inti pelanggan seperti paket proxy disimpan. Untuk mengetahui daftarnya, lihat Region bidang kontrol API Apigee yang tersedia. Nilai ini ditetapkan ke variabel lingkungan CONTROL_PLANE_LOCATION
di Langkah 2: Buat organisasi.Lihat
contractProvider
.ENVIRONMENT_NAME Gunakan nama yang sama dengan yang Anda gunakan saat membuat lingkungan di UI, seperti yang dijelaskan dalam Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Lihat
envs[].name
.ENVIRONMENT_GROUP_
NAMENama grup lingkungan tempat lingkungan Anda ditetapkan. Ini adalah grup yang Anda buat di Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Ini adalah nilai yang ditetapkan ke variabel lingkungan ENV_GROUP
.Lihat
virtualhosts[].name
.INGRESS_NAME Nama gateway ingress Apigee untuk deployment Anda. Nama ini dapat berupa nama apa pun yang memenuhi persyaratan berikut: - Memiliki panjang maksimum 17 karakter
- Hanya berisi karakter alfanumerik huruf kecil, '-', atau '.'
- Diawali dengan karakter alfanumerik
- Diakhiri dengan karakter alfanumerik
Lihat:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEMasukkan jalur dan nama file kunci TLS dan sertifikat yang ditandatangani sendiri yang Anda buat sebelumnya di Langkah 6: Buat sertifikat TLS. File ini harus berada di direktori APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Contoh:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Lihat:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opsional). Ini adalah key-value pair yang menyediakan anotasi untuk layanan ingress default Anda. Platform cloud Anda menggunakan anotasi untuk membantu mengonfigurasi penginstalan hybrid, misalnya menyetel jenis load balancer ke internal atau eksternal. Anotasi bervariasi dari satu platform ke platform lainnya. Lihat dokumentasi platform Anda untuk mengetahui anotasi wajib dan yang disarankan.
Beri komentar atau hapus bagian ini jika Anda tidak menggunakannya.
Contoh
instanceID: "my_hybrid_example" namespace: "apigee" gcp: projectID: my-project region: us-central1 k8sCluster: name: hybrid-env region: us-central1 org: my-project serviceAccountSecretProviderClass: apigee-orgsakeys-spc enhanceProxyLimits: true contractProvider: https://us-apigee.googleapis.com envs: - name: prod-env serviceAccountSecretProviderClass: apigee-envsakeys-prod-env-spc cassandra: hostNetwork: false replicaCount: 3 storage: storageSize: 500Gi resources: requests: cpu: 7 memory: 15Gi maxHeapSize: 8192M heapNewSize: 1200M ingressGateways: - name: my-ingress-1 replicaCountMin: 2 replicaCountMax: 10 virtualhosts: - name: example-env-group selector: app: apigee-ingressgateway ingress_name: my-ingress-1 sslCertPath: certs/keystore.pem sslKeyPath: certs/keystore.key logger: enabled: true # Monetization for Apigee hybrid runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.1" # For message payloads larger than 10MB: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Gi
Tabel berikut menjelaskan setiap nilai properti yang harus Anda berikan dalam file penggantian. Untuk mengetahui informasi selengkapnya, lihat Referensi properti konfigurasi.
Variabel Deskripsi UNIQUE_INSTANCE_
IDENTIFIERString unik untuk mengidentifikasi instance ini. ID dapat berupa kombinasi huruf dan angka hingga 63 karakter.
Anda dapat membuat beberapa organisasi dalam cluster yang sama, tetapi
instanceID
harus sama untuk semua organisasi dalam cluster Kubernetes yang sama.Lihat
instanceID
.APIGEE_NAMESPACE Namespace Kubernetes untuk komponen hybrid Apigee Anda.
Nilai defaultnya adalah
apigee
.Lihat
namespace
.PROJECT_ID Mengidentifikasi project Google Cloud tempat apigee-logger
danapigee-metrics
mengirim data mereka. Ini adalah nilai yang ditetapkan ke variabel lingkunganPROJECT_ID
.Lihat
gcp.projectID
.ANALYTICS_REGION Di GKE, Anda harus menetapkan nilai ini ke region yang sama dengan tempat cluster berjalan. Di semua platform lainnya, pilih wilayah analisis yang paling dekat dengan cluster Anda yang memiliki dukungan Analytics (lihat tabel di Bagian 1, Langkah 2: Buat organisasi). Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
ANALYTICS_REGION
sebelumnya.Lihat
gcp.region
.CLUSTER_NAME Nama cluster Kubernetes Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan CLUSTER_NAME
.Lihat
k8sCluster.name
.CLUSTER_LOCATION Region tempat cluster berjalan. Ini adalah region tempat Anda membuat cluster di Langkah 1: Buat cluster. Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
CLUSTER_LOCATION
sebelumnya.Lihat
k8sCluster.location
.ORG_NAME ID organisasi hybrid Apigee Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan ORG_NAME
.Lihat
org
.CONTROL_PLANE_
LOCATIONWajib diisi jika Anda menggunakan Residensi data dengan penginstalan hybrid Apigee. Ini adalah lokasi tempat konten inti pelanggan seperti paket proxy disimpan. Untuk mengetahui daftarnya, lihat Region bidang kontrol API Apigee yang tersedia. Nilai ini ditetapkan ke variabel lingkungan CONTROL_PLANE_LOCATION
di Langkah 2: Buat organisasi.Lihat
contractProvider
.ENVIRONMENT_NAME Gunakan nama yang sama dengan yang Anda gunakan saat membuat lingkungan di UI, seperti yang dijelaskan dalam Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Lihat
envs[].name
.ENVIRONMENT_GROUP_
NAMENama grup lingkungan tempat lingkungan Anda ditetapkan. Ini adalah grup yang Anda buat di Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Ini adalah nilai yang ditetapkan ke variabel lingkungan ENV_GROUP
.Lihat
virtualhosts[].name
.INGRESS_NAME Nama gateway ingress Apigee untuk deployment Anda. Nama ini dapat berupa nama apa pun yang memenuhi persyaratan berikut: - Memiliki panjang maksimum 17 karakter
- Hanya berisi karakter alfanumerik huruf kecil, '-', atau '.'
- Diawali dengan karakter alfanumerik
- Diakhiri dengan karakter alfanumerik
Lihat:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEMasukkan jalur dan nama file kunci TLS dan sertifikat yang ditandatangani sendiri yang Anda buat sebelumnya di Langkah 6: Buat sertifikat TLS. File ini harus berada di direktori APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Contoh:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Lihat:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opsional). Ini adalah key-value pair yang menyediakan anotasi untuk layanan ingress default Anda. Platform cloud Anda menggunakan anotasi untuk membantu mengonfigurasi penginstalan hybrid, misalnya menyetel jenis load balancer ke internal atau eksternal. Anotasi bervariasi dari satu platform ke platform lainnya. Lihat dokumentasi platform Anda untuk mengetahui anotasi wajib dan yang disarankan.
Beri komentar atau hapus bagian ini jika Anda tidak menggunakannya.
Non-prod
Template
Nilai dalam red, bold italics adalah nilai properti yang harus Anda berikan. Anda dapat mengedit nilainya di halaman ini. Objek ini dijelaskan dalam tabel di bawah.
instanceID: UNIQUE_INSTANCE_IDENTIFIER namespace: APIGEE_NAMESPACE # Usually "apigee" gcp: projectID: PROJECT_ID region: ANALYTICS_REGION k8sCluster: name: CLUSTER_NAME region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster. org: ORG_NAME serviceAccountSecretProviderClass: apigee-orgsakeys-spc # Required for Enhanced per-environment proxy limits: enhanceProxyLimits: true # Required if using data residency with hybrid: contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com envs: - name: ENVIRONMENT_NAME serviceAccountSecretProviderClass: apigee-envsakeys-ENVIRONMENT_NAME-spc cassandra: hostNetwork: false # Set to false for single region installations and for multi-region # installations with connectivity between pods in different clusters, # like GKE. # Set to true for multi-region installations with no communication # between pods in different clusters, for example Google Distributed # Cloud on VMware or bare metal, GKE on AWS, AKS, EKS, and OpenShift. # See Multi-region deployment: Prerequisites replicaCount: 1 # Use 1 for non-prod installations and multiples of 3 for production. # See Configure Cassandra for production for guidelines. ingressGateways: - name: INGRESS_NAME # maximum 17 characters. replicaCountMin: 2 replicaCountMax: 10 svcAnnotations: # optional. If you are on AKS, see Known issue #260772383 SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE virtualhosts: - name: ENVIRONMENT_GROUP_NAME selector: app: apigee-ingressgateway ingress_name: INGRESS_NAME sslCertPath: PATH_TO_CERT_FILE sslKeyPath: PATH_TO_KEY_FILE logger: enabled: true # enabled by default # See apigee-logger in Service accounts and roles used by hybrid components. # Required if using Monetization for Apigee hybrid (v1.15.1 and later) runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.1" # Must be 1.15.1 or higher. # If using message payloads larger than 10MB. # See configure large message payload support: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Gi
Tabel berikut menjelaskan setiap nilai properti yang harus Anda berikan dalam file penggantian. Untuk mengetahui informasi selengkapnya, lihat Referensi properti konfigurasi.
Variabel Deskripsi UNIQUE_INSTANCE_
IDENTIFIERString unik untuk mengidentifikasi instance ini. ID dapat berupa kombinasi huruf dan angka hingga 63 karakter.
Anda dapat membuat beberapa organisasi dalam cluster yang sama, tetapi
instanceID
harus sama untuk semua organisasi dalam cluster Kubernetes yang sama.Lihat
instanceID
.APIGEE_NAMESPACE Namespace Kubernetes untuk komponen hybrid Apigee Anda.
Nilai defaultnya adalah
apigee
.Lihat
namespace
.PROJECT_ID Mengidentifikasi project Google Cloud tempat apigee-logger
danapigee-metrics
mengirim data mereka. Ini adalah nilai yang ditetapkan ke variabel lingkunganPROJECT_ID
.Lihat
gcp.projectID
.ANALYTICS_REGION Di GKE, Anda harus menetapkan nilai ini ke region yang sama dengan tempat cluster berjalan. Di semua platform lainnya, pilih wilayah analisis yang paling dekat dengan cluster Anda yang memiliki dukungan Analytics (lihat tabel di Bagian 1, Langkah 2: Buat organisasi). Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
ANALYTICS_REGION
sebelumnya.Lihat
gcp.region
.CLUSTER_NAME Nama cluster Kubernetes Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan CLUSTER_NAME
.Lihat
k8sCluster.name
.CLUSTER_LOCATION Region tempat cluster berjalan. Ini adalah region tempat Anda membuat cluster di Langkah 1: Buat cluster. Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
CLUSTER_LOCATION
sebelumnya.Lihat
k8sCluster.location
.ORG_NAME ID organisasi hybrid Apigee Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan ORG_NAME
.Lihat
org
.CONTROL_PLANE_
LOCATIONWajib diisi jika Anda menggunakan Residensi data dengan penginstalan hybrid Apigee. Ini adalah lokasi tempat konten inti pelanggan seperti paket proxy disimpan. Untuk mengetahui daftarnya, lihat Region bidang kontrol API Apigee yang tersedia. Nilai ini ditetapkan ke variabel lingkungan CONTROL_PLANE_LOCATION
di Langkah 2: Buat organisasi.Lihat
contractProvider
.ENVIRONMENT_NAME Gunakan nama yang sama dengan yang Anda gunakan saat membuat lingkungan di UI, seperti yang dijelaskan dalam Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Lihat
envs[].name
.ENVIRONMENT_GROUP_
NAMENama grup lingkungan tempat lingkungan Anda ditetapkan. Ini adalah grup yang Anda buat di Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Ini adalah nilai yang ditetapkan ke variabel lingkungan ENV_GROUP
.Lihat
virtualhosts[].name
.INGRESS_NAME Nama gateway ingress Apigee untuk deployment Anda. Nama ini dapat berupa nama apa pun yang memenuhi persyaratan berikut: - Memiliki panjang maksimum 17 karakter
- Hanya berisi karakter alfanumerik huruf kecil, '-', atau '.'
- Diawali dengan karakter alfanumerik
- Diakhiri dengan karakter alfanumerik
Lihat:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEMasukkan jalur dan nama file kunci TLS dan sertifikat yang ditandatangani sendiri yang Anda buat sebelumnya di Langkah 6: Buat sertifikat TLS. File ini harus berada di direktori APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Contoh:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Lihat:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opsional). Ini adalah key-value pair yang menyediakan anotasi untuk layanan ingress default Anda. Platform cloud Anda menggunakan anotasi untuk membantu mengonfigurasi penginstalan hybrid, misalnya menyetel jenis load balancer ke internal atau eksternal. Anotasi bervariasi dari satu platform ke platform lainnya. Lihat dokumentasi platform Anda untuk mengetahui anotasi wajib dan yang disarankan.
Beri komentar atau hapus bagian ini jika Anda tidak menggunakannya.
Contoh
instanceID: "my_hybrid_example" namespace: "apigee" gcp: projectID: my-project region: us-central1 k8sCluster: name: hybrid-env region: us-central1 org: my-project serviceAccountSecretProviderClass: apigee-orgsakeys-spc enhanceProxyLimits: true contractProvider: https://us-apigee.googleapis.com envs: - name: test serviceAccountSecretProviderClass: apigee-envsakeys-test-env-spc cassandra: hostNetwork: false replicaCount: 1 ingressGateways: - name: my-ingress-1 replicaCountMin: 2 replicaCountMax: 10 virtualhosts: - name: example-env-group selector: app: apigee-ingressgateway ingress_name: my-ingress-1 sslCertPath: certs/keystore.pem sslKeyPath: certs/keystore.key logger: enabled: true # Monetization for Apigee hybrid runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.1" # for message payloads larger than 10MB: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Gi
Tabel berikut menjelaskan setiap nilai properti yang harus Anda berikan dalam file penggantian. Untuk mengetahui informasi selengkapnya, lihat Referensi properti konfigurasi.
Variabel Deskripsi UNIQUE_INSTANCE_
IDENTIFIERString unik untuk mengidentifikasi instance ini. ID dapat berupa kombinasi huruf dan angka hingga 63 karakter.
Anda dapat membuat beberapa organisasi dalam cluster yang sama, tetapi
instanceID
harus sama untuk semua organisasi dalam cluster Kubernetes yang sama.Lihat
instanceID
.APIGEE_NAMESPACE Namespace Kubernetes untuk komponen hybrid Apigee Anda.
Nilai defaultnya adalah
apigee
.Lihat
namespace
.PROJECT_ID Mengidentifikasi project Google Cloud tempat apigee-logger
danapigee-metrics
mengirim data mereka. Ini adalah nilai yang ditetapkan ke variabel lingkunganPROJECT_ID
.Lihat
gcp.projectID
.ANALYTICS_REGION Di GKE, Anda harus menetapkan nilai ini ke region yang sama dengan tempat cluster berjalan. Di semua platform lainnya, pilih wilayah analisis yang paling dekat dengan cluster Anda yang memiliki dukungan Analytics (lihat tabel di Bagian 1, Langkah 2: Buat organisasi). Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
ANALYTICS_REGION
sebelumnya.Lihat
gcp.region
.CLUSTER_NAME Nama cluster Kubernetes Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan CLUSTER_NAME
.Lihat
k8sCluster.name
.CLUSTER_LOCATION Region tempat cluster berjalan. Ini adalah region tempat Anda membuat cluster di Langkah 1: Buat cluster. Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
CLUSTER_LOCATION
sebelumnya.Lihat
k8sCluster.location
.ORG_NAME ID organisasi hybrid Apigee Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan ORG_NAME
.Lihat
org
.CONTROL_PLANE_
LOCATIONWajib diisi jika Anda menggunakan Residensi data dengan penginstalan hybrid Apigee. Ini adalah lokasi tempat konten inti pelanggan seperti paket proxy disimpan. Untuk mengetahui daftarnya, lihat Region bidang kontrol API Apigee yang tersedia. Nilai ini ditetapkan ke variabel lingkungan CONTROL_PLANE_LOCATION
di Langkah 2: Buat organisasi.Lihat
contractProvider
.ENVIRONMENT_NAME Gunakan nama yang sama dengan yang Anda gunakan saat membuat lingkungan di UI, seperti yang dijelaskan dalam Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Lihat
envs[].name
.ENVIRONMENT_GROUP_
NAMENama grup lingkungan tempat lingkungan Anda ditetapkan. Ini adalah grup yang Anda buat di Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Ini adalah nilai yang ditetapkan ke variabel lingkungan ENV_GROUP
.Lihat
virtualhosts[].name
.INGRESS_NAME Nama gateway ingress Apigee untuk deployment Anda. Nama ini dapat berupa nama apa pun yang memenuhi persyaratan berikut: - Memiliki panjang maksimum 17 karakter
- Hanya berisi karakter alfanumerik huruf kecil, '-', atau '.'
- Diawali dengan karakter alfanumerik
- Diakhiri dengan karakter alfanumerik
Lihat:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEMasukkan jalur dan nama file kunci TLS dan sertifikat yang ditandatangani sendiri yang Anda buat sebelumnya di Langkah 6: Buat sertifikat TLS. File ini harus berada di direktori APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Contoh:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Lihat:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opsional). Ini adalah key-value pair yang menyediakan anotasi untuk layanan ingress default Anda. Platform cloud Anda menggunakan anotasi untuk membantu mengonfigurasi penginstalan hybrid, misalnya menyetel jenis load balancer ke internal atau eksternal. Anotasi bervariasi dari satu platform ke platform lainnya. Lihat dokumentasi platform Anda untuk mengetahui anotasi wajib dan yang disarankan.
Beri komentar atau hapus bagian ini jika Anda tidak menggunakannya.
WIF untuk GKE
Produksi
Template
Nilai dalam red, bold italics adalah nilai properti yang harus Anda berikan. Anda dapat mengedit nilainya di halaman ini. Objek ini dijelaskan dalam tabel di bawah.
instanceID: UNIQUE_INSTANCE_IDENTIFIER namespace: APIGEE_NAMESPACE # Usually "apigee" gcp: projectID: PROJECT_ID region: ANALYTICS_REGION workloadIdentity: enabled: true k8sCluster: name: CLUSTER_NAME region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster. org: ORG_NAME # Required for Enhanced per-environment proxy limits: enhanceProxyLimits: true # Required if using data residency with hybrid: contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com envs: - name: ENVIRONMENT_NAME gsa: synchronizer: SYNCHRONIZER_SERVICE_ACCOUNT_EMAIL # For example: "apigee-synchronizer@PROJECT_ID.iam.gserviceaccount.com" runtime: RUNTIME_SERVICE_ACCOUNT_EMAIL # For example: "apigee-runtime@PROJECT_ID.iam.gserviceaccount.com" udca: UDCA_SERVICE_ACCOUNT_EMAIL # For example: "apigee-udca@PROJECT_ID.iam.gserviceaccount.com" cassandra: hostNetwork: false # Set to false for single region installations and for multi-region # installations with connectivity between pods in different clusters, # like GKE. # Set to true for multi-region installations with no communication # between pods in different clusters, for example Google Distributed # Cloud on VMware or bare metal, GKE on AWS, AKS, EKS, and OpenShift. # See Multi-region deployment: Prerequisites replicaCount:
3 # Use multiples of 3 for production. # See Configure Cassandra for production for guidelines. storage: storageSize: 500Gi resources: requests: cpu: 7 memory: 15Gi maxHeapSize: 8192M heapNewSize: 1200M # Minimum storage requirements for a production environment. # See Configure Cassandra for production. backup: enabled: true # Required to create the Cassandra Kubernetes service accounts # for Workload Identity Federation for GKE # See Cassandra backup overview. ingressGateways: - name: INGRESS_NAME # maximum 17 characters. replicaCountMin: 2 replicaCountMax: 10 svcAnnotations: # optional. If you are on AKS, see Known issue #260772383 SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE virtualhosts: - name: ENVIRONMENT_GROUP_NAME selector: app: apigee-ingressgateway ingress_name: INGRESS_NAME sslCertPath: PATH_TO_CERT_FILE sslKeyPath: PATH_TO_KEY_FILE mart: gsa: MART_SERVICE_ACCOUNT_EMAIL # For example: "apigee-mart@PROJECT_ID.iam.gserviceaccount.com" connectAgent: gsa: MART_SERVICE_ACCOUNT_EMAIL # Use the same service account email for mart and connectAgent # For example: "apigee-mart@PROJECT_ID.iam.gserviceaccount.com" logger: enabled: true # enabled by default # See apigee-logger in Service accounts and roles used by hybrid components. gsa: LOGGER_SERVICE_ACCOUNT_EMAIL # For example: "apigee-logger@PROJECT_ID.iam.gserviceaccount.com" metrics: gsa: METRICS_SERVICE_ACCOUNT_EMAIL # For example: "apigee-metrics@PROJECT_ID.iam.gserviceaccount.com" udca: gsa: UDCA_SERVICE_ACCOUNT_EMAIL # For example: "apigee-udca@PROJECT_ID.iam.gserviceaccount.com" watcher: gsa: WATCHER_SERVICE_ACCOUNT_EMAIL # For example: "apigee-watcher@PROJECT_ID.iam.gserviceaccount.com" # Required if using Monetization for Apigee hybrid (v1.15.1 and later) runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.1" # Must be 1.15.1 or higher. mintTaskScheduler: # Required for Monetization for Apigee hybrid gsa: MINT_TASK_SCHEDULER_SERVICE_ACCOUNT_EMAIL # For example: "apigee-mint-task-scheduler@PROJECT_ID.iam.gserviceaccount.com" # If using message payloads larger than 10MB. # See configure large message payload support: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Gi Tabel berikut menjelaskan setiap nilai properti yang harus Anda berikan dalam file penggantian. Untuk mengetahui informasi selengkapnya, lihat Referensi properti konfigurasi.
Variabel Deskripsi UNIQUE_INSTANCE_
IDENTIFIERString unik untuk mengidentifikasi instance ini. ID dapat berupa kombinasi huruf dan angka hingga 63 karakter.
Anda dapat membuat beberapa organisasi dalam cluster yang sama, tetapi
instanceID
harus sama untuk semua organisasi dalam cluster Kubernetes yang sama.Lihat
instanceID
.APIGEE_NAMESPACE Namespace Kubernetes untuk komponen hybrid Apigee Anda.
Nilai defaultnya adalah
apigee
.Lihat
namespace
.PROJECT_ID Mengidentifikasi project Google Cloud tempat apigee-logger
danapigee-metrics
mengirim data mereka. Ini adalah nilai yang ditetapkan ke variabel lingkunganPROJECT_ID
.Lihat
gcp.projectID
.ANALYTICS_REGION Di GKE, Anda harus menetapkan nilai ini ke region yang sama dengan tempat cluster berjalan. Di semua platform lainnya, pilih wilayah analisis yang paling dekat dengan cluster Anda yang memiliki dukungan Analytics (lihat tabel di Bagian 1, Langkah 2: Buat organisasi). Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
ANALYTICS_REGION
sebelumnya.Lihat
gcp.region
.CLUSTER_NAME Nama cluster Kubernetes Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan CLUSTER_NAME
.Lihat
k8sCluster.name
.CLUSTER_LOCATION Region tempat cluster berjalan. Ini adalah region tempat Anda membuat cluster di Langkah 1: Buat cluster. Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
CLUSTER_LOCATION
sebelumnya.Lihat
k8sCluster.location
.ORG_NAME ID organisasi hybrid Apigee Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan ORG_NAME
.Lihat
org
.CONTROL_PLANE_
LOCATIONWajib diisi jika Anda menggunakan Residensi data dengan penginstalan hybrid Apigee. Ini adalah lokasi tempat konten inti pelanggan seperti paket proxy disimpan. Untuk mengetahui daftarnya, lihat Region bidang kontrol API Apigee yang tersedia. Nilai ini ditetapkan ke variabel lingkungan CONTROL_PLANE_LOCATION
di Langkah 2: Buat organisasi.Lihat
contractProvider
.ENVIRONMENT_NAME Gunakan nama yang sama dengan yang Anda gunakan saat membuat lingkungan di UI, seperti yang dijelaskan dalam Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Lihat
envs[].name
.ENVIRONMENT_GROUP_
NAMENama grup lingkungan tempat lingkungan Anda ditetapkan. Ini adalah grup yang Anda buat di Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Ini adalah nilai yang ditetapkan ke variabel lingkungan ENV_GROUP
.Lihat
virtualhosts[].name
.INGRESS_NAME Nama gateway ingress Apigee untuk deployment Anda. Nama ini dapat berupa nama apa pun yang memenuhi persyaratan berikut: - Memiliki panjang maksimum 17 karakter
- Hanya berisi karakter alfanumerik huruf kecil, '-', atau '.'
- Diawali dengan karakter alfanumerik
- Diakhiri dengan karakter alfanumerik
Lihat:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEMasukkan jalur dan nama file kunci TLS dan sertifikat yang ditandatangani sendiri yang Anda buat sebelumnya di Langkah 6: Buat sertifikat TLS. File ini harus berada di direktori APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Contoh:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Lihat:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opsional). Ini adalah key-value pair yang menyediakan anotasi untuk layanan ingress default Anda. Platform cloud Anda menggunakan anotasi untuk membantu mengonfigurasi penginstalan hybrid, misalnya menyetel jenis load balancer ke internal atau eksternal. Anotasi bervariasi dari satu platform ke platform lainnya. Lihat dokumentasi platform Anda untuk mengetahui anotasi wajib dan yang disarankan.
Beri komentar atau hapus bagian ini jika Anda tidak menggunakannya.
<component>_
SERVICE_ACCOUNT_
EMAILAlamat email akun layanan untuk akun layanan Google (GSA) yang perlu Anda berikan jika Anda menggunakan Workload Identity Federation untuk GKE. Ini adalah akun layanan yang Anda buat di Langkah 4: Buat akun layanan. Anda dapat menemukan alamat email untuk akun layanan dengan perintah berikut: gcloud iam service-accounts list \ --project ${PROJECT_ID} \ --filter "apigee"
Lihat:
Contoh
instanceID: "my_hybrid_example" namespace: "apigee" gcp: projectID: my-project region: us-central1 workloadIdentity: enabled: true k8sCluster: name: hybrid-env region: us-central1 org: my-project enhanceProxyLimits: true contractProvider: https://us-apigee.googleapis.com envs: - name: prod-env gsa: synchronizer: "apigee-synchronizer@my-project.iam.gserviceaccount.com" runtime: "apigee-runtime@my-project.iam.gserviceaccount.com" udca: "apigee-udca@my-project.iam.gserviceaccount.com" cassandra: hostNetwork: false replicaCount: 3 storage: storageSize: 500Gi resources: requests: cpu: 7 memory: 15Gi maxHeapSize: 8192M heapNewSize: 1200M ingressGateways: - name: my-ingress-1 replicaCountMin: 2 replicaCountMax: 10 virtualhosts: - name: example-env-group selector: app: apigee-ingressgateway ingress_name: my-ingress-1 sslCertPath: certs/keystore.pem sslKeyPath: certs/keystore.key mart: gsa: "apigee-mart@my-project.iam.gserviceaccount.com" connectAgent: gsa: "apigee-mart@my-project.iam.gserviceaccount.com" logger: enabled: true gsa: "apigee-logger@my-project.iam.gserviceaccount.com" metrics: gsa: "apigee-metrics@my-project.iam.gserviceaccount.com" udca: gsa: "apigee-udca@my-project.iam.gserviceaccount.com" watcher: gsa: "apigee-watcher@my-project.iam.gserviceaccount.com" # Monetization for Apigee hybrid runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.1" mintTaskScheduler: serviceAccountPath: my-project-apigee-mint-task-scheduler.json" # For message payloads larger than 10MB: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Gi
Tabel berikut menjelaskan setiap nilai properti yang harus Anda berikan dalam file penggantian. Untuk mengetahui informasi selengkapnya, lihat Referensi properti konfigurasi.
Variabel Deskripsi UNIQUE_INSTANCE_
IDENTIFIERString unik untuk mengidentifikasi instance ini. ID dapat berupa kombinasi huruf dan angka hingga 63 karakter.
Anda dapat membuat beberapa organisasi dalam cluster yang sama, tetapi
instanceID
harus sama untuk semua organisasi dalam cluster Kubernetes yang sama.Lihat
instanceID
.APIGEE_NAMESPACE Namespace Kubernetes untuk komponen hybrid Apigee Anda.
Nilai defaultnya adalah
apigee
.Lihat
namespace
.PROJECT_ID Mengidentifikasi project Google Cloud tempat apigee-logger
danapigee-metrics
mengirim data mereka. Ini adalah nilai yang ditetapkan ke variabel lingkunganPROJECT_ID
.Lihat
gcp.projectID
.ANALYTICS_REGION Di GKE, Anda harus menetapkan nilai ini ke region yang sama dengan tempat cluster berjalan. Di semua platform lainnya, pilih wilayah analisis yang paling dekat dengan cluster Anda yang memiliki dukungan Analytics (lihat tabel di Bagian 1, Langkah 2: Buat organisasi). Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
ANALYTICS_REGION
sebelumnya.Lihat
gcp.region
.CLUSTER_NAME Nama cluster Kubernetes Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan CLUSTER_NAME
.Lihat
k8sCluster.name
.CLUSTER_LOCATION Region tempat cluster berjalan. Ini adalah region tempat Anda membuat cluster di Langkah 1: Buat cluster. Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
CLUSTER_LOCATION
sebelumnya.Lihat
k8sCluster.location
.ORG_NAME ID organisasi hybrid Apigee Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan ORG_NAME
.Lihat
org
.CONTROL_PLANE_
LOCATIONWajib diisi jika Anda menggunakan Residensi data dengan penginstalan hybrid Apigee. Ini adalah lokasi tempat konten inti pelanggan seperti paket proxy disimpan. Untuk mengetahui daftarnya, lihat Region bidang kontrol API Apigee yang tersedia. Nilai ini ditetapkan ke variabel lingkungan CONTROL_PLANE_LOCATION
di Langkah 2: Buat organisasi.Lihat
contractProvider
.ENVIRONMENT_NAME Gunakan nama yang sama dengan yang Anda gunakan saat membuat lingkungan di UI, seperti yang dijelaskan dalam Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Lihat
envs[].name
.ENVIRONMENT_GROUP_
NAMENama grup lingkungan tempat lingkungan Anda ditetapkan. Ini adalah grup yang Anda buat di Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Ini adalah nilai yang ditetapkan ke variabel lingkungan ENV_GROUP
.Lihat
virtualhosts[].name
.INGRESS_NAME Nama gateway ingress Apigee untuk deployment Anda. Nama ini dapat berupa nama apa pun yang memenuhi persyaratan berikut: - Memiliki panjang maksimum 17 karakter
- Hanya berisi karakter alfanumerik huruf kecil, '-', atau '.'
- Diawali dengan karakter alfanumerik
- Diakhiri dengan karakter alfanumerik
Lihat:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEMasukkan jalur dan nama file kunci TLS dan sertifikat yang ditandatangani sendiri yang Anda buat sebelumnya di Langkah 6: Buat sertifikat TLS. File ini harus berada di direktori APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Contoh:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Lihat:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opsional). Ini adalah key-value pair yang menyediakan anotasi untuk layanan ingress default Anda. Platform cloud Anda menggunakan anotasi untuk membantu mengonfigurasi penginstalan hybrid, misalnya menyetel jenis load balancer ke internal atau eksternal. Anotasi bervariasi dari satu platform ke platform lainnya. Lihat dokumentasi platform Anda untuk mengetahui anotasi wajib dan yang disarankan.
Beri komentar atau hapus bagian ini jika Anda tidak menggunakannya.
<component>_
SERVICE_ACCOUNT_
EMAILAlamat email akun layanan untuk akun layanan Google (GSA) yang perlu Anda berikan jika Anda menggunakan Workload Identity Federation untuk GKE. Ini adalah akun layanan yang Anda buat di Langkah 4: Buat akun layanan. Anda dapat menemukan alamat email untuk akun layanan dengan perintah berikut: gcloud iam service-accounts list \ --project ${PROJECT_ID} \ --filter "apigee"
Lihat:
Non-prod
Template
Nilai dalam red, bold italics adalah nilai properti yang harus Anda berikan. Anda dapat mengedit nilainya di halaman ini. Objek ini dijelaskan dalam tabel di bawah.
instanceID: UNIQUE_INSTANCE_IDENTIFIER namespace: APIGEE_NAMESPACE # Usually "apigee" gcp: projectID: PROJECT_ID region: ANALYTICS_REGION workloadIdentity: enabled: true gsa: "NON_PROD_SERVICE_ACCOUNT_EMAIL" # For example: "apigee-non-prod@PROJECT_ID.iam.gserviceaccount.com" k8sCluster: name: CLUSTER_NAME region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster. org: ORG_NAME # Required for Enhanced per-environment proxy limits: enhanceProxyLimits: true # Required if using data residency with hybrid: contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com envs: - name: ENVIRONMENT_NAME cassandra: hostNetwork: false # Set to false for single region installations and for multi-region # installations with connectivity between pods in different clusters, # like GKE. # Set to true for multi-region installations with no communication # between pods in different clusters, for example Google Distributed # Cloud on VMware or bare metal, GKE on AWS, AKS, EKS, and OpenShift. # See Multi-region deployment: Prerequisites replicaCount:
1 # Use 1 for non-prod installations and multiples of 3 for production. # See Configure Cassandra for production for guidelines. ingressGateways: - name: INGRESS_NAME # maximum 17 characters. replicaCountMin: 2 replicaCountMax: 10 svcAnnotations: # optional. If you are on AKS, see Known issue #260772383 SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE virtualhosts: - name: ENVIRONMENT_GROUP_NAME selector: app: apigee-ingressgateway ingress_name: INGRESS_NAME sslCertPath: PATH_TO_CERT_FILE sslKeyPath: PATH_TO_KEY_FILE logger: enabled: true # enabled by default # See apigee-logger in Service accounts and roles used by hybrid components. # Required if using Monetization for Apigee hybrid (v1.15.1 and later) runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.1" # Must be 1.15.1 or higher. # If using message payloads larger than 10MB. # See configure large message payload support: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Gi Tabel berikut menjelaskan setiap nilai properti yang harus Anda berikan dalam file penggantian. Untuk mengetahui informasi selengkapnya, lihat Referensi properti konfigurasi.
Variabel Deskripsi UNIQUE_INSTANCE_
IDENTIFIERString unik untuk mengidentifikasi instance ini. ID dapat berupa kombinasi huruf dan angka hingga 63 karakter.
Anda dapat membuat beberapa organisasi dalam cluster yang sama, tetapi
instanceID
harus sama untuk semua organisasi dalam cluster Kubernetes yang sama.Lihat
instanceID
.APIGEE_NAMESPACE Namespace Kubernetes untuk komponen hybrid Apigee Anda.
Nilai defaultnya adalah
apigee
.Lihat
namespace
.PROJECT_ID Mengidentifikasi project Google Cloud tempat apigee-logger
danapigee-metrics
mengirim data mereka. Ini adalah nilai yang ditetapkan ke variabel lingkunganPROJECT_ID
.Lihat
gcp.projectID
.ANALYTICS_REGION Di GKE, Anda harus menetapkan nilai ini ke region yang sama dengan tempat cluster berjalan. Di semua platform lainnya, pilih wilayah analisis yang paling dekat dengan cluster Anda yang memiliki dukungan Analytics (lihat tabel di Bagian 1, Langkah 2: Buat organisasi). Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
ANALYTICS_REGION
sebelumnya.Lihat
gcp.region
.NON_PROD_
SERVICE_ACCOUNT_
EMAILAlamat email akun layanan untuk akun layanan Google (GSA) non-prod. Ini adalah akun layanan apigee-non-prod
yang Anda buat di Langkah 4: Buat akun layanan.Jika Anda menggunakan Workload Identity Federation untuk GKE dalam penginstalan non-prod, tentukan alamat email akun layanan untuk properti
gcp.workloadIdentity.gsa
. Anda tidak perlu menambahkan propertigsa
untuk setiap komponen.Anda dapat menemukan alamat email untuk akun layanan dengan perintah berikut:
gcloud iam service-accounts list \ --project ${PROJECT_ID} \ --filter "apigee"
Lihat
gcp.workloadIdentity.gsa
.CLUSTER_NAME Nama cluster Kubernetes Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan CLUSTER_NAME
.Lihat
k8sCluster.name
.CLUSTER_LOCATION Region tempat cluster berjalan. Ini adalah region tempat Anda membuat cluster di Langkah 1: Buat cluster. Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
CLUSTER_LOCATION
sebelumnya.Lihat
k8sCluster.location
.ORG_NAME ID organisasi hybrid Apigee Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan ORG_NAME
.Lihat
org
.CONTROL_PLANE_
LOCATIONWajib diisi jika Anda menggunakan Residensi data dengan penginstalan hybrid Apigee. Ini adalah lokasi tempat konten inti pelanggan seperti paket proxy disimpan. Untuk mengetahui daftarnya, lihat Region bidang kontrol API Apigee yang tersedia. Nilai ini ditetapkan ke variabel lingkungan CONTROL_PLANE_LOCATION
di Langkah 2: Buat organisasi.Lihat
contractProvider
.ENVIRONMENT_NAME Gunakan nama yang sama dengan yang Anda gunakan saat membuat lingkungan di UI, seperti yang dijelaskan dalam Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Lihat
envs[].name
.ENVIRONMENT_GROUP_
NAMENama grup lingkungan tempat lingkungan Anda ditetapkan. Ini adalah grup yang Anda buat di Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Ini adalah nilai yang ditetapkan ke variabel lingkungan ENV_GROUP
.Lihat
virtualhosts[].name
.INGRESS_NAME Nama gateway ingress Apigee untuk deployment Anda. Nama ini dapat berupa nama apa pun yang memenuhi persyaratan berikut: - Memiliki panjang maksimum 17 karakter
- Hanya berisi karakter alfanumerik huruf kecil, '-', atau '.'
- Diawali dengan karakter alfanumerik
- Diakhiri dengan karakter alfanumerik
Lihat:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEMasukkan jalur dan nama file kunci TLS dan sertifikat yang ditandatangani sendiri yang Anda buat sebelumnya di Langkah 6: Buat sertifikat TLS. File ini harus berada di direktori APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Contoh:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Lihat:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opsional). Ini adalah key-value pair yang menyediakan anotasi untuk layanan ingress default Anda. Platform cloud Anda menggunakan anotasi untuk membantu mengonfigurasi penginstalan hybrid, misalnya menyetel jenis load balancer ke internal atau eksternal. Anotasi bervariasi dari satu platform ke platform lainnya. Lihat dokumentasi platform Anda untuk mengetahui anotasi wajib dan yang disarankan.
Beri komentar atau hapus bagian ini jika Anda tidak menggunakannya.
Contoh
instanceID: "my_hybrid_example" namespace: "apigee" gcp: projectID: my-project region: us-central1 workloadIdentity: enabled: true gsa: "apigee-non-prod@my-project.iam.gserviceaccount.com" k8sCluster: name: hybrid-env region: us-central1 org: my-project enhanceProxyLimits: true contractProvider: https://us-apigee.googleapis.com envs: - name: test cassandra: hostNetwork: false replicaCount: 1 ingressGateways: - name: my-ingress-1 replicaCountMin: 2 replicaCountMax: 10 virtualhosts: - name: example-env-group selector: app: apigee-ingressgateway ingress_name: my-ingress-1 sslCertPath: certs/keystore.pem sslKeyPath: certs/keystore.key logger: enabled: true # Monetization for Apigee hybrid runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.1" # For message payloads larger than 10MB: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Gi
Tabel berikut menjelaskan setiap nilai properti yang harus Anda berikan dalam file penggantian. Untuk mengetahui informasi selengkapnya, lihat Referensi properti konfigurasi.
Variabel Deskripsi UNIQUE_INSTANCE_
IDENTIFIERString unik untuk mengidentifikasi instance ini. ID dapat berupa kombinasi huruf dan angka hingga 63 karakter.
Anda dapat membuat beberapa organisasi dalam cluster yang sama, tetapi
instanceID
harus sama untuk semua organisasi dalam cluster Kubernetes yang sama.Lihat
instanceID
.APIGEE_NAMESPACE Namespace Kubernetes untuk komponen hybrid Apigee Anda.
Nilai defaultnya adalah
apigee
.Lihat
namespace
.PROJECT_ID Mengidentifikasi project Google Cloud tempat apigee-logger
danapigee-metrics
mengirim data mereka. Ini adalah nilai yang ditetapkan ke variabel lingkunganPROJECT_ID
.Lihat
gcp.projectID
.ANALYTICS_REGION Di GKE, Anda harus menetapkan nilai ini ke region yang sama dengan tempat cluster berjalan. Di semua platform lainnya, pilih wilayah analisis yang paling dekat dengan cluster Anda yang memiliki dukungan Analytics (lihat tabel di Bagian 1, Langkah 2: Buat organisasi). Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
ANALYTICS_REGION
sebelumnya.Lihat
gcp.region
.NON_PROD_
SERVICE_ACCOUNT_
EMAILAlamat email akun layanan untuk akun layanan Google (GSA) non-prod. Ini adalah akun layanan apigee-non-prod
yang Anda buat di Langkah 4: Buat akun layanan.Jika Anda menggunakan Workload Identity Federation untuk GKE dalam penginstalan non-prod, tentukan alamat email akun layanan untuk properti
gcp.workloadIdentity.gsa
. Anda tidak perlu menambahkan propertigsa
untuk setiap komponen.Anda dapat menemukan alamat email untuk akun layanan dengan perintah berikut:
gcloud iam service-accounts list \ --project ${PROJECT_ID} \ --filter "apigee"
Lihat
gcp.workloadIdentity.gsa
.CLUSTER_NAME Nama cluster Kubernetes Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan CLUSTER_NAME
.Lihat
k8sCluster.name
.CLUSTER_LOCATION Region tempat cluster berjalan. Ini adalah region tempat Anda membuat cluster di Langkah 1: Buat cluster. Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
CLUSTER_LOCATION
sebelumnya.Lihat
k8sCluster.location
.ORG_NAME ID organisasi hybrid Apigee Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan ORG_NAME
.Lihat
org
.CONTROL_PLANE_
LOCATIONWajib diisi jika Anda menggunakan Residensi data dengan penginstalan hybrid Apigee. Ini adalah lokasi tempat konten inti pelanggan seperti paket proxy disimpan. Untuk mengetahui daftarnya, lihat Region bidang kontrol API Apigee yang tersedia. Nilai ini ditetapkan ke variabel lingkungan CONTROL_PLANE_LOCATION
di Langkah 2: Buat organisasi.Lihat
contractProvider
.ENVIRONMENT_NAME Gunakan nama yang sama dengan yang Anda gunakan saat membuat lingkungan di UI, seperti yang dijelaskan dalam Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Lihat
envs[].name
.ENVIRONMENT_GROUP_
NAMENama grup lingkungan tempat lingkungan Anda ditetapkan. Ini adalah grup yang Anda buat di Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Ini adalah nilai yang ditetapkan ke variabel lingkungan ENV_GROUP
.Lihat
virtualhosts[].name
.INGRESS_NAME Nama gateway ingress Apigee untuk deployment Anda. Nama ini dapat berupa nama apa pun yang memenuhi persyaratan berikut: - Memiliki panjang maksimum 17 karakter
- Hanya berisi karakter alfanumerik huruf kecil, '-', atau '.'
- Diawali dengan karakter alfanumerik
- Diakhiri dengan karakter alfanumerik
Lihat:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEMasukkan jalur dan nama file kunci TLS dan sertifikat yang ditandatangani sendiri yang Anda buat sebelumnya di Langkah 6: Buat sertifikat TLS. File ini harus berada di direktori APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Contoh:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Lihat:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opsional). Ini adalah key-value pair yang menyediakan anotasi untuk layanan ingress default Anda. Platform cloud Anda menggunakan anotasi untuk membantu mengonfigurasi penginstalan hybrid, misalnya menyetel jenis load balancer ke internal atau eksternal. Anotasi bervariasi dari satu platform ke platform lainnya. Lihat dokumentasi platform Anda untuk mengetahui anotasi wajib dan yang disarankan.
Beri komentar atau hapus bagian ini jika Anda tidak menggunakannya.
WIF di platform lain
WIF: rahasia
Produksi
Template
Nilai dalam red, bold italics adalah nilai properti yang harus Anda berikan. Anda dapat mengedit nilainya di halaman ini. Objek ini dijelaskan dalam tabel di bawah.
instanceID: UNIQUE_INSTANCE_IDENTIFIER namespace: APIGEE_NAMESPACE # Usually "apigee" gcp: projectID: PROJECT_ID region: ANALYTICS_REGION workloadIdentity: enabled: false # Must be set to false to use # Workload Identity Federation on other platforms. federatedWorkloadIdentity: enabled: true audience: "AUDIENCE" credentialSourceFile: "/var/run/service-account/token" k8sCluster: name: CLUSTER_NAME region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster. org: ORG_NAME # Required for Enhanced per-environment proxy limits: enhanceProxyLimits: true # Required if using data residency with hybrid: contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com envs: - name: ENVIRONMENT_NAME serviceAccountSecretRefs: synchronizer: SYNCHRONIZER_WORKLOAD_IDENTITY_SECRET # For example: "synchronizer-workload-identity-secret" runtime: RUNTIME_WORKLOAD_IDENTITY_SECRET # For example: "runtime-workload-identity-secret" udca: UDCA_WORKLOAD_IDENTITY_SECRET # For example: "udca-workload-identity-secret" cassandra: hostNetwork: false # Set to false for single region installations and for multi-region # installations with connectivity between pods in different clusters, # like GKE. # Set to true for multi-region installations with no communication # between pods in different clusters, for example Google Distributed # Cloud on VMware or bare metal, GKE on AWS, AKS, EKS, and OpenShift. # See Multi-region deployment: Prerequisites replicaCount:
3 # Use multiples of 3 for production. # See Configure Cassandra for production for guidelines. storage: storageSize: 500Gi resources: requests: cpu: 7 memory: 15Gi maxHeapSize: 8192M heapNewSize: 1200M # Minimum storage requirements for a production environment. # See Configure Cassandra for production. ingressGateways: - name: INGRESS_NAME # maximum 17 characters. replicaCountMin: 2 replicaCountMax: 10 svcAnnotations: # optional. If you are on AKS, see Known issue #260772383 SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE virtualhosts: - name: ENVIRONMENT_GROUP_NAME selector: app: apigee-ingressgateway ingress_name: INGRESS_NAME sslCertPath: PATH_TO_CERT_FILE sslKeyPath: PATH_TO_KEY_FILE mart: serviceAccountPath: MART_WORKLOAD_IDENTITY_SECRET # For example: "mart-workload-identity-secret" connectAgent: serviceAccountPath: MART_WORKLOAD_IDENTITY_SECRET # Use the same secret for mart and connectAgent # For example: "mart-workload-identity-secret" logger: enabled: false # apigee-logger does not support Workload Identity Federation. # See Known issue #341099433. # If you want to enable the apigee-logger component, create a # Kubernetes secret for apigee-logger by following the steps # under Kubernetes secrets in # Step 5: Set up service account authentication. # Provide a reference to the secret with the # logger.serviceAccountRef property. metrics: serviceAccountPath: METRICS_WORKLOAD_IDENTITY_SECRET # For example: "metrics-workload-identity-secret" udca: serviceAccountPath: UDCA_WORKLOAD_IDENTITY_SECRET # For example: "udca-workload-identity-secret" watcher: serviceAccountPath: WATCHER_WORKLOAD_IDENTITY_SECRET # For example: "watcher-workload-identity-secret" # Required if using Monetization for Apigee hybrid (v1.15.1 and later) runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.1" # Must be 1.15.1 or higher. mintTaskScheduler: # Required for Monetization for Apigee hybrid serviceAccountRef: MINT_TASK_SCHEDULER_WORKLOAD_IDENTITY_SECRET # For example: "apigee-mint-task-scheduler-workload-identity-secret" # If using message payloads larger than 10MB. # See configure large message payload support: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Gi Tabel berikut menjelaskan setiap nilai properti yang harus Anda berikan dalam file penggantian. Untuk mengetahui informasi selengkapnya, lihat Referensi properti konfigurasi.
Variabel Deskripsi UNIQUE_INSTANCE_
IDENTIFIERString unik untuk mengidentifikasi instance ini. ID dapat berupa kombinasi huruf dan angka hingga 63 karakter.
Anda dapat membuat beberapa organisasi dalam cluster yang sama, tetapi
instanceID
harus sama untuk semua organisasi dalam cluster Kubernetes yang sama.Lihat
instanceID
.APIGEE_NAMESPACE Namespace Kubernetes untuk komponen hybrid Apigee Anda.
Nilai defaultnya adalah
apigee
.Lihat
namespace
.PROJECT_ID Mengidentifikasi project Google Cloud tempat apigee-logger
danapigee-metrics
mengirim data mereka. Ini adalah nilai yang ditetapkan ke variabel lingkunganPROJECT_ID
.Lihat
gcp.projectID
.ANALYTICS_REGION Di GKE, Anda harus menetapkan nilai ini ke region yang sama dengan tempat cluster berjalan. Di semua platform lainnya, pilih wilayah analisis yang paling dekat dengan cluster Anda yang memiliki dukungan Analytics (lihat tabel di Bagian 1, Langkah 2: Buat organisasi). Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
ANALYTICS_REGION
sebelumnya.Lihat
gcp.region
.AUDIENCE Audiens yang diizinkan dari Penyedia Workload Identity. Anda dapat menemukan nilai tersebut dengan menelusuri file konfigurasi kredensial untuk istilah audience:
. Nilai audiens sama di setiap file konfigurasi kredensial.Misalnya, dalam contoh file
apigee-udca-credential-configuration.json
berikut:{ "universe_domain": "googleapis.com", "type": "external_account:," "audience": "AUDIENCE", "subject_token_type": "TOKEN_TYPE", "token_url": "TOKEN_URL", "service "impersonation_url": "IMPERSONATION_URL", "credential_source": { "file": "FILE_PATH", "format": { "type": "text" } } }
Nilai audiens akan terlihat seperti berikut (tanpa jeda baris):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"
CLUSTER_NAME Nama cluster Kubernetes Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan CLUSTER_NAME
.Lihat
k8sCluster.name
.CLUSTER_LOCATION Region tempat cluster berjalan. Ini adalah region tempat Anda membuat cluster di Langkah 1: Buat cluster. Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
CLUSTER_LOCATION
sebelumnya.Lihat
k8sCluster.location
.ORG_NAME ID organisasi hybrid Apigee Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan ORG_NAME
.Lihat
org
.CONTROL_PLANE_
LOCATIONWajib diisi jika Anda menggunakan Residensi data dengan penginstalan hybrid Apigee. Ini adalah lokasi tempat konten inti pelanggan seperti paket proxy disimpan. Untuk mengetahui daftarnya, lihat Region bidang kontrol API Apigee yang tersedia. Nilai ini ditetapkan ke variabel lingkungan CONTROL_PLANE_LOCATION
di Langkah 2: Buat organisasi.Lihat
contractProvider
.ENVIRONMENT_NAME Gunakan nama yang sama dengan yang Anda gunakan saat membuat lingkungan di UI, seperti yang dijelaskan dalam Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Lihat
envs[].name
.ENVIRONMENT_GROUP_
NAMENama grup lingkungan tempat lingkungan Anda ditetapkan. Ini adalah grup yang Anda buat di Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Ini adalah nilai yang ditetapkan ke variabel lingkungan ENV_GROUP
.Lihat
virtualhosts[].name
.INGRESS_NAME Nama gateway ingress Apigee untuk deployment Anda. Nama ini dapat berupa nama apa pun yang memenuhi persyaratan berikut: - Memiliki panjang maksimum 17 karakter
- Hanya berisi karakter alfanumerik huruf kecil, '-', atau '.'
- Diawali dengan karakter alfanumerik
- Diakhiri dengan karakter alfanumerik
Lihat:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEMasukkan jalur dan nama file kunci TLS dan sertifikat yang ditandatangani sendiri yang Anda buat sebelumnya di Langkah 6: Buat sertifikat TLS. File ini harus berada di direktori APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Contoh:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Lihat:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opsional). Ini adalah key-value pair yang menyediakan anotasi untuk layanan ingress default Anda. Platform cloud Anda menggunakan anotasi untuk membantu mengonfigurasi penginstalan hybrid, misalnya menyetel jenis load balancer ke internal atau eksternal. Anotasi bervariasi dari satu platform ke platform lainnya. Lihat dokumentasi platform Anda untuk mengetahui anotasi wajib dan yang disarankan.
Beri komentar atau hapus bagian ini jika Anda tidak menggunakannya.
<component>_
WORKLOAD_IDENTITY_
SECRETNama secret Kubernetes yang Anda buat untuk konfigurasi kredensial akun layanan di Langkah 5: Siapkan autentikasi akun layanan. Nama default secret yang disarankan dalam panduan ini adalah:
Produksi
cassandra-workload-identity-secret
logger-workload-identity-secret
mart-workload-identity-secret
metrics-workload-identity-secret
mint-task-scheduler-workload-identity-secret
runtime-workload-identity-secret
synchronizer-workload-identity-secret
udca-workload-identity-secret
watcher-workload-identity-secret
Non-prod
non-prod-workload-identity-secret
Lihat:
-
envs[].serviceAccountSecretRefs.synchronizer
. -
envs[].serviceAccountSecretRefs.runtime
. -
envs[].serviceAccountSecretRefs.udca
. -
logger.serviceAccountRef
. -
connectAgent.serviceAccountRef
. -
mart.serviceAccountRef
. -
metrics.serviceAccountRef
. -
mintTaskScheduler.serviceAccountRef
. -
udca.serviceAccountRef
. -
watcher.serviceAccountRef
.
Contoh
instanceID: "my_hybrid_example" namespace: "apigee" gcp: projectID: my-project region: us-central1 workloadIdentity: enabled: false federatedWorkloadIdentity: enabled: true audience: "//iam.googleapis.com/projects/123123123123/locations/global/workloadIdentityPools/my-wi-pool/providers/my-wi-provider" credentialSourceFile: "/var/run/service-account/token" k8sCluster: name: hybrid-env region: us-central1 org: my-project enhanceProxyLimits: true contractProvider: https://us-apigee.googleapis.com envs: - name: prod-env serviceAccountSecretRefs: synchronizer: "synchronizer-workload-identity-secret" runtime: "runtime-workload-identity-secret" udca: "udca-workload-identity-secret" cassandra: hostNetwork: false replicaCount: 3 storage: storageSize: 500Gi resources: requests: cpu: 7 memory: 15Gi maxHeapSize: 8192M heapNewSize: 1200M ingressGateways: - name: my-ingress-1 replicaCountMin: 2 replicaCountMax: 10 virtualhosts: - name: example-env-group selector: app: apigee-ingressgateway ingress_name: my-ingress-1 sslCertPath: certs/keystore.pem sslKeyPath: certs/keystore.key mart: serviceAccountRef: "mart-workload-identity-secret" connectAgent: serviceAccountRef: "mart-workload-identity-secret" logger: enabled: false metrics: serviceAccountRef: "metrics-workload-identity-secret" udca: serviceAccountRef: "udca-workload-identity-secret" watcher: serviceAccountRef: "watcher-workload-identity-secret" # Monetization for Apigee hybrid runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.1" mintTaskScheduler: serviceAccountRef: "apigee-mint-task-scheduler-workload-identity-secret" # For message payloads larger than 10MB: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Gi
Tabel berikut menjelaskan setiap nilai properti yang harus Anda berikan dalam file penggantian. Untuk mengetahui informasi selengkapnya, lihat Referensi properti konfigurasi.
Variabel Deskripsi UNIQUE_INSTANCE_
IDENTIFIERString unik untuk mengidentifikasi instance ini. ID dapat berupa kombinasi huruf dan angka hingga 63 karakter.
Anda dapat membuat beberapa organisasi dalam cluster yang sama, tetapi
instanceID
harus sama untuk semua organisasi dalam cluster Kubernetes yang sama.Lihat
instanceID
.APIGEE_NAMESPACE Namespace Kubernetes untuk komponen hybrid Apigee Anda.
Nilai defaultnya adalah
apigee
.Lihat
namespace
.PROJECT_ID Mengidentifikasi project Google Cloud tempat apigee-logger
danapigee-metrics
mengirim data mereka. Ini adalah nilai yang ditetapkan ke variabel lingkunganPROJECT_ID
.Lihat
gcp.projectID
.ANALYTICS_REGION Di GKE, Anda harus menetapkan nilai ini ke region yang sama dengan tempat cluster berjalan. Di semua platform lainnya, pilih wilayah analisis yang paling dekat dengan cluster Anda yang memiliki dukungan Analytics (lihat tabel di Bagian 1, Langkah 2: Buat organisasi). Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
ANALYTICS_REGION
sebelumnya.Lihat
gcp.region
.AUDIENCE Audiens yang diizinkan dari Penyedia Workload Identity. Anda dapat menemukan nilai tersebut dengan menelusuri file konfigurasi kredensial untuk istilah audience:
. Nilai audiens sama di setiap file konfigurasi kredensial.Misalnya, dalam contoh file
apigee-udca-credential-configuration.json
berikut:{ "universe_domain": "googleapis.com", "type": "external_account:," "audience": "AUDIENCE", "subject_token_type": "TOKEN_TYPE", "token_url": "TOKEN_URL", "service "impersonation_url": "IMPERSONATION_URL", "credential_source": { "file": "FILE_PATH", "format": { "type": "text" } } }
Nilai audiens akan terlihat seperti berikut (tanpa jeda baris):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"
CLUSTER_NAME Nama cluster Kubernetes Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan CLUSTER_NAME
.Lihat
k8sCluster.name
.CLUSTER_LOCATION Region tempat cluster berjalan. Ini adalah region tempat Anda membuat cluster di Langkah 1: Buat cluster. Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
CLUSTER_LOCATION
sebelumnya.Lihat
k8sCluster.location
.ORG_NAME ID organisasi hybrid Apigee Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan ORG_NAME
.Lihat
org
.CONTROL_PLANE_
LOCATIONWajib diisi jika Anda menggunakan Residensi data dengan penginstalan hybrid Apigee. Ini adalah lokasi tempat konten inti pelanggan seperti paket proxy disimpan. Untuk mengetahui daftarnya, lihat Region bidang kontrol API Apigee yang tersedia. Nilai ini ditetapkan ke variabel lingkungan CONTROL_PLANE_LOCATION
di Langkah 2: Buat organisasi.Lihat
contractProvider
.ENVIRONMENT_NAME Gunakan nama yang sama dengan yang Anda gunakan saat membuat lingkungan di UI, seperti yang dijelaskan dalam Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Lihat
envs[].name
.ENVIRONMENT_GROUP_
NAMENama grup lingkungan tempat lingkungan Anda ditetapkan. Ini adalah grup yang Anda buat di Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Ini adalah nilai yang ditetapkan ke variabel lingkungan ENV_GROUP
.Lihat
virtualhosts[].name
.INGRESS_NAME Nama gateway ingress Apigee untuk deployment Anda. Nama ini dapat berupa nama apa pun yang memenuhi persyaratan berikut: - Memiliki panjang maksimum 17 karakter
- Hanya berisi karakter alfanumerik huruf kecil, '-', atau '.'
- Diawali dengan karakter alfanumerik
- Diakhiri dengan karakter alfanumerik
Lihat:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEMasukkan jalur dan nama file kunci TLS dan sertifikat yang ditandatangani sendiri yang Anda buat sebelumnya di Langkah 6: Buat sertifikat TLS. File ini harus berada di direktori APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Contoh:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Lihat:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opsional). Ini adalah key-value pair yang menyediakan anotasi untuk layanan ingress default Anda. Platform cloud Anda menggunakan anotasi untuk membantu mengonfigurasi penginstalan hybrid, misalnya menyetel jenis load balancer ke internal atau eksternal. Anotasi bervariasi dari satu platform ke platform lainnya. Lihat dokumentasi platform Anda untuk mengetahui anotasi wajib dan yang disarankan.
Beri komentar atau hapus bagian ini jika Anda tidak menggunakannya.
<component>_
WORKLOAD_IDENTITY_
SECRETNama secret Kubernetes yang Anda buat untuk konfigurasi kredensial akun layanan di Langkah 5: Siapkan autentikasi akun layanan. Nama default secret yang disarankan dalam panduan ini adalah:
Produksi
cassandra-workload-identity-secret
logger-workload-identity-secret
mart-workload-identity-secret
metrics-workload-identity-secret
mint-task-scheduler-workload-identity-secret
runtime-workload-identity-secret
synchronizer-workload-identity-secret
udca-workload-identity-secret
watcher-workload-identity-secret
Non-prod
non-prod-workload-identity-secret
Lihat:
-
envs[].serviceAccountSecretRefs.synchronizer
. -
envs[].serviceAccountSecretRefs.runtime
. -
envs[].serviceAccountSecretRefs.udca
. -
logger.serviceAccountRef
. -
connectAgent.serviceAccountRef
. -
mart.serviceAccountRef
. -
metrics.serviceAccountRef
. -
mintTaskScheduler.serviceAccountRef
. -
udca.serviceAccountRef
. -
watcher.serviceAccountRef
.
Non-prod
Template
Nilai dalam red, bold italics adalah nilai properti yang harus Anda berikan. Anda dapat mengedit nilainya di halaman ini. Objek ini dijelaskan dalam tabel di bawah.
instanceID: UNIQUE_INSTANCE_IDENTIFIER namespace: APIGEE_NAMESPACE # Usually "apigee" gcp: projectID: PROJECT_ID region: ANALYTICS_REGION workloadIdentity: enabled: false # Must be set to false to use # Workload Identity Federation on other platforms. federatedWorkloadIdentity: enabled: true audience: "AUDIENCE" credentialSourceFile: "/var/run/service-account/token" k8sCluster: name: CLUSTER_NAME region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster. org: ORG_NAME # Required for Enhanced per-environment proxy limits: enhanceProxyLimits: true # Required if using data residency with hybrid: contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com envs: - name: ENVIRONMENT_NAME serviceAccountSecretRefs: synchronizer: NON_PROD_WORKLOAD_IDENTITY_SECRET # For example: "non-prod-workload-identity-secret" runtime: NON_PROD_WORKLOAD_IDENTITY_SECRET # For example: "non-prod-workload-identity-secret" udca: NON_PROD_WORKLOAD_IDENTITY_SECRET # For example: "non-prod-workload-identity-secret" cassandra: hostNetwork: false # Set to false for single region installations and for multi-region # installations with connectivity between pods in different clusters, # like GKE. # Set to true for multi-region installations with no communication # between pods in different clusters, for example Google Distributed # Cloud on VMware or bare metal, GKE on AWS, AKS, EKS, and OpenShift. # See Multi-region deployment: Prerequisites replicaCount: 1 # Use 1 for non-prod installations and multiples of 3 for production. # See Configure Cassandra for production for guidelines. ingressGateways: - name: INGRESS_NAME # maximum 17 characters. replicaCountMin: 2 replicaCountMax: 10 svcAnnotations: # optional. If you are on AKS, see Known issue #260772383 SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE virtualhosts: - name: ENVIRONMENT_GROUP_NAME selector: app: apigee-ingressgateway ingress_name: INGRESS_NAME sslCertPath: PATH_TO_CERT_FILE sslKeyPath: PATH_TO_KEY_FILE mart: serviceAccountRef: NON_PROD_WORKLOAD_IDENTITY_SECRET # For example: "non-prod-workload-identity-secret" connectAgent: serviceAccountRef: NON_PROD_WORKLOAD_IDENTITY_SECRET # Use the same secret for mart and connectAgent # For example: "non-prod-workload-identity-secret" logger: enabled: false # apigee-logger does not support Workload Identity Federation. # See Known issue #341099433. # If you want to enable the apigee-logger component, create a # Kubernetes secret for apigee-logger by following the steps # under Kubernetes secrets in # Step 5: Set up service account authentication. # Provide a reference to the secret with the # logger.serviceAccountRef property. metrics: serviceAccountRef: NON_PROD_WORKLOAD_IDENTITY_SECRET # For example: "non-prod-workload-identity-secret" udca: serviceAccountRef: NON_PROD_WORKLOAD_IDENTITY_SECRET # For example: "non-prod-workload-identity-secret" watcher: serviceAccountRef: NON_PROD_WORKLOAD_IDENTITY_SECRET # For example: "non-prod-workload-identity-secret" # Required if using Monetization for Apigee hybrid (v1.15.1 and later) runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.1" # Must be 1.15.1 or higher. mintTaskScheduler: # Required for Monetization for Apigee hybrid serviceAccountRef: NON_PROD_WORKLOAD_IDENTITY_SECRET # For example: "non-prod-workload-identity-secret" # If using message payloads larger than 10MB. # See configure large message payload support: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Gi
Tabel berikut menjelaskan setiap nilai properti yang harus Anda berikan dalam file penggantian. Untuk mengetahui informasi selengkapnya, lihat Referensi properti konfigurasi.
Variabel Deskripsi UNIQUE_INSTANCE_
IDENTIFIERString unik untuk mengidentifikasi instance ini. ID dapat berupa kombinasi huruf dan angka hingga 63 karakter.
Anda dapat membuat beberapa organisasi dalam cluster yang sama, tetapi
instanceID
harus sama untuk semua organisasi dalam cluster Kubernetes yang sama.Lihat
instanceID
.APIGEE_NAMESPACE Namespace Kubernetes untuk komponen hybrid Apigee Anda.
Nilai defaultnya adalah
apigee
.Lihat
namespace
.PROJECT_ID Mengidentifikasi project Google Cloud tempat apigee-logger
danapigee-metrics
mengirim data mereka. Ini adalah nilai yang ditetapkan ke variabel lingkunganPROJECT_ID
.Lihat
gcp.projectID
.ANALYTICS_REGION Di GKE, Anda harus menetapkan nilai ini ke region yang sama dengan tempat cluster berjalan. Di semua platform lainnya, pilih wilayah analisis yang paling dekat dengan cluster Anda yang memiliki dukungan Analytics (lihat tabel di Bagian 1, Langkah 2: Buat organisasi). Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
ANALYTICS_REGION
sebelumnya.Lihat
gcp.region
.AUDIENCE Audiens yang diizinkan dari Penyedia Workload Identity. Anda dapat menemukan nilai tersebut dengan menelusuri file konfigurasi kredensial untuk istilah audience:
. Nilai audiens sama di setiap file konfigurasi kredensial.Misalnya, dalam contoh file
apigee-udca-credential-configuration.json
berikut:{ "universe_domain": "googleapis.com", "type": "external_account:," "audience": "AUDIENCE", "subject_token_type": "TOKEN_TYPE", "token_url": "TOKEN_URL", "service "impersonation_url": "IMPERSONATION_URL", "credential_source": { "file": "FILE_PATH", "format": { "type": "text" } } }
Nilai audiens akan terlihat seperti berikut (tanpa jeda baris):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"
CLUSTER_NAME Nama cluster Kubernetes Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan CLUSTER_NAME
.Lihat
k8sCluster.name
.CLUSTER_LOCATION Region tempat cluster berjalan. Ini adalah region tempat Anda membuat cluster di Langkah 1: Buat cluster. Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
CLUSTER_LOCATION
sebelumnya.Lihat
k8sCluster.location
.ORG_NAME ID organisasi hybrid Apigee Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan ORG_NAME
.Lihat
org
.CONTROL_PLANE_
LOCATIONWajib diisi jika Anda menggunakan Residensi data dengan penginstalan hybrid Apigee. Ini adalah lokasi tempat konten inti pelanggan seperti paket proxy disimpan. Untuk mengetahui daftarnya, lihat Region bidang kontrol API Apigee yang tersedia. Nilai ini ditetapkan ke variabel lingkungan CONTROL_PLANE_LOCATION
di Langkah 2: Buat organisasi.Lihat
contractProvider
.ENVIRONMENT_NAME Gunakan nama yang sama dengan yang Anda gunakan saat membuat lingkungan di UI, seperti yang dijelaskan dalam Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Lihat
envs[].name
.ENVIRONMENT_GROUP_
NAMENama grup lingkungan tempat lingkungan Anda ditetapkan. Ini adalah grup yang Anda buat di Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Ini adalah nilai yang ditetapkan ke variabel lingkungan ENV_GROUP
.Lihat
virtualhosts[].name
.INGRESS_NAME Nama gateway ingress Apigee untuk deployment Anda. Nama ini dapat berupa nama apa pun yang memenuhi persyaratan berikut: - Memiliki panjang maksimum 17 karakter
- Hanya berisi karakter alfanumerik huruf kecil, '-', atau '.'
- Diawali dengan karakter alfanumerik
- Diakhiri dengan karakter alfanumerik
Lihat:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEMasukkan jalur dan nama file kunci TLS dan sertifikat yang ditandatangani sendiri yang Anda buat sebelumnya di Langkah 6: Buat sertifikat TLS. File ini harus berada di direktori APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Contoh:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Lihat:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opsional). Ini adalah key-value pair yang menyediakan anotasi untuk layanan ingress default Anda. Platform cloud Anda menggunakan anotasi untuk membantu mengonfigurasi penginstalan hybrid, misalnya menyetel jenis load balancer ke internal atau eksternal. Anotasi bervariasi dari satu platform ke platform lainnya. Lihat dokumentasi platform Anda untuk mengetahui anotasi wajib dan yang disarankan.
Beri komentar atau hapus bagian ini jika Anda tidak menggunakannya.
<component>_
WORKLOAD_IDENTITY_
SECRETNama secret Kubernetes yang Anda buat untuk konfigurasi kredensial akun layanan di Langkah 5: Siapkan autentikasi akun layanan. Nama default secret yang disarankan dalam panduan ini adalah:
Produksi
cassandra-workload-identity-secret
logger-workload-identity-secret
mart-workload-identity-secret
metrics-workload-identity-secret
mint-task-scheduler-workload-identity-secret
runtime-workload-identity-secret
synchronizer-workload-identity-secret
udca-workload-identity-secret
watcher-workload-identity-secret
Non-prod
non-prod-workload-identity-secret
Lihat:
-
envs[].serviceAccountSecretRefs.synchronizer
. -
envs[].serviceAccountSecretRefs.runtime
. -
envs[].serviceAccountSecretRefs.udca
. -
logger.serviceAccountRef
. -
connectAgent.serviceAccountRef
. -
mart.serviceAccountRef
. -
metrics.serviceAccountRef
. -
mintTaskScheduler.serviceAccountRef
. -
udca.serviceAccountRef
. -
watcher.serviceAccountRef
.
Contoh
instanceID: "my_hybrid_example" namespace: "apigee" gcp: projectID: my-project region: us-central1 workloadIdentity: enabled: false federatedWorkloadIdentity: enabled: true audience: "//iam.googleapis.com/projects/123123123123/locations/global/workloadIdentityPools/my-wi-pool/providers/my-wi-provider" credentialSourceFile: "/var/run/service-account/token" k8sCluster: name: hybrid-env region: us-central1 org: my-project enhanceProxyLimits: true contractProvider: https://us-apigee.googleapis.com envs: - name: test serviceAccountSecretRefs: synchronizer: "non-prod-workload-identity-secret" runtime: "non-prod-workload-identity-secret" udca: "non-prod-workload-identity-secret" cassandra: hostNetwork: false replicaCount: 1 ingressGateways: - name: my-ingress-1 replicaCountMin: 2 replicaCountMax: 10 virtualhosts: - name: example-env-group selector: app: apigee-ingressgateway ingress_name: my-ingress-1 sslCertPath: certs/keystore.pem sslKeyPath: certs/keystore.key mart: serviceAccountRef: "non-prod-workload-identity-secret" connectAgent: serviceAccountRef: "non-prod-workload-identity-secret" logger: enabled: false metrics: serviceAccountRef: "non-prod-workload-identity-secret" udca: serviceAccountRef: "non-prod-workload-identity-secret" watcher: serviceAccountRef: "non-prod-workload-identity-secret" # Monetization for Apigee hybrid runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.1" mintTaskScheduler: serviceAccountRef: "non-prod-workload-identity-secret" # for message payloads larger than 10MB: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Gi
Tabel berikut menjelaskan setiap nilai properti yang harus Anda berikan dalam file penggantian. Untuk mengetahui informasi selengkapnya, lihat Referensi properti konfigurasi.
Variabel Deskripsi UNIQUE_INSTANCE_
IDENTIFIERString unik untuk mengidentifikasi instance ini. ID dapat berupa kombinasi huruf dan angka hingga 63 karakter.
Anda dapat membuat beberapa organisasi dalam cluster yang sama, tetapi
instanceID
harus sama untuk semua organisasi dalam cluster Kubernetes yang sama.Lihat
instanceID
.APIGEE_NAMESPACE Namespace Kubernetes untuk komponen hybrid Apigee Anda.
Nilai defaultnya adalah
apigee
.Lihat
namespace
.PROJECT_ID Mengidentifikasi project Google Cloud tempat apigee-logger
danapigee-metrics
mengirim data mereka. Ini adalah nilai yang ditetapkan ke variabel lingkunganPROJECT_ID
.Lihat
gcp.projectID
.ANALYTICS_REGION Di GKE, Anda harus menetapkan nilai ini ke region yang sama dengan tempat cluster berjalan. Di semua platform lainnya, pilih wilayah analisis yang paling dekat dengan cluster Anda yang memiliki dukungan Analytics (lihat tabel di Bagian 1, Langkah 2: Buat organisasi). Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
ANALYTICS_REGION
sebelumnya.Lihat
gcp.region
.AUDIENCE Audiens yang diizinkan dari Penyedia Workload Identity. Anda dapat menemukan nilai tersebut dengan menelusuri file konfigurasi kredensial untuk istilah audience:
. Nilai audiens sama di setiap file konfigurasi kredensial.Misalnya, dalam contoh file
apigee-udca-credential-configuration.json
berikut:{ "universe_domain": "googleapis.com", "type": "external_account:," "audience": "AUDIENCE", "subject_token_type": "TOKEN_TYPE", "token_url": "TOKEN_URL", "service "impersonation_url": "IMPERSONATION_URL", "credential_source": { "file": "FILE_PATH", "format": { "type": "text" } } }
Nilai audiens akan terlihat seperti berikut (tanpa jeda baris):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"
CLUSTER_NAME Nama cluster Kubernetes Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan CLUSTER_NAME
.Lihat
k8sCluster.name
.CLUSTER_LOCATION Region tempat cluster berjalan. Ini adalah region tempat Anda membuat cluster di Langkah 1: Buat cluster. Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
CLUSTER_LOCATION
sebelumnya.Lihat
k8sCluster.location
.ORG_NAME ID organisasi hybrid Apigee Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan ORG_NAME
.Lihat
org
.CONTROL_PLANE_
LOCATIONWajib diisi jika Anda menggunakan Residensi data dengan penginstalan hybrid Apigee. Ini adalah lokasi tempat konten inti pelanggan seperti paket proxy disimpan. Untuk mengetahui daftarnya, lihat Region bidang kontrol API Apigee yang tersedia. Nilai ini ditetapkan ke variabel lingkungan CONTROL_PLANE_LOCATION
di Langkah 2: Buat organisasi.Lihat
contractProvider
.ENVIRONMENT_NAME Gunakan nama yang sama dengan yang Anda gunakan saat membuat lingkungan di UI, seperti yang dijelaskan dalam Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Lihat
envs[].name
.ENVIRONMENT_GROUP_
NAMENama grup lingkungan tempat lingkungan Anda ditetapkan. Ini adalah grup yang Anda buat di Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Ini adalah nilai yang ditetapkan ke variabel lingkungan ENV_GROUP
.Lihat
virtualhosts[].name
.INGRESS_NAME Nama gateway ingress Apigee untuk deployment Anda. Nama ini dapat berupa nama apa pun yang memenuhi persyaratan berikut: - Memiliki panjang maksimum 17 karakter
- Hanya berisi karakter alfanumerik huruf kecil, '-', atau '.'
- Diawali dengan karakter alfanumerik
- Diakhiri dengan karakter alfanumerik
Lihat:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEMasukkan jalur dan nama file kunci TLS dan sertifikat yang ditandatangani sendiri yang Anda buat sebelumnya di Langkah 6: Buat sertifikat TLS. File ini harus berada di direktori APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Contoh:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Lihat:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opsional). Ini adalah key-value pair yang menyediakan anotasi untuk layanan ingress default Anda. Platform cloud Anda menggunakan anotasi untuk membantu mengonfigurasi penginstalan hybrid, misalnya menyetel jenis load balancer ke internal atau eksternal. Anotasi bervariasi dari satu platform ke platform lainnya. Lihat dokumentasi platform Anda untuk mengetahui anotasi wajib dan yang disarankan.
Beri komentar atau hapus bagian ini jika Anda tidak menggunakannya.
<component>_
WORKLOAD_IDENTITY_
SECRETNama secret Kubernetes yang Anda buat untuk konfigurasi kredensial akun layanan di Langkah 5: Siapkan autentikasi akun layanan. Nama default secret yang disarankan dalam panduan ini adalah:
Produksi
cassandra-workload-identity-secret
logger-workload-identity-secret
mart-workload-identity-secret
metrics-workload-identity-secret
mint-task-scheduler-workload-identity-secret
runtime-workload-identity-secret
synchronizer-workload-identity-secret
udca-workload-identity-secret
watcher-workload-identity-secret
Non-prod
non-prod-workload-identity-secret
Lihat:
-
envs[].serviceAccountSecretRefs.synchronizer
. -
envs[].serviceAccountSecretRefs.runtime
. -
envs[].serviceAccountSecretRefs.udca
. -
logger.serviceAccountRef
. -
connectAgent.serviceAccountRef
. -
mart.serviceAccountRef
. -
metrics.serviceAccountRef
. -
mintTaskScheduler.serviceAccountRef
. -
udca.serviceAccountRef
. -
watcher.serviceAccountRef
.
WIF: file
Produksi
Template
Nilai dalam red, bold italics adalah nilai properti yang harus Anda berikan. Anda dapat mengedit nilainya di halaman ini. Objek ini dijelaskan dalam tabel di bawah.
instanceID: UNIQUE_INSTANCE_IDENTIFIER namespace: APIGEE_NAMESPACE # Usually "apigee" gcp: projectID: PROJECT_ID region: ANALYTICS_REGION workloadIdentity: enabled: false # Must be set to false to use # Workload Identity Federation on other platforms. federatedWorkloadIdentity: enabled: true audience: "AUDIENCE" credentialSourceFile: "/var/run/service-account/token" k8sCluster: name: CLUSTER_NAME region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster. org: ORG_NAME # Required for Enhanced per-environment proxy limits: enhanceProxyLimits: true # Required if using data residency with hybrid: contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com envs: - name: ENVIRONMENT_NAME serviceAccountPaths: # Provide the path relative to the apigee-env chart directory. synchronizer: SYNCHRONIZER_CREDENTIAL_CONFIGURATION_FILEPATH # For example: "apigee-synchronizer-credential-configuration.json" runtime: RUNTIME_SERVICE_CREDENTIAL_CONFIGURATION_FILEPATH # For example: "apigee-runtime-credential-configuration.json" udca: UDCA_SERVICE_CREDENTIAL_CONFIGURATION_FILEPATH # For example: "apigee-udca-credential-configuration.json" cassandra: hostNetwork: false # Set to false for single region installations and for multi-region # installations with connectivity between pods in different clusters, # like GKE installations. # Set to true for multi-region installations with no communication # between pods in different clusters, for example Google Distributed # Cloud on VMware or bare metal, GKE on AWS, AKS, EKS, and OpenShift # installations. See Multi-region deployment: Prerequisites replicaCount:
3 # Use multiples of 3 for production. # See Configure Cassandra for production for guidelines. storage: storageSize: 500Gi resources: requests: cpu: 7 memory: 15Gi maxHeapSize: 8192M heapNewSize: 1200M # Minimum storage requirements for a production environment. # See Configure Cassandra for production. ingressGateways: - name: INGRESS_NAME # maximum 17 characters. replicaCountMin: 2 replicaCountMax: 10 svcAnnotations: # optional. If you are on AKS, see Known issue #260772383 SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE virtualhosts: - name: ENVIRONMENT_GROUP_NAME selector: app: apigee-ingressgateway ingress_name: INGRESS_NAME sslCertPath: PATH_TO_CERT_FILE sslKeyPath: PATH_TO_KEY_FILE mart: serviceAccountPath: MART_CREDENTIAL_CONFIGURATION_FILEPATH # Provide the path relative to the apigee-org chart directory. # For example: "apigee-mart-credential-configuration.json" connectAgent: serviceAccountPath: MART_CREDENTIAL_CONFIGURATION_FILEPATH # Use the same service account for mart and connectAgent # Provide the path relative to the apigee-org chart directory. # For example: "apigee-mart-credential-configuration.json" logger: enabled: false # apigee-logger does not support Workload Identity Federation. # See Known issue #341099433. # If you want to enable the apigee-logger component, provide # the path to the apigee-logger service account key file with # the logger.serviceAccountPath property. metrics: serviceAccountPath: METRICS_CREDENTIAL_CONFIGURATION_FILEPATH # Provide the path relative to the apigee-telemetry chart directory. # For example: "apigee-metrics-credential-configuration.json" udca: serviceAccountPath: UDCA_CREDENTIAL_CONFIGURATION_FILEPATH # Provide the path relative to the apigee-telemetry chart directory. # For example: "apigee-udca-credential-configuration.json" watcher: serviceAccountPath: WATCHER_CREDENTIAL_CONFIGURATION_FILEPATH # Provide the path relative to the apigee-telemetry chart directory. # For example: "apigee-watcher-credential-configuration.json" # Required if using Monetization for Apigee hybrid (v1.15.1 and later) runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.1" # Must be 1.15.1 or higher. mintTaskScheduler: # Required for Monetization for Apigee hybrid serviceAccountPath: MINT_TASK_SCHEDULER_CREDENTIAL_CONFIGURATION_FILEPATH # Provide the path relative to the apigee-org chart directory. # For example: "apigee-mint-task-scheduler-credential-configuration.json" # If using message payloads larger than 10MB. # See configure large message payload support: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Gi Tabel berikut menjelaskan setiap nilai properti yang harus Anda berikan dalam file penggantian. Untuk mengetahui informasi selengkapnya, lihat Referensi properti konfigurasi.
Variabel Deskripsi UNIQUE_INSTANCE_
IDENTIFIERString unik untuk mengidentifikasi instance ini. ID dapat berupa kombinasi huruf dan angka hingga 63 karakter.
Anda dapat membuat beberapa organisasi dalam cluster yang sama, tetapi
instanceID
harus sama untuk semua organisasi dalam cluster Kubernetes yang sama.Lihat
instanceID
.APIGEE_NAMESPACE Namespace Kubernetes untuk komponen hybrid Apigee Anda.
Nilai defaultnya adalah
apigee
.Lihat
namespace
.PROJECT_ID Mengidentifikasi project Google Cloud tempat apigee-logger
danapigee-metrics
mengirim data mereka. Ini adalah nilai yang ditetapkan ke variabel lingkunganPROJECT_ID
.Lihat
gcp.projectID
.ANALYTICS_REGION Di GKE, Anda harus menetapkan nilai ini ke region yang sama dengan tempat cluster berjalan. Di semua platform lainnya, pilih wilayah analisis yang paling dekat dengan cluster Anda yang memiliki dukungan Analytics (lihat tabel di Bagian 1, Langkah 2: Buat organisasi). Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
ANALYTICS_REGION
sebelumnya.Lihat
gcp.region
.AUDIENCE Audiens yang diizinkan dari Penyedia Workload Identity. Anda dapat menemukan nilai tersebut dengan menelusuri file konfigurasi kredensial untuk istilah audience:
. Nilai audiens sama di setiap file konfigurasi kredensial.Misalnya, dalam contoh file
apigee-udca-credential-configuration.json
berikut:{ "universe_domain": "googleapis.com", "type": "external_account:," "audience": "AUDIENCE", "subject_token_type": "TOKEN_TYPE", "token_url": "TOKEN_URL", "service "impersonation_url": "IMPERSONATION_URL", "credential_source": { "file": "FILE_PATH", "format": { "type": "text" } } }
Nilai audiens akan terlihat seperti berikut (tanpa jeda baris):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"
CLUSTER_NAME Nama cluster Kubernetes Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan CLUSTER_NAME
.Lihat
k8sCluster.name
.CLUSTER_LOCATION Region tempat cluster berjalan. Ini adalah region tempat Anda membuat cluster di Langkah 1: Buat cluster. Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
CLUSTER_LOCATION
sebelumnya.Lihat
k8sCluster.location
.ORG_NAME ID organisasi hybrid Apigee Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan ORG_NAME
.Lihat
org
.CONTROL_PLANE_
LOCATIONWajib diisi jika Anda menggunakan Residensi data dengan penginstalan hybrid Apigee. Ini adalah lokasi tempat konten inti pelanggan seperti paket proxy disimpan. Untuk mengetahui daftarnya, lihat Region bidang kontrol API Apigee yang tersedia. Nilai ini ditetapkan ke variabel lingkungan CONTROL_PLANE_LOCATION
di Langkah 2: Buat organisasi.Lihat
contractProvider
.ENVIRONMENT_NAME Gunakan nama yang sama dengan yang Anda gunakan saat membuat lingkungan di UI, seperti yang dijelaskan dalam Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Lihat
envs[].name
.ENVIRONMENT_GROUP_
NAMENama grup lingkungan tempat lingkungan Anda ditetapkan. Ini adalah grup yang Anda buat di Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Ini adalah nilai yang ditetapkan ke variabel lingkungan ENV_GROUP
.Lihat
virtualhosts[].name
.INGRESS_NAME Nama gateway ingress Apigee untuk deployment Anda. Nama ini dapat berupa nama apa pun yang memenuhi persyaratan berikut: - Memiliki panjang maksimum 17 karakter
- Hanya berisi karakter alfanumerik huruf kecil, '-', atau '.'
- Diawali dengan karakter alfanumerik
- Diakhiri dengan karakter alfanumerik
Lihat:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEMasukkan jalur dan nama file kunci TLS dan sertifikat yang ditandatangani sendiri yang Anda buat sebelumnya di Langkah 6: Buat sertifikat TLS. File ini harus berada di direktori APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Contoh:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Lihat:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opsional). Ini adalah key-value pair yang menyediakan anotasi untuk layanan ingress default Anda. Platform cloud Anda menggunakan anotasi untuk membantu mengonfigurasi penginstalan hybrid, misalnya menyetel jenis load balancer ke internal atau eksternal. Anotasi bervariasi dari satu platform ke platform lainnya. Lihat dokumentasi platform Anda untuk mengetahui anotasi wajib dan yang disarankan.
Beri komentar atau hapus bagian ini jika Anda tidak menggunakannya.
<component>_
CREDENTIAL_
CONFIGURATION_
FILEPATHJalur dan nama file akun dari file konfigurasi kredensial yang Anda buat di Langkah 5: Menyiapkan autentikasi akun layanan. Berikan nama dengan jalur yang terkait dengan direktori diagram. Contoh:
- Jika file
apigee-synchronizer-credential-configuration.json
berada di direktori diagramapigee-env/
, Anda hanya perlu memberikan nama file, seperti:synchronizer: "FILE_NAME.json"
- Jika file berada di direktori
apigee-env/service-accounts/
, Anda akan menentukan jalur relatif:synchronizer: "service-accounts/FILE_NAME.json"
Nama default direktori dan diagram yang sesuai untuk akun layanan adalah:
Produksi
Nama file akun layanan Direktori diagram apigee-cassandra-credential-configuration.json
apigee-datastore/
apigee-logger-credential-configuration.json
apigee-telemetry/
apigee-mart-credential-configuration.json
apigee-org/
apigee-metrics-credential-configuration.json
apigee-telemetry/
apigee-mint-task-scheduler-credential-configuration.json
apigee-org/
apigee-runtime-credential-configuration.json
apigee-env/
apigee-synchronizer-credential-configuration.json
apigee-env/
apigee-udca-credential-configuration.json
apigee-org/
apigee-watcher-credential-configuration.json
apigee-org/
Non-prod
Nama file akun layanan Direktori diagram apigee-non-prod-credential-configuration.json
apigee-datastore/
apigee-org/
apigee-telemetry/
Lihat:
-
envs[].serviceAccountPaths.synchronizer
. -
envs[].serviceAccountPaths.runtime
. -
envs[].serviceAccountPaths.udca
. -
logger.serviceAccountPath
. -
connectAgent.serviceAccountPath
. -
mart.serviceAccountPath
. -
metrics.serviceAccountPath
. -
mintTaskScheduler.serviceAccountPath
. -
udca.serviceAccountPath
. -
watcher.serviceAccountPath
.
Contoh
instanceID: "my_hybrid_example" namespace: "apigee" gcp: projectID: my-project region: us-central1 workloadIdentity: enabled: false federatedWorkloadIdentity: enabled: true audience: "//iam.googleapis.com/projects/123123123123/locations/global/workloadIdentityPools/my-wi-pool/providers/my-wi-provider" credentialSourceFile: "/var/run/service-account/token" k8sCluster: name: hybrid-env region: us-central1 org: my-project enhanceProxyLimits: true contractProvider: https://us-apigee.googleapis.com envs: - name: prod-env serviceAccountPaths: synchronizer: "apigee-synchronizer-credential-configuration.json" runtime: "apigee-runtime-credential-configuration.json" udca: "apigee-udca-credential-configuration.json" cassandra: hostNetwork: false replicaCount: 3 storage: storageSize: 500Gi resources: requests: cpu: 7 memory: 15Gi maxHeapSize: 8192M heapNewSize: 1200M ingressGateways: - name: my-ingress-1 replicaCountMin: 2 replicaCountMax: 10 virtualhosts: - name: example-env-group selector: app: apigee-ingressgateway ingress_name: my-ingress-1 sslCertPath: certs/keystore.pem sslKeyPath: certs/keystore.key mart: serviceAccountPath: "apigee-mart-credential-configuration.json" connectAgent: serviceAccountPath: "apigee-mart-credential-configuration.json" logger: enabled: false metrics: serviceAccountPath: "apigee-metrics-credential-configuration.json" udca: serviceAccountPath: "apigee-udca-credential-configuration.json" watcher: serviceAccountPath: "apigee-watcher-credential-configuration.json" # Monetization for Apigee hybrid runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.1" mintTaskScheduler: serviceAccountPath: apigee-mint-task-scheduler-credential-configuration.json" # For message payloads larger than 10MB: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Gi
Tabel berikut menjelaskan setiap nilai properti yang harus Anda berikan dalam file penggantian. Untuk mengetahui informasi selengkapnya, lihat Referensi properti konfigurasi.
Variabel Deskripsi UNIQUE_INSTANCE_
IDENTIFIERString unik untuk mengidentifikasi instance ini. ID dapat berupa kombinasi huruf dan angka hingga 63 karakter.
Anda dapat membuat beberapa organisasi dalam cluster yang sama, tetapi
instanceID
harus sama untuk semua organisasi dalam cluster Kubernetes yang sama.Lihat
instanceID
.APIGEE_NAMESPACE Namespace Kubernetes untuk komponen hybrid Apigee Anda.
Nilai defaultnya adalah
apigee
.Lihat
namespace
.PROJECT_ID Mengidentifikasi project Google Cloud tempat apigee-logger
danapigee-metrics
mengirim data mereka. Ini adalah nilai yang ditetapkan ke variabel lingkunganPROJECT_ID
.Lihat
gcp.projectID
.ANALYTICS_REGION Di GKE, Anda harus menetapkan nilai ini ke region yang sama dengan tempat cluster berjalan. Di semua platform lainnya, pilih wilayah analisis yang paling dekat dengan cluster Anda yang memiliki dukungan Analytics (lihat tabel di Bagian 1, Langkah 2: Buat organisasi). Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
ANALYTICS_REGION
sebelumnya.Lihat
gcp.region
.AUDIENCE Audiens yang diizinkan dari Penyedia Workload Identity. Anda dapat menemukan nilai tersebut dengan menelusuri file konfigurasi kredensial untuk istilah audience:
. Nilai audiens sama di setiap file konfigurasi kredensial.Misalnya, dalam contoh file
apigee-udca-credential-configuration.json
berikut:{ "universe_domain": "googleapis.com", "type": "external_account:," "audience": "AUDIENCE", "subject_token_type": "TOKEN_TYPE", "token_url": "TOKEN_URL", "service "impersonation_url": "IMPERSONATION_URL", "credential_source": { "file": "FILE_PATH", "format": { "type": "text" } } }
Nilai audiens akan terlihat seperti berikut (tanpa jeda baris):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"
CLUSTER_NAME Nama cluster Kubernetes Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan CLUSTER_NAME
.Lihat
k8sCluster.name
.CLUSTER_LOCATION Region tempat cluster berjalan. Ini adalah region tempat Anda membuat cluster di Langkah 1: Buat cluster. Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
CLUSTER_LOCATION
sebelumnya.Lihat
k8sCluster.location
.ORG_NAME ID organisasi hybrid Apigee Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan ORG_NAME
.Lihat
org
.CONTROL_PLANE_
LOCATIONWajib diisi jika Anda menggunakan Residensi data dengan penginstalan hybrid Apigee. Ini adalah lokasi tempat konten inti pelanggan seperti paket proxy disimpan. Untuk mengetahui daftarnya, lihat Region bidang kontrol API Apigee yang tersedia. Nilai ini ditetapkan ke variabel lingkungan CONTROL_PLANE_LOCATION
di Langkah 2: Buat organisasi.Lihat
contractProvider
.ENVIRONMENT_NAME Gunakan nama yang sama dengan yang Anda gunakan saat membuat lingkungan di UI, seperti yang dijelaskan dalam Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Lihat
envs[].name
.ENVIRONMENT_GROUP_
NAMENama grup lingkungan tempat lingkungan Anda ditetapkan. Ini adalah grup yang Anda buat di Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Ini adalah nilai yang ditetapkan ke variabel lingkungan ENV_GROUP
.Lihat
virtualhosts[].name
.INGRESS_NAME Nama gateway ingress Apigee untuk deployment Anda. Nama ini dapat berupa nama apa pun yang memenuhi persyaratan berikut: - Memiliki panjang maksimum 17 karakter
- Hanya berisi karakter alfanumerik huruf kecil, '-', atau '.'
- Diawali dengan karakter alfanumerik
- Diakhiri dengan karakter alfanumerik
Lihat:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEMasukkan jalur dan nama file kunci TLS dan sertifikat yang ditandatangani sendiri yang Anda buat sebelumnya di Langkah 6: Buat sertifikat TLS. File ini harus berada di direktori APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Contoh:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Lihat:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opsional). Ini adalah key-value pair yang menyediakan anotasi untuk layanan ingress default Anda. Platform cloud Anda menggunakan anotasi untuk membantu mengonfigurasi penginstalan hybrid, misalnya menyetel jenis load balancer ke internal atau eksternal. Anotasi bervariasi dari satu platform ke platform lainnya. Lihat dokumentasi platform Anda untuk mengetahui anotasi wajib dan yang disarankan.
Beri komentar atau hapus bagian ini jika Anda tidak menggunakannya.
<component>_
CREDENTIAL_
CONFIGURATION_
FILEPATHJalur dan nama file akun dari file konfigurasi kredensial yang Anda buat di Langkah 5: Menyiapkan autentikasi akun layanan. Berikan nama dengan jalur yang terkait dengan direktori diagram. Contoh:
- Jika file
apigee-synchronizer-credential-configuration.json
berada di direktori diagramapigee-env/
, Anda hanya perlu memberikan nama file, seperti:synchronizer: "FILE_NAME.json"
- Jika file berada di direktori
apigee-env/service-accounts/
, Anda akan menentukan jalur relatif:synchronizer: "service-accounts/FILE_NAME.json"
Nama default direktori dan diagram yang sesuai untuk akun layanan adalah:
Produksi
Nama file akun layanan Direktori diagram apigee-cassandra-credential-configuration.json
apigee-datastore/
apigee-logger-credential-configuration.json
apigee-telemetry/
apigee-mart-credential-configuration.json
apigee-org/
apigee-metrics-credential-configuration.json
apigee-telemetry/
apigee-mint-task-scheduler-credential-configuration.json
apigee-org/
apigee-runtime-credential-configuration.json
apigee-env/
apigee-synchronizer-credential-configuration.json
apigee-env/
apigee-udca-credential-configuration.json
apigee-org/
apigee-watcher-credential-configuration.json
apigee-org/
Non-prod
Nama file akun layanan Direktori diagram apigee-non-prod-credential-configuration.json
apigee-datastore/
apigee-org/
apigee-telemetry/
Lihat:
-
envs[].serviceAccountPaths.synchronizer
. -
envs[].serviceAccountPaths.runtime
. -
envs[].serviceAccountPaths.udca
. -
logger.serviceAccountPath
. -
connectAgent.serviceAccountPath
. -
mart.serviceAccountPath
. -
metrics.serviceAccountPath
. -
mintTaskScheduler.serviceAccountPath
. -
udca.serviceAccountPath
. -
watcher.serviceAccountPath
.
Non-prod
Template
Nilai dalam red, bold italics adalah nilai properti yang harus Anda berikan. Anda dapat mengedit nilainya di halaman ini. Objek ini dijelaskan dalam tabel di bawah.
instanceID: UNIQUE_INSTANCE_IDENTIFIER namespace: APIGEE_NAMESPACE # Usually "apigee" gcp: projectID: PROJECT_ID region: ANALYTICS_REGION workloadIdentity: enabled: false # Must be set to false to use # Workload Identity Federation on other platforms. federatedWorkloadIdentity: enabled: true audience: "AUDIENCE" credentialSourceFile: "/var/run/service-account/token" k8sCluster: name: CLUSTER_NAME region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster. org: ORG_NAME # Required for Enhanced per-environment proxy limits: enhanceProxyLimits: true # Required if using data residency with hybrid: contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com envs: - name: ENVIRONMENT_NAME serviceAccountPaths: # Provide the path relative to the apigee-env chart directory. synchronizer: NON_PROD_CREDENTIAL_CONFIGURATION_FILEPATH # For example: "apigee-non-prod-credential-configuration.json" runtime: NON_PROD_CREDENTIAL_CONFIGURATION_FILEPATH # For example: "apigee-non-prod-credential-configuration.json" udca: NON_PROD_CREDENTIAL_CONFIGURATION_FILEPATH # For example: "apigee-non-prod-credential-configuration.json" cassandra: hostNetwork: false # Set to false for single region installations and for multi-region # installations with connectivity between pods in different clusters, # like GKE. # Set to true for multi-region installations with no communication # between pods in different clusters, for example Google Distributed # Cloud on VMware or bare metal, GKE on AWS, AKS, EKS, and OpenShift. # See Multi-region deployment: Prerequisites replicaCount: 1 # Use 1 for non-prod installations and multiples of 3 for production. # See Configure Cassandra for production for guidelines. ingressGateways: - name: INGRESS_NAME # maximum 17 characters. replicaCountMin: 2 replicaCountMax: 10 svcAnnotations: # optional. If you are on AKS, see Known issue #260772383 SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE virtualhosts: - name: ENVIRONMENT_GROUP_NAME selector: app: apigee-ingressgateway ingress_name: INGRESS_NAME sslCertPath: PATH_TO_CERT_FILE sslKeyPath: PATH_TO_KEY_FILE mart: serviceAccountPath: NON_PROD_CREDENTIAL_CONFIGURATION_FILEPATH # Provide the path relative to the apigee-org chart directory. # For example: "apigee-non-prod-credential-configuration.json" connectAgent: serviceAccountPath: NON_PROD_CREDENTIAL_CONFIGURATION_FILEPATH # Use the same service account for mart and connectAgent # Provide the path relative to the apigee-org chart directory. # For example: "apigee-non-prod-credential-configuration.json" logger: enabled: false # apigee-logger does not support Workload Identity Federation. # See Known issue #341099433. # If you want to enable the apigee-logger component, provide # the path to the apigee-non-prod service account key file with # the logger.serviceAccountPath property. metrics: serviceAccountPath: NON_PROD_CREDENTIAL_CONFIGURATION_FILEPATH # Provide the path relative to the apigee-telemetry chart directory. # For example: "apigee-non-prod-credential-configuration.json" udca: serviceAccountPath: NON_PROD_CREDENTIAL_CONFIGURATION_FILEPATH # Provide the path relative to the apigee-telemetry chart directory. # For example: "apigee-non-prod-credential-configuration.json" watcher: serviceAccountPath: NON_PROD_CREDENTIAL_CONFIGURATION_FILEPATH # Provide the path relative to the apigee-telemetry chart directory. # For example: "apigee-non-prod-credential-configuration.json" # Required if using Monetization for Apigee hybrid (v1.15.1 and later) runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.1" # Must be 1.15.1 or higher. mintTaskScheduler: # Required for Monetization for Apigee hybrid serviceAccountPath: NON_PROD_CREDENTIAL_CONFIGURATION_FILEPATH # Provide the path relative to the apigee-org chart directory. # For example: "apigee-non-prod-credential-configuration.json" # If using message payloads larger than 10MB. # See configure large message payload support: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Gi
Tabel berikut menjelaskan setiap nilai properti yang harus Anda berikan dalam file penggantian. Untuk mengetahui informasi selengkapnya, lihat Referensi properti konfigurasi.
Variabel Deskripsi UNIQUE_INSTANCE_
IDENTIFIERString unik untuk mengidentifikasi instance ini. ID dapat berupa kombinasi huruf dan angka hingga 63 karakter.
Anda dapat membuat beberapa organisasi dalam cluster yang sama, tetapi
instanceID
harus sama untuk semua organisasi dalam cluster Kubernetes yang sama.Lihat
instanceID
.APIGEE_NAMESPACE Namespace Kubernetes untuk komponen hybrid Apigee Anda.
Nilai defaultnya adalah
apigee
.Lihat
namespace
.PROJECT_ID Mengidentifikasi project Google Cloud tempat apigee-logger
danapigee-metrics
mengirim data mereka. Ini adalah nilai yang ditetapkan ke variabel lingkunganPROJECT_ID
.Lihat
gcp.projectID
.ANALYTICS_REGION Di GKE, Anda harus menetapkan nilai ini ke region yang sama dengan tempat cluster berjalan. Di semua platform lainnya, pilih wilayah analisis yang paling dekat dengan cluster Anda yang memiliki dukungan Analytics (lihat tabel di Bagian 1, Langkah 2: Buat organisasi). Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
ANALYTICS_REGION
sebelumnya.Lihat
gcp.region
.AUDIENCE Audiens yang diizinkan dari Penyedia Workload Identity. Anda dapat menemukan nilai tersebut dengan menelusuri file konfigurasi kredensial untuk istilah audience:
. Nilai audiens sama di setiap file konfigurasi kredensial.Misalnya, dalam contoh file
apigee-udca-credential-configuration.json
berikut:{ "universe_domain": "googleapis.com", "type": "external_account:," "audience": "AUDIENCE", "subject_token_type": "TOKEN_TYPE", "token_url": "TOKEN_URL", "service "impersonation_url": "IMPERSONATION_URL", "credential_source": { "file": "FILE_PATH", "format": { "type": "text" } } }
Nilai audiens akan terlihat seperti berikut (tanpa jeda baris):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"
CLUSTER_NAME Nama cluster Kubernetes Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan CLUSTER_NAME
.Lihat
k8sCluster.name
.CLUSTER_LOCATION Region tempat cluster berjalan. Ini adalah region tempat Anda membuat cluster di Langkah 1: Buat cluster. Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
CLUSTER_LOCATION
sebelumnya.Lihat
k8sCluster.location
.ORG_NAME ID organisasi hybrid Apigee Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan ORG_NAME
.Lihat
org
.CONTROL_PLANE_
LOCATIONWajib diisi jika Anda menggunakan Residensi data dengan penginstalan hybrid Apigee. Ini adalah lokasi tempat konten inti pelanggan seperti paket proxy disimpan. Untuk mengetahui daftarnya, lihat Region bidang kontrol API Apigee yang tersedia. Nilai ini ditetapkan ke variabel lingkungan CONTROL_PLANE_LOCATION
di Langkah 2: Buat organisasi.Lihat
contractProvider
.ENVIRONMENT_NAME Gunakan nama yang sama dengan yang Anda gunakan saat membuat lingkungan di UI, seperti yang dijelaskan dalam Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Lihat
envs[].name
.ENVIRONMENT_GROUP_
NAMENama grup lingkungan tempat lingkungan Anda ditetapkan. Ini adalah grup yang Anda buat di Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Ini adalah nilai yang ditetapkan ke variabel lingkungan ENV_GROUP
.Lihat
virtualhosts[].name
.INGRESS_NAME Nama gateway ingress Apigee untuk deployment Anda. Nama ini dapat berupa nama apa pun yang memenuhi persyaratan berikut: - Memiliki panjang maksimum 17 karakter
- Hanya berisi karakter alfanumerik huruf kecil, '-', atau '.'
- Diawali dengan karakter alfanumerik
- Diakhiri dengan karakter alfanumerik
Lihat:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEMasukkan jalur dan nama file kunci TLS dan sertifikat yang ditandatangani sendiri yang Anda buat sebelumnya di Langkah 6: Buat sertifikat TLS. File ini harus berada di direktori APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Contoh:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Lihat:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opsional). Ini adalah key-value pair yang menyediakan anotasi untuk layanan ingress default Anda. Platform cloud Anda menggunakan anotasi untuk membantu mengonfigurasi penginstalan hybrid, misalnya menyetel jenis load balancer ke internal atau eksternal. Anotasi bervariasi dari satu platform ke platform lainnya. Lihat dokumentasi platform Anda untuk mengetahui anotasi wajib dan yang disarankan.
Beri komentar atau hapus bagian ini jika Anda tidak menggunakannya.
<component>_
CREDENTIAL_
CONFIGURATION_
FILEPATHJalur dan nama file akun dari file konfigurasi kredensial yang Anda buat di Langkah 5: Menyiapkan autentikasi akun layanan. Berikan nama dengan jalur yang terkait dengan direktori diagram. Contoh:
- Jika file
apigee-synchronizer-credential-configuration.json
berada di direktori diagramapigee-env/
, Anda hanya perlu memberikan nama file, seperti:synchronizer: "FILE_NAME.json"
- Jika file berada di direktori
apigee-env/service-accounts/
, Anda akan menentukan jalur relatif:synchronizer: "service-accounts/FILE_NAME.json"
Nama default direktori dan diagram yang sesuai untuk akun layanan adalah:
Produksi
Nama file akun layanan Direktori diagram apigee-cassandra-credential-configuration.json
apigee-datastore/
apigee-logger-credential-configuration.json
apigee-telemetry/
apigee-mart-credential-configuration.json
apigee-org/
apigee-metrics-credential-configuration.json
apigee-telemetry/
apigee-mint-task-scheduler-credential-configuration.json
apigee-org/
apigee-runtime-credential-configuration.json
apigee-env/
apigee-synchronizer-credential-configuration.json
apigee-env/
apigee-udca-credential-configuration.json
apigee-org/
apigee-watcher-credential-configuration.json
apigee-org/
Non-prod
Nama file akun layanan Direktori diagram apigee-non-prod-credential-configuration.json
apigee-datastore/
apigee-org/
apigee-telemetry/
Lihat:
-
envs[].serviceAccountPaths.synchronizer
. -
envs[].serviceAccountPaths.runtime
. -
envs[].serviceAccountPaths.udca
. -
logger.serviceAccountPath
. -
connectAgent.serviceAccountPath
. -
mart.serviceAccountPath
. -
metrics.serviceAccountPath
. -
mintTaskScheduler.serviceAccountPath
. -
udca.serviceAccountPath
. -
watcher.serviceAccountPath
.
Contoh
instanceID: "my_hybrid_example" namespace: "apigee" gcp: projectID: my-project region: us-central1 workloadIdentity: enabled: false federatedWorkloadIdentity: enabled: true audience: "//iam.googleapis.com/projects/123123123123/locations/global/workloadIdentityPools/my-wi-pool/providers/my-wi-provider" credentialSourceFile: "/var/run/service-account/token" k8sCluster: name: hybrid-env region: us-central1 org: my-project enhanceProxyLimits: true contractProvider: https://us-apigee.googleapis.com envs: - name: test serviceAccountPaths: synchronizer: "apigee-non-prod-credential-configuration.json" runtime: "apigee-non-prod-credential-configuration.json<" udca: "apigee-non-prod-credential-configuration.json" cassandra: hostNetwork: false replicaCount: 1 ingressGateways: - name: my-ingress-1 replicaCountMin: 2 replicaCountMax: 10 virtualhosts: - name: example-env-group selector: app: apigee-ingressgateway ingress_name: my-ingress-1 sslCertPath: certs/keystore.pem sslKeyPath: certs/keystore.key mart: serviceAccountPath: "apigee-non-prod-credential-configuration.json" connectAgent: serviceAccountPath: "apigee-non-prod-credential-configuration.json" logger: enabled: false metrics: serviceAccountPath: "apigee-non-prod-credential-configuration.json" udca: serviceAccountPath: "apigee-non-prod-credential-configuration.json" watcher: serviceAccountPath: "apigee-non-prod-credential-configuration.json" # Monetization for Apigee hybrid runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.1" mintTaskScheduler: serviceAccountPath: apigee-non-prod-credential-configuration.json" # For message payloads larger than 10MB: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Gi
Tabel berikut menjelaskan setiap nilai properti yang harus Anda berikan dalam file penggantian. Untuk mengetahui informasi selengkapnya, lihat Referensi properti konfigurasi.
Variabel Deskripsi UNIQUE_INSTANCE_
IDENTIFIERString unik untuk mengidentifikasi instance ini. ID dapat berupa kombinasi huruf dan angka hingga 63 karakter.
Anda dapat membuat beberapa organisasi dalam cluster yang sama, tetapi
instanceID
harus sama untuk semua organisasi dalam cluster Kubernetes yang sama.Lihat
instanceID
.APIGEE_NAMESPACE Namespace Kubernetes untuk komponen hybrid Apigee Anda.
Nilai defaultnya adalah
apigee
.Lihat
namespace
.PROJECT_ID Mengidentifikasi project Google Cloud tempat apigee-logger
danapigee-metrics
mengirim data mereka. Ini adalah nilai yang ditetapkan ke variabel lingkunganPROJECT_ID
.Lihat
gcp.projectID
.ANALYTICS_REGION Di GKE, Anda harus menetapkan nilai ini ke region yang sama dengan tempat cluster berjalan. Di semua platform lainnya, pilih wilayah analisis yang paling dekat dengan cluster Anda yang memiliki dukungan Analytics (lihat tabel di Bagian 1, Langkah 2: Buat organisasi). Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
ANALYTICS_REGION
sebelumnya.Lihat
gcp.region
.AUDIENCE Audiens yang diizinkan dari Penyedia Workload Identity. Anda dapat menemukan nilai tersebut dengan menelusuri file konfigurasi kredensial untuk istilah audience:
. Nilai audiens sama di setiap file konfigurasi kredensial.Misalnya, dalam contoh file
apigee-udca-credential-configuration.json
berikut:{ "universe_domain": "googleapis.com", "type": "external_account:," "audience": "AUDIENCE", "subject_token_type": "TOKEN_TYPE", "token_url": "TOKEN_URL", "service "impersonation_url": "IMPERSONATION_URL", "credential_source": { "file": "FILE_PATH", "format": { "type": "text" } } }
Nilai audiens akan terlihat seperti berikut (tanpa jeda baris):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"
CLUSTER_NAME Nama cluster Kubernetes Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan CLUSTER_NAME
.Lihat
k8sCluster.name
.CLUSTER_LOCATION Region tempat cluster berjalan. Ini adalah region tempat Anda membuat cluster di Langkah 1: Buat cluster. Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
CLUSTER_LOCATION
sebelumnya.Lihat
k8sCluster.location
.ORG_NAME ID organisasi hybrid Apigee Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan ORG_NAME
.Lihat
org
.CONTROL_PLANE_
LOCATIONWajib diisi jika Anda menggunakan Residensi data dengan penginstalan hybrid Apigee. Ini adalah lokasi tempat konten inti pelanggan seperti paket proxy disimpan. Untuk mengetahui daftarnya, lihat Region bidang kontrol API Apigee yang tersedia. Nilai ini ditetapkan ke variabel lingkungan CONTROL_PLANE_LOCATION
di Langkah 2: Buat organisasi.Lihat
contractProvider
.ENVIRONMENT_NAME Gunakan nama yang sama dengan yang Anda gunakan saat membuat lingkungan di UI, seperti yang dijelaskan dalam Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Lihat
envs[].name
.ENVIRONMENT_GROUP_
NAMENama grup lingkungan tempat lingkungan Anda ditetapkan. Ini adalah grup yang Anda buat di Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Ini adalah nilai yang ditetapkan ke variabel lingkungan ENV_GROUP
.Lihat
virtualhosts[].name
.INGRESS_NAME Nama gateway ingress Apigee untuk deployment Anda. Nama ini dapat berupa nama apa pun yang memenuhi persyaratan berikut: - Memiliki panjang maksimum 17 karakter
- Hanya berisi karakter alfanumerik huruf kecil, '-', atau '.'
- Diawali dengan karakter alfanumerik
- Diakhiri dengan karakter alfanumerik
Lihat:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEMasukkan jalur dan nama file kunci TLS dan sertifikat yang ditandatangani sendiri yang Anda buat sebelumnya di Langkah 6: Buat sertifikat TLS. File ini harus berada di direktori APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Contoh:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Lihat:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opsional). Ini adalah key-value pair yang menyediakan anotasi untuk layanan ingress default Anda. Platform cloud Anda menggunakan anotasi untuk membantu mengonfigurasi penginstalan hybrid, misalnya menyetel jenis load balancer ke internal atau eksternal. Anotasi bervariasi dari satu platform ke platform lainnya. Lihat dokumentasi platform Anda untuk mengetahui anotasi wajib dan yang disarankan.
Beri komentar atau hapus bagian ini jika Anda tidak menggunakannya.
<component>_
CREDENTIAL_
CONFIGURATION_
FILEPATHJalur dan nama file akun dari file konfigurasi kredensial yang Anda buat di Langkah 5: Menyiapkan autentikasi akun layanan. Berikan nama dengan jalur yang terkait dengan direktori diagram. Contoh:
- Jika file
apigee-synchronizer-credential-configuration.json
berada di direktori diagramapigee-env/
, Anda hanya perlu memberikan nama file, seperti:synchronizer: "FILE_NAME.json"
- Jika file berada di direktori
apigee-env/service-accounts/
, Anda akan menentukan jalur relatif:synchronizer: "service-accounts/FILE_NAME.json"
Nama default direktori dan diagram yang sesuai untuk akun layanan adalah:
Produksi
Nama file akun layanan Direktori diagram apigee-cassandra-credential-configuration.json
apigee-datastore/
apigee-logger-credential-configuration.json
apigee-telemetry/
apigee-mart-credential-configuration.json
apigee-org/
apigee-metrics-credential-configuration.json
apigee-telemetry/
apigee-mint-task-scheduler-credential-configuration.json
apigee-org/
apigee-runtime-credential-configuration.json
apigee-env/
apigee-synchronizer-credential-configuration.json
apigee-env/
apigee-udca-credential-configuration.json
apigee-org/
apigee-watcher-credential-configuration.json
apigee-org/
Non-prod
Nama file akun layanan Direktori diagram apigee-non-prod-credential-configuration.json
apigee-datastore/
apigee-org/
apigee-telemetry/
Lihat:
-
envs[].serviceAccountPaths.synchronizer
. -
envs[].serviceAccountPaths.runtime
. -
envs[].serviceAccountPaths.udca
. -
logger.serviceAccountPath
. -
connectAgent.serviceAccountPath
. -
mart.serviceAccountPath
. -
metrics.serviceAccountPath
. -
mintTaskScheduler.serviceAccountPath
. -
udca.serviceAccountPath
. -
watcher.serviceAccountPath
.
WIF: Vault
Produksi
Template
Nilai dalam red, bold italics adalah nilai properti yang harus Anda berikan. Anda dapat mengedit nilainya di halaman ini. Objek ini dijelaskan dalam tabel di bawah.
instanceID: UNIQUE_INSTANCE_IDENTIFIER namespace: APIGEE_NAMESPACE # Usually "apigee" gcp: projectID: PROJECT_ID region: ANALYTICS_REGION workloadIdentity: enabled: false # Must be set to false to use # Workload Identity Federation on other platforms. federatedWorkloadIdentity: enabled: true audience: "AUDIENCE" credentialSourceFile: "/var/run/service-account/token" k8sCluster: name: CLUSTER_NAME region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster. org: ORG_NAME serviceAccountSecretProviderClass: apigee-orgsakeys-spc # Required for Enhanced per-environment proxy limits: enhanceProxyLimits: true # Required if using data residency with hybrid: contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com envs: - name: ENVIRONMENT_NAME serviceAccountSecretProviderClass: apigee-envsakeys-ENVIRONMENT_NAME-spc cassandra: hostNetwork: false # Set to false for single region installations and for multi-region # installations with connectivity between pods in different clusters, # like GKE. # Set to true for multi-region installations with no communication # between pods in different clusters, for example Google Distributed # Cloud on VMware or bare metal, GKE on AWS, AKS, EKS, and OpenShift. # See Multi-region deployment: Prerequisites replicaCount:
3 # Use multiples of 3 for production. # See Configure Cassandra for production for guidelines. storage: storageSize: 500Gi resources: requests: cpu: 7 memory: 15Gi maxHeapSize: 8192M heapNewSize: 1200M # Minimum storage requirements for a production environment. # See Configure Cassandra for production. ingressGateways: - name: INGRESS_NAME # maximum 17 characters. replicaCountMin: 2 replicaCountMax: 10 svcAnnotations: # optional. If you are on AKS, see Known issue #260772383 SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE virtualhosts: - name: ENVIRONMENT_GROUP_NAME selector: app: apigee-ingressgateway ingress_name: INGRESS_NAME sslCertPath: PATH_TO_CERT_FILE sslKeyPath: PATH_TO_KEY_FILE logger: enabled: false # apigee-logger does not support Workload Identity Federation. # See Known issue #341099433. # If you want to enable the apigee-logger component, add # a "logger" : "value" entry in the orgsakeys vault secret # using the contents of the apigee-logger key file for the # value. See Step 5: Set up service account authentication. # Required if using Monetization for Apigee hybrid (v1.15.1 and later) runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.1" # Must be 1.15.1 or higher. # If using message payloads larger than 10MB. # See configure large message payload support: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Gi Tabel berikut menjelaskan setiap nilai properti yang harus Anda berikan dalam file penggantian. Untuk mengetahui informasi selengkapnya, lihat Referensi properti konfigurasi.
Variabel Deskripsi UNIQUE_INSTANCE_
IDENTIFIERString unik untuk mengidentifikasi instance ini. ID dapat berupa kombinasi huruf dan angka hingga 63 karakter.
Anda dapat membuat beberapa organisasi dalam cluster yang sama, tetapi
instanceID
harus sama untuk semua organisasi dalam cluster Kubernetes yang sama.Lihat
instanceID
.APIGEE_NAMESPACE Namespace Kubernetes untuk komponen hybrid Apigee Anda.
Nilai defaultnya adalah
apigee
.Lihat
namespace
.PROJECT_ID Mengidentifikasi project Google Cloud tempat apigee-logger
danapigee-metrics
mengirim data mereka. Ini adalah nilai yang ditetapkan ke variabel lingkunganPROJECT_ID
.Lihat
gcp.projectID
.ANALYTICS_REGION Di GKE, Anda harus menetapkan nilai ini ke region yang sama dengan tempat cluster berjalan. Di semua platform lainnya, pilih wilayah analisis yang paling dekat dengan cluster Anda yang memiliki dukungan Analytics (lihat tabel di Bagian 1, Langkah 2: Buat organisasi). Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
ANALYTICS_REGION
sebelumnya.Lihat
gcp.region
.AUDIENCE Audiens yang diizinkan dari Penyedia Workload Identity. Anda dapat menemukan nilai tersebut dengan menelusuri file konfigurasi kredensial untuk istilah audience:
. Nilai audiens sama di setiap file konfigurasi kredensial.Misalnya, dalam contoh file
apigee-udca-credential-configuration.json
berikut:{ "universe_domain": "googleapis.com", "type": "external_account:," "audience": "AUDIENCE", "subject_token_type": "TOKEN_TYPE", "token_url": "TOKEN_URL", "service "impersonation_url": "IMPERSONATION_URL", "credential_source": { "file": "FILE_PATH", "format": { "type": "text" } } }
Nilai audiens akan terlihat seperti berikut (tanpa jeda baris):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"
CLUSTER_NAME Nama cluster Kubernetes Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan CLUSTER_NAME
.Lihat
k8sCluster.name
.CLUSTER_LOCATION Region tempat cluster berjalan. Ini adalah region tempat Anda membuat cluster di Langkah 1: Buat cluster. Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
CLUSTER_LOCATION
sebelumnya.Lihat
k8sCluster.location
.ORG_NAME ID organisasi hybrid Apigee Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan ORG_NAME
.Lihat
org
.CONTROL_PLANE_
LOCATIONWajib diisi jika Anda menggunakan Residensi data dengan penginstalan hybrid Apigee. Ini adalah lokasi tempat konten inti pelanggan seperti paket proxy disimpan. Untuk mengetahui daftarnya, lihat Region bidang kontrol API Apigee yang tersedia. Nilai ini ditetapkan ke variabel lingkungan CONTROL_PLANE_LOCATION
di Langkah 2: Buat organisasi.Lihat
contractProvider
.ENVIRONMENT_NAME Gunakan nama yang sama dengan yang Anda gunakan saat membuat lingkungan di UI, seperti yang dijelaskan dalam Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Lihat
envs[].name
.ENVIRONMENT_GROUP_
NAMENama grup lingkungan tempat lingkungan Anda ditetapkan. Ini adalah grup yang Anda buat di Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Ini adalah nilai yang ditetapkan ke variabel lingkungan ENV_GROUP
.Lihat
virtualhosts[].name
.INGRESS_NAME Nama gateway ingress Apigee untuk deployment Anda. Nama ini dapat berupa nama apa pun yang memenuhi persyaratan berikut: - Memiliki panjang maksimum 17 karakter
- Hanya berisi karakter alfanumerik huruf kecil, '-', atau '.'
- Diawali dengan karakter alfanumerik
- Diakhiri dengan karakter alfanumerik
Lihat:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEMasukkan jalur dan nama file kunci TLS dan sertifikat yang ditandatangani sendiri yang Anda buat sebelumnya di Langkah 6: Buat sertifikat TLS. File ini harus berada di direktori APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Contoh:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Lihat:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opsional). Ini adalah key-value pair yang menyediakan anotasi untuk layanan ingress default Anda. Platform cloud Anda menggunakan anotasi untuk membantu mengonfigurasi penginstalan hybrid, misalnya menyetel jenis load balancer ke internal atau eksternal. Anotasi bervariasi dari satu platform ke platform lainnya. Lihat dokumentasi platform Anda untuk mengetahui anotasi wajib dan yang disarankan.
Beri komentar atau hapus bagian ini jika Anda tidak menggunakannya.
Contoh
instanceID: "my_hybrid_example" namespace: "apigee" gcp: projectID: my-project region: us-central1 workloadIdentity: enabled: false federatedWorkloadIdentity: enabled: true audience: "//iam.googleapis.com/projects/123123123123/locations/global/workloadIdentityPools/my-wi-pool/providers/my-wi-provider" credentialSourceFile: "/var/run/service-account/token" k8sCluster: name: hybrid-env region: us-central1 org: my-project serviceAccountSecretProviderClass: apigee-orgsakeys-spc enhanceProxyLimits: true contractProvider: https://us-apigee.googleapis.com envs: - name: prod-env serviceAccountSecretProviderClass: apigee-envsakeys-prod-env-spc cassandra: hostNetwork: false replicaCount: 3 storage: storageSize: 500Gi resources: requests: cpu: 7 memory: 15Gi maxHeapSize: 8192M heapNewSize: 1200M ingressGateways: - name: my-ingress-1 replicaCountMin: 2 replicaCountMax: 10 virtualhosts: - name: example-env-group selector: app: apigee-ingressgateway ingress_name: my-ingress-1 sslCertPath: certs/keystore.pem sslKeyPath: certs/keystore.key logger: enabled: false # Monetization for Apigee hybrid runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.1" # For message payloads larger than 10MB: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Gi
Tabel berikut menjelaskan setiap nilai properti yang harus Anda berikan dalam file penggantian. Untuk mengetahui informasi selengkapnya, lihat Referensi properti konfigurasi.
Variabel Deskripsi UNIQUE_INSTANCE_
IDENTIFIERString unik untuk mengidentifikasi instance ini. ID dapat berupa kombinasi huruf dan angka hingga 63 karakter.
Anda dapat membuat beberapa organisasi dalam cluster yang sama, tetapi
instanceID
harus sama untuk semua organisasi dalam cluster Kubernetes yang sama.Lihat
instanceID
.APIGEE_NAMESPACE Namespace Kubernetes untuk komponen hybrid Apigee Anda.
Nilai defaultnya adalah
apigee
.Lihat
namespace
.PROJECT_ID Mengidentifikasi project Google Cloud tempat apigee-logger
danapigee-metrics
mengirim data mereka. Ini adalah nilai yang ditetapkan ke variabel lingkunganPROJECT_ID
.Lihat
gcp.projectID
.ANALYTICS_REGION Di GKE, Anda harus menetapkan nilai ini ke region yang sama dengan tempat cluster berjalan. Di semua platform lainnya, pilih wilayah analisis yang paling dekat dengan cluster Anda yang memiliki dukungan Analytics (lihat tabel di Bagian 1, Langkah 2: Buat organisasi). Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
ANALYTICS_REGION
sebelumnya.Lihat
gcp.region
.AUDIENCE Audiens yang diizinkan dari Penyedia Workload Identity. Anda dapat menemukan nilai tersebut dengan menelusuri file konfigurasi kredensial untuk istilah audience:
. Nilai audiens sama di setiap file konfigurasi kredensial.Misalnya, dalam contoh file
apigee-udca-credential-configuration.json
berikut:{ "universe_domain": "googleapis.com", "type": "external_account:," "audience": "AUDIENCE", "subject_token_type": "TOKEN_TYPE", "token_url": "TOKEN_URL", "service "impersonation_url": "IMPERSONATION_URL", "credential_source": { "file": "FILE_PATH", "format": { "type": "text" } } }
Nilai audiens akan terlihat seperti berikut (tanpa jeda baris):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"
CLUSTER_NAME Nama cluster Kubernetes Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan CLUSTER_NAME
.Lihat
k8sCluster.name
.CLUSTER_LOCATION Region tempat cluster berjalan. Ini adalah region tempat Anda membuat cluster di Langkah 1: Buat cluster. Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
CLUSTER_LOCATION
sebelumnya.Lihat
k8sCluster.location
.ORG_NAME ID organisasi hybrid Apigee Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan ORG_NAME
.Lihat
org
.CONTROL_PLANE_
LOCATIONWajib diisi jika Anda menggunakan Residensi data dengan penginstalan hybrid Apigee. Ini adalah lokasi tempat konten inti pelanggan seperti paket proxy disimpan. Untuk mengetahui daftarnya, lihat Region bidang kontrol API Apigee yang tersedia. Nilai ini ditetapkan ke variabel lingkungan CONTROL_PLANE_LOCATION
di Langkah 2: Buat organisasi.Lihat
contractProvider
.ENVIRONMENT_NAME Gunakan nama yang sama dengan yang Anda gunakan saat membuat lingkungan di UI, seperti yang dijelaskan dalam Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Lihat
envs[].name
.ENVIRONMENT_GROUP_
NAMENama grup lingkungan tempat lingkungan Anda ditetapkan. Ini adalah grup yang Anda buat di Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Ini adalah nilai yang ditetapkan ke variabel lingkungan ENV_GROUP
.Lihat
virtualhosts[].name
.INGRESS_NAME Nama gateway ingress Apigee untuk deployment Anda. Nama ini dapat berupa nama apa pun yang memenuhi persyaratan berikut: - Memiliki panjang maksimum 17 karakter
- Hanya berisi karakter alfanumerik huruf kecil, '-', atau '.'
- Diawali dengan karakter alfanumerik
- Diakhiri dengan karakter alfanumerik
Lihat:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEMasukkan jalur dan nama file kunci TLS dan sertifikat yang ditandatangani sendiri yang Anda buat sebelumnya di Langkah 6: Buat sertifikat TLS. File ini harus berada di direktori APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Contoh:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Lihat:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opsional). Ini adalah key-value pair yang menyediakan anotasi untuk layanan ingress default Anda. Platform cloud Anda menggunakan anotasi untuk membantu mengonfigurasi penginstalan hybrid, misalnya menyetel jenis load balancer ke internal atau eksternal. Anotasi bervariasi dari satu platform ke platform lainnya. Lihat dokumentasi platform Anda untuk mengetahui anotasi wajib dan yang disarankan.
Beri komentar atau hapus bagian ini jika Anda tidak menggunakannya.
Non-prod
Template
Nilai dalam red, bold italics adalah nilai properti yang harus Anda berikan. Anda dapat mengedit nilainya di halaman ini. Objek ini dijelaskan dalam tabel di bawah.
instanceID: UNIQUE_INSTANCE_IDENTIFIER namespace: APIGEE_NAMESPACE # Usually "apigee" gcp: projectID: PROJECT_ID region: ANALYTICS_REGION workloadIdentity: enabled: false # Must be set to false to use # Workload Identity Federation on other platforms. federatedWorkloadIdentity: enabled: true audience: "AUDIENCE" credentialSourceFile: "/var/run/service-account/token" k8sCluster: name: CLUSTER_NAME region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster. org: ORG_NAME serviceAccountSecretProviderClass: apigee-orgsakeys-spc # Required for Enhanced per-environment proxy limits: enhanceProxyLimits: true # Required if using data residency with hybrid: contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com envs: - name: ENVIRONMENT_NAME serviceAccountSecretProviderClass: apigee-envsakeys-ENVIRONMENT_NAME-spc cassandra: hostNetwork: false # Set to false for single region installations and for multi-region # installations with connectivity between pods in different clusters, # like GKE. # Set to true for multi-region installations with no communication # between pods in different clusters, for example Google Distributed # Cloud on VMware or bare metal, GKE on AWS, AKS, EKS, and OpenShift. # See Multi-region deployment: Prerequisites replicaCount: 1 # Use 1 for non-prod installations and multiples of 3 for production. # See Configure Cassandra for production for guidelines. ingressGateways: - name: INGRESS_NAME # maximum 17 characters. replicaCountMin: 2 replicaCountMax: 10 svcAnnotations: # optional. If you are on AKS, see Known issue #260772383 SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE virtualhosts: - name: ENVIRONMENT_GROUP_NAME selector: app: apigee-ingressgateway ingress_name: INGRESS_NAME sslCertPath: PATH_TO_CERT_FILE sslKeyPath: PATH_TO_KEY_FILE logger: enabled: false # apigee-logger does not support Workload Identity Federation. # See Known issue #341099433. # If you want to enable the apigee-logger component, add # a "logger" : "value" entry in the orgsakeys vault secret # using the contents of the apigee-non-prod key file for the # value. See Step 5: Set up service account authentication. # Required if using Monetization for Apigee hybrid (v1.15.1 and later) runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.1" # Must be 1.15.1 or higher. # If using message payloads larger than 10MB. # See configure large message payload support: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Gi
Tabel berikut menjelaskan setiap nilai properti yang harus Anda berikan dalam file penggantian. Untuk mengetahui informasi selengkapnya, lihat Referensi properti konfigurasi.
Variabel Deskripsi UNIQUE_INSTANCE_
IDENTIFIERString unik untuk mengidentifikasi instance ini. ID dapat berupa kombinasi huruf dan angka hingga 63 karakter.
Anda dapat membuat beberapa organisasi dalam cluster yang sama, tetapi
instanceID
harus sama untuk semua organisasi dalam cluster Kubernetes yang sama.Lihat
instanceID
.APIGEE_NAMESPACE Namespace Kubernetes untuk komponen hybrid Apigee Anda.
Nilai defaultnya adalah
apigee
.Lihat
namespace
.PROJECT_ID Mengidentifikasi project Google Cloud tempat apigee-logger
danapigee-metrics
mengirim data mereka. Ini adalah nilai yang ditetapkan ke variabel lingkunganPROJECT_ID
.Lihat
gcp.projectID
.ANALYTICS_REGION Di GKE, Anda harus menetapkan nilai ini ke region yang sama dengan tempat cluster berjalan. Di semua platform lainnya, pilih wilayah analisis yang paling dekat dengan cluster Anda yang memiliki dukungan Analytics (lihat tabel di Bagian 1, Langkah 2: Buat organisasi). Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
ANALYTICS_REGION
sebelumnya.Lihat
gcp.region
.AUDIENCE Audiens yang diizinkan dari Penyedia Workload Identity. Anda dapat menemukan nilai tersebut dengan menelusuri file konfigurasi kredensial untuk istilah audience:
. Nilai audiens sama di setiap file konfigurasi kredensial.Misalnya, dalam contoh file
apigee-udca-credential-configuration.json
berikut:{ "universe_domain": "googleapis.com", "type": "external_account:," "audience": "AUDIENCE", "subject_token_type": "TOKEN_TYPE", "token_url": "TOKEN_URL", "service "impersonation_url": "IMPERSONATION_URL", "credential_source": { "file": "FILE_PATH", "format": { "type": "text" } } }
Nilai audiens akan terlihat seperti berikut (tanpa jeda baris):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"
CLUSTER_NAME Nama cluster Kubernetes Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan CLUSTER_NAME
.Lihat
k8sCluster.name
.CLUSTER_LOCATION Region tempat cluster berjalan. Ini adalah region tempat Anda membuat cluster di Langkah 1: Buat cluster. Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
CLUSTER_LOCATION
sebelumnya.Lihat
k8sCluster.location
.ORG_NAME ID organisasi hybrid Apigee Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan ORG_NAME
.Lihat
org
.CONTROL_PLANE_
LOCATIONWajib diisi jika Anda menggunakan Residensi data dengan penginstalan hybrid Apigee. Ini adalah lokasi tempat konten inti pelanggan seperti paket proxy disimpan. Untuk mengetahui daftarnya, lihat Region bidang kontrol API Apigee yang tersedia. Nilai ini ditetapkan ke variabel lingkungan CONTROL_PLANE_LOCATION
di Langkah 2: Buat organisasi.Lihat
contractProvider
.ENVIRONMENT_NAME Gunakan nama yang sama dengan yang Anda gunakan saat membuat lingkungan di UI, seperti yang dijelaskan dalam Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Lihat
envs[].name
.ENVIRONMENT_GROUP_
NAMENama grup lingkungan tempat lingkungan Anda ditetapkan. Ini adalah grup yang Anda buat di Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Ini adalah nilai yang ditetapkan ke variabel lingkungan ENV_GROUP
.Lihat
virtualhosts[].name
.INGRESS_NAME Nama gateway ingress Apigee untuk deployment Anda. Nama ini dapat berupa nama apa pun yang memenuhi persyaratan berikut: - Memiliki panjang maksimum 17 karakter
- Hanya berisi karakter alfanumerik huruf kecil, '-', atau '.'
- Diawali dengan karakter alfanumerik
- Diakhiri dengan karakter alfanumerik
Lihat:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEMasukkan jalur dan nama file kunci TLS dan sertifikat yang ditandatangani sendiri yang Anda buat sebelumnya di Langkah 6: Buat sertifikat TLS. File ini harus berada di direktori APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Contoh:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Lihat:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opsional). Ini adalah key-value pair yang menyediakan anotasi untuk layanan ingress default Anda. Platform cloud Anda menggunakan anotasi untuk membantu mengonfigurasi penginstalan hybrid, misalnya menyetel jenis load balancer ke internal atau eksternal. Anotasi bervariasi dari satu platform ke platform lainnya. Lihat dokumentasi platform Anda untuk mengetahui anotasi wajib dan yang disarankan.
Beri komentar atau hapus bagian ini jika Anda tidak menggunakannya.
Contoh
instanceID: "my_hybrid_example" namespace: "apigee" gcp: projectID: my-project region: us-central1 workloadIdentity: enabled: false federatedWorkloadIdentity: enabled: true audience: "//iam.googleapis.com/projects/123123123123/locations/global/workloadIdentityPools/my-wi-pool/providers/my-wi-provider" credentialSourceFile: "/var/run/service-account/token" k8sCluster: name: hybrid-env region: us-central1 org: my-project serviceAccountSecretProviderClass: apigee-orgsakeys-spc enhanceProxyLimits: true contractProvider: https://us-apigee.googleapis.com envs: - name: test serviceAccountSecretProviderClass: apigee-envsakeys-test-env-spc cassandra: hostNetwork: false replicaCount: 1 ingressGateways: - name: my-ingress-1 replicaCountMin: 2 replicaCountMax: 10 virtualhosts: - name: example-env-group selector: app: apigee-ingressgateway ingress_name: my-ingress-1 sslCertPath: certs/keystore.pem sslKeyPath: certs/keystore.key logger: enabled: false # Monetization for Apigee hybrid runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.1" # for message payloads larger than 10MB: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Gi
Tabel berikut menjelaskan setiap nilai properti yang harus Anda berikan dalam file penggantian. Untuk mengetahui informasi selengkapnya, lihat Referensi properti konfigurasi.
Variabel Deskripsi UNIQUE_INSTANCE_
IDENTIFIERString unik untuk mengidentifikasi instance ini. ID dapat berupa kombinasi huruf dan angka hingga 63 karakter.
Anda dapat membuat beberapa organisasi dalam cluster yang sama, tetapi
instanceID
harus sama untuk semua organisasi dalam cluster Kubernetes yang sama.Lihat
instanceID
.APIGEE_NAMESPACE Namespace Kubernetes untuk komponen hybrid Apigee Anda.
Nilai defaultnya adalah
apigee
.Lihat
namespace
.PROJECT_ID Mengidentifikasi project Google Cloud tempat apigee-logger
danapigee-metrics
mengirim data mereka. Ini adalah nilai yang ditetapkan ke variabel lingkunganPROJECT_ID
.Lihat
gcp.projectID
.ANALYTICS_REGION Di GKE, Anda harus menetapkan nilai ini ke region yang sama dengan tempat cluster berjalan. Di semua platform lainnya, pilih wilayah analisis yang paling dekat dengan cluster Anda yang memiliki dukungan Analytics (lihat tabel di Bagian 1, Langkah 2: Buat organisasi). Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
ANALYTICS_REGION
sebelumnya.Lihat
gcp.region
.AUDIENCE Audiens yang diizinkan dari Penyedia Workload Identity. Anda dapat menemukan nilai tersebut dengan menelusuri file konfigurasi kredensial untuk istilah audience:
. Nilai audiens sama di setiap file konfigurasi kredensial.Misalnya, dalam contoh file
apigee-udca-credential-configuration.json
berikut:{ "universe_domain": "googleapis.com", "type": "external_account:," "audience": "AUDIENCE", "subject_token_type": "TOKEN_TYPE", "token_url": "TOKEN_URL", "service "impersonation_url": "IMPERSONATION_URL", "credential_source": { "file": "FILE_PATH", "format": { "type": "text" } } }
Nilai audiens akan terlihat seperti berikut (tanpa jeda baris):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"
CLUSTER_NAME Nama cluster Kubernetes Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan CLUSTER_NAME
.Lihat
k8sCluster.name
.CLUSTER_LOCATION Region tempat cluster berjalan. Ini adalah region tempat Anda membuat cluster di Langkah 1: Buat cluster. Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
CLUSTER_LOCATION
sebelumnya.Lihat
k8sCluster.location
.ORG_NAME ID organisasi hybrid Apigee Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan ORG_NAME
.Lihat
org
.CONTROL_PLANE_
LOCATIONWajib diisi jika Anda menggunakan Residensi data dengan penginstalan hybrid Apigee. Ini adalah lokasi tempat konten inti pelanggan seperti paket proxy disimpan. Untuk mengetahui daftarnya, lihat Region bidang kontrol API Apigee yang tersedia. Nilai ini ditetapkan ke variabel lingkungan CONTROL_PLANE_LOCATION
di Langkah 2: Buat organisasi.Lihat
contractProvider
.ENVIRONMENT_NAME Gunakan nama yang sama dengan yang Anda gunakan saat membuat lingkungan di UI, seperti yang dijelaskan dalam Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Lihat
envs[].name
.ENVIRONMENT_GROUP_
NAMENama grup lingkungan tempat lingkungan Anda ditetapkan. Ini adalah grup yang Anda buat di Penyiapan project dan organisasi - Langkah 3: Buat grup lingkungan. Ini adalah nilai yang ditetapkan ke variabel lingkungan ENV_GROUP
.Lihat
virtualhosts[].name
.INGRESS_NAME Nama gateway ingress Apigee untuk deployment Anda. Nama ini dapat berupa nama apa pun yang memenuhi persyaratan berikut: - Memiliki panjang maksimum 17 karakter
- Hanya berisi karakter alfanumerik huruf kecil, '-', atau '.'
- Diawali dengan karakter alfanumerik
- Diakhiri dengan karakter alfanumerik
Lihat:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEMasukkan jalur dan nama file kunci TLS dan sertifikat yang ditandatangani sendiri yang Anda buat sebelumnya di Langkah 6: Buat sertifikat TLS. File ini harus berada di direktori APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Contoh:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Lihat:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opsional). Ini adalah key-value pair yang menyediakan anotasi untuk layanan ingress default Anda. Platform cloud Anda menggunakan anotasi untuk membantu mengonfigurasi penginstalan hybrid, misalnya menyetel jenis load balancer ke internal atau eksternal. Anotasi bervariasi dari satu platform ke platform lainnya. Lihat dokumentasi platform Anda untuk mengetahui anotasi wajib dan yang disarankan.
Beri komentar atau hapus bagian ini jika Anda tidak menggunakannya.
Ringkasan
File konfigurasi memberi tahu Kubernetes cara men-deploy komponen hibrida ke cluster. Selanjutnya, Anda akan mengaktifkan akses sinkronisasi sehingga bidang pengelolaan dan runtime Apigee dapat berkomunikasi.
Langkah berikutnya
1 2 3 4 5 6 7 (BERIKUTNYA) Langkah 8: Aktifkan akses Control Plane 9 10 11