L'installatore di Apigee Hybrid utilizza i valori predefiniti per molte impostazioni. Tuttavia, alcune impostazioni
non hanno valori predefiniti. Devi fornire i valori per queste impostazioni, come spiegato di seguito.
Assicurati di trovarti nella directory hybrid-base-directory/hybrid-files/overrides/.
cd hybrid-base-directory/hybrid-files/overrides
Crea un nuovo file denominato overrides.yaml nel tuo editor di testo preferito. Ad esempio:
vi overrides.yaml
overrides.yaml fornisce la configurazione per la tua installazione unica di Apigee hybrid. Il file delle sostituzioni in questo passaggio fornisce una configurazione di base per un'installazione del runtime hybrid di piccole dimensioni, adatta per la prima installazione.
In overrides.yaml, aggiungi i valori delle proprietà richiesti, mostrati di seguito. Di seguito è riportata anche una descrizione dettagliata di ogni proprietà:
Sintassi
Assicurati che il file overrides.yaml abbia la seguente struttura e sintassi.
I valori in red, bold italics sono
valori delle proprietà che devi fornire. Sono descritti nella tabella riportata di seguito.
gcp:
region: analytics-region
projectID: gcp-project-id
k8sCluster:
name: cluster-name
region: cluster-region # Must be the same region where the cluster is running.
org: org-name
instanceID: "unique-instance-identifier"
cassandra:
hostNetwork: false #Set this to `true` for GKE-On-prem installations.
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
udca: ./service-accounts/udca-service-account-name.json
mart:
serviceAccountPath: ./service-accounts/mart-service-account-name.json
connectAgent:
serviceAccountPath: ./service-accounts/mart-service-account-name.json
# Same account used for mart and connectAgent
metrics:
serviceAccountPath: ./service-accounts/metrics-service-account-name.json
watcher:
serviceAccountPath: ./service-accounts/watcher-service-account-name.json
logger:
enabled: true
serviceAccountPath: ./service-accounts/logger-service-account-name.json
Esempio
L'esempio seguente mostra un file delle sostituzioni completato con valori di proprietà di esempio aggiunti:
La tabella seguente descrive ciascuno dei valori delle proprietà che devi fornire nel
file delle sostituzioni. Per ulteriori informazioni, consulta
Riferimento per le proprietà di configurazione.
Variabile
Descrizione
analytics-region
Devi impostare questo valore sulla stessa regione in cui è in esecuzione il cluster.
Questo è il valore che hai assegnato alla variabile di ambiente
ANALYTICS_REGION in precedenza
durante la creazione del cluster
I apigee-logger e apigee-metrics inviano i propri
dati a questa regione.
gcp-project-id
Identifica il progetto Google Cloud in cui apigee-logger e apigee-metrics inviano
i propri dati. Questo è il valore assegnato alla variabile di ambiente PROJECT_ID.
cluster-name
Il nome del cluster Kubernetes. Questo è il valore assegnato alla variabile di ambiente
CLUSTER_NAME.
org-name
L'ID della tua organizzazione Apigee hybrid. Questo è il valore assegnato alla variabile di ambiente
ORG_NAME.
unique-instance-identifier
Una stringa univoca per identificare questa istanza. Può essere una combinazione qualsiasi di lettere e
numeri con una lunghezza massima di 63 caratteri.
Puoi creare più organizzazioni nello stesso cluster, ma instanceId deve essere uguale per tutte le organizzazioni nello stesso cluster Kubernetes
Inserisci il nome dei file della chiave e del certificato TLS autofirmati che hai generato in precedenza nel
Passaggio 3: installa apigeectl.
Questi file devono trovarsi
nella directory base_directory/hybrid-files/certs. Ad esempio:
Il nome dell'account di servizio mart (a cui è assegnato il ruolo Agente Apigee Connect) che hai creato nel
passaggio 3: installa apigeectl.
MART e l'agente Apigee Connect utilizzano lo stesso account di servizio.
watcher-service-account-name
Il nome del file JSON dell'account di servizio watcher che hai generato con lo strumento
create-service-account. Ad esempio:
Il file di configurazione indica a Kubernetes come eseguire il deployment dei componenti ibridi in un cluster. Successivamente, dovrai applicare questa configurazione al tuo cluster.
[[["Facile da capire","easyToUnderstand","thumb-up"],["Il problema è stato risolto","solvedMyProblem","thumb-up"],["Altra","otherUp","thumb-up"]],[["Difficile da capire","hardToUnderstand","thumb-down"],["Informazioni o codice di esempio errati","incorrectInformationOrSampleCode","thumb-down"],["Mancano le informazioni o gli esempi di cui ho bisogno","missingTheInformationSamplesINeed","thumb-down"],["Problema di traduzione","translationIssue","thumb-down"],["Altra","otherDown","thumb-down"]],["Ultimo aggiornamento 2025-09-05 UTC."],[[["\u003cp\u003eThis documentation outlines the process of setting up configuration overrides for an Apigee hybrid installation, which requires creating an \u003ccode\u003eoverrides.yaml\u003c/code\u003e file in the specified directory.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eoverrides.yaml\u003c/code\u003e file requires specific property values related to GCP, Kubernetes cluster details, organization specifics, and service account paths for various Apigee components, such as synchronizer, UDCA, mart, metrics, watcher, and logger.\u003c/p\u003e\n"],["\u003cp\u003eSeveral essential property values in \u003ccode\u003eoverrides.yaml\u003c/code\u003e need to match previously set environment variables, such as the analytics region, GCP project ID, cluster name, and organization name.\u003c/p\u003e\n"],["\u003cp\u003eEach service account (synchronizer, UDCA, mart, etc.) needs its unique service account key file generated and referenced in the \u003ccode\u003eoverrides.yaml\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe instance ID must be unique and consistent across all organizations in the same Kubernetes cluster, while environment group configurations must be included in the overrides file for each cluster instance when using multiple regions.\u003c/p\u003e\n"]]],[],null,["# Step 4: Configure the cluster\n\n| You are currently viewing version 1.3 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\n gcp:\n region: analytics-region\n projectID: gcp-project-id\n\n k8sCluster:\n name: cluster-name\n region: cluster-region # Must be the same region where the cluster is running.\n\n org: org-name\n\n instanceID: \"unique-instance-identifier\"\n\n cassandra:\n hostNetwork: false #Set this to `true` for GKE-On-prem installations.\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 udca: ./service-accounts/udca-service-account-name.json\n\n mart:\n serviceAccountPath: ./service-accounts/mart-service-account-name.json\n\n connectAgent:\n serviceAccountPath: ./service-accounts/mart-service-account-name.json\n # Same account used for mart and connectAgent\n\n metrics:\n serviceAccountPath: ./service-accounts/metrics-service-account-name.json\n\n watcher:\n serviceAccountPath: ./service-accounts/watcher-service-account-name.json\n\n logger:\n enabled: true\n serviceAccountPath: ./service-accounts/logger-service-account-name.json\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 #Set this to `true` for GKE-On Prem installations.\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-synchronizer.json\n udca: ./service-accounts/hybrid-project-apigee-udca.json\n\n mart:\n serviceAccountPath: ./service-accounts/hybrid-project-apigee-mart.json\n\n connectAgent:\n serviceAccountPath: ./service-accounts/example-hybrid-apigee-mart.json\n\n metrics:\n serviceAccountPath: ./service-accounts/hybrid-project-apigee-metrics.json\n\n watcher:\n serviceAccountPath: ./service-accounts/hybrid-project-apigee-watcher.json\n\n logger:\n enabled: true\n serviceAccountPath: ./service-accounts/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.3/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 apply this configuration to your cluster.\n[1](/apigee/docs/hybrid/v1.3/install-create-cluster) [2](/apigee/docs/hybrid/v1.3/install-download-cert-manager-istio) [3](/apigee/docs/hybrid/v1.3/install-download-install) [4](/apigee/docs/hybrid/v1.3/install-copy-overrides) [(NEXT) Step 5: Install hybrid runtime](/apigee/docs/hybrid/v1.3/install-apply-hybrid)\n\n\u003cbr /\u003e"]]
