Specificare gli override della configurazione
Il programma di installazione di Apigee hybrid utilizza i valori predefiniti per molte impostazioni. Tuttavia, esistono alcune impostazioni che non hanno valori predefiniti. Devi fornire i valori per queste impostazioni, come spiegato di seguito.
Prima di iniziare
Ti consigliamo di esaminare gli scenari seguenti per determinare se vuoi configurare il tuo cluster per questi scenari. Queste configurazioni sono facoltative.
- Se prevedi di installare ibrido in più regioni, leggi Deployment multiregionale prima di continuare.
- Apigee Hybrid fornisce password predefinite per gli utenti Cassandra. Apigee consiglia di modificare le password utente predefinite. Per maggiori dettagli, vedi Configurazione di TLS per Cassandra.
- Se vuoi configurare le impostazioni di archiviazione e heap per Cassandra, vedi Configurare le impostazioni di archiviazione e heap.
- Come descritto nella Parte 1: configurazione di progetto e organizzazione - Passaggio 1: abilita le API, per gli scenari di installazione di produzione, configura l'archiviazione SSD (solid state disk) persistente per Cassandra. Apigee non supporta l'utilizzo di SSD locali per Apigee Hybrid. Per i dettagli, vedi Aggiungere spazio di archiviazione SSD per i deployment di produzione.
Configura il cluster
Per convenzione, gli override di configurazione vengono scritti in un file denominato overrides.yaml
in genere archiviato nella directory $APIGEE_HELM_CHARTS_HOME
.
- Crea un nuovo file denominato
overrides.yaml
nella directory$APIGEE_HELM_CHARTS_HOME
.Il file
overrides.yaml
fornisce la configurazione per la tua installazione unica di Apigee hybrid. Il file di override in questo passaggio fornisce una configurazione di base per un'installazione di runtime ibrido con un ingombro ridotto, adatta alla tua prima installazione. - In
overrides.yaml
, aggiungi i valori delle proprietà obbligatorie, mostrati di seguito. Di seguito è riportata una descrizione dettagliata di ciascuna proprietà.Assicurati che il file
overrides.yaml
abbia la seguente struttura e sintassi.Scegli la scheda relativa al tipo di autenticazione del account di servizio che utilizzi nell'installazione: Passaggio 4: crea service account.
- Chiavi del service account in Kubernetes Secrets: Kubernetes Secrets
- File JSON della chiave del service account: file JSON
- Chiavi service account in Vault: Vault
- Workload Identity Federation for GKE: WIF per GKE
- Federazione delle identità per i workload: WIF su altre piattaforme
Per una panoramica delle diverse opzioni di autenticazione, vedi Metodi di autenticazione degli account di servizio in Apigee Hybrid.
Seleziona la scheda relativa all'installazione, produzione, Produzione o non produzione (installazioni demo, di valutazione o proof-of-concept), Non produzione a seconda della tua scelta nel passaggio 4: crea account di servizio.
Per le installazioni negli ambienti di produzione, esamina i requisiti di archiviazione per il database Cassandra in Configurazione di Cassandra per la produzione.
Secret Kubernetes
Produzione
Modello
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 I valori in red, bold italics sono valori delle proprietà che devi fornire. Puoi modificare i relativi valori in questa pagina. Sono descritti nella tabella riportata di seguito.
La tabella seguente descrive ciascuno dei valori delle proprietà che devi fornire nel file di override. Per ulteriori informazioni, consulta Riferimento alle proprietà di configurazione.
Variabile Descrizione UNIQUE_INSTANCE_
IDENTIFIERUna stringa univoca per identificare questa istanza. Può essere qualsiasi combinazione di lettere e numeri fino a 63 caratteri.
Puoi creare più organizzazioni nello stesso cluster, ma
instanceID
deve essere lo stesso per tutte le organizzazioni nello stesso cluster Kubernetes.Vedi
instanceID
.APIGEE_NAMESPACE Lo spazio dei nomi Kubernetes per i componenti Apigee hybrid.
Il valore predefinito è
apigee
.Vedi
namespace
.PROJECT_ID Identifica il progetto Google Cloud in cui apigee-logger
eapigee-metrics
inviano i propri dati. Questo è il valore assegnato alla variabile di ambientePROJECT_ID
.Vedi
gcp.projectID
.ANALYTICS_REGION In GKE, devi impostare questo valore sulla stessa regione in cui è in esecuzione il cluster. In tutte le altre piattaforme, seleziona la regione di analisi più vicina al tuo cluster che supporta Analytics (vedi la tabella in Parte 1, passaggio 2: crea un'organizzazione). Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
ANALYTICS_REGION
.Vedi
gcp.region
.CLUSTER_NAME Il nome del cluster Kubernetes. Questo è il valore assegnato alla variabile di ambiente CLUSTER_NAME
.Vedi
k8sCluster.name
.CLUSTER_LOCATION La regione in cui è in esecuzione il cluster. Questa è la regione in cui hai creato il cluster nel passaggio 1: crea un cluster. Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
CLUSTER_LOCATION
.Vedi
k8sCluster.location
.ORG_NAME L'ID della tua organizzazione Apigee hybrid. Questo è il valore assegnato alla variabile di ambiente ORG_NAME
.Vedi
org
.CONTROL_PLANE_
LOCATIONObbligatorio se utilizzi la residenza dei dati con l'installazione ibrida di Apigee. Questa è la posizione in cui vengono memorizzati i contenuti principali dei clienti, come i bundle proxy. Per un elenco, consulta Regioni del control plane dell'API Apigee disponibili. È il valore assegnato alla variabile di ambiente CONTROL_PLANE_LOCATION
nel passaggio 2: crea un'organizzazione.Vedi
contractProvider
.ENVIRONMENT_NAME Utilizza lo stesso nome che hai utilizzato quando hai creato un ambiente nell'interfaccia utente, come spiegato in Configurazione di progetto e organizzazione - Passaggio 3: crea un gruppo di ambienti. Vedi
envs[].name
.ENVIRONMENT_GROUP_
NAMEIl nome del gruppo di ambienti a cui sono assegnati i tuoi ambienti. Questo è il gruppo che hai creato in Configurazione del progetto e dell'organizzazione - Passaggio 3: crea un gruppo di ambienti. Questo è il valore assegnato alla variabile di ambiente ENV_GROUP
.Vedi
virtualhosts[].name
.INGRESS_NAME Il nome del gateway in entrata Apigee per il deployment. Può essere qualsiasi nome che soddisfi i seguenti requisiti: - Avere una lunghezza massima di 17 caratteri
- Contenere solo caratteri alfanumerici minuscoli, '-' o '.'
- Iniziare con un carattere alfanumerico
- Terminare con un carattere alfanumerico
Vedi:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEInserisci il percorso e il nome file della chiave TLS autofirmata e dei file del certificato che hai generato in precedenza nel passaggio 6: creazione dei certificati TLS. Questi file devono trovarsi nella directory APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Ad esempio:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Vedi:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Facoltativo) Si tratta di una coppia chiave-valore che fornisce annotazioni per il servizio di ingresso predefinito. La tua piattaforma cloud utilizza le annotazioni per configurare l'installazione ibrida, ad esempio impostando il tipo di bilanciatore del carico su interno o esterno. Le annotazioni variano da piattaforma a piattaforma. Consulta la documentazione della piattaforma per le annotazioni richieste e suggerite.
Commenta o elimina questa sezione se non la utilizzi.
<component>_
SERVICE_ACCOUNT_
SECRETIl nome del secret Kubernetes che hai creato per la chiave del account di servizio nel passaggio 5: configura l'autenticazione del account di servizio account. I nomi predefiniti dei secret suggeriti in questa guida sono:
Produzione
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 di produzione
apigee-non-prod-svc-account
Vedi:
-
envs[].serviceAccountSecretRefs.synchronizer
. -
envs[].serviceAccountSecretRefs.runtime
. -
envs[].serviceAccountSecretRefs.udca
. -
logger.serviceAccountRef
. -
connectAgent.serviceAccountRef
. -
mart.serviceAccountRef
. -
metrics.serviceAccountRef
. -
mintTaskScheduler.serviceAccountRef
. -
udca.serviceAccountRef
. -
watcher.serviceAccountRef
.
Esempio
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
La tabella seguente descrive ciascuno dei valori delle proprietà che devi fornire nel file di override. Per ulteriori informazioni, consulta Riferimento alle proprietà di configurazione.
Variabile Descrizione UNIQUE_INSTANCE_
IDENTIFIERUna stringa univoca per identificare questa istanza. Può essere qualsiasi combinazione di lettere e numeri fino a 63 caratteri.
Puoi creare più organizzazioni nello stesso cluster, ma
instanceID
deve essere lo stesso per tutte le organizzazioni nello stesso cluster Kubernetes.Vedi
instanceID
.APIGEE_NAMESPACE Lo spazio dei nomi Kubernetes per i componenti Apigee hybrid.
Il valore predefinito è
apigee
.Vedi
namespace
.PROJECT_ID Identifica il progetto Google Cloud in cui apigee-logger
eapigee-metrics
inviano i propri dati. Questo è il valore assegnato alla variabile di ambientePROJECT_ID
.Vedi
gcp.projectID
.ANALYTICS_REGION In GKE, devi impostare questo valore sulla stessa regione in cui è in esecuzione il cluster. In tutte le altre piattaforme, seleziona la regione di analisi più vicina al tuo cluster che supporta Analytics (vedi la tabella in Parte 1, passaggio 2: crea un'organizzazione). Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
ANALYTICS_REGION
.Vedi
gcp.region
.CLUSTER_NAME Il nome del cluster Kubernetes. Questo è il valore assegnato alla variabile di ambiente CLUSTER_NAME
.Vedi
k8sCluster.name
.CLUSTER_LOCATION La regione in cui è in esecuzione il cluster. Questa è la regione in cui hai creato il cluster nel passaggio 1: crea un cluster. Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
CLUSTER_LOCATION
.Vedi
k8sCluster.location
.ORG_NAME L'ID della tua organizzazione Apigee hybrid. Questo è il valore assegnato alla variabile di ambiente ORG_NAME
.Vedi
org
.CONTROL_PLANE_
LOCATIONObbligatorio se utilizzi la residenza dei dati con l'installazione ibrida di Apigee. Questa è la posizione in cui vengono memorizzati i contenuti principali dei clienti, come i bundle proxy. Per un elenco, consulta Regioni del control plane dell'API Apigee disponibili. È il valore assegnato alla variabile di ambiente CONTROL_PLANE_LOCATION
nel passaggio 2: crea un'organizzazione.Vedi
contractProvider
.ENVIRONMENT_NAME Utilizza lo stesso nome che hai utilizzato quando hai creato un ambiente nell'interfaccia utente, come spiegato in Configurazione di progetto e organizzazione - Passaggio 3: crea un gruppo di ambienti. Vedi
envs[].name
.ENVIRONMENT_GROUP_
NAMEIl nome del gruppo di ambienti a cui sono assegnati i tuoi ambienti. Questo è il gruppo che hai creato in Configurazione del progetto e dell'organizzazione - Passaggio 3: crea un gruppo di ambienti. Questo è il valore assegnato alla variabile di ambiente ENV_GROUP
.Vedi
virtualhosts[].name
.INGRESS_NAME Il nome del gateway in entrata Apigee per il deployment. Può essere qualsiasi nome che soddisfi i seguenti requisiti: - Avere una lunghezza massima di 17 caratteri
- Contenere solo caratteri alfanumerici minuscoli, '-' o '.'
- Iniziare con un carattere alfanumerico
- Terminare con un carattere alfanumerico
Vedi:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEInserisci il percorso e il nome file della chiave TLS autofirmata e dei file del certificato che hai generato in precedenza nel passaggio 6: creazione dei certificati TLS. Questi file devono trovarsi nella directory APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Ad esempio:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Vedi:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Facoltativo) Si tratta di una coppia chiave-valore che fornisce annotazioni per il servizio di ingresso predefinito. La tua piattaforma cloud utilizza le annotazioni per configurare l'installazione ibrida, ad esempio impostando il tipo di bilanciatore del carico su interno o esterno. Le annotazioni variano da piattaforma a piattaforma. Consulta la documentazione della piattaforma per le annotazioni richieste e suggerite.
Commenta o elimina questa sezione se non la utilizzi.
<component>_
SERVICE_ACCOUNT_
SECRETIl nome del secret Kubernetes che hai creato per la chiave del account di servizio nel passaggio 5: configura l'autenticazione del account di servizio account. I nomi predefiniti dei secret suggeriti in questa guida sono:
Produzione
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 di produzione
apigee-non-prod-svc-account
Vedi:
-
envs[].serviceAccountSecretRefs.synchronizer
. -
envs[].serviceAccountSecretRefs.runtime
. -
envs[].serviceAccountSecretRefs.udca
. -
logger.serviceAccountRef
. -
connectAgent.serviceAccountRef
. -
mart.serviceAccountRef
. -
metrics.serviceAccountRef
. -
mintTaskScheduler.serviceAccountRef
. -
udca.serviceAccountRef
. -
watcher.serviceAccountRef
.
Non di produzione
Modello
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
I valori in red, bold italics sono valori delle proprietà che devi fornire. Puoi modificare i relativi valori in questa pagina. Sono descritti nella tabella riportata di seguito.
La tabella seguente descrive ciascuno dei valori delle proprietà che devi fornire nel file di override. Per ulteriori informazioni, consulta Riferimento alle proprietà di configurazione.
Variabile Descrizione UNIQUE_INSTANCE_
IDENTIFIERUna stringa univoca per identificare questa istanza. Può essere qualsiasi combinazione di lettere e numeri fino a 63 caratteri.
Puoi creare più organizzazioni nello stesso cluster, ma
instanceID
deve essere lo stesso per tutte le organizzazioni nello stesso cluster Kubernetes.Vedi
instanceID
.APIGEE_NAMESPACE Lo spazio dei nomi Kubernetes per i componenti Apigee hybrid.
Il valore predefinito è
apigee
.Vedi
namespace
.PROJECT_ID Identifica il progetto Google Cloud in cui apigee-logger
eapigee-metrics
inviano i propri dati. Questo è il valore assegnato alla variabile di ambientePROJECT_ID
.Vedi
gcp.projectID
.ANALYTICS_REGION In GKE, devi impostare questo valore sulla stessa regione in cui è in esecuzione il cluster. In tutte le altre piattaforme, seleziona la regione di analisi più vicina al tuo cluster che supporta Analytics (vedi la tabella in Parte 1, passaggio 2: crea un'organizzazione). Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
ANALYTICS_REGION
.Vedi
gcp.region
.CLUSTER_NAME Il nome del cluster Kubernetes. Questo è il valore assegnato alla variabile di ambiente CLUSTER_NAME
.Vedi
k8sCluster.name
.CLUSTER_LOCATION La regione in cui è in esecuzione il cluster. Questa è la regione in cui hai creato il cluster nel passaggio 1: crea un cluster. Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
CLUSTER_LOCATION
.Vedi
k8sCluster.location
.ORG_NAME L'ID della tua organizzazione Apigee hybrid. Questo è il valore assegnato alla variabile di ambiente ORG_NAME
.Vedi
org
.CONTROL_PLANE_
LOCATIONObbligatorio se utilizzi la residenza dei dati con l'installazione ibrida di Apigee. Questa è la posizione in cui vengono memorizzati i contenuti principali dei clienti, come i bundle proxy. Per un elenco, consulta Regioni del control plane dell'API Apigee disponibili. È il valore assegnato alla variabile di ambiente CONTROL_PLANE_LOCATION
nel passaggio 2: crea un'organizzazione.Vedi
contractProvider
.ENVIRONMENT_NAME Utilizza lo stesso nome che hai utilizzato quando hai creato un ambiente nell'interfaccia utente, come spiegato in Configurazione di progetto e organizzazione - Passaggio 3: crea un gruppo di ambienti. Vedi
envs[].name
.ENVIRONMENT_GROUP_
NAMEIl nome del gruppo di ambienti a cui sono assegnati i tuoi ambienti. Questo è il gruppo che hai creato in Configurazione del progetto e dell'organizzazione - Passaggio 3: crea un gruppo di ambienti. Questo è il valore assegnato alla variabile di ambiente ENV_GROUP
.Vedi
virtualhosts[].name
.INGRESS_NAME Il nome del gateway in entrata Apigee per il deployment. Può essere qualsiasi nome che soddisfi i seguenti requisiti: - Avere una lunghezza massima di 17 caratteri
- Contenere solo caratteri alfanumerici minuscoli, '-' o '.'
- Iniziare con un carattere alfanumerico
- Terminare con un carattere alfanumerico
Vedi:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEInserisci il percorso e il nome file della chiave TLS autofirmata e dei file del certificato che hai generato in precedenza nel passaggio 6: creazione dei certificati TLS. Questi file devono trovarsi nella directory APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Ad esempio:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Vedi:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Facoltativo) Si tratta di una coppia chiave-valore che fornisce annotazioni per il servizio di ingresso predefinito. La tua piattaforma cloud utilizza le annotazioni per configurare l'installazione ibrida, ad esempio impostando il tipo di bilanciatore del carico su interno o esterno. Le annotazioni variano da piattaforma a piattaforma. Consulta la documentazione della piattaforma per le annotazioni richieste e suggerite.
Commenta o elimina questa sezione se non la utilizzi.
<component>_
SERVICE_ACCOUNT_
SECRETIl nome del secret Kubernetes che hai creato per la chiave del account di servizio nel passaggio 5: configura l'autenticazione del account di servizio account. I nomi predefiniti dei secret suggeriti in questa guida sono:
Produzione
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 di produzione
apigee-non-prod-svc-account
Vedi:
-
envs[].serviceAccountSecretRefs.synchronizer
. -
envs[].serviceAccountSecretRefs.runtime
. -
envs[].serviceAccountSecretRefs.udca
. -
logger.serviceAccountRef
. -
connectAgent.serviceAccountRef
. -
mart.serviceAccountRef
. -
metrics.serviceAccountRef
. -
mintTaskScheduler.serviceAccountRef
. -
udca.serviceAccountRef
. -
watcher.serviceAccountRef
.
Esempio
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
La tabella seguente descrive ciascuno dei valori delle proprietà che devi fornire nel file di override. Per ulteriori informazioni, consulta Riferimento alle proprietà di configurazione.
Variabile Descrizione UNIQUE_INSTANCE_
IDENTIFIERUna stringa univoca per identificare questa istanza. Può essere qualsiasi combinazione di lettere e numeri fino a 63 caratteri.
Puoi creare più organizzazioni nello stesso cluster, ma
instanceID
deve essere lo stesso per tutte le organizzazioni nello stesso cluster Kubernetes.Vedi
instanceID
.APIGEE_NAMESPACE Lo spazio dei nomi Kubernetes per i componenti Apigee hybrid.
Il valore predefinito è
apigee
.Vedi
namespace
.PROJECT_ID Identifica il progetto Google Cloud in cui apigee-logger
eapigee-metrics
inviano i propri dati. Questo è il valore assegnato alla variabile di ambientePROJECT_ID
.Vedi
gcp.projectID
.ANALYTICS_REGION In GKE, devi impostare questo valore sulla stessa regione in cui è in esecuzione il cluster. In tutte le altre piattaforme, seleziona la regione di analisi più vicina al tuo cluster che supporta Analytics (vedi la tabella in Parte 1, passaggio 2: crea un'organizzazione). Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
ANALYTICS_REGION
.Vedi
gcp.region
.CLUSTER_NAME Il nome del cluster Kubernetes. Questo è il valore assegnato alla variabile di ambiente CLUSTER_NAME
.Vedi
k8sCluster.name
.CLUSTER_LOCATION La regione in cui è in esecuzione il cluster. Questa è la regione in cui hai creato il cluster nel passaggio 1: crea un cluster. Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
CLUSTER_LOCATION
.Vedi
k8sCluster.location
.ORG_NAME L'ID della tua organizzazione Apigee hybrid. Questo è il valore assegnato alla variabile di ambiente ORG_NAME
.Vedi
org
.CONTROL_PLANE_
LOCATIONObbligatorio se utilizzi la residenza dei dati con l'installazione ibrida di Apigee. Questa è la posizione in cui vengono memorizzati i contenuti principali dei clienti, come i bundle proxy. Per un elenco, consulta Regioni del control plane dell'API Apigee disponibili. È il valore assegnato alla variabile di ambiente CONTROL_PLANE_LOCATION
nel passaggio 2: crea un'organizzazione.Vedi
contractProvider
.ENVIRONMENT_NAME Utilizza lo stesso nome che hai utilizzato quando hai creato un ambiente nell'interfaccia utente, come spiegato in Configurazione di progetto e organizzazione - Passaggio 3: crea un gruppo di ambienti. Vedi
envs[].name
.ENVIRONMENT_GROUP_
NAMEIl nome del gruppo di ambienti a cui sono assegnati i tuoi ambienti. Questo è il gruppo che hai creato in Configurazione del progetto e dell'organizzazione - Passaggio 3: crea un gruppo di ambienti. Questo è il valore assegnato alla variabile di ambiente ENV_GROUP
.Vedi
virtualhosts[].name
.INGRESS_NAME Il nome del gateway in entrata Apigee per il deployment. Può essere qualsiasi nome che soddisfi i seguenti requisiti: - Avere una lunghezza massima di 17 caratteri
- Contenere solo caratteri alfanumerici minuscoli, '-' o '.'
- Iniziare con un carattere alfanumerico
- Terminare con un carattere alfanumerico
Vedi:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEInserisci il percorso e il nome file della chiave TLS autofirmata e dei file del certificato che hai generato in precedenza nel passaggio 6: creazione dei certificati TLS. Questi file devono trovarsi nella directory APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Ad esempio:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Vedi:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Facoltativo) Si tratta di una coppia chiave-valore che fornisce annotazioni per il servizio di ingresso predefinito. La tua piattaforma cloud utilizza le annotazioni per configurare l'installazione ibrida, ad esempio impostando il tipo di bilanciatore del carico su interno o esterno. Le annotazioni variano da piattaforma a piattaforma. Consulta la documentazione della piattaforma per le annotazioni richieste e suggerite.
Commenta o elimina questa sezione se non la utilizzi.
<component>_
SERVICE_ACCOUNT_
SECRETIl nome del secret Kubernetes che hai creato per la chiave del account di servizio nel passaggio 5: configura l'autenticazione del account di servizio account. I nomi predefiniti dei secret suggeriti in questa guida sono:
Produzione
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 di produzione
apigee-non-prod-svc-account
Vedi:
-
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
Produzione
Modello
I valori in red, bold italics sono valori delle proprietà che devi fornire. Puoi modificare i relativi valori in questa pagina. Sono descritti nella tabella riportata di seguito.
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 La tabella seguente descrive ciascuno dei valori delle proprietà che devi fornire nel file di override. Per ulteriori informazioni, consulta Riferimento alle proprietà di configurazione.
Variabile Descrizione UNIQUE_INSTANCE_
IDENTIFIERUna stringa univoca per identificare questa istanza. Può essere qualsiasi combinazione di lettere e numeri fino a 63 caratteri.
Puoi creare più organizzazioni nello stesso cluster, ma
instanceID
deve essere lo stesso per tutte le organizzazioni nello stesso cluster Kubernetes.Vedi
instanceID
.APIGEE_NAMESPACE Lo spazio dei nomi Kubernetes per i componenti Apigee hybrid.
Il valore predefinito è
apigee
.Vedi
namespace
.PROJECT_ID Identifica il progetto Google Cloud in cui apigee-logger
eapigee-metrics
inviano i propri dati. Questo è il valore assegnato alla variabile di ambientePROJECT_ID
.Vedi
gcp.projectID
.ANALYTICS_REGION In GKE, devi impostare questo valore sulla stessa regione in cui è in esecuzione il cluster. In tutte le altre piattaforme, seleziona la regione di analisi più vicina al tuo cluster che supporta Analytics (vedi la tabella in Parte 1, passaggio 2: crea un'organizzazione). Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
ANALYTICS_REGION
.Vedi
gcp.region
.CLUSTER_NAME Il nome del cluster Kubernetes. Questo è il valore assegnato alla variabile di ambiente CLUSTER_NAME
.Vedi
k8sCluster.name
.CLUSTER_LOCATION La regione in cui è in esecuzione il cluster. Questa è la regione in cui hai creato il cluster nel passaggio 1: crea un cluster. Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
CLUSTER_LOCATION
.Vedi
k8sCluster.location
.ORG_NAME L'ID della tua organizzazione Apigee hybrid. Questo è il valore assegnato alla variabile di ambiente ORG_NAME
.Vedi
org
.CONTROL_PLANE_
LOCATIONObbligatorio se utilizzi la residenza dei dati con l'installazione ibrida di Apigee. Questa è la posizione in cui vengono memorizzati i contenuti principali dei clienti, come i bundle proxy. Per un elenco, consulta Regioni del control plane dell'API Apigee disponibili. È il valore assegnato alla variabile di ambiente CONTROL_PLANE_LOCATION
nel passaggio 2: crea un'organizzazione.Vedi
contractProvider
.ENVIRONMENT_NAME Utilizza lo stesso nome che hai utilizzato quando hai creato un ambiente nell'interfaccia utente, come spiegato in Configurazione di progetto e organizzazione - Passaggio 3: crea un gruppo di ambienti. Vedi
envs[].name
.ENVIRONMENT_GROUP_
NAMEIl nome del gruppo di ambienti a cui sono assegnati i tuoi ambienti. Questo è il gruppo che hai creato in Configurazione del progetto e dell'organizzazione - Passaggio 3: crea un gruppo di ambienti. Questo è il valore assegnato alla variabile di ambiente ENV_GROUP
.Vedi
virtualhosts[].name
.INGRESS_NAME Il nome del gateway in entrata Apigee per il deployment. Può essere qualsiasi nome che soddisfi i seguenti requisiti: - Avere una lunghezza massima di 17 caratteri
- Contenere solo caratteri alfanumerici minuscoli, '-' o '.'
- Iniziare con un carattere alfanumerico
- Terminare con un carattere alfanumerico
Vedi:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEInserisci il percorso e il nome file della chiave TLS autofirmata e dei file del certificato che hai generato in precedenza nel passaggio 6: creazione dei certificati TLS. Questi file devono trovarsi nella directory APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Ad esempio:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Vedi:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Facoltativo) Si tratta di una coppia chiave-valore che fornisce annotazioni per il servizio di ingresso predefinito. La tua piattaforma cloud utilizza le annotazioni per configurare l'installazione ibrida, ad esempio impostando il tipo di bilanciatore del carico su interno o esterno. Le annotazioni variano da piattaforma a piattaforma. Consulta la documentazione della piattaforma per le annotazioni richieste e suggerite.
Commenta o elimina questa sezione se non la utilizzi.
<component>_
SERVICE_ACCOUNT_
FILEPATHIl percorso e il nome file dell'account dei file JSON dell'account di servizio nella directory del grafico corrispondente. Fornisci i nomi con il percorso relativo alla directory del grafico. Ad esempio: - Se il file
my-project-apigee-synchronizer.json
si trova nella directory del graficoapigee-env/
, devi solo fornire il nome del file, ad esempio:synchronizer: "FILE_NAME.json"
- Se il file si trova in una directory
apigee-env/service-accounts/
, specifica un percorso relativo:synchronizer: "service-accounts/FILE_NAME.json"
Per gli ambienti non di produzione, il nome del singolo account di servizio è
PROJECT_ID-non-prod.json
per impostazione predefinita.Per gli ambienti di produzione, il nome del file della chiave del account di servizio che hai generato con lo strumento
create-service-account
nel passaggio 4: crea service account.Puoi visualizzare i file dell'account di servizio in ogni directory del grafico corrispondente.
I nomi predefiniti delle directory dei grafici corrispondenti per i service account sono:
Produzione
Nome file service account Directory dei grafici 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 di produzione
Nome file service account Directory dei grafici PROJECT_ID-non-prod.json
apigee-datastore/
apigee-org/
apigee-telemetry/
Vedi:
-
envs[].serviceAccountPaths.synchronizer
. -
envs[].serviceAccountPaths.runtime
. -
envs[].serviceAccountPaths.udca
. -
logger.serviceAccountPath
. -
connectAgent.serviceAccountPath
. -
mart.serviceAccountPath
. -
metrics.serviceAccountPath
. -
mintTaskScheduler.serviceAccountPath
. -
udca.serviceAccountPath
. -
watcher.serviceAccountPath
.
Esempio
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
La tabella seguente descrive ciascuno dei valori delle proprietà che devi fornire nel file di override. Per ulteriori informazioni, consulta Riferimento alle proprietà di configurazione.
Variabile Descrizione UNIQUE_INSTANCE_
IDENTIFIERUna stringa univoca per identificare questa istanza. Può essere qualsiasi combinazione di lettere e numeri fino a 63 caratteri.
Puoi creare più organizzazioni nello stesso cluster, ma
instanceID
deve essere lo stesso per tutte le organizzazioni nello stesso cluster Kubernetes.Vedi
instanceID
.APIGEE_NAMESPACE Lo spazio dei nomi Kubernetes per i componenti Apigee hybrid.
Il valore predefinito è
apigee
.Vedi
namespace
.PROJECT_ID Identifica il progetto Google Cloud in cui apigee-logger
eapigee-metrics
inviano i propri dati. Questo è il valore assegnato alla variabile di ambientePROJECT_ID
.Vedi
gcp.projectID
.ANALYTICS_REGION In GKE, devi impostare questo valore sulla stessa regione in cui è in esecuzione il cluster. In tutte le altre piattaforme, seleziona la regione di analisi più vicina al tuo cluster che supporta Analytics (vedi la tabella in Parte 1, passaggio 2: crea un'organizzazione). Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
ANALYTICS_REGION
.Vedi
gcp.region
.CLUSTER_NAME Il nome del cluster Kubernetes. Questo è il valore assegnato alla variabile di ambiente CLUSTER_NAME
.Vedi
k8sCluster.name
.CLUSTER_LOCATION La regione in cui è in esecuzione il cluster. Questa è la regione in cui hai creato il cluster nel passaggio 1: crea un cluster. Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
CLUSTER_LOCATION
.Vedi
k8sCluster.location
.ORG_NAME L'ID della tua organizzazione Apigee hybrid. Questo è il valore assegnato alla variabile di ambiente ORG_NAME
.Vedi
org
.CONTROL_PLANE_
LOCATIONObbligatorio se utilizzi la residenza dei dati con l'installazione ibrida di Apigee. Questa è la posizione in cui vengono memorizzati i contenuti principali dei clienti, come i bundle proxy. Per un elenco, consulta Regioni del control plane dell'API Apigee disponibili. È il valore assegnato alla variabile di ambiente CONTROL_PLANE_LOCATION
nel passaggio 2: crea un'organizzazione.Vedi
contractProvider
.ENVIRONMENT_NAME Utilizza lo stesso nome che hai utilizzato quando hai creato un ambiente nell'interfaccia utente, come spiegato in Configurazione di progetto e organizzazione - Passaggio 3: crea un gruppo di ambienti. Vedi
envs[].name
.ENVIRONMENT_GROUP_
NAMEIl nome del gruppo di ambienti a cui sono assegnati i tuoi ambienti. Questo è il gruppo che hai creato in Configurazione del progetto e dell'organizzazione - Passaggio 3: crea un gruppo di ambienti. Questo è il valore assegnato alla variabile di ambiente ENV_GROUP
.Vedi
virtualhosts[].name
.INGRESS_NAME Il nome del gateway in entrata Apigee per il deployment. Può essere qualsiasi nome che soddisfi i seguenti requisiti: - Avere una lunghezza massima di 17 caratteri
- Contenere solo caratteri alfanumerici minuscoli, '-' o '.'
- Iniziare con un carattere alfanumerico
- Terminare con un carattere alfanumerico
Vedi:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEInserisci il percorso e il nome file della chiave TLS autofirmata e dei file del certificato che hai generato in precedenza nel passaggio 6: creazione dei certificati TLS. Questi file devono trovarsi nella directory APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Ad esempio:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Vedi:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Facoltativo) Si tratta di una coppia chiave-valore che fornisce annotazioni per il servizio di ingresso predefinito. La tua piattaforma cloud utilizza le annotazioni per configurare l'installazione ibrida, ad esempio impostando il tipo di bilanciatore del carico su interno o esterno. Le annotazioni variano da piattaforma a piattaforma. Consulta la documentazione della piattaforma per le annotazioni richieste e suggerite.
Commenta o elimina questa sezione se non la utilizzi.
<component>_
SERVICE_ACCOUNT_
FILEPATHIl percorso e il nome file dell'account dei file JSON dell'account di servizio nella directory del grafico corrispondente. Fornisci i nomi con il percorso relativo alla directory del grafico. Ad esempio: - Se il file
my-project-apigee-synchronizer.json
si trova nella directory del graficoapigee-env/
, devi solo fornire il nome del file, ad esempio:synchronizer: "FILE_NAME.json"
- Se il file si trova in una directory
apigee-env/service-accounts/
, specifica un percorso relativo:synchronizer: "service-accounts/FILE_NAME.json"
Per gli ambienti non di produzione, il nome del singolo account di servizio è
PROJECT_ID-non-prod.json
per impostazione predefinita.Per gli ambienti di produzione, il nome del file della chiave del account di servizio che hai generato con lo strumento
create-service-account
nel passaggio 4: crea service account.Puoi visualizzare i file dell'account di servizio in ogni directory del grafico corrispondente.
I nomi predefiniti delle directory dei grafici corrispondenti per i service account sono:
Produzione
Nome file service account Directory dei grafici 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 di produzione
Nome file service account Directory dei grafici PROJECT_ID-non-prod.json
apigee-datastore/
apigee-org/
apigee-telemetry/
Vedi:
-
envs[].serviceAccountPaths.synchronizer
. -
envs[].serviceAccountPaths.runtime
. -
envs[].serviceAccountPaths.udca
. -
logger.serviceAccountPath
. -
connectAgent.serviceAccountPath
. -
mart.serviceAccountPath
. -
metrics.serviceAccountPath
. -
mintTaskScheduler.serviceAccountPath
. -
udca.serviceAccountPath
. -
watcher.serviceAccountPath
.
Non di produzione
Modello
I valori in red, bold italics sono valori delle proprietà che devi fornire. Puoi modificare i relativi valori in questa pagina. Sono descritti nella tabella riportata di seguito.
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
La tabella seguente descrive ciascuno dei valori delle proprietà che devi fornire nel file di override. Per ulteriori informazioni, consulta Riferimento alle proprietà di configurazione.
Variabile Descrizione UNIQUE_INSTANCE_
IDENTIFIERUna stringa univoca per identificare questa istanza. Può essere qualsiasi combinazione di lettere e numeri fino a 63 caratteri.
Puoi creare più organizzazioni nello stesso cluster, ma
instanceID
deve essere lo stesso per tutte le organizzazioni nello stesso cluster Kubernetes.Vedi
instanceID
.APIGEE_NAMESPACE Lo spazio dei nomi Kubernetes per i componenti Apigee hybrid.
Il valore predefinito è
apigee
.Vedi
namespace
.PROJECT_ID Identifica il progetto Google Cloud in cui apigee-logger
eapigee-metrics
inviano i propri dati. Questo è il valore assegnato alla variabile di ambientePROJECT_ID
.Vedi
gcp.projectID
.ANALYTICS_REGION In GKE, devi impostare questo valore sulla stessa regione in cui è in esecuzione il cluster. In tutte le altre piattaforme, seleziona la regione di analisi più vicina al tuo cluster che supporta Analytics (vedi la tabella in Parte 1, passaggio 2: crea un'organizzazione). Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
ANALYTICS_REGION
.Vedi
gcp.region
.CLUSTER_NAME Il nome del cluster Kubernetes. Questo è il valore assegnato alla variabile di ambiente CLUSTER_NAME
.Vedi
k8sCluster.name
.CLUSTER_LOCATION La regione in cui è in esecuzione il cluster. Questa è la regione in cui hai creato il cluster nel passaggio 1: crea un cluster. Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
CLUSTER_LOCATION
.Vedi
k8sCluster.location
.ORG_NAME L'ID della tua organizzazione Apigee hybrid. Questo è il valore assegnato alla variabile di ambiente ORG_NAME
.Vedi
org
.CONTROL_PLANE_
LOCATIONObbligatorio se utilizzi la residenza dei dati con l'installazione ibrida di Apigee. Questa è la posizione in cui vengono memorizzati i contenuti principali dei clienti, come i bundle proxy. Per un elenco, consulta Regioni del control plane dell'API Apigee disponibili. È il valore assegnato alla variabile di ambiente CONTROL_PLANE_LOCATION
nel passaggio 2: crea un'organizzazione.Vedi
contractProvider
.ENVIRONMENT_NAME Utilizza lo stesso nome che hai utilizzato quando hai creato un ambiente nell'interfaccia utente, come spiegato in Configurazione di progetto e organizzazione - Passaggio 3: crea un gruppo di ambienti. Vedi
envs[].name
.ENVIRONMENT_GROUP_
NAMEIl nome del gruppo di ambienti a cui sono assegnati i tuoi ambienti. Questo è il gruppo che hai creato in Configurazione del progetto e dell'organizzazione - Passaggio 3: crea un gruppo di ambienti. Questo è il valore assegnato alla variabile di ambiente ENV_GROUP
.Vedi
virtualhosts[].name
.INGRESS_NAME Il nome del gateway in entrata Apigee per il deployment. Può essere qualsiasi nome che soddisfi i seguenti requisiti: - Avere una lunghezza massima di 17 caratteri
- Contenere solo caratteri alfanumerici minuscoli, '-' o '.'
- Iniziare con un carattere alfanumerico
- Terminare con un carattere alfanumerico
Vedi:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEInserisci il percorso e il nome file della chiave TLS autofirmata e dei file del certificato che hai generato in precedenza nel passaggio 6: creazione dei certificati TLS. Questi file devono trovarsi nella directory APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Ad esempio:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Vedi:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Facoltativo) Si tratta di una coppia chiave-valore che fornisce annotazioni per il servizio di ingresso predefinito. La tua piattaforma cloud utilizza le annotazioni per configurare l'installazione ibrida, ad esempio impostando il tipo di bilanciatore del carico su interno o esterno. Le annotazioni variano da piattaforma a piattaforma. Consulta la documentazione della piattaforma per le annotazioni richieste e suggerite.
Commenta o elimina questa sezione se non la utilizzi.
<component>_
SERVICE_ACCOUNT_
FILEPATHIl percorso e il nome file dell'account dei file JSON dell'account di servizio nella directory del grafico corrispondente. Fornisci i nomi con il percorso relativo alla directory del grafico. Ad esempio: - Se il file
my-project-apigee-synchronizer.json
si trova nella directory del graficoapigee-env/
, devi solo fornire il nome del file, ad esempio:synchronizer: "FILE_NAME.json"
- Se il file si trova in una directory
apigee-env/service-accounts/
, specifica un percorso relativo:synchronizer: "service-accounts/FILE_NAME.json"
Per gli ambienti non di produzione, il nome del singolo account di servizio è
PROJECT_ID-non-prod.json
per impostazione predefinita.Per gli ambienti di produzione, il nome del file della chiave del account di servizio che hai generato con lo strumento
create-service-account
nel passaggio 4: crea service account.Puoi visualizzare i file dell'account di servizio in ogni directory del grafico corrispondente.
I nomi predefiniti delle directory dei grafici corrispondenti per i service account sono:
Produzione
Nome file service account Directory dei grafici 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 di produzione
Nome file service account Directory dei grafici PROJECT_ID-non-prod.json
apigee-datastore/
apigee-org/
apigee-telemetry/
Vedi:
-
envs[].serviceAccountPaths.synchronizer
. -
envs[].serviceAccountPaths.runtime
. -
envs[].serviceAccountPaths.udca
. -
logger.serviceAccountPath
. -
connectAgent.serviceAccountPath
. -
mart.serviceAccountPath
. -
metrics.serviceAccountPath
. -
mintTaskScheduler.serviceAccountPath
. -
udca.serviceAccountPath
. -
watcher.serviceAccountPath
.
Esempio
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
La tabella seguente descrive ciascuno dei valori delle proprietà che devi fornire nel file di override. Per ulteriori informazioni, consulta Riferimento alle proprietà di configurazione.
Variabile Descrizione UNIQUE_INSTANCE_
IDENTIFIERUna stringa univoca per identificare questa istanza. Può essere qualsiasi combinazione di lettere e numeri fino a 63 caratteri.
Puoi creare più organizzazioni nello stesso cluster, ma
instanceID
deve essere lo stesso per tutte le organizzazioni nello stesso cluster Kubernetes.Vedi
instanceID
.APIGEE_NAMESPACE Lo spazio dei nomi Kubernetes per i componenti Apigee hybrid.
Il valore predefinito è
apigee
.Vedi
namespace
.PROJECT_ID Identifica il progetto Google Cloud in cui apigee-logger
eapigee-metrics
inviano i propri dati. Questo è il valore assegnato alla variabile di ambientePROJECT_ID
.Vedi
gcp.projectID
.ANALYTICS_REGION In GKE, devi impostare questo valore sulla stessa regione in cui è in esecuzione il cluster. In tutte le altre piattaforme, seleziona la regione di analisi più vicina al tuo cluster che supporta Analytics (vedi la tabella in Parte 1, passaggio 2: crea un'organizzazione). Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
ANALYTICS_REGION
.Vedi
gcp.region
.CLUSTER_NAME Il nome del cluster Kubernetes. Questo è il valore assegnato alla variabile di ambiente CLUSTER_NAME
.Vedi
k8sCluster.name
.CLUSTER_LOCATION La regione in cui è in esecuzione il cluster. Questa è la regione in cui hai creato il cluster nel passaggio 1: crea un cluster. Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
CLUSTER_LOCATION
.Vedi
k8sCluster.location
.ORG_NAME L'ID della tua organizzazione Apigee hybrid. Questo è il valore assegnato alla variabile di ambiente ORG_NAME
.Vedi
org
.CONTROL_PLANE_
LOCATIONObbligatorio se utilizzi la residenza dei dati con l'installazione ibrida di Apigee. Questa è la posizione in cui vengono memorizzati i contenuti principali dei clienti, come i bundle proxy. Per un elenco, consulta Regioni del control plane dell'API Apigee disponibili. È il valore assegnato alla variabile di ambiente CONTROL_PLANE_LOCATION
nel passaggio 2: crea un'organizzazione.Vedi
contractProvider
.ENVIRONMENT_NAME Utilizza lo stesso nome che hai utilizzato quando hai creato un ambiente nell'interfaccia utente, come spiegato in Configurazione di progetto e organizzazione - Passaggio 3: crea un gruppo di ambienti. Vedi
envs[].name
.ENVIRONMENT_GROUP_
NAMEIl nome del gruppo di ambienti a cui sono assegnati i tuoi ambienti. Questo è il gruppo che hai creato in Configurazione del progetto e dell'organizzazione - Passaggio 3: crea un gruppo di ambienti. Questo è il valore assegnato alla variabile di ambiente ENV_GROUP
.Vedi
virtualhosts[].name
.INGRESS_NAME Il nome del gateway in entrata Apigee per il deployment. Può essere qualsiasi nome che soddisfi i seguenti requisiti: - Avere una lunghezza massima di 17 caratteri
- Contenere solo caratteri alfanumerici minuscoli, '-' o '.'
- Iniziare con un carattere alfanumerico
- Terminare con un carattere alfanumerico
Vedi:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEInserisci il percorso e il nome file della chiave TLS autofirmata e dei file del certificato che hai generato in precedenza nel passaggio 6: creazione dei certificati TLS. Questi file devono trovarsi nella directory APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Ad esempio:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Vedi:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Facoltativo) Si tratta di una coppia chiave-valore che fornisce annotazioni per il servizio di ingresso predefinito. La tua piattaforma cloud utilizza le annotazioni per configurare l'installazione ibrida, ad esempio impostando il tipo di bilanciatore del carico su interno o esterno. Le annotazioni variano da piattaforma a piattaforma. Consulta la documentazione della piattaforma per le annotazioni richieste e suggerite.
Commenta o elimina questa sezione se non la utilizzi.
<component>_
SERVICE_ACCOUNT_
FILEPATHIl percorso e il nome file dell'account dei file JSON dell'account di servizio nella directory del grafico corrispondente. Fornisci i nomi con il percorso relativo alla directory del grafico. Ad esempio: - Se il file
my-project-apigee-synchronizer.json
si trova nella directory del graficoapigee-env/
, devi solo fornire il nome del file, ad esempio:synchronizer: "FILE_NAME.json"
- Se il file si trova in una directory
apigee-env/service-accounts/
, specifica un percorso relativo:synchronizer: "service-accounts/FILE_NAME.json"
Per gli ambienti non di produzione, il nome del singolo account di servizio è
PROJECT_ID-non-prod.json
per impostazione predefinita.Per gli ambienti di produzione, il nome del file della chiave del account di servizio che hai generato con lo strumento
create-service-account
nel passaggio 4: crea service account.Puoi visualizzare i file dell'account di servizio in ogni directory del grafico corrispondente.
I nomi predefiniti delle directory dei grafici corrispondenti per i service account sono:
Produzione
Nome file service account Directory dei grafici 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 di produzione
Nome file service account Directory dei grafici PROJECT_ID-non-prod.json
apigee-datastore/
apigee-org/
apigee-telemetry/
Vedi:
-
envs[].serviceAccountPaths.synchronizer
. -
envs[].serviceAccountPaths.runtime
. -
envs[].serviceAccountPaths.udca
. -
logger.serviceAccountPath
. -
connectAgent.serviceAccountPath
. -
mart.serviceAccountPath
. -
metrics.serviceAccountPath
. -
mintTaskScheduler.serviceAccountPath
. -
udca.serviceAccountPath
. -
watcher.serviceAccountPath
.
Vault
Produzione
Modello
I valori in red, bold italics sono valori delle proprietà che devi fornire. Puoi modificare i relativi valori in questa pagina. Sono descritti nella tabella riportata di seguito.
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 La tabella seguente descrive ciascuno dei valori delle proprietà che devi fornire nel file di override. Per ulteriori informazioni, consulta Riferimento alle proprietà di configurazione.
Variabile Descrizione UNIQUE_INSTANCE_
IDENTIFIERUna stringa univoca per identificare questa istanza. Può essere qualsiasi combinazione di lettere e numeri fino a 63 caratteri.
Puoi creare più organizzazioni nello stesso cluster, ma
instanceID
deve essere lo stesso per tutte le organizzazioni nello stesso cluster Kubernetes.Vedi
instanceID
.APIGEE_NAMESPACE Lo spazio dei nomi Kubernetes per i componenti Apigee hybrid.
Il valore predefinito è
apigee
.Vedi
namespace
.PROJECT_ID Identifica il progetto Google Cloud in cui apigee-logger
eapigee-metrics
inviano i propri dati. Questo è il valore assegnato alla variabile di ambientePROJECT_ID
.Vedi
gcp.projectID
.ANALYTICS_REGION In GKE, devi impostare questo valore sulla stessa regione in cui è in esecuzione il cluster. In tutte le altre piattaforme, seleziona la regione di analisi più vicina al tuo cluster che supporta Analytics (vedi la tabella in Parte 1, passaggio 2: crea un'organizzazione). Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
ANALYTICS_REGION
.Vedi
gcp.region
.CLUSTER_NAME Il nome del cluster Kubernetes. Questo è il valore assegnato alla variabile di ambiente CLUSTER_NAME
.Vedi
k8sCluster.name
.CLUSTER_LOCATION La regione in cui è in esecuzione il cluster. Questa è la regione in cui hai creato il cluster nel passaggio 1: crea un cluster. Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
CLUSTER_LOCATION
.Vedi
k8sCluster.location
.ORG_NAME L'ID della tua organizzazione Apigee hybrid. Questo è il valore assegnato alla variabile di ambiente ORG_NAME
.Vedi
org
.CONTROL_PLANE_
LOCATIONObbligatorio se utilizzi la residenza dei dati con l'installazione ibrida di Apigee. Questa è la posizione in cui vengono memorizzati i contenuti principali dei clienti, come i bundle proxy. Per un elenco, consulta Regioni del control plane dell'API Apigee disponibili. È il valore assegnato alla variabile di ambiente CONTROL_PLANE_LOCATION
nel passaggio 2: crea un'organizzazione.Vedi
contractProvider
.ENVIRONMENT_NAME Utilizza lo stesso nome che hai utilizzato quando hai creato un ambiente nell'interfaccia utente, come spiegato in Configurazione di progetto e organizzazione - Passaggio 3: crea un gruppo di ambienti. Vedi
envs[].name
.ENVIRONMENT_GROUP_
NAMEIl nome del gruppo di ambienti a cui sono assegnati i tuoi ambienti. Questo è il gruppo che hai creato in Configurazione del progetto e dell'organizzazione - Passaggio 3: crea un gruppo di ambienti. Questo è il valore assegnato alla variabile di ambiente ENV_GROUP
.Vedi
virtualhosts[].name
.INGRESS_NAME Il nome del gateway in entrata Apigee per il deployment. Può essere qualsiasi nome che soddisfi i seguenti requisiti: - Avere una lunghezza massima di 17 caratteri
- Contenere solo caratteri alfanumerici minuscoli, '-' o '.'
- Iniziare con un carattere alfanumerico
- Terminare con un carattere alfanumerico
Vedi:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEInserisci il percorso e il nome file della chiave TLS autofirmata e dei file del certificato che hai generato in precedenza nel passaggio 6: creazione dei certificati TLS. Questi file devono trovarsi nella directory APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Ad esempio:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Vedi:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Facoltativo) Si tratta di una coppia chiave-valore che fornisce annotazioni per il servizio di ingresso predefinito. La tua piattaforma cloud utilizza le annotazioni per configurare l'installazione ibrida, ad esempio impostando il tipo di bilanciatore del carico su interno o esterno. Le annotazioni variano da piattaforma a piattaforma. Consulta la documentazione della piattaforma per le annotazioni richieste e suggerite.
Commenta o elimina questa sezione se non la utilizzi.
Esempio
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
La tabella seguente descrive ciascuno dei valori delle proprietà che devi fornire nel file di override. Per ulteriori informazioni, consulta Riferimento alle proprietà di configurazione.
Variabile Descrizione UNIQUE_INSTANCE_
IDENTIFIERUna stringa univoca per identificare questa istanza. Può essere qualsiasi combinazione di lettere e numeri fino a 63 caratteri.
Puoi creare più organizzazioni nello stesso cluster, ma
instanceID
deve essere lo stesso per tutte le organizzazioni nello stesso cluster Kubernetes.Vedi
instanceID
.APIGEE_NAMESPACE Lo spazio dei nomi Kubernetes per i componenti Apigee hybrid.
Il valore predefinito è
apigee
.Vedi
namespace
.PROJECT_ID Identifica il progetto Google Cloud in cui apigee-logger
eapigee-metrics
inviano i propri dati. Questo è il valore assegnato alla variabile di ambientePROJECT_ID
.Vedi
gcp.projectID
.ANALYTICS_REGION In GKE, devi impostare questo valore sulla stessa regione in cui è in esecuzione il cluster. In tutte le altre piattaforme, seleziona la regione di analisi più vicina al tuo cluster che supporta Analytics (vedi la tabella in Parte 1, passaggio 2: crea un'organizzazione). Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
ANALYTICS_REGION
.Vedi
gcp.region
.CLUSTER_NAME Il nome del cluster Kubernetes. Questo è il valore assegnato alla variabile di ambiente CLUSTER_NAME
.Vedi
k8sCluster.name
.CLUSTER_LOCATION La regione in cui è in esecuzione il cluster. Questa è la regione in cui hai creato il cluster nel passaggio 1: crea un cluster. Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
CLUSTER_LOCATION
.Vedi
k8sCluster.location
.ORG_NAME L'ID della tua organizzazione Apigee hybrid. Questo è il valore assegnato alla variabile di ambiente ORG_NAME
.Vedi
org
.CONTROL_PLANE_
LOCATIONObbligatorio se utilizzi la residenza dei dati con l'installazione ibrida di Apigee. Questa è la posizione in cui vengono memorizzati i contenuti principali dei clienti, come i bundle proxy. Per un elenco, consulta Regioni del control plane dell'API Apigee disponibili. È il valore assegnato alla variabile di ambiente CONTROL_PLANE_LOCATION
nel passaggio 2: crea un'organizzazione.Vedi
contractProvider
.ENVIRONMENT_NAME Utilizza lo stesso nome che hai utilizzato quando hai creato un ambiente nell'interfaccia utente, come spiegato in Configurazione di progetto e organizzazione - Passaggio 3: crea un gruppo di ambienti. Vedi
envs[].name
.ENVIRONMENT_GROUP_
NAMEIl nome del gruppo di ambienti a cui sono assegnati i tuoi ambienti. Questo è il gruppo che hai creato in Configurazione del progetto e dell'organizzazione - Passaggio 3: crea un gruppo di ambienti. Questo è il valore assegnato alla variabile di ambiente ENV_GROUP
.Vedi
virtualhosts[].name
.INGRESS_NAME Il nome del gateway in entrata Apigee per il deployment. Può essere qualsiasi nome che soddisfi i seguenti requisiti: - Avere una lunghezza massima di 17 caratteri
- Contenere solo caratteri alfanumerici minuscoli, '-' o '.'
- Iniziare con un carattere alfanumerico
- Terminare con un carattere alfanumerico
Vedi:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEInserisci il percorso e il nome file della chiave TLS autofirmata e dei file del certificato che hai generato in precedenza nel passaggio 6: creazione dei certificati TLS. Questi file devono trovarsi nella directory APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Ad esempio:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Vedi:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Facoltativo) Si tratta di una coppia chiave-valore che fornisce annotazioni per il servizio di ingresso predefinito. La tua piattaforma cloud utilizza le annotazioni per configurare l'installazione ibrida, ad esempio impostando il tipo di bilanciatore del carico su interno o esterno. Le annotazioni variano da piattaforma a piattaforma. Consulta la documentazione della piattaforma per le annotazioni richieste e suggerite.
Commenta o elimina questa sezione se non la utilizzi.
Non di produzione
Modello
I valori in red, bold italics sono valori delle proprietà che devi fornire. Puoi modificare i relativi valori in questa pagina. Sono descritti nella tabella riportata di seguito.
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
La tabella seguente descrive ciascuno dei valori delle proprietà che devi fornire nel file di override. Per ulteriori informazioni, consulta Riferimento alle proprietà di configurazione.
Variabile Descrizione UNIQUE_INSTANCE_
IDENTIFIERUna stringa univoca per identificare questa istanza. Può essere qualsiasi combinazione di lettere e numeri fino a 63 caratteri.
Puoi creare più organizzazioni nello stesso cluster, ma
instanceID
deve essere lo stesso per tutte le organizzazioni nello stesso cluster Kubernetes.Vedi
instanceID
.APIGEE_NAMESPACE Lo spazio dei nomi Kubernetes per i componenti Apigee hybrid.
Il valore predefinito è
apigee
.Vedi
namespace
.PROJECT_ID Identifica il progetto Google Cloud in cui apigee-logger
eapigee-metrics
inviano i propri dati. Questo è il valore assegnato alla variabile di ambientePROJECT_ID
.Vedi
gcp.projectID
.ANALYTICS_REGION In GKE, devi impostare questo valore sulla stessa regione in cui è in esecuzione il cluster. In tutte le altre piattaforme, seleziona la regione di analisi più vicina al tuo cluster che supporta Analytics (vedi la tabella in Parte 1, passaggio 2: crea un'organizzazione). Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
ANALYTICS_REGION
.Vedi
gcp.region
.CLUSTER_NAME Il nome del cluster Kubernetes. Questo è il valore assegnato alla variabile di ambiente CLUSTER_NAME
.Vedi
k8sCluster.name
.CLUSTER_LOCATION La regione in cui è in esecuzione il cluster. Questa è la regione in cui hai creato il cluster nel passaggio 1: crea un cluster. Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
CLUSTER_LOCATION
.Vedi
k8sCluster.location
.ORG_NAME L'ID della tua organizzazione Apigee hybrid. Questo è il valore assegnato alla variabile di ambiente ORG_NAME
.Vedi
org
.CONTROL_PLANE_
LOCATIONObbligatorio se utilizzi la residenza dei dati con l'installazione ibrida di Apigee. Questa è la posizione in cui vengono memorizzati i contenuti principali dei clienti, come i bundle proxy. Per un elenco, consulta Regioni del control plane dell'API Apigee disponibili. È il valore assegnato alla variabile di ambiente CONTROL_PLANE_LOCATION
nel passaggio 2: crea un'organizzazione.Vedi
contractProvider
.ENVIRONMENT_NAME Utilizza lo stesso nome che hai utilizzato quando hai creato un ambiente nell'interfaccia utente, come spiegato in Configurazione di progetto e organizzazione - Passaggio 3: crea un gruppo di ambienti. Vedi
envs[].name
.ENVIRONMENT_GROUP_
NAMEIl nome del gruppo di ambienti a cui sono assegnati i tuoi ambienti. Questo è il gruppo che hai creato in Configurazione del progetto e dell'organizzazione - Passaggio 3: crea un gruppo di ambienti. Questo è il valore assegnato alla variabile di ambiente ENV_GROUP
.Vedi
virtualhosts[].name
.INGRESS_NAME Il nome del gateway in entrata Apigee per il deployment. Può essere qualsiasi nome che soddisfi i seguenti requisiti: - Avere una lunghezza massima di 17 caratteri
- Contenere solo caratteri alfanumerici minuscoli, '-' o '.'
- Iniziare con un carattere alfanumerico
- Terminare con un carattere alfanumerico
Vedi:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEInserisci il percorso e il nome file della chiave TLS autofirmata e dei file del certificato che hai generato in precedenza nel passaggio 6: creazione dei certificati TLS. Questi file devono trovarsi nella directory APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Ad esempio:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Vedi:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Facoltativo) Si tratta di una coppia chiave-valore che fornisce annotazioni per il servizio di ingresso predefinito. La tua piattaforma cloud utilizza le annotazioni per configurare l'installazione ibrida, ad esempio impostando il tipo di bilanciatore del carico su interno o esterno. Le annotazioni variano da piattaforma a piattaforma. Consulta la documentazione della piattaforma per le annotazioni richieste e suggerite.
Commenta o elimina questa sezione se non la utilizzi.
Esempio
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
La tabella seguente descrive ciascuno dei valori delle proprietà che devi fornire nel file di override. Per ulteriori informazioni, consulta Riferimento alle proprietà di configurazione.
Variabile Descrizione UNIQUE_INSTANCE_
IDENTIFIERUna stringa univoca per identificare questa istanza. Può essere qualsiasi combinazione di lettere e numeri fino a 63 caratteri.
Puoi creare più organizzazioni nello stesso cluster, ma
instanceID
deve essere lo stesso per tutte le organizzazioni nello stesso cluster Kubernetes.Vedi
instanceID
.APIGEE_NAMESPACE Lo spazio dei nomi Kubernetes per i componenti Apigee hybrid.
Il valore predefinito è
apigee
.Vedi
namespace
.PROJECT_ID Identifica il progetto Google Cloud in cui apigee-logger
eapigee-metrics
inviano i propri dati. Questo è il valore assegnato alla variabile di ambientePROJECT_ID
.Vedi
gcp.projectID
.ANALYTICS_REGION In GKE, devi impostare questo valore sulla stessa regione in cui è in esecuzione il cluster. In tutte le altre piattaforme, seleziona la regione di analisi più vicina al tuo cluster che supporta Analytics (vedi la tabella in Parte 1, passaggio 2: crea un'organizzazione). Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
ANALYTICS_REGION
.Vedi
gcp.region
.CLUSTER_NAME Il nome del cluster Kubernetes. Questo è il valore assegnato alla variabile di ambiente CLUSTER_NAME
.Vedi
k8sCluster.name
.CLUSTER_LOCATION La regione in cui è in esecuzione il cluster. Questa è la regione in cui hai creato il cluster nel passaggio 1: crea un cluster. Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
CLUSTER_LOCATION
.Vedi
k8sCluster.location
.ORG_NAME L'ID della tua organizzazione Apigee hybrid. Questo è il valore assegnato alla variabile di ambiente ORG_NAME
.Vedi
org
.CONTROL_PLANE_
LOCATIONObbligatorio se utilizzi la residenza dei dati con l'installazione ibrida di Apigee. Questa è la posizione in cui vengono memorizzati i contenuti principali dei clienti, come i bundle proxy. Per un elenco, consulta Regioni del control plane dell'API Apigee disponibili. È il valore assegnato alla variabile di ambiente CONTROL_PLANE_LOCATION
nel passaggio 2: crea un'organizzazione.Vedi
contractProvider
.ENVIRONMENT_NAME Utilizza lo stesso nome che hai utilizzato quando hai creato un ambiente nell'interfaccia utente, come spiegato in Configurazione di progetto e organizzazione - Passaggio 3: crea un gruppo di ambienti. Vedi
envs[].name
.ENVIRONMENT_GROUP_
NAMEIl nome del gruppo di ambienti a cui sono assegnati i tuoi ambienti. Questo è il gruppo che hai creato in Configurazione del progetto e dell'organizzazione - Passaggio 3: crea un gruppo di ambienti. Questo è il valore assegnato alla variabile di ambiente ENV_GROUP
.Vedi
virtualhosts[].name
.INGRESS_NAME Il nome del gateway in entrata Apigee per il deployment. Può essere qualsiasi nome che soddisfi i seguenti requisiti: - Avere una lunghezza massima di 17 caratteri
- Contenere solo caratteri alfanumerici minuscoli, '-' o '.'
- Iniziare con un carattere alfanumerico
- Terminare con un carattere alfanumerico
Vedi:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEInserisci il percorso e il nome file della chiave TLS autofirmata e dei file del certificato che hai generato in precedenza nel passaggio 6: creazione dei certificati TLS. Questi file devono trovarsi nella directory APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Ad esempio:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Vedi:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Facoltativo) Si tratta di una coppia chiave-valore che fornisce annotazioni per il servizio di ingresso predefinito. La tua piattaforma cloud utilizza le annotazioni per configurare l'installazione ibrida, ad esempio impostando il tipo di bilanciatore del carico su interno o esterno. Le annotazioni variano da piattaforma a piattaforma. Consulta la documentazione della piattaforma per le annotazioni richieste e suggerite.
Commenta o elimina questa sezione se non la utilizzi.
WIF per GKE
Produzione
Modello
I valori in red, bold italics sono valori delle proprietà che devi fornire. Puoi modificare i relativi valori in questa pagina. Sono descritti nella tabella riportata di seguito.
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 La tabella seguente descrive ciascuno dei valori delle proprietà che devi fornire nel file di override. Per ulteriori informazioni, consulta Riferimento alle proprietà di configurazione.
Variabile Descrizione UNIQUE_INSTANCE_
IDENTIFIERUna stringa univoca per identificare questa istanza. Può essere qualsiasi combinazione di lettere e numeri fino a 63 caratteri.
Puoi creare più organizzazioni nello stesso cluster, ma
instanceID
deve essere lo stesso per tutte le organizzazioni nello stesso cluster Kubernetes.Vedi
instanceID
.APIGEE_NAMESPACE Lo spazio dei nomi Kubernetes per i componenti Apigee hybrid.
Il valore predefinito è
apigee
.Vedi
namespace
.PROJECT_ID Identifica il progetto Google Cloud in cui apigee-logger
eapigee-metrics
inviano i propri dati. Questo è il valore assegnato alla variabile di ambientePROJECT_ID
.Vedi
gcp.projectID
.ANALYTICS_REGION In GKE, devi impostare questo valore sulla stessa regione in cui è in esecuzione il cluster. In tutte le altre piattaforme, seleziona la regione di analisi più vicina al tuo cluster che supporta Analytics (vedi la tabella in Parte 1, passaggio 2: crea un'organizzazione). Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
ANALYTICS_REGION
.Vedi
gcp.region
.CLUSTER_NAME Il nome del cluster Kubernetes. Questo è il valore assegnato alla variabile di ambiente CLUSTER_NAME
.Vedi
k8sCluster.name
.CLUSTER_LOCATION La regione in cui è in esecuzione il cluster. Questa è la regione in cui hai creato il cluster nel passaggio 1: crea un cluster. Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
CLUSTER_LOCATION
.Vedi
k8sCluster.location
.ORG_NAME L'ID della tua organizzazione Apigee hybrid. Questo è il valore assegnato alla variabile di ambiente ORG_NAME
.Vedi
org
.CONTROL_PLANE_
LOCATIONObbligatorio se utilizzi la residenza dei dati con l'installazione ibrida di Apigee. Questa è la posizione in cui vengono memorizzati i contenuti principali dei clienti, come i bundle proxy. Per un elenco, consulta Regioni del control plane dell'API Apigee disponibili. È il valore assegnato alla variabile di ambiente CONTROL_PLANE_LOCATION
nel passaggio 2: crea un'organizzazione.Vedi
contractProvider
.ENVIRONMENT_NAME Utilizza lo stesso nome che hai utilizzato quando hai creato un ambiente nell'interfaccia utente, come spiegato in Configurazione di progetto e organizzazione - Passaggio 3: crea un gruppo di ambienti. Vedi
envs[].name
.ENVIRONMENT_GROUP_
NAMEIl nome del gruppo di ambienti a cui sono assegnati i tuoi ambienti. Questo è il gruppo che hai creato in Configurazione del progetto e dell'organizzazione - Passaggio 3: crea un gruppo di ambienti. Questo è il valore assegnato alla variabile di ambiente ENV_GROUP
.Vedi
virtualhosts[].name
.INGRESS_NAME Il nome del gateway in entrata Apigee per il deployment. Può essere qualsiasi nome che soddisfi i seguenti requisiti: - Avere una lunghezza massima di 17 caratteri
- Contenere solo caratteri alfanumerici minuscoli, '-' o '.'
- Iniziare con un carattere alfanumerico
- Terminare con un carattere alfanumerico
Vedi:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEInserisci il percorso e il nome file della chiave TLS autofirmata e dei file del certificato che hai generato in precedenza nel passaggio 6: creazione dei certificati TLS. Questi file devono trovarsi nella directory APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Ad esempio:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Vedi:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Facoltativo) Si tratta di una coppia chiave-valore che fornisce annotazioni per il servizio di ingresso predefinito. La tua piattaforma cloud utilizza le annotazioni per configurare l'installazione ibrida, ad esempio impostando il tipo di bilanciatore del carico su interno o esterno. Le annotazioni variano da piattaforma a piattaforma. Consulta la documentazione della piattaforma per le annotazioni richieste e suggerite.
Commenta o elimina questa sezione se non la utilizzi.
<component>_
SERVICE_ACCOUNT_
EMAILGli indirizzi email dei account di servizio per i service account Google (GSA) che devi fornire se utilizzi Workload Identity Federation for GKE. Si tratta degli account di servizio che hai creato nel passaggio 4: crea gli account di servizio. Puoi trovare gli indirizzi email dei service account con il seguente comando: gcloud iam service-accounts list \ --project ${PROJECT_ID} \ --filter "apigee"
Vedi:
Esempio
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
La tabella seguente descrive ciascuno dei valori delle proprietà che devi fornire nel file di override. Per ulteriori informazioni, consulta Riferimento alle proprietà di configurazione.
Variabile Descrizione UNIQUE_INSTANCE_
IDENTIFIERUna stringa univoca per identificare questa istanza. Può essere qualsiasi combinazione di lettere e numeri fino a 63 caratteri.
Puoi creare più organizzazioni nello stesso cluster, ma
instanceID
deve essere lo stesso per tutte le organizzazioni nello stesso cluster Kubernetes.Vedi
instanceID
.APIGEE_NAMESPACE Lo spazio dei nomi Kubernetes per i componenti Apigee hybrid.
Il valore predefinito è
apigee
.Vedi
namespace
.PROJECT_ID Identifica il progetto Google Cloud in cui apigee-logger
eapigee-metrics
inviano i propri dati. Questo è il valore assegnato alla variabile di ambientePROJECT_ID
.Vedi
gcp.projectID
.ANALYTICS_REGION In GKE, devi impostare questo valore sulla stessa regione in cui è in esecuzione il cluster. In tutte le altre piattaforme, seleziona la regione di analisi più vicina al tuo cluster che supporta Analytics (vedi la tabella in Parte 1, passaggio 2: crea un'organizzazione). Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
ANALYTICS_REGION
.Vedi
gcp.region
.CLUSTER_NAME Il nome del cluster Kubernetes. Questo è il valore assegnato alla variabile di ambiente CLUSTER_NAME
.Vedi
k8sCluster.name
.CLUSTER_LOCATION La regione in cui è in esecuzione il cluster. Questa è la regione in cui hai creato il cluster nel passaggio 1: crea un cluster. Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
CLUSTER_LOCATION
.Vedi
k8sCluster.location
.ORG_NAME L'ID della tua organizzazione Apigee hybrid. Questo è il valore assegnato alla variabile di ambiente ORG_NAME
.Vedi
org
.CONTROL_PLANE_
LOCATIONObbligatorio se utilizzi la residenza dei dati con l'installazione ibrida di Apigee. Questa è la posizione in cui vengono memorizzati i contenuti principali dei clienti, come i bundle proxy. Per un elenco, consulta Regioni del control plane dell'API Apigee disponibili. È il valore assegnato alla variabile di ambiente CONTROL_PLANE_LOCATION
nel passaggio 2: crea un'organizzazione.Vedi
contractProvider
.ENVIRONMENT_NAME Utilizza lo stesso nome che hai utilizzato quando hai creato un ambiente nell'interfaccia utente, come spiegato in Configurazione di progetto e organizzazione - Passaggio 3: crea un gruppo di ambienti. Vedi
envs[].name
.ENVIRONMENT_GROUP_
NAMEIl nome del gruppo di ambienti a cui sono assegnati i tuoi ambienti. Questo è il gruppo che hai creato in Configurazione del progetto e dell'organizzazione - Passaggio 3: crea un gruppo di ambienti. Questo è il valore assegnato alla variabile di ambiente ENV_GROUP
.Vedi
virtualhosts[].name
.INGRESS_NAME Il nome del gateway in entrata Apigee per il deployment. Può essere qualsiasi nome che soddisfi i seguenti requisiti: - Avere una lunghezza massima di 17 caratteri
- Contenere solo caratteri alfanumerici minuscoli, '-' o '.'
- Iniziare con un carattere alfanumerico
- Terminare con un carattere alfanumerico
Vedi:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEInserisci il percorso e il nome file della chiave TLS autofirmata e dei file del certificato che hai generato in precedenza nel passaggio 6: creazione dei certificati TLS. Questi file devono trovarsi nella directory APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Ad esempio:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Vedi:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Facoltativo) Si tratta di una coppia chiave-valore che fornisce annotazioni per il servizio di ingresso predefinito. La tua piattaforma cloud utilizza le annotazioni per configurare l'installazione ibrida, ad esempio impostando il tipo di bilanciatore del carico su interno o esterno. Le annotazioni variano da piattaforma a piattaforma. Consulta la documentazione della piattaforma per le annotazioni richieste e suggerite.
Commenta o elimina questa sezione se non la utilizzi.
<component>_
SERVICE_ACCOUNT_
EMAILGli indirizzi email dei account di servizio per i service account Google (GSA) che devi fornire se utilizzi Workload Identity Federation for GKE. Si tratta degli account di servizio che hai creato nel passaggio 4: crea gli account di servizio. Puoi trovare gli indirizzi email dei service account con il seguente comando: gcloud iam service-accounts list \ --project ${PROJECT_ID} \ --filter "apigee"
Vedi:
Non di produzione
Modello
I valori in red, bold italics sono valori delle proprietà che devi fornire. Puoi modificare i relativi valori in questa pagina. Sono descritti nella tabella riportata di seguito.
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 La tabella seguente descrive ciascuno dei valori delle proprietà che devi fornire nel file di override. Per ulteriori informazioni, consulta Riferimento alle proprietà di configurazione.
Variabile Descrizione UNIQUE_INSTANCE_
IDENTIFIERUna stringa univoca per identificare questa istanza. Può essere qualsiasi combinazione di lettere e numeri fino a 63 caratteri.
Puoi creare più organizzazioni nello stesso cluster, ma
instanceID
deve essere lo stesso per tutte le organizzazioni nello stesso cluster Kubernetes.Vedi
instanceID
.APIGEE_NAMESPACE Lo spazio dei nomi Kubernetes per i componenti Apigee hybrid.
Il valore predefinito è
apigee
.Vedi
namespace
.PROJECT_ID Identifica il progetto Google Cloud in cui apigee-logger
eapigee-metrics
inviano i propri dati. Questo è il valore assegnato alla variabile di ambientePROJECT_ID
.Vedi
gcp.projectID
.ANALYTICS_REGION In GKE, devi impostare questo valore sulla stessa regione in cui è in esecuzione il cluster. In tutte le altre piattaforme, seleziona la regione di analisi più vicina al tuo cluster che supporta Analytics (vedi la tabella in Parte 1, passaggio 2: crea un'organizzazione). Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
ANALYTICS_REGION
.Vedi
gcp.region
.NON_PROD_
SERVICE_ACCOUNT_
EMAILGli indirizzi email del account di servizio per il account di servizio Google (GSA) non di produzione. Questo è l'account di servizio apigee-non-prod
che hai creato nel passaggio 4: crea gli account di servizio.Se utilizzi Workload Identity Federation for GKE in un'installazione non di produzione, specifica l'indirizzo email del account di servizio per la proprietà
gcp.workloadIdentity.gsa
. Non dovrai aggiungere la proprietàgsa
per i singoli componenti.Puoi trovare gli indirizzi email dei service account con il seguente comando:
gcloud iam service-accounts list \ --project ${PROJECT_ID} \ --filter "apigee"
Vedi
gcp.workloadIdentity.gsa
.CLUSTER_NAME Il nome del cluster Kubernetes. Questo è il valore assegnato alla variabile di ambiente CLUSTER_NAME
.Vedi
k8sCluster.name
.CLUSTER_LOCATION La regione in cui è in esecuzione il cluster. Questa è la regione in cui hai creato il cluster nel passaggio 1: crea un cluster. Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
CLUSTER_LOCATION
.Vedi
k8sCluster.location
.ORG_NAME L'ID della tua organizzazione Apigee hybrid. Questo è il valore assegnato alla variabile di ambiente ORG_NAME
.Vedi
org
.CONTROL_PLANE_
LOCATIONObbligatorio se utilizzi la residenza dei dati con l'installazione ibrida di Apigee. Questa è la posizione in cui vengono memorizzati i contenuti principali dei clienti, come i bundle proxy. Per un elenco, consulta Regioni del control plane dell'API Apigee disponibili. È il valore assegnato alla variabile di ambiente CONTROL_PLANE_LOCATION
nel passaggio 2: crea un'organizzazione.Vedi
contractProvider
.ENVIRONMENT_NAME Utilizza lo stesso nome che hai utilizzato quando hai creato un ambiente nell'interfaccia utente, come spiegato in Configurazione di progetto e organizzazione - Passaggio 3: crea un gruppo di ambienti. Vedi
envs[].name
.ENVIRONMENT_GROUP_
NAMEIl nome del gruppo di ambienti a cui sono assegnati i tuoi ambienti. Questo è il gruppo che hai creato in Configurazione del progetto e dell'organizzazione - Passaggio 3: crea un gruppo di ambienti. Questo è il valore assegnato alla variabile di ambiente ENV_GROUP
.Vedi
virtualhosts[].name
.INGRESS_NAME Il nome del gateway in entrata Apigee per il deployment. Può essere qualsiasi nome che soddisfi i seguenti requisiti: - Avere una lunghezza massima di 17 caratteri
- Contenere solo caratteri alfanumerici minuscoli, '-' o '.'
- Iniziare con un carattere alfanumerico
- Terminare con un carattere alfanumerico
Vedi:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEInserisci il percorso e il nome file della chiave TLS autofirmata e dei file del certificato che hai generato in precedenza nel passaggio 6: creazione dei certificati TLS. Questi file devono trovarsi nella directory APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Ad esempio:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Vedi:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Facoltativo) Si tratta di una coppia chiave-valore che fornisce annotazioni per il servizio di ingresso predefinito. La tua piattaforma cloud utilizza le annotazioni per configurare l'installazione ibrida, ad esempio impostando il tipo di bilanciatore del carico su interno o esterno. Le annotazioni variano da piattaforma a piattaforma. Consulta la documentazione della piattaforma per le annotazioni richieste e suggerite.
Commenta o elimina questa sezione se non la utilizzi.
Esempio
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
La tabella seguente descrive ciascuno dei valori delle proprietà che devi fornire nel file di override. Per ulteriori informazioni, consulta Riferimento alle proprietà di configurazione.
Variabile Descrizione UNIQUE_INSTANCE_
IDENTIFIERUna stringa univoca per identificare questa istanza. Può essere qualsiasi combinazione di lettere e numeri fino a 63 caratteri.
Puoi creare più organizzazioni nello stesso cluster, ma
instanceID
deve essere lo stesso per tutte le organizzazioni nello stesso cluster Kubernetes.Vedi
instanceID
.APIGEE_NAMESPACE Lo spazio dei nomi Kubernetes per i componenti Apigee hybrid.
Il valore predefinito è
apigee
.Vedi
namespace
.PROJECT_ID Identifica il progetto Google Cloud in cui apigee-logger
eapigee-metrics
inviano i propri dati. Questo è il valore assegnato alla variabile di ambientePROJECT_ID
.Vedi
gcp.projectID
.ANALYTICS_REGION In GKE, devi impostare questo valore sulla stessa regione in cui è in esecuzione il cluster. In tutte le altre piattaforme, seleziona la regione di analisi più vicina al tuo cluster che supporta Analytics (vedi la tabella in Parte 1, passaggio 2: crea un'organizzazione). Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
ANALYTICS_REGION
.Vedi
gcp.region
.NON_PROD_
SERVICE_ACCOUNT_
EMAILGli indirizzi email del account di servizio per il account di servizio Google (GSA) non di produzione. Questo è l'account di servizio apigee-non-prod
che hai creato nel passaggio 4: crea gli account di servizio.Se utilizzi Workload Identity Federation for GKE in un'installazione non di produzione, specifica l'indirizzo email del account di servizio per la proprietà
gcp.workloadIdentity.gsa
. Non dovrai aggiungere la proprietàgsa
per i singoli componenti.Puoi trovare gli indirizzi email dei service account con il seguente comando:
gcloud iam service-accounts list \ --project ${PROJECT_ID} \ --filter "apigee"
Vedi
gcp.workloadIdentity.gsa
.CLUSTER_NAME Il nome del cluster Kubernetes. Questo è il valore assegnato alla variabile di ambiente CLUSTER_NAME
.Vedi
k8sCluster.name
.CLUSTER_LOCATION La regione in cui è in esecuzione il cluster. Questa è la regione in cui hai creato il cluster nel passaggio 1: crea un cluster. Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
CLUSTER_LOCATION
.Vedi
k8sCluster.location
.ORG_NAME L'ID della tua organizzazione Apigee hybrid. Questo è il valore assegnato alla variabile di ambiente ORG_NAME
.Vedi
org
.CONTROL_PLANE_
LOCATIONObbligatorio se utilizzi la residenza dei dati con l'installazione ibrida di Apigee. Questa è la posizione in cui vengono memorizzati i contenuti principali dei clienti, come i bundle proxy. Per un elenco, consulta Regioni del control plane dell'API Apigee disponibili. È il valore assegnato alla variabile di ambiente CONTROL_PLANE_LOCATION
nel passaggio 2: crea un'organizzazione.Vedi
contractProvider
.ENVIRONMENT_NAME Utilizza lo stesso nome che hai utilizzato quando hai creato un ambiente nell'interfaccia utente, come spiegato in Configurazione di progetto e organizzazione - Passaggio 3: crea un gruppo di ambienti. Vedi
envs[].name
.ENVIRONMENT_GROUP_
NAMEIl nome del gruppo di ambienti a cui sono assegnati i tuoi ambienti. Questo è il gruppo che hai creato in Configurazione del progetto e dell'organizzazione - Passaggio 3: crea un gruppo di ambienti. Questo è il valore assegnato alla variabile di ambiente ENV_GROUP
.Vedi
virtualhosts[].name
.INGRESS_NAME Il nome del gateway in entrata Apigee per il deployment. Può essere qualsiasi nome che soddisfi i seguenti requisiti: - Avere una lunghezza massima di 17 caratteri
- Contenere solo caratteri alfanumerici minuscoli, '-' o '.'
- Iniziare con un carattere alfanumerico
- Terminare con un carattere alfanumerico
Vedi:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEInserisci il percorso e il nome file della chiave TLS autofirmata e dei file del certificato che hai generato in precedenza nel passaggio 6: creazione dei certificati TLS. Questi file devono trovarsi nella directory APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Ad esempio:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Vedi:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Facoltativo) Si tratta di una coppia chiave-valore che fornisce annotazioni per il servizio di ingresso predefinito. La tua piattaforma cloud utilizza le annotazioni per configurare l'installazione ibrida, ad esempio impostando il tipo di bilanciatore del carico su interno o esterno. Le annotazioni variano da piattaforma a piattaforma. Consulta la documentazione della piattaforma per le annotazioni richieste e suggerite.
Commenta o elimina questa sezione se non la utilizzi.
WIF su altre piattaforme
WIF: secrets
Produzione
Modello
I valori in red, bold italics sono valori delle proprietà che devi fornire. Puoi modificare i relativi valori in questa pagina. Sono descritti nella tabella riportata di seguito.
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 La tabella seguente descrive ciascuno dei valori delle proprietà che devi fornire nel file di override. Per ulteriori informazioni, consulta Riferimento alle proprietà di configurazione.
Variabile Descrizione UNIQUE_INSTANCE_
IDENTIFIERUna stringa univoca per identificare questa istanza. Può essere qualsiasi combinazione di lettere e numeri fino a 63 caratteri.
Puoi creare più organizzazioni nello stesso cluster, ma
instanceID
deve essere lo stesso per tutte le organizzazioni nello stesso cluster Kubernetes.Vedi
instanceID
.APIGEE_NAMESPACE Lo spazio dei nomi Kubernetes per i componenti Apigee hybrid.
Il valore predefinito è
apigee
.Vedi
namespace
.PROJECT_ID Identifica il progetto Google Cloud in cui apigee-logger
eapigee-metrics
inviano i propri dati. Questo è il valore assegnato alla variabile di ambientePROJECT_ID
.Vedi
gcp.projectID
.ANALYTICS_REGION In GKE, devi impostare questo valore sulla stessa regione in cui è in esecuzione il cluster. In tutte le altre piattaforme, seleziona la regione di analisi più vicina al tuo cluster che supporta Analytics (vedi la tabella in Parte 1, passaggio 2: crea un'organizzazione). Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
ANALYTICS_REGION
.Vedi
gcp.region
.AUDIENCE Il pubblico consentito del provider di identità del workload. Puoi trovare il valore cercando il termine audience:
in uno dei file di configurazione delle credenziali. Il valore del segmento di pubblico è lo stesso in ogni file di configurazione delle credenziali.Ad esempio, nel seguente file
apigee-udca-credential-configuration.json
di esempio:{ "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" } } }
Il valore del segmento di pubblico sarà simile al seguente (senza interruzioni di riga):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"
CLUSTER_NAME Il nome del cluster Kubernetes. Questo è il valore assegnato alla variabile di ambiente CLUSTER_NAME
.Vedi
k8sCluster.name
.CLUSTER_LOCATION La regione in cui è in esecuzione il cluster. Questa è la regione in cui hai creato il cluster nel passaggio 1: crea un cluster. Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
CLUSTER_LOCATION
.Vedi
k8sCluster.location
.ORG_NAME L'ID della tua organizzazione Apigee hybrid. Questo è il valore assegnato alla variabile di ambiente ORG_NAME
.Vedi
org
.CONTROL_PLANE_
LOCATIONObbligatorio se utilizzi la residenza dei dati con l'installazione ibrida di Apigee. Questa è la posizione in cui vengono memorizzati i contenuti principali dei clienti, come i bundle proxy. Per un elenco, consulta Regioni del control plane dell'API Apigee disponibili. È il valore assegnato alla variabile di ambiente CONTROL_PLANE_LOCATION
nel passaggio 2: crea un'organizzazione.Vedi
contractProvider
.ENVIRONMENT_NAME Utilizza lo stesso nome che hai utilizzato quando hai creato un ambiente nell'interfaccia utente, come spiegato in Configurazione di progetto e organizzazione - Passaggio 3: crea un gruppo di ambienti. Vedi
envs[].name
.ENVIRONMENT_GROUP_
NAMEIl nome del gruppo di ambienti a cui sono assegnati i tuoi ambienti. Questo è il gruppo che hai creato in Configurazione del progetto e dell'organizzazione - Passaggio 3: crea un gruppo di ambienti. Questo è il valore assegnato alla variabile di ambiente ENV_GROUP
.Vedi
virtualhosts[].name
.INGRESS_NAME Il nome del gateway in entrata Apigee per il deployment. Può essere qualsiasi nome che soddisfi i seguenti requisiti: - Avere una lunghezza massima di 17 caratteri
- Contenere solo caratteri alfanumerici minuscoli, '-' o '.'
- Iniziare con un carattere alfanumerico
- Terminare con un carattere alfanumerico
Vedi:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEInserisci il percorso e il nome file della chiave TLS autofirmata e dei file del certificato che hai generato in precedenza nel passaggio 6: creazione dei certificati TLS. Questi file devono trovarsi nella directory APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Ad esempio:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Vedi:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Facoltativo) Si tratta di una coppia chiave-valore che fornisce annotazioni per il servizio di ingresso predefinito. La tua piattaforma cloud utilizza le annotazioni per configurare l'installazione ibrida, ad esempio impostando il tipo di bilanciatore del carico su interno o esterno. Le annotazioni variano da piattaforma a piattaforma. Consulta la documentazione della piattaforma per le annotazioni richieste e suggerite.
Commenta o elimina questa sezione se non la utilizzi.
<component>_
WORKLOAD_IDENTITY_
SECRETIl nome del secret Kubernetes che hai creato per la configurazione delle credenziali del account di servizio nel passaggio 5: configura l'autenticazione account di servizio account. I nomi predefiniti dei secret suggeriti in questa guida sono:
Produzione
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 di produzione
non-prod-workload-identity-secret
Vedi:
-
envs[].serviceAccountSecretRefs.synchronizer
. -
envs[].serviceAccountSecretRefs.runtime
. -
envs[].serviceAccountSecretRefs.udca
. -
logger.serviceAccountRef
. -
connectAgent.serviceAccountRef
. -
mart.serviceAccountRef
. -
metrics.serviceAccountRef
. -
mintTaskScheduler.serviceAccountRef
. -
udca.serviceAccountRef
. -
watcher.serviceAccountRef
.
Esempio
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
La tabella seguente descrive ciascuno dei valori delle proprietà che devi fornire nel file di override. Per ulteriori informazioni, consulta Riferimento alle proprietà di configurazione.
Variabile Descrizione UNIQUE_INSTANCE_
IDENTIFIERUna stringa univoca per identificare questa istanza. Può essere qualsiasi combinazione di lettere e numeri fino a 63 caratteri.
Puoi creare più organizzazioni nello stesso cluster, ma
instanceID
deve essere lo stesso per tutte le organizzazioni nello stesso cluster Kubernetes.Vedi
instanceID
.APIGEE_NAMESPACE Lo spazio dei nomi Kubernetes per i componenti Apigee hybrid.
Il valore predefinito è
apigee
.Vedi
namespace
.PROJECT_ID Identifica il progetto Google Cloud in cui apigee-logger
eapigee-metrics
inviano i propri dati. Questo è il valore assegnato alla variabile di ambientePROJECT_ID
.Vedi
gcp.projectID
.ANALYTICS_REGION In GKE, devi impostare questo valore sulla stessa regione in cui è in esecuzione il cluster. In tutte le altre piattaforme, seleziona la regione di analisi più vicina al tuo cluster che supporta Analytics (vedi la tabella in Parte 1, passaggio 2: crea un'organizzazione). Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
ANALYTICS_REGION
.Vedi
gcp.region
.AUDIENCE Il pubblico consentito del provider di identità del workload. Puoi trovare il valore cercando il termine audience:
in uno dei file di configurazione delle credenziali. Il valore del segmento di pubblico è lo stesso in ogni file di configurazione delle credenziali.Ad esempio, nel seguente file
apigee-udca-credential-configuration.json
di esempio:{ "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" } } }
Il valore del segmento di pubblico sarà simile al seguente (senza interruzioni di riga):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"
CLUSTER_NAME Il nome del cluster Kubernetes. Questo è il valore assegnato alla variabile di ambiente CLUSTER_NAME
.Vedi
k8sCluster.name
.CLUSTER_LOCATION La regione in cui è in esecuzione il cluster. Questa è la regione in cui hai creato il cluster nel passaggio 1: crea un cluster. Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
CLUSTER_LOCATION
.Vedi
k8sCluster.location
.ORG_NAME L'ID della tua organizzazione Apigee hybrid. Questo è il valore assegnato alla variabile di ambiente ORG_NAME
.Vedi
org
.CONTROL_PLANE_
LOCATIONObbligatorio se utilizzi la residenza dei dati con l'installazione ibrida di Apigee. Questa è la posizione in cui vengono memorizzati i contenuti principali dei clienti, come i bundle proxy. Per un elenco, consulta Regioni del control plane dell'API Apigee disponibili. È il valore assegnato alla variabile di ambiente CONTROL_PLANE_LOCATION
nel passaggio 2: crea un'organizzazione.Vedi
contractProvider
.ENVIRONMENT_NAME Utilizza lo stesso nome che hai utilizzato quando hai creato un ambiente nell'interfaccia utente, come spiegato in Configurazione di progetto e organizzazione - Passaggio 3: crea un gruppo di ambienti. Vedi
envs[].name
.ENVIRONMENT_GROUP_
NAMEIl nome del gruppo di ambienti a cui sono assegnati i tuoi ambienti. Questo è il gruppo che hai creato in Configurazione del progetto e dell'organizzazione - Passaggio 3: crea un gruppo di ambienti. Questo è il valore assegnato alla variabile di ambiente ENV_GROUP
.Vedi
virtualhosts[].name
.INGRESS_NAME Il nome del gateway in entrata Apigee per il deployment. Può essere qualsiasi nome che soddisfi i seguenti requisiti: - Avere una lunghezza massima di 17 caratteri
- Contenere solo caratteri alfanumerici minuscoli, '-' o '.'
- Iniziare con un carattere alfanumerico
- Terminare con un carattere alfanumerico
Vedi:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEInserisci il percorso e il nome file della chiave TLS autofirmata e dei file del certificato che hai generato in precedenza nel passaggio 6: creazione dei certificati TLS. Questi file devono trovarsi nella directory APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Ad esempio:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Vedi:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Facoltativo) Si tratta di una coppia chiave-valore che fornisce annotazioni per il servizio di ingresso predefinito. La tua piattaforma cloud utilizza le annotazioni per configurare l'installazione ibrida, ad esempio impostando il tipo di bilanciatore del carico su interno o esterno. Le annotazioni variano da piattaforma a piattaforma. Consulta la documentazione della piattaforma per le annotazioni richieste e suggerite.
Commenta o elimina questa sezione se non la utilizzi.
<component>_
WORKLOAD_IDENTITY_
SECRETIl nome del secret Kubernetes che hai creato per la configurazione delle credenziali del account di servizio nel passaggio 5: configura l'autenticazione account di servizio account. I nomi predefiniti dei secret suggeriti in questa guida sono:
Produzione
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 di produzione
non-prod-workload-identity-secret
Vedi:
-
envs[].serviceAccountSecretRefs.synchronizer
. -
envs[].serviceAccountSecretRefs.runtime
. -
envs[].serviceAccountSecretRefs.udca
. -
logger.serviceAccountRef
. -
connectAgent.serviceAccountRef
. -
mart.serviceAccountRef
. -
metrics.serviceAccountRef
. -
mintTaskScheduler.serviceAccountRef
. -
udca.serviceAccountRef
. -
watcher.serviceAccountRef
.
Non di produzione
Modello
I valori in red, bold italics sono valori delle proprietà che devi fornire. Puoi modificare i relativi valori in questa pagina. Sono descritti nella tabella riportata di seguito.
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
La tabella seguente descrive ciascuno dei valori delle proprietà che devi fornire nel file di override. Per ulteriori informazioni, consulta Riferimento alle proprietà di configurazione.
Variabile Descrizione UNIQUE_INSTANCE_
IDENTIFIERUna stringa univoca per identificare questa istanza. Può essere qualsiasi combinazione di lettere e numeri fino a 63 caratteri.
Puoi creare più organizzazioni nello stesso cluster, ma
instanceID
deve essere lo stesso per tutte le organizzazioni nello stesso cluster Kubernetes.Vedi
instanceID
.APIGEE_NAMESPACE Lo spazio dei nomi Kubernetes per i componenti Apigee hybrid.
Il valore predefinito è
apigee
.Vedi
namespace
.PROJECT_ID Identifica il progetto Google Cloud in cui apigee-logger
eapigee-metrics
inviano i propri dati. Questo è il valore assegnato alla variabile di ambientePROJECT_ID
.Vedi
gcp.projectID
.ANALYTICS_REGION In GKE, devi impostare questo valore sulla stessa regione in cui è in esecuzione il cluster. In tutte le altre piattaforme, seleziona la regione di analisi più vicina al tuo cluster che supporta Analytics (vedi la tabella in Parte 1, passaggio 2: crea un'organizzazione). Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
ANALYTICS_REGION
.Vedi
gcp.region
.AUDIENCE Il pubblico consentito del provider di identità del workload. Puoi trovare il valore cercando il termine audience:
in uno dei file di configurazione delle credenziali. Il valore del segmento di pubblico è lo stesso in ogni file di configurazione delle credenziali.Ad esempio, nel seguente file
apigee-udca-credential-configuration.json
di esempio:{ "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" } } }
Il valore del segmento di pubblico sarà simile al seguente (senza interruzioni di riga):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"
CLUSTER_NAME Il nome del cluster Kubernetes. Questo è il valore assegnato alla variabile di ambiente CLUSTER_NAME
.Vedi
k8sCluster.name
.CLUSTER_LOCATION La regione in cui è in esecuzione il cluster. Questa è la regione in cui hai creato il cluster nel passaggio 1: crea un cluster. Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
CLUSTER_LOCATION
.Vedi
k8sCluster.location
.ORG_NAME L'ID della tua organizzazione Apigee hybrid. Questo è il valore assegnato alla variabile di ambiente ORG_NAME
.Vedi
org
.CONTROL_PLANE_
LOCATIONObbligatorio se utilizzi la residenza dei dati con l'installazione ibrida di Apigee. Questa è la posizione in cui vengono memorizzati i contenuti principali dei clienti, come i bundle proxy. Per un elenco, consulta Regioni del control plane dell'API Apigee disponibili. È il valore assegnato alla variabile di ambiente CONTROL_PLANE_LOCATION
nel passaggio 2: crea un'organizzazione.Vedi
contractProvider
.ENVIRONMENT_NAME Utilizza lo stesso nome che hai utilizzato quando hai creato un ambiente nell'interfaccia utente, come spiegato in Configurazione di progetto e organizzazione - Passaggio 3: crea un gruppo di ambienti. Vedi
envs[].name
.ENVIRONMENT_GROUP_
NAMEIl nome del gruppo di ambienti a cui sono assegnati i tuoi ambienti. Questo è il gruppo che hai creato in Configurazione del progetto e dell'organizzazione - Passaggio 3: crea un gruppo di ambienti. Questo è il valore assegnato alla variabile di ambiente ENV_GROUP
.Vedi
virtualhosts[].name
.INGRESS_NAME Il nome del gateway in entrata Apigee per il deployment. Può essere qualsiasi nome che soddisfi i seguenti requisiti: - Avere una lunghezza massima di 17 caratteri
- Contenere solo caratteri alfanumerici minuscoli, '-' o '.'
- Iniziare con un carattere alfanumerico
- Terminare con un carattere alfanumerico
Vedi:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEInserisci il percorso e il nome file della chiave TLS autofirmata e dei file del certificato che hai generato in precedenza nel passaggio 6: creazione dei certificati TLS. Questi file devono trovarsi nella directory APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Ad esempio:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Vedi:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Facoltativo) Si tratta di una coppia chiave-valore che fornisce annotazioni per il servizio di ingresso predefinito. La tua piattaforma cloud utilizza le annotazioni per configurare l'installazione ibrida, ad esempio impostando il tipo di bilanciatore del carico su interno o esterno. Le annotazioni variano da piattaforma a piattaforma. Consulta la documentazione della piattaforma per le annotazioni richieste e suggerite.
Commenta o elimina questa sezione se non la utilizzi.
<component>_
WORKLOAD_IDENTITY_
SECRETIl nome del secret Kubernetes che hai creato per la configurazione delle credenziali del account di servizio nel passaggio 5: configura l'autenticazione account di servizio account. I nomi predefiniti dei secret suggeriti in questa guida sono:
Produzione
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 di produzione
non-prod-workload-identity-secret
Vedi:
-
envs[].serviceAccountSecretRefs.synchronizer
. -
envs[].serviceAccountSecretRefs.runtime
. -
envs[].serviceAccountSecretRefs.udca
. -
logger.serviceAccountRef
. -
connectAgent.serviceAccountRef
. -
mart.serviceAccountRef
. -
metrics.serviceAccountRef
. -
mintTaskScheduler.serviceAccountRef
. -
udca.serviceAccountRef
. -
watcher.serviceAccountRef
.
Esempio
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
La tabella seguente descrive ciascuno dei valori delle proprietà che devi fornire nel file di override. Per ulteriori informazioni, consulta Riferimento alle proprietà di configurazione.
Variabile Descrizione UNIQUE_INSTANCE_
IDENTIFIERUna stringa univoca per identificare questa istanza. Può essere qualsiasi combinazione di lettere e numeri fino a 63 caratteri.
Puoi creare più organizzazioni nello stesso cluster, ma
instanceID
deve essere lo stesso per tutte le organizzazioni nello stesso cluster Kubernetes.Vedi
instanceID
.APIGEE_NAMESPACE Lo spazio dei nomi Kubernetes per i componenti Apigee hybrid.
Il valore predefinito è
apigee
.Vedi
namespace
.PROJECT_ID Identifica il progetto Google Cloud in cui apigee-logger
eapigee-metrics
inviano i propri dati. Questo è il valore assegnato alla variabile di ambientePROJECT_ID
.Vedi
gcp.projectID
.ANALYTICS_REGION In GKE, devi impostare questo valore sulla stessa regione in cui è in esecuzione il cluster. In tutte le altre piattaforme, seleziona la regione di analisi più vicina al tuo cluster che supporta Analytics (vedi la tabella in Parte 1, passaggio 2: crea un'organizzazione). Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
ANALYTICS_REGION
.Vedi
gcp.region
.AUDIENCE Il pubblico consentito del provider di identità del workload. Puoi trovare il valore cercando il termine audience:
in uno dei file di configurazione delle credenziali. Il valore del segmento di pubblico è lo stesso in ogni file di configurazione delle credenziali.Ad esempio, nel seguente file
apigee-udca-credential-configuration.json
di esempio:{ "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" } } }
Il valore del segmento di pubblico sarà simile al seguente (senza interruzioni di riga):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"
CLUSTER_NAME Il nome del cluster Kubernetes. Questo è il valore assegnato alla variabile di ambiente CLUSTER_NAME
.Vedi
k8sCluster.name
.CLUSTER_LOCATION La regione in cui è in esecuzione il cluster. Questa è la regione in cui hai creato il cluster nel passaggio 1: crea un cluster. Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
CLUSTER_LOCATION
.Vedi
k8sCluster.location
.ORG_NAME L'ID della tua organizzazione Apigee hybrid. Questo è il valore assegnato alla variabile di ambiente ORG_NAME
.Vedi
org
.CONTROL_PLANE_
LOCATIONObbligatorio se utilizzi la residenza dei dati con l'installazione ibrida di Apigee. Questa è la posizione in cui vengono memorizzati i contenuti principali dei clienti, come i bundle proxy. Per un elenco, consulta Regioni del control plane dell'API Apigee disponibili. È il valore assegnato alla variabile di ambiente CONTROL_PLANE_LOCATION
nel passaggio 2: crea un'organizzazione.Vedi
contractProvider
.ENVIRONMENT_NAME Utilizza lo stesso nome che hai utilizzato quando hai creato un ambiente nell'interfaccia utente, come spiegato in Configurazione di progetto e organizzazione - Passaggio 3: crea un gruppo di ambienti. Vedi
envs[].name
.ENVIRONMENT_GROUP_
NAMEIl nome del gruppo di ambienti a cui sono assegnati i tuoi ambienti. Questo è il gruppo che hai creato in Configurazione del progetto e dell'organizzazione - Passaggio 3: crea un gruppo di ambienti. Questo è il valore assegnato alla variabile di ambiente ENV_GROUP
.Vedi
virtualhosts[].name
.INGRESS_NAME Il nome del gateway in entrata Apigee per il deployment. Può essere qualsiasi nome che soddisfi i seguenti requisiti: - Avere una lunghezza massima di 17 caratteri
- Contenere solo caratteri alfanumerici minuscoli, '-' o '.'
- Iniziare con un carattere alfanumerico
- Terminare con un carattere alfanumerico
Vedi:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEInserisci il percorso e il nome file della chiave TLS autofirmata e dei file del certificato che hai generato in precedenza nel passaggio 6: creazione dei certificati TLS. Questi file devono trovarsi nella directory APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Ad esempio:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Vedi:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Facoltativo) Si tratta di una coppia chiave-valore che fornisce annotazioni per il servizio di ingresso predefinito. La tua piattaforma cloud utilizza le annotazioni per configurare l'installazione ibrida, ad esempio impostando il tipo di bilanciatore del carico su interno o esterno. Le annotazioni variano da piattaforma a piattaforma. Consulta la documentazione della piattaforma per le annotazioni richieste e suggerite.
Commenta o elimina questa sezione se non la utilizzi.
<component>_
WORKLOAD_IDENTITY_
SECRETIl nome del secret Kubernetes che hai creato per la configurazione delle credenziali del account di servizio nel passaggio 5: configura l'autenticazione account di servizio account. I nomi predefiniti dei secret suggeriti in questa guida sono:
Produzione
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 di produzione
non-prod-workload-identity-secret
Vedi:
-
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
Produzione
Modello
I valori in red, bold italics sono valori delle proprietà che devi fornire. Puoi modificare i relativi valori in questa pagina. Sono descritti nella tabella riportata di seguito.
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 La tabella seguente descrive ciascuno dei valori delle proprietà che devi fornire nel file di override. Per ulteriori informazioni, consulta Riferimento alle proprietà di configurazione.
Variabile Descrizione UNIQUE_INSTANCE_
IDENTIFIERUna stringa univoca per identificare questa istanza. Può essere qualsiasi combinazione di lettere e numeri fino a 63 caratteri.
Puoi creare più organizzazioni nello stesso cluster, ma
instanceID
deve essere lo stesso per tutte le organizzazioni nello stesso cluster Kubernetes.Vedi
instanceID
.APIGEE_NAMESPACE Lo spazio dei nomi Kubernetes per i componenti Apigee hybrid.
Il valore predefinito è
apigee
.Vedi
namespace
.PROJECT_ID Identifica il progetto Google Cloud in cui apigee-logger
eapigee-metrics
inviano i propri dati. Questo è il valore assegnato alla variabile di ambientePROJECT_ID
.Vedi
gcp.projectID
.ANALYTICS_REGION In GKE, devi impostare questo valore sulla stessa regione in cui è in esecuzione il cluster. In tutte le altre piattaforme, seleziona la regione di analisi più vicina al tuo cluster che supporta Analytics (vedi la tabella in Parte 1, passaggio 2: crea un'organizzazione). Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
ANALYTICS_REGION
.Vedi
gcp.region
.AUDIENCE Il pubblico consentito del provider di identità del workload. Puoi trovare il valore cercando il termine audience:
in uno dei file di configurazione delle credenziali. Il valore del segmento di pubblico è lo stesso in ogni file di configurazione delle credenziali.Ad esempio, nel seguente file
apigee-udca-credential-configuration.json
di esempio:{ "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" } } }
Il valore del segmento di pubblico sarà simile al seguente (senza interruzioni di riga):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"
CLUSTER_NAME Il nome del cluster Kubernetes. Questo è il valore assegnato alla variabile di ambiente CLUSTER_NAME
.Vedi
k8sCluster.name
.CLUSTER_LOCATION La regione in cui è in esecuzione il cluster. Questa è la regione in cui hai creato il cluster nel passaggio 1: crea un cluster. Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
CLUSTER_LOCATION
.Vedi
k8sCluster.location
.ORG_NAME L'ID della tua organizzazione Apigee hybrid. Questo è il valore assegnato alla variabile di ambiente ORG_NAME
.Vedi
org
.CONTROL_PLANE_
LOCATIONObbligatorio se utilizzi la residenza dei dati con l'installazione ibrida di Apigee. Questa è la posizione in cui vengono memorizzati i contenuti principali dei clienti, come i bundle proxy. Per un elenco, consulta Regioni del control plane dell'API Apigee disponibili. È il valore assegnato alla variabile di ambiente CONTROL_PLANE_LOCATION
nel passaggio 2: crea un'organizzazione.Vedi
contractProvider
.ENVIRONMENT_NAME Utilizza lo stesso nome che hai utilizzato quando hai creato un ambiente nell'interfaccia utente, come spiegato in Configurazione di progetto e organizzazione - Passaggio 3: crea un gruppo di ambienti. Vedi
envs[].name
.ENVIRONMENT_GROUP_
NAMEIl nome del gruppo di ambienti a cui sono assegnati i tuoi ambienti. Questo è il gruppo che hai creato in Configurazione del progetto e dell'organizzazione - Passaggio 3: crea un gruppo di ambienti. Questo è il valore assegnato alla variabile di ambiente ENV_GROUP
.Vedi
virtualhosts[].name
.INGRESS_NAME Il nome del gateway in entrata Apigee per il deployment. Può essere qualsiasi nome che soddisfi i seguenti requisiti: - Avere una lunghezza massima di 17 caratteri
- Contenere solo caratteri alfanumerici minuscoli, '-' o '.'
- Iniziare con un carattere alfanumerico
- Terminare con un carattere alfanumerico
Vedi:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEInserisci il percorso e il nome file della chiave TLS autofirmata e dei file del certificato che hai generato in precedenza nel passaggio 6: creazione dei certificati TLS. Questi file devono trovarsi nella directory APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Ad esempio:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Vedi:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Facoltativo) Si tratta di una coppia chiave-valore che fornisce annotazioni per il servizio di ingresso predefinito. La tua piattaforma cloud utilizza le annotazioni per configurare l'installazione ibrida, ad esempio impostando il tipo di bilanciatore del carico su interno o esterno. Le annotazioni variano da piattaforma a piattaforma. Consulta la documentazione della piattaforma per le annotazioni richieste e suggerite.
Commenta o elimina questa sezione se non la utilizzi.
<component>_
CREDENTIAL_
CONFIGURATION_
FILEPATHIl percorso e il nome file dell'account dei file di configurazione delle credenziali che hai creato nel passaggio 5: configura l'autenticazione dell'account di servizio. Fornisci i nomi con il percorso relativo alla directory del grafico. Ad esempio:
- Se il file
apigee-synchronizer-credential-configuration.json
si trova nella directory del graficoapigee-env/
, devi solo fornire il nome del file, ad esempio:synchronizer: "FILE_NAME.json"
- Se il file si trova in una directory
apigee-env/service-accounts/
, specifica un percorso relativo:synchronizer: "service-accounts/FILE_NAME.json"
I nomi predefiniti delle directory dei grafici corrispondenti per i service account sono:
Produzione
Nome file service account Directory dei grafici 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 di produzione
Nome file service account Directory dei grafici apigee-non-prod-credential-configuration.json
apigee-datastore/
apigee-org/
apigee-telemetry/
Vedi:
-
envs[].serviceAccountPaths.synchronizer
. -
envs[].serviceAccountPaths.runtime
. -
envs[].serviceAccountPaths.udca
. -
logger.serviceAccountPath
. -
connectAgent.serviceAccountPath
. -
mart.serviceAccountPath
. -
metrics.serviceAccountPath
. -
mintTaskScheduler.serviceAccountPath
. -
udca.serviceAccountPath
. -
watcher.serviceAccountPath
.
Esempio
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
La tabella seguente descrive ciascuno dei valori delle proprietà che devi fornire nel file di override. Per ulteriori informazioni, consulta Riferimento alle proprietà di configurazione.
Variabile Descrizione UNIQUE_INSTANCE_
IDENTIFIERUna stringa univoca per identificare questa istanza. Può essere qualsiasi combinazione di lettere e numeri fino a 63 caratteri.
Puoi creare più organizzazioni nello stesso cluster, ma
instanceID
deve essere lo stesso per tutte le organizzazioni nello stesso cluster Kubernetes.Vedi
instanceID
.APIGEE_NAMESPACE Lo spazio dei nomi Kubernetes per i componenti Apigee hybrid.
Il valore predefinito è
apigee
.Vedi
namespace
.PROJECT_ID Identifica il progetto Google Cloud in cui apigee-logger
eapigee-metrics
inviano i propri dati. Questo è il valore assegnato alla variabile di ambientePROJECT_ID
.Vedi
gcp.projectID
.ANALYTICS_REGION In GKE, devi impostare questo valore sulla stessa regione in cui è in esecuzione il cluster. In tutte le altre piattaforme, seleziona la regione di analisi più vicina al tuo cluster che supporta Analytics (vedi la tabella in Parte 1, passaggio 2: crea un'organizzazione). Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
ANALYTICS_REGION
.Vedi
gcp.region
.AUDIENCE Il pubblico consentito del provider di identità del workload. Puoi trovare il valore cercando il termine audience:
in uno dei file di configurazione delle credenziali. Il valore del segmento di pubblico è lo stesso in ogni file di configurazione delle credenziali.Ad esempio, nel seguente file
apigee-udca-credential-configuration.json
di esempio:{ "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" } } }
Il valore del segmento di pubblico sarà simile al seguente (senza interruzioni di riga):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"
CLUSTER_NAME Il nome del cluster Kubernetes. Questo è il valore assegnato alla variabile di ambiente CLUSTER_NAME
.Vedi
k8sCluster.name
.CLUSTER_LOCATION La regione in cui è in esecuzione il cluster. Questa è la regione in cui hai creato il cluster nel passaggio 1: crea un cluster. Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
CLUSTER_LOCATION
.Vedi
k8sCluster.location
.ORG_NAME L'ID della tua organizzazione Apigee hybrid. Questo è il valore assegnato alla variabile di ambiente ORG_NAME
.Vedi
org
.CONTROL_PLANE_
LOCATIONObbligatorio se utilizzi la residenza dei dati con l'installazione ibrida di Apigee. Questa è la posizione in cui vengono memorizzati i contenuti principali dei clienti, come i bundle proxy. Per un elenco, consulta Regioni del control plane dell'API Apigee disponibili. È il valore assegnato alla variabile di ambiente CONTROL_PLANE_LOCATION
nel passaggio 2: crea un'organizzazione.Vedi
contractProvider
.ENVIRONMENT_NAME Utilizza lo stesso nome che hai utilizzato quando hai creato un ambiente nell'interfaccia utente, come spiegato in Configurazione di progetto e organizzazione - Passaggio 3: crea un gruppo di ambienti. Vedi
envs[].name
.ENVIRONMENT_GROUP_
NAMEIl nome del gruppo di ambienti a cui sono assegnati i tuoi ambienti. Questo è il gruppo che hai creato in Configurazione del progetto e dell'organizzazione - Passaggio 3: crea un gruppo di ambienti. Questo è il valore assegnato alla variabile di ambiente ENV_GROUP
.Vedi
virtualhosts[].name
.INGRESS_NAME Il nome del gateway in entrata Apigee per il deployment. Può essere qualsiasi nome che soddisfi i seguenti requisiti: - Avere una lunghezza massima di 17 caratteri
- Contenere solo caratteri alfanumerici minuscoli, '-' o '.'
- Iniziare con un carattere alfanumerico
- Terminare con un carattere alfanumerico
Vedi:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEInserisci il percorso e il nome file della chiave TLS autofirmata e dei file del certificato che hai generato in precedenza nel passaggio 6: creazione dei certificati TLS. Questi file devono trovarsi nella directory APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Ad esempio:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Vedi:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Facoltativo) Si tratta di una coppia chiave-valore che fornisce annotazioni per il servizio di ingresso predefinito. La tua piattaforma cloud utilizza le annotazioni per configurare l'installazione ibrida, ad esempio impostando il tipo di bilanciatore del carico su interno o esterno. Le annotazioni variano da piattaforma a piattaforma. Consulta la documentazione della piattaforma per le annotazioni richieste e suggerite.
Commenta o elimina questa sezione se non la utilizzi.
<component>_
CREDENTIAL_
CONFIGURATION_
FILEPATHIl percorso e il nome file dell'account dei file di configurazione delle credenziali che hai creato nel passaggio 5: configura l'autenticazione dell'account di servizio. Fornisci i nomi con il percorso relativo alla directory del grafico. Ad esempio:
- Se il file
apigee-synchronizer-credential-configuration.json
si trova nella directory del graficoapigee-env/
, devi solo fornire il nome del file, ad esempio:synchronizer: "FILE_NAME.json"
- Se il file si trova in una directory
apigee-env/service-accounts/
, specifica un percorso relativo:synchronizer: "service-accounts/FILE_NAME.json"
I nomi predefiniti delle directory dei grafici corrispondenti per i service account sono:
Produzione
Nome file service account Directory dei grafici 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 di produzione
Nome file service account Directory dei grafici apigee-non-prod-credential-configuration.json
apigee-datastore/
apigee-org/
apigee-telemetry/
Vedi:
-
envs[].serviceAccountPaths.synchronizer
. -
envs[].serviceAccountPaths.runtime
. -
envs[].serviceAccountPaths.udca
. -
logger.serviceAccountPath
. -
connectAgent.serviceAccountPath
. -
mart.serviceAccountPath
. -
metrics.serviceAccountPath
. -
mintTaskScheduler.serviceAccountPath
. -
udca.serviceAccountPath
. -
watcher.serviceAccountPath
.
Non di produzione
Modello
I valori in red, bold italics sono valori delle proprietà che devi fornire. Puoi modificare i relativi valori in questa pagina. Sono descritti nella tabella riportata di seguito.
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
La tabella seguente descrive ciascuno dei valori delle proprietà che devi fornire nel file di override. Per ulteriori informazioni, consulta Riferimento alle proprietà di configurazione.
Variabile Descrizione UNIQUE_INSTANCE_
IDENTIFIERUna stringa univoca per identificare questa istanza. Può essere qualsiasi combinazione di lettere e numeri fino a 63 caratteri.
Puoi creare più organizzazioni nello stesso cluster, ma
instanceID
deve essere lo stesso per tutte le organizzazioni nello stesso cluster Kubernetes.Vedi
instanceID
.APIGEE_NAMESPACE Lo spazio dei nomi Kubernetes per i componenti Apigee hybrid.
Il valore predefinito è
apigee
.Vedi
namespace
.PROJECT_ID Identifica il progetto Google Cloud in cui apigee-logger
eapigee-metrics
inviano i propri dati. Questo è il valore assegnato alla variabile di ambientePROJECT_ID
.Vedi
gcp.projectID
.ANALYTICS_REGION In GKE, devi impostare questo valore sulla stessa regione in cui è in esecuzione il cluster. In tutte le altre piattaforme, seleziona la regione di analisi più vicina al tuo cluster che supporta Analytics (vedi la tabella in Parte 1, passaggio 2: crea un'organizzazione). Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
ANALYTICS_REGION
.Vedi
gcp.region
.AUDIENCE Il pubblico consentito del provider di identità del workload. Puoi trovare il valore cercando il termine audience:
in uno dei file di configurazione delle credenziali. Il valore del segmento di pubblico è lo stesso in ogni file di configurazione delle credenziali.Ad esempio, nel seguente file
apigee-udca-credential-configuration.json
di esempio:{ "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" } } }
Il valore del segmento di pubblico sarà simile al seguente (senza interruzioni di riga):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"
CLUSTER_NAME Il nome del cluster Kubernetes. Questo è il valore assegnato alla variabile di ambiente CLUSTER_NAME
.Vedi
k8sCluster.name
.CLUSTER_LOCATION La regione in cui è in esecuzione il cluster. Questa è la regione in cui hai creato il cluster nel passaggio 1: crea un cluster. Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
CLUSTER_LOCATION
.Vedi
k8sCluster.location
.ORG_NAME L'ID della tua organizzazione Apigee hybrid. Questo è il valore assegnato alla variabile di ambiente ORG_NAME
.Vedi
org
.CONTROL_PLANE_
LOCATIONObbligatorio se utilizzi la residenza dei dati con l'installazione ibrida di Apigee. Questa è la posizione in cui vengono memorizzati i contenuti principali dei clienti, come i bundle proxy. Per un elenco, consulta Regioni del control plane dell'API Apigee disponibili. È il valore assegnato alla variabile di ambiente CONTROL_PLANE_LOCATION
nel passaggio 2: crea un'organizzazione.Vedi
contractProvider
.ENVIRONMENT_NAME Utilizza lo stesso nome che hai utilizzato quando hai creato un ambiente nell'interfaccia utente, come spiegato in Configurazione di progetto e organizzazione - Passaggio 3: crea un gruppo di ambienti. Vedi
envs[].name
.ENVIRONMENT_GROUP_
NAMEIl nome del gruppo di ambienti a cui sono assegnati i tuoi ambienti. Questo è il gruppo che hai creato in Configurazione del progetto e dell'organizzazione - Passaggio 3: crea un gruppo di ambienti. Questo è il valore assegnato alla variabile di ambiente ENV_GROUP
.Vedi
virtualhosts[].name
.INGRESS_NAME Il nome del gateway in entrata Apigee per il deployment. Può essere qualsiasi nome che soddisfi i seguenti requisiti: - Avere una lunghezza massima di 17 caratteri
- Contenere solo caratteri alfanumerici minuscoli, '-' o '.'
- Iniziare con un carattere alfanumerico
- Terminare con un carattere alfanumerico
Vedi:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEInserisci il percorso e il nome file della chiave TLS autofirmata e dei file del certificato che hai generato in precedenza nel passaggio 6: creazione dei certificati TLS. Questi file devono trovarsi nella directory APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Ad esempio:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Vedi:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Facoltativo) Si tratta di una coppia chiave-valore che fornisce annotazioni per il servizio di ingresso predefinito. La tua piattaforma cloud utilizza le annotazioni per configurare l'installazione ibrida, ad esempio impostando il tipo di bilanciatore del carico su interno o esterno. Le annotazioni variano da piattaforma a piattaforma. Consulta la documentazione della piattaforma per le annotazioni richieste e suggerite.
Commenta o elimina questa sezione se non la utilizzi.
<component>_
CREDENTIAL_
CONFIGURATION_
FILEPATHIl percorso e il nome file dell'account dei file di configurazione delle credenziali che hai creato nel passaggio 5: configura l'autenticazione dell'account di servizio. Fornisci i nomi con il percorso relativo alla directory del grafico. Ad esempio:
- Se il file
apigee-synchronizer-credential-configuration.json
si trova nella directory del graficoapigee-env/
, devi solo fornire il nome del file, ad esempio:synchronizer: "FILE_NAME.json"
- Se il file si trova in una directory
apigee-env/service-accounts/
, specifica un percorso relativo:synchronizer: "service-accounts/FILE_NAME.json"
I nomi predefiniti delle directory dei grafici corrispondenti per i service account sono:
Produzione
Nome file service account Directory dei grafici 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 di produzione
Nome file service account Directory dei grafici apigee-non-prod-credential-configuration.json
apigee-datastore/
apigee-org/
apigee-telemetry/
Vedi:
-
envs[].serviceAccountPaths.synchronizer
. -
envs[].serviceAccountPaths.runtime
. -
envs[].serviceAccountPaths.udca
. -
logger.serviceAccountPath
. -
connectAgent.serviceAccountPath
. -
mart.serviceAccountPath
. -
metrics.serviceAccountPath
. -
mintTaskScheduler.serviceAccountPath
. -
udca.serviceAccountPath
. -
watcher.serviceAccountPath
.
Esempio
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
La tabella seguente descrive ciascuno dei valori delle proprietà che devi fornire nel file di override. Per ulteriori informazioni, consulta Riferimento alle proprietà di configurazione.
Variabile Descrizione UNIQUE_INSTANCE_
IDENTIFIERUna stringa univoca per identificare questa istanza. Può essere qualsiasi combinazione di lettere e numeri fino a 63 caratteri.
Puoi creare più organizzazioni nello stesso cluster, ma
instanceID
deve essere lo stesso per tutte le organizzazioni nello stesso cluster Kubernetes.Vedi
instanceID
.APIGEE_NAMESPACE Lo spazio dei nomi Kubernetes per i componenti Apigee hybrid.
Il valore predefinito è
apigee
.Vedi
namespace
.PROJECT_ID Identifica il progetto Google Cloud in cui apigee-logger
eapigee-metrics
inviano i propri dati. Questo è il valore assegnato alla variabile di ambientePROJECT_ID
.Vedi
gcp.projectID
.ANALYTICS_REGION In GKE, devi impostare questo valore sulla stessa regione in cui è in esecuzione il cluster. In tutte le altre piattaforme, seleziona la regione di analisi più vicina al tuo cluster che supporta Analytics (vedi la tabella in Parte 1, passaggio 2: crea un'organizzazione). Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
ANALYTICS_REGION
.Vedi
gcp.region
.AUDIENCE Il pubblico consentito del provider di identità del workload. Puoi trovare il valore cercando il termine audience:
in uno dei file di configurazione delle credenziali. Il valore del segmento di pubblico è lo stesso in ogni file di configurazione delle credenziali.Ad esempio, nel seguente file
apigee-udca-credential-configuration.json
di esempio:{ "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" } } }
Il valore del segmento di pubblico sarà simile al seguente (senza interruzioni di riga):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"
CLUSTER_NAME Il nome del cluster Kubernetes. Questo è il valore assegnato alla variabile di ambiente CLUSTER_NAME
.Vedi
k8sCluster.name
.CLUSTER_LOCATION La regione in cui è in esecuzione il cluster. Questa è la regione in cui hai creato il cluster nel passaggio 1: crea un cluster. Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
CLUSTER_LOCATION
.Vedi
k8sCluster.location
.ORG_NAME L'ID della tua organizzazione Apigee hybrid. Questo è il valore assegnato alla variabile di ambiente ORG_NAME
.Vedi
org
.CONTROL_PLANE_
LOCATIONObbligatorio se utilizzi la residenza dei dati con l'installazione ibrida di Apigee. Questa è la posizione in cui vengono memorizzati i contenuti principali dei clienti, come i bundle proxy. Per un elenco, consulta Regioni del control plane dell'API Apigee disponibili. È il valore assegnato alla variabile di ambiente CONTROL_PLANE_LOCATION
nel passaggio 2: crea un'organizzazione.Vedi
contractProvider
.ENVIRONMENT_NAME Utilizza lo stesso nome che hai utilizzato quando hai creato un ambiente nell'interfaccia utente, come spiegato in Configurazione di progetto e organizzazione - Passaggio 3: crea un gruppo di ambienti. Vedi
envs[].name
.ENVIRONMENT_GROUP_
NAMEIl nome del gruppo di ambienti a cui sono assegnati i tuoi ambienti. Questo è il gruppo che hai creato in Configurazione del progetto e dell'organizzazione - Passaggio 3: crea un gruppo di ambienti. Questo è il valore assegnato alla variabile di ambiente ENV_GROUP
.Vedi
virtualhosts[].name
.INGRESS_NAME Il nome del gateway in entrata Apigee per il deployment. Può essere qualsiasi nome che soddisfi i seguenti requisiti: - Avere una lunghezza massima di 17 caratteri
- Contenere solo caratteri alfanumerici minuscoli, '-' o '.'
- Iniziare con un carattere alfanumerico
- Terminare con un carattere alfanumerico
Vedi:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEInserisci il percorso e il nome file della chiave TLS autofirmata e dei file del certificato che hai generato in precedenza nel passaggio 6: creazione dei certificati TLS. Questi file devono trovarsi nella directory APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Ad esempio:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Vedi:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Facoltativo) Si tratta di una coppia chiave-valore che fornisce annotazioni per il servizio di ingresso predefinito. La tua piattaforma cloud utilizza le annotazioni per configurare l'installazione ibrida, ad esempio impostando il tipo di bilanciatore del carico su interno o esterno. Le annotazioni variano da piattaforma a piattaforma. Consulta la documentazione della piattaforma per le annotazioni richieste e suggerite.
Commenta o elimina questa sezione se non la utilizzi.
<component>_
CREDENTIAL_
CONFIGURATION_
FILEPATHIl percorso e il nome file dell'account dei file di configurazione delle credenziali che hai creato nel passaggio 5: configura l'autenticazione dell'account di servizio. Fornisci i nomi con il percorso relativo alla directory del grafico. Ad esempio:
- Se il file
apigee-synchronizer-credential-configuration.json
si trova nella directory del graficoapigee-env/
, devi solo fornire il nome del file, ad esempio:synchronizer: "FILE_NAME.json"
- Se il file si trova in una directory
apigee-env/service-accounts/
, specifica un percorso relativo:synchronizer: "service-accounts/FILE_NAME.json"
I nomi predefiniti delle directory dei grafici corrispondenti per i service account sono:
Produzione
Nome file service account Directory dei grafici 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 di produzione
Nome file service account Directory dei grafici apigee-non-prod-credential-configuration.json
apigee-datastore/
apigee-org/
apigee-telemetry/
Vedi:
-
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
Produzione
Modello
I valori in red, bold italics sono valori delle proprietà che devi fornire. Puoi modificare i relativi valori in questa pagina. Sono descritti nella tabella riportata di seguito.
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 La tabella seguente descrive ciascuno dei valori delle proprietà che devi fornire nel file di override. Per ulteriori informazioni, consulta Riferimento alle proprietà di configurazione.
Variabile Descrizione UNIQUE_INSTANCE_
IDENTIFIERUna stringa univoca per identificare questa istanza. Può essere qualsiasi combinazione di lettere e numeri fino a 63 caratteri.
Puoi creare più organizzazioni nello stesso cluster, ma
instanceID
deve essere lo stesso per tutte le organizzazioni nello stesso cluster Kubernetes.Vedi
instanceID
.APIGEE_NAMESPACE Lo spazio dei nomi Kubernetes per i componenti Apigee hybrid.
Il valore predefinito è
apigee
.Vedi
namespace
.PROJECT_ID Identifica il progetto Google Cloud in cui apigee-logger
eapigee-metrics
inviano i propri dati. Questo è il valore assegnato alla variabile di ambientePROJECT_ID
.Vedi
gcp.projectID
.ANALYTICS_REGION In GKE, devi impostare questo valore sulla stessa regione in cui è in esecuzione il cluster. In tutte le altre piattaforme, seleziona la regione di analisi più vicina al tuo cluster che supporta Analytics (vedi la tabella in Parte 1, passaggio 2: crea un'organizzazione). Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
ANALYTICS_REGION
.Vedi
gcp.region
.AUDIENCE Il pubblico consentito del provider di identità del workload. Puoi trovare il valore cercando il termine audience:
in uno dei file di configurazione delle credenziali. Il valore del segmento di pubblico è lo stesso in ogni file di configurazione delle credenziali.Ad esempio, nel seguente file
apigee-udca-credential-configuration.json
di esempio:{ "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" } } }
Il valore del segmento di pubblico sarà simile al seguente (senza interruzioni di riga):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"
CLUSTER_NAME Il nome del cluster Kubernetes. Questo è il valore assegnato alla variabile di ambiente CLUSTER_NAME
.Vedi
k8sCluster.name
.CLUSTER_LOCATION La regione in cui è in esecuzione il cluster. Questa è la regione in cui hai creato il cluster nel passaggio 1: crea un cluster. Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
CLUSTER_LOCATION
.Vedi
k8sCluster.location
.ORG_NAME L'ID della tua organizzazione Apigee hybrid. Questo è il valore assegnato alla variabile di ambiente ORG_NAME
.Vedi
org
.CONTROL_PLANE_
LOCATIONObbligatorio se utilizzi la residenza dei dati con l'installazione ibrida di Apigee. Questa è la posizione in cui vengono memorizzati i contenuti principali dei clienti, come i bundle proxy. Per un elenco, consulta Regioni del control plane dell'API Apigee disponibili. È il valore assegnato alla variabile di ambiente CONTROL_PLANE_LOCATION
nel passaggio 2: crea un'organizzazione.Vedi
contractProvider
.ENVIRONMENT_NAME Utilizza lo stesso nome che hai utilizzato quando hai creato un ambiente nell'interfaccia utente, come spiegato in Configurazione di progetto e organizzazione - Passaggio 3: crea un gruppo di ambienti. Vedi
envs[].name
.ENVIRONMENT_GROUP_
NAMEIl nome del gruppo di ambienti a cui sono assegnati i tuoi ambienti. Questo è il gruppo che hai creato in Configurazione del progetto e dell'organizzazione - Passaggio 3: crea un gruppo di ambienti. Questo è il valore assegnato alla variabile di ambiente ENV_GROUP
.Vedi
virtualhosts[].name
.INGRESS_NAME Il nome del gateway in entrata Apigee per il deployment. Può essere qualsiasi nome che soddisfi i seguenti requisiti: - Avere una lunghezza massima di 17 caratteri
- Contenere solo caratteri alfanumerici minuscoli, '-' o '.'
- Iniziare con un carattere alfanumerico
- Terminare con un carattere alfanumerico
Vedi:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEInserisci il percorso e il nome file della chiave TLS autofirmata e dei file del certificato che hai generato in precedenza nel passaggio 6: creazione dei certificati TLS. Questi file devono trovarsi nella directory APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Ad esempio:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Vedi:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Facoltativo) Si tratta di una coppia chiave-valore che fornisce annotazioni per il servizio di ingresso predefinito. La tua piattaforma cloud utilizza le annotazioni per configurare l'installazione ibrida, ad esempio impostando il tipo di bilanciatore del carico su interno o esterno. Le annotazioni variano da piattaforma a piattaforma. Consulta la documentazione della piattaforma per le annotazioni richieste e suggerite.
Commenta o elimina questa sezione se non la utilizzi.
Esempio
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
La tabella seguente descrive ciascuno dei valori delle proprietà che devi fornire nel file di override. Per ulteriori informazioni, consulta Riferimento alle proprietà di configurazione.
Variabile Descrizione UNIQUE_INSTANCE_
IDENTIFIERUna stringa univoca per identificare questa istanza. Può essere qualsiasi combinazione di lettere e numeri fino a 63 caratteri.
Puoi creare più organizzazioni nello stesso cluster, ma
instanceID
deve essere lo stesso per tutte le organizzazioni nello stesso cluster Kubernetes.Vedi
instanceID
.APIGEE_NAMESPACE Lo spazio dei nomi Kubernetes per i componenti Apigee hybrid.
Il valore predefinito è
apigee
.Vedi
namespace
.PROJECT_ID Identifica il progetto Google Cloud in cui apigee-logger
eapigee-metrics
inviano i propri dati. Questo è il valore assegnato alla variabile di ambientePROJECT_ID
.Vedi
gcp.projectID
.ANALYTICS_REGION In GKE, devi impostare questo valore sulla stessa regione in cui è in esecuzione il cluster. In tutte le altre piattaforme, seleziona la regione di analisi più vicina al tuo cluster che supporta Analytics (vedi la tabella in Parte 1, passaggio 2: crea un'organizzazione). Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
ANALYTICS_REGION
.Vedi
gcp.region
.AUDIENCE Il pubblico consentito del provider di identità del workload. Puoi trovare il valore cercando il termine audience:
in uno dei file di configurazione delle credenziali. Il valore del segmento di pubblico è lo stesso in ogni file di configurazione delle credenziali.Ad esempio, nel seguente file
apigee-udca-credential-configuration.json
di esempio:{ "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" } } }
Il valore del segmento di pubblico sarà simile al seguente (senza interruzioni di riga):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"
CLUSTER_NAME Il nome del cluster Kubernetes. Questo è il valore assegnato alla variabile di ambiente CLUSTER_NAME
.Vedi
k8sCluster.name
.CLUSTER_LOCATION La regione in cui è in esecuzione il cluster. Questa è la regione in cui hai creato il cluster nel passaggio 1: crea un cluster. Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
CLUSTER_LOCATION
.Vedi
k8sCluster.location
.ORG_NAME L'ID della tua organizzazione Apigee hybrid. Questo è il valore assegnato alla variabile di ambiente ORG_NAME
.Vedi
org
.CONTROL_PLANE_
LOCATIONObbligatorio se utilizzi la residenza dei dati con l'installazione ibrida di Apigee. Questa è la posizione in cui vengono memorizzati i contenuti principali dei clienti, come i bundle proxy. Per un elenco, consulta Regioni del control plane dell'API Apigee disponibili. È il valore assegnato alla variabile di ambiente CONTROL_PLANE_LOCATION
nel passaggio 2: crea un'organizzazione.Vedi
contractProvider
.ENVIRONMENT_NAME Utilizza lo stesso nome che hai utilizzato quando hai creato un ambiente nell'interfaccia utente, come spiegato in Configurazione di progetto e organizzazione - Passaggio 3: crea un gruppo di ambienti. Vedi
envs[].name
.ENVIRONMENT_GROUP_
NAMEIl nome del gruppo di ambienti a cui sono assegnati i tuoi ambienti. Questo è il gruppo che hai creato in Configurazione del progetto e dell'organizzazione - Passaggio 3: crea un gruppo di ambienti. Questo è il valore assegnato alla variabile di ambiente ENV_GROUP
.Vedi
virtualhosts[].name
.INGRESS_NAME Il nome del gateway in entrata Apigee per il deployment. Può essere qualsiasi nome che soddisfi i seguenti requisiti: - Avere una lunghezza massima di 17 caratteri
- Contenere solo caratteri alfanumerici minuscoli, '-' o '.'
- Iniziare con un carattere alfanumerico
- Terminare con un carattere alfanumerico
Vedi:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEInserisci il percorso e il nome file della chiave TLS autofirmata e dei file del certificato che hai generato in precedenza nel passaggio 6: creazione dei certificati TLS. Questi file devono trovarsi nella directory APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Ad esempio:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Vedi:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Facoltativo) Si tratta di una coppia chiave-valore che fornisce annotazioni per il servizio di ingresso predefinito. La tua piattaforma cloud utilizza le annotazioni per configurare l'installazione ibrida, ad esempio impostando il tipo di bilanciatore del carico su interno o esterno. Le annotazioni variano da piattaforma a piattaforma. Consulta la documentazione della piattaforma per le annotazioni richieste e suggerite.
Commenta o elimina questa sezione se non la utilizzi.
Non di produzione
Modello
I valori in red, bold italics sono valori delle proprietà che devi fornire. Puoi modificare i relativi valori in questa pagina. Sono descritti nella tabella riportata di seguito.
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
La tabella seguente descrive ciascuno dei valori delle proprietà che devi fornire nel file di override. Per ulteriori informazioni, consulta Riferimento alle proprietà di configurazione.
Variabile Descrizione UNIQUE_INSTANCE_
IDENTIFIERUna stringa univoca per identificare questa istanza. Può essere qualsiasi combinazione di lettere e numeri fino a 63 caratteri.
Puoi creare più organizzazioni nello stesso cluster, ma
instanceID
deve essere lo stesso per tutte le organizzazioni nello stesso cluster Kubernetes.Vedi
instanceID
.APIGEE_NAMESPACE Lo spazio dei nomi Kubernetes per i componenti Apigee hybrid.
Il valore predefinito è
apigee
.Vedi
namespace
.PROJECT_ID Identifica il progetto Google Cloud in cui apigee-logger
eapigee-metrics
inviano i propri dati. Questo è il valore assegnato alla variabile di ambientePROJECT_ID
.Vedi
gcp.projectID
.ANALYTICS_REGION In GKE, devi impostare questo valore sulla stessa regione in cui è in esecuzione il cluster. In tutte le altre piattaforme, seleziona la regione di analisi più vicina al tuo cluster che supporta Analytics (vedi la tabella in Parte 1, passaggio 2: crea un'organizzazione). Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
ANALYTICS_REGION
.Vedi
gcp.region
.AUDIENCE Il pubblico consentito del provider di identità del workload. Puoi trovare il valore cercando il termine audience:
in uno dei file di configurazione delle credenziali. Il valore del segmento di pubblico è lo stesso in ogni file di configurazione delle credenziali.Ad esempio, nel seguente file
apigee-udca-credential-configuration.json
di esempio:{ "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" } } }
Il valore del segmento di pubblico sarà simile al seguente (senza interruzioni di riga):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"
CLUSTER_NAME Il nome del cluster Kubernetes. Questo è il valore assegnato alla variabile di ambiente CLUSTER_NAME
.Vedi
k8sCluster.name
.CLUSTER_LOCATION La regione in cui è in esecuzione il cluster. Questa è la regione in cui hai creato il cluster nel passaggio 1: crea un cluster. Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
CLUSTER_LOCATION
.Vedi
k8sCluster.location
.ORG_NAME L'ID della tua organizzazione Apigee hybrid. Questo è il valore assegnato alla variabile di ambiente ORG_NAME
.Vedi
org
.CONTROL_PLANE_
LOCATIONObbligatorio se utilizzi la residenza dei dati con l'installazione ibrida di Apigee. Questa è la posizione in cui vengono memorizzati i contenuti principali dei clienti, come i bundle proxy. Per un elenco, consulta Regioni del control plane dell'API Apigee disponibili. È il valore assegnato alla variabile di ambiente CONTROL_PLANE_LOCATION
nel passaggio 2: crea un'organizzazione.Vedi
contractProvider
.ENVIRONMENT_NAME Utilizza lo stesso nome che hai utilizzato quando hai creato un ambiente nell'interfaccia utente, come spiegato in Configurazione di progetto e organizzazione - Passaggio 3: crea un gruppo di ambienti. Vedi
envs[].name
.ENVIRONMENT_GROUP_
NAMEIl nome del gruppo di ambienti a cui sono assegnati i tuoi ambienti. Questo è il gruppo che hai creato in Configurazione del progetto e dell'organizzazione - Passaggio 3: crea un gruppo di ambienti. Questo è il valore assegnato alla variabile di ambiente ENV_GROUP
.Vedi
virtualhosts[].name
.INGRESS_NAME Il nome del gateway in entrata Apigee per il deployment. Può essere qualsiasi nome che soddisfi i seguenti requisiti: - Avere una lunghezza massima di 17 caratteri
- Contenere solo caratteri alfanumerici minuscoli, '-' o '.'
- Iniziare con un carattere alfanumerico
- Terminare con un carattere alfanumerico
Vedi:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEInserisci il percorso e il nome file della chiave TLS autofirmata e dei file del certificato che hai generato in precedenza nel passaggio 6: creazione dei certificati TLS. Questi file devono trovarsi nella directory APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Ad esempio:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Vedi:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Facoltativo) Si tratta di una coppia chiave-valore che fornisce annotazioni per il servizio di ingresso predefinito. La tua piattaforma cloud utilizza le annotazioni per configurare l'installazione ibrida, ad esempio impostando il tipo di bilanciatore del carico su interno o esterno. Le annotazioni variano da piattaforma a piattaforma. Consulta la documentazione della piattaforma per le annotazioni richieste e suggerite.
Commenta o elimina questa sezione se non la utilizzi.
Esempio
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
La tabella seguente descrive ciascuno dei valori delle proprietà che devi fornire nel file di override. Per ulteriori informazioni, consulta Riferimento alle proprietà di configurazione.
Variabile Descrizione UNIQUE_INSTANCE_
IDENTIFIERUna stringa univoca per identificare questa istanza. Può essere qualsiasi combinazione di lettere e numeri fino a 63 caratteri.
Puoi creare più organizzazioni nello stesso cluster, ma
instanceID
deve essere lo stesso per tutte le organizzazioni nello stesso cluster Kubernetes.Vedi
instanceID
.APIGEE_NAMESPACE Lo spazio dei nomi Kubernetes per i componenti Apigee hybrid.
Il valore predefinito è
apigee
.Vedi
namespace
.PROJECT_ID Identifica il progetto Google Cloud in cui apigee-logger
eapigee-metrics
inviano i propri dati. Questo è il valore assegnato alla variabile di ambientePROJECT_ID
.Vedi
gcp.projectID
.ANALYTICS_REGION In GKE, devi impostare questo valore sulla stessa regione in cui è in esecuzione il cluster. In tutte le altre piattaforme, seleziona la regione di analisi più vicina al tuo cluster che supporta Analytics (vedi la tabella in Parte 1, passaggio 2: crea un'organizzazione). Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
ANALYTICS_REGION
.Vedi
gcp.region
.AUDIENCE Il pubblico consentito del provider di identità del workload. Puoi trovare il valore cercando il termine audience:
in uno dei file di configurazione delle credenziali. Il valore del segmento di pubblico è lo stesso in ogni file di configurazione delle credenziali.Ad esempio, nel seguente file
apigee-udca-credential-configuration.json
di esempio:{ "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" } } }
Il valore del segmento di pubblico sarà simile al seguente (senza interruzioni di riga):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"
CLUSTER_NAME Il nome del cluster Kubernetes. Questo è il valore assegnato alla variabile di ambiente CLUSTER_NAME
.Vedi
k8sCluster.name
.CLUSTER_LOCATION La regione in cui è in esecuzione il cluster. Questa è la regione in cui hai creato il cluster nel passaggio 1: crea un cluster. Questo è il valore che hai assegnato in precedenza alla variabile di ambiente
CLUSTER_LOCATION
.Vedi
k8sCluster.location
.ORG_NAME L'ID della tua organizzazione Apigee hybrid. Questo è il valore assegnato alla variabile di ambiente ORG_NAME
.Vedi
org
.CONTROL_PLANE_
LOCATIONObbligatorio se utilizzi la residenza dei dati con l'installazione ibrida di Apigee. Questa è la posizione in cui vengono memorizzati i contenuti principali dei clienti, come i bundle proxy. Per un elenco, consulta Regioni del control plane dell'API Apigee disponibili. È il valore assegnato alla variabile di ambiente CONTROL_PLANE_LOCATION
nel passaggio 2: crea un'organizzazione.Vedi
contractProvider
.ENVIRONMENT_NAME Utilizza lo stesso nome che hai utilizzato quando hai creato un ambiente nell'interfaccia utente, come spiegato in Configurazione di progetto e organizzazione - Passaggio 3: crea un gruppo di ambienti. Vedi
envs[].name
.ENVIRONMENT_GROUP_
NAMEIl nome del gruppo di ambienti a cui sono assegnati i tuoi ambienti. Questo è il gruppo che hai creato in Configurazione del progetto e dell'organizzazione - Passaggio 3: crea un gruppo di ambienti. Questo è il valore assegnato alla variabile di ambiente ENV_GROUP
.Vedi
virtualhosts[].name
.INGRESS_NAME Il nome del gateway in entrata Apigee per il deployment. Può essere qualsiasi nome che soddisfi i seguenti requisiti: - Avere una lunghezza massima di 17 caratteri
- Contenere solo caratteri alfanumerici minuscoli, '-' o '.'
- Iniziare con un carattere alfanumerico
- Terminare con un carattere alfanumerico
Vedi:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEInserisci il percorso e il nome file della chiave TLS autofirmata e dei file del certificato che hai generato in precedenza nel passaggio 6: creazione dei certificati TLS. Questi file devono trovarsi nella directory APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Ad esempio:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Vedi:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Facoltativo) Si tratta di una coppia chiave-valore che fornisce annotazioni per il servizio di ingresso predefinito. La tua piattaforma cloud utilizza le annotazioni per configurare l'installazione ibrida, ad esempio impostando il tipo di bilanciatore del carico su interno o esterno. Le annotazioni variano da piattaforma a piattaforma. Consulta la documentazione della piattaforma per le annotazioni richieste e suggerite.
Commenta o elimina questa sezione se non la utilizzi.
Riepilogo
Il file di configurazione indica a Kubernetes come eseguire il deployment dei componenti ibridi in un cluster. Successivamente, attiverai l'accesso al sincronizzatore in modo che i piani di gestione e runtime di Apigee possano comunicare.
Passaggio successivo
1 2 3 4 5 6 7 (SUCCESSIVO) Passaggio 8: Abilita l'accesso al piano di controllo 9 10 11