Penginstal Apigee hybrid menggunakan setelan default untuk banyak setelan; namun, ada beberapa setelan yang tidak memiliki setelan default. Anda harus memberikan nilai untuk setelan ini, seperti yang dijelaskan di bawah.
Pastikan Anda berada di direktori hybrid-base-directory/hybrid-files/overrides/.
cd hybrid-base-directory/hybrid-files/overrides
Buat file baru bernama overrides.yaml di editor teks favorit Anda. Misalnya:
vi overrides.yaml
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, yang ditunjukkan di bawah. Deskripsi
mendetail untuk setiap properti juga diberikan di bawah ini:
Sintaks
Pastikan file overrides.yaml memiliki struktur dan sintaksis berikut.
Nilai dalam red, bold italics adalah
nilai properti yang harus Anda berikan. Hal ini dijelaskan dalam tabel di bawah.
Ada perbedaan antara berbagai platform untuk region project Google Cloud dan
region cluster Kubernetes. Pilih platform tempat Anda menginstal Apigee hybrid.
gcp:
region: analytics-region
projectID: gcp-project-id
k8sCluster:
name: cluster-name
region: cluster-location # Must be the closest Google Cloud region to your cluster.
org: org-name
instanceID: "unique-instance-identifier"
cassandra:
hostNetwork: false
# Set to false for single region installations and multi-region installations
# with connectivity between pods in different clusters, for example GKE installations.
# Set to true for multi-region installations with no communication between
# pods in different clusters, for example GKE On-prem, GKE on AWS, Anthos on bare metal,
# AKS, EKS, and OpenShift installations.
# See Multi-region deployment: Prerequisites
virtualhosts:
- name: environment-group-name
sslCertPath: ./certs/cert-name.pem
sslKeyPath: ./certs/key-name.key
envs:
- name: environment-name
serviceAccountPaths:
synchronizer: ./service-accounts/synchronizer-service-account-name.json
# for non-production environments, gcp-project-id-apigee-non-prod.json
# for production environments, gcp-project-apigee-synchronizer.json
udca: ./service-accounts/udca-service-account-name.json
# for non-production environments, gcp-project-id-apigee-non-prod.json
# for production environments, gcp-project-id-apigee-udca.json
mart:
serviceAccountPath: ./service-accounts/mart-service-account-name.json
# for non-production environments, gcp-project-id-apigee-non-prod.json
# for production environments, gcp-project-id-apigee-mart.json
connectAgent:
serviceAccountPath: ./service-accounts/mart-service-account-name.json
# for non-production environments, gcp-project-id-apigee-non-prod.json
# for production environments, gcp-project-id-apigee-mart.json
# Same account used for mart and connectAgent
metrics:
serviceAccountPath: ./service-accounts/metrics-service-account-name.json
# for non-production environments, gcp-project-id-apigee-non-prod.json
# for production environments, gcp-project-id-apigee-metrics.json
watcher:
serviceAccountPath: ./service-accounts/watcher-service-account-name.json
# for non-production environments, gcp-project-id-apigee-non-prod.json
# for production environments, gcp-project-id-apigee-watcher.json
logger:
enabled: true # set to "false" for GKE.
serviceAccountPath: ./service-accounts/logger-service-account-name.json
# for non-production environments, gcp-project-id-apigee-non-prod.json
# for production environments, gcp-project-id-apigee-logger.json
Contoh
Contoh berikut menunjukkan file penggantian yang telah selesai dengan contoh nilai properti
yang ditambahkan:
gcp:
region: us-central1
projectID: hybrid-example
k8sCluster:
name: apigee-hybrid
region: us-central1
org: hybrid-example
instanceID: "my_hybrid_example"
cassandra:
hostNetwork: false
virtualhosts:
- name: example-env-group
sslCertPath: ./certs/keystore.pem
sslKeyPath: ./certs/keystore.key
envs:
- name: test
serviceAccountPaths:
synchronizer: ./service-accounts/hybrid-project-apigee-non-prod.json
# for production environments, hybrid-project-apigee-synchronizer.json
udca: ./service-accounts/hybrid-project-apigee-non-prod.json
# for production environments, hybrid-project-apigee-udca.json
mart:
serviceAccountPath: ./service-accounts/hybrid-project-apigee-non-prod.json
# for production environments, hybrid-project-apigee-mart.json
connectAgent:
serviceAccountPath: ./service-accounts/hybrid-project-apigee-non-prod.json
# for production environments, example-hybrid-apigee-mart.json
metrics:
serviceAccountPath: ./service-accounts/hybrid-project-apigee-non-prod.json
# for production environments, hybrid-project-apigee-metrics.json
watcher:
serviceAccountPath: ./service-accounts/hybrid-project-apigee-non-prod.json
# for production environments, hybrid-project-apigee-watcher.json
logger:
enabled: true # set to "false" for GKE.
serviceAccountPath: ./service-accounts/hybrid-project-apigee-non-prod.json
# for production environments, logger-service-account-name.json
Setelah selesai, simpan file.
Tabel berikut menjelaskan setiap nilai properti yang harus Anda berikan dalam
file penggantian. Untuk mengetahui informasi selengkapnya, lihat
Referensi properti konfigurasi.
Variabel
Deskripsi
analytics-region
Di GKE, Anda harus menetapkan nilai ini ke region yang sama dengan tempat cluster berjalan. Di semua
platform lainnya, pilih region analisis terdekat ke cluster Anda yang memiliki dukungan
Analytics (lihat tabel di
Bagian 1, Langkah 4: Membuat organisasi.
Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
ANALYTICS_REGION sebelumnya.
gcp-project-id
Mengidentifikasi project Google Cloud tempat apigee-logger dan apigee-metrics mendorong datanya. Ini adalah nilai yang ditetapkan ke variabel lingkungan PROJECT_ID.
cluster-name
Nama cluster Kubernetes Anda. Ini adalah nilai yang ditetapkan ke variabel lingkungan
CLUSTER_NAME.
cluster-location
Region tempat cluster berjalan. Ini adalah region tempat Anda membuat cluster di Langkah 1: Membuat cluster.
Ini adalah nilai yang Anda tetapkan ke variabel lingkungan
CLUSTER_LOCATION sebelumnya.
org-name
ID organisasi hybrid Apigee Anda. Ini adalah nilai yang ditetapkan ke variabel
lingkungan ORG_NAME.
unique-instance-identifier
String unik untuk mengidentifikasi instance ini. Nama ini dapat berupa kombinasi huruf dan angka dengan panjang maksimal 63 karakter.
Anda dapat membuat beberapa organisasi di cluster yang sama, tetapi instanceId harus sama untuk semua organisasi di cluster kubernetes yang sama.
Masukkan nama file kunci dan sertifikat TLS yang ditandatangani sendiri yang Anda buat sebelumnya di
Langkah 6: Membuat sertifikat TLS.
File ini harus berada di
direktori base_directory/hybrid-files/certs. Contoh:
Untuk lingkungan non-produksi, nama satu akun layanan,
non-prod secara default. Untuk lingkungan produksi, nama file kunci akun layanan apigee-synchronizer yang Anda buat dengan alat create-service-account di Penyiapan runtime campuran - Langkah 6: Membuat akun layanan dan kredensial. Anda dapat melihat daftar file akun layanan di direktori service-accounts/. Misalnya:
ls ../service-accounts/
udca-service-account-name
Untuk lingkungan non-produksi, nama satu akun layanan,
non-prod secara default. Untuk lingkungan produksi, nama file kunci akun layanan apigee-udca yang Anda buat dengan alat create-service-account.
mart-service-account-name
Untuk lingkungan non-produksi, nama satu akun layanan,
non-prod secara default. Untuk lingkungan produksi, nama file kunci akun layanan apigee-mart yang Anda buat dengan alat create-service-account.
metrics-service-account-name
Untuk lingkungan non-produksi, nama satu akun layanan,
non-prod secara default. Untuk lingkungan produksi, nama file kunci akun layanan apigee-metrics yang Anda buat dengan alat create-service-account.
watcher-service-account-name
Untuk lingkungan non-produksi, nama satu akun layanan,
non-prod secara default. Untuk lingkungan produksi, nama file kunci akun layanan apigee-watcher yang Anda buat dengan alat create-service-account.
logger-service-account-name
Untuk lingkungan non-produksi, nama satu akun layanan,
non-prod secara default. Untuk lingkungan produksi, nama file kunci akun layanan apigee-logger yang Anda buat dengan alat create-service-account.
Ringkasan
File konfigurasi memberi tahu Kubernetes cara men-deploy komponen campuran ke
cluster. Selanjutnya, Anda akan mengaktifkan akses sinkronisasi sehingga runtime dan platform pengelolaan Apigee
dapat berkomunikasi.
[[["Mudah dipahami","easyToUnderstand","thumb-up"],["Memecahkan masalah saya","solvedMyProblem","thumb-up"],["Lainnya","otherUp","thumb-up"]],[["Sulit dipahami","hardToUnderstand","thumb-down"],["Informasi atau kode contoh salah","incorrectInformationOrSampleCode","thumb-down"],["Informasi/contoh yang saya butuhkan tidak ada","missingTheInformationSamplesINeed","thumb-down"],["Masalah terjemahan","translationIssue","thumb-down"],["Lainnya","otherDown","thumb-down"]],["Terakhir diperbarui pada 2025-09-03 UTC."],[[["\u003cp\u003eThis document provides instructions for configuring the \u003ccode\u003eoverrides.yaml\u003c/code\u003e file, which is essential for customizing your unique Apigee hybrid installation, using a basic setup suitable for a first-time installation.\u003c/p\u003e\n"],["\u003cp\u003eYou must navigate to the \u003ccode\u003ehybrid-base-directory/hybrid-files/overrides\u003c/code\u003e directory and create an \u003ccode\u003eoverrides.yaml\u003c/code\u003e file to specify required properties like \u003ccode\u003egcp\u003c/code\u003e, \u003ccode\u003ek8sCluster\u003c/code\u003e, \u003ccode\u003eorg\u003c/code\u003e, and others to enable a functional Apigee hybrid environment.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eoverrides.yaml\u003c/code\u003e file uses a specific syntax, including defining values for regions, project IDs, cluster names, organization names, and unique instance identifiers, along with service account paths and virtual host details, that must be specified.\u003c/p\u003e\n"],["\u003cp\u003eSpecific service account key files, generated by the create-service-account tool, must be referenced within the \u003ccode\u003eoverrides.yaml\u003c/code\u003e file for components such as synchronizer, udca, mart, metrics, watcher, and logger.\u003c/p\u003e\n"],["\u003cp\u003eThe document version (1.5) of the Apigee hybrid documentation you are viewing is end-of-life, and you should consider upgrading to a newer version for the most up-to-date information and support.\u003c/p\u003e\n"]]],[],null,["# Step 7: Configure the hybrid runtime\n\n| You are currently viewing version 1.5 of the Apigee hybrid documentation. **This version is end of life.** You should upgrade to a newer version. For more information, see [Supported versions](/apigee/docs/hybrid/supported-platforms#supported-versions).\n\nSpecify configuration overrides\n-------------------------------\n\n\nThe Apigee hybrid installer uses defaults for many settings; however, there are a few settings\nthat do not have defaults. You must provide values for these settings, as explained next.\n\n1. Be sure you are in the \u003cvar translate=\"no\"\u003ehybrid-base-directory\u003c/var\u003e`/hybrid-files/overrides/` directory. \n\n ```\n cd hybrid-base-directory/hybrid-files/overrides\n ```\n2. Create a new file named **\u003cvar translate=\"no\"\u003eoverrides\u003c/var\u003e`.yaml`** in your favorite text editor. For example: \n\n ```\n vi overrides.yaml\n ```\n\n\n The \u003cvar translate=\"no\"\u003eoverrides\u003c/var\u003e`.yaml` provides the configuration for your unique Apigee hybrid\n installation. The overrides file in this step provides a basic configuration for a small-footprint\n hybrid runtime installation, suitable for your first installation.\n3. In \u003cvar translate=\"no\"\u003eoverrides\u003c/var\u003e`.yaml`, add the required property values, shown below. A detailed description of each property is also provided below: \n\n ### Syntax\n\n Make sure the \u003cvar translate=\"no\"\u003eoverrides\u003c/var\u003e`.yaml` file has the following structure and syntax.\n Values in \u003cvar translate=\"no\"\u003ered, bold italics\u003c/var\u003e are\n property values that you must provide. They are described in the [table below](#tablebelow).\n\n\n There are differences between the different platforms for the Google Cloud project region and\n Kubernetes cluster region. Choose the platform where you are installing Apigee hybrid. \n\n ```\n gcp:\n region: analytics-region\n projectID: gcp-project-id\n\n k8sCluster:\n name: cluster-name\n region: cluster-location # Must be the closest Google Cloud region to your cluster.\n org: org-name\n\n instanceID: \"unique-instance-identifier\"\n \n cassandra:\n hostNetwork: false\n # Set to false for single region installations and multi-region installations\n # with connectivity between pods in different clusters, for example GKE installations.\n # Set to true for multi-region installations with no communication between\n # pods in different clusters, for example GKE On-prem, GKE on AWS, Anthos on bare metal,\n # AKS, EKS, and OpenShift installations.\n # See Multi-region deployment: Prerequisites\n\n virtualhosts:\n - name: environment-group-name\n sslCertPath: ./certs/cert-name.pem\n sslKeyPath: ./certs/key-name.key\n\n envs:\n - name: environment-name\n serviceAccountPaths:\n synchronizer: ./service-accounts/synchronizer-service-account-name.json\n # for non-production environments, gcp-project-id-apigee-non-prod.json\n # for production environments, gcp-project-apigee-synchronizer.json\n udca: ./service-accounts/udca-service-account-name.json\n # for non-production environments, gcp-project-id-apigee-non-prod.json\n # for production environments, gcp-project-id-apigee-udca.json\n\n mart:\n serviceAccountPath: ./service-accounts/mart-service-account-name.json\n # for non-production environments, gcp-project-id-apigee-non-prod.json\n # for production environments, gcp-project-id-apigee-mart.json\n\n connectAgent:\n serviceAccountPath: ./service-accounts/mart-service-account-name.json\n # for non-production environments, gcp-project-id-apigee-non-prod.json\n # for production environments, gcp-project-id-apigee-mart.json\n # Same account used for mart and connectAgent\n\n metrics:\n serviceAccountPath: ./service-accounts/metrics-service-account-name.json\n # for non-production environments, gcp-project-id-apigee-non-prod.json\n # for production environments, gcp-project-id-apigee-metrics.json\n\n watcher:\n serviceAccountPath: ./service-accounts/watcher-service-account-name.json\n # for non-production environments, gcp-project-id-apigee-non-prod.json\n # for production environments, gcp-project-id-apigee-watcher.json\n\n logger:\n enabled: true # set to \"false\" for GKE.\n serviceAccountPath: ./service-accounts/logger-service-account-name.json\n # for non-production environments, gcp-project-id-apigee-non-prod.json\n # for production environments, gcp-project-id-apigee-logger.json\n\n ```\n\n ### Example\n\n The following example shows a completed overrides file with example property values\n added: \n\n ```\n gcp:\n region: us-central1\n projectID: hybrid-example\n\n k8sCluster:\n name: apigee-hybrid\n region: us-central1\n\n org: hybrid-example\n\n instanceID: \"my_hybrid_example\"\n \n cassandra:\n hostNetwork: false\n\n virtualhosts:\n - name: example-env-group\n sslCertPath: ./certs/keystore.pem\n sslKeyPath: ./certs/keystore.key\n\n envs:\n - name: test\n serviceAccountPaths:\n synchronizer: ./service-accounts/hybrid-project-apigee-non-prod.json\n # for production environments, hybrid-project-apigee-synchronizer.json\n udca: ./service-accounts/hybrid-project-apigee-non-prod.json\n # for production environments, hybrid-project-apigee-udca.json\n\n mart:\n serviceAccountPath: ./service-accounts/hybrid-project-apigee-non-prod.json\n # for production environments, hybrid-project-apigee-mart.json\n\n connectAgent:\n serviceAccountPath: ./service-accounts/hybrid-project-apigee-non-prod.json\n # for production environments, example-hybrid-apigee-mart.json\n\n metrics:\n serviceAccountPath: ./service-accounts/hybrid-project-apigee-non-prod.json\n # for production environments, hybrid-project-apigee-metrics.json\n\n watcher:\n serviceAccountPath: ./service-accounts/hybrid-project-apigee-non-prod.json\n # for production environments, hybrid-project-apigee-watcher.json\n\n logger:\n enabled: true # set to \"false\" for GKE.\n serviceAccountPath: ./service-accounts/hybrid-project-apigee-non-prod.json\n # for production environments, logger-service-account-name.json\n\n ```\n4. When you are finished, save the file.\n\n\nThe following table describes each of the property values that you must provide in the\noverrides file. For more information, see\n[Configuration property reference](/apigee/docs/hybrid/v1.5/config-prop-ref).\n\n| **Note:** If you want to create a security perimeter around your cluster and related Cloud services, you can configure one using Google Cloud [Virtual Private Cloud (VPC) Service\n| Controls](https://cloud.google.com/vpc-service-controls) with Apigee hybrid. See [Using\n| VPC Service Controls with Apigee and Apigee hybrid](/apigee/docs/api-platform/security/vpc-sc) for instructions.\n\nSummary\n-------\n\n\nThe configuration file tells Kubernetes how to deploy the hybrid components to\na cluster. Next, you will enable synchronizer access so the Apigee runtime and management planes\nwill be able to communicate.\n[1](/apigee/docs/hybrid/v1.5/install-create-cluster) [2](/apigee/docs/hybrid/v1.5/install-cert-manager) [3](/apigee/docs/hybrid/v1.5/install-asm) [4](/apigee/docs/hybrid/v1.5/install-apigeectl) [5](/apigee/docs/hybrid/v1.5/install-service-accounts) [6](/apigee/docs/hybrid/v1.5/install-create-tls-certificates) [7](/apigee/docs/hybrid/v1.5/install-configure-cluster) [(NEXT) Step 8: Enable Synchronizer access](/apigee/docs/hybrid/v1.5/install-enable-synchronizer-access) [9](/apigee/docs/hybrid/v1.5/install-hybrid-runtime)\n\n\u003cbr /\u003e"]]
