Riferimento file di configurazione perimetrale

Di seguito è riportato un esempio di file di configurazione invisibile all'utente completo per un'installazione Edge a 9 nodi. Modifica questo file in base alle esigenze della configurazione. Utilizza l'opzione -f per setup.sh per includere questo file. Per esempi di file di configurazione specifici per ogni topologia, consulta Installare i componenti Edge.

# IP address or DNS name of nodes.
IP1=192.168.1.1  # Management Server, OpenLDAP, UI, ZooKeeper, Cassandra (IP address only; do not use a DNS name)
IP2=192.168.1.2  # ZooKeeper, Cassandra (IP address only; do not use a DNS name)
IP3=192.168.1.3  # ZooKeeper, Cassandra (IP address only; do not use a DNS name)
IP4=192.168.1.4  # Router, Message Processor
IP5=192.168.1.5  # Router, Message Processor
IP6=192.168.1.6  # Qpid
IP7=192.168.1.7  # Qpid
IP8=192.168.1.8  # Postgres
IP9=192.168.1.9  # Postgres

# Must resolve to IP address or DNS name of host - not to 127.0.0.1 or localhost.
HOSTIP=$(hostname -i)

# Specify "y" to check that the system meets the CPU and memory requirements
# for the component being installed. See Installation Requirements for requirements
# for each component. The default value is "n" to disable check.
ENABLE_SYSTEM_CHECK=n

# When "hostname -i" returns multiple IP addresses,
# set to "y", to have the installer prompt you to select the IP address to use.
ENABLE_DYNAMIC_HOSTIP=n

# Set Edge sys admin credentials.
ADMIN_EMAIL=your@email.com
APIGEE_ADMINPW=yourPassword    # If omitted, you are prompted for it.

# Location of Edge license file.
LICENSE_FILE=/tmp/license.txt

# Management Server information.
MSIP=$IP1    # IP or DNS name of Management Server node.
# Specify the port the Management Server listens on for API calls.
# APIGEE_PORT_HTTP_MS=8080    # Default is 8080.

#
# OpenLDAP information.
#
# Set to y if you are connecting to a remote LDAP server.
# If n, Edge installs OpenLDAP when it installs the Management Server.
USE_LDAP_REMOTE_HOST=n 

# If connecting to remote OpenLDAP server, specify the IP/DNS name and port.
# LDAP_HOST=$IP1    # IP or DNS name of OpenLDAP node.
# LDAP_PORT=10389   # Default is 10389.
APIGEE_LDAPPW=yourLdapPassword

# Specify OpenLDAP without replication, 1, or with replication, 2.
LDAP_TYPE=1

# Set only if using replication.
# LDAP_SID=1    # Unique ID for this LDAP server.
# LDAP_PEER=    # IP or DNS name of LDAP peer.

# The Message Processor and Router pod.
MP_POD=gateway

# The name of the region, corresponding to the data center name.
REGION=dc-1 # Use dc-1 unless installing in a
            # multi-data center environment.

# If you are using region names other than dc-1, dc-2 etc, set this property to map your region
# name to the appropriate dc-x format region name. This property is required by Management server
# to appropriately register Cassandra data stores based on Cassandra's data centers and regions.
REGION_MAPPING="<custom-region-1>:dc-1 <custom-region-2>:dc-2 ... <custom-region-x>:dc-x"

# ZooKeeper information.
# See table below if installing in a multi-data center environment.
ZK_HOSTS="$IP1 $IP2 $IP3"         # IP/DNS names of all ZooKeeper nodes.
ZK_CLIENT_HOSTS="$IP1 $IP2 $IP3"  # IP/DNS names of all ZooKeeper nodes.

# Cassandra information.
CASS_CLUSTERNAME=Apigee    # Default name is Apigee.

# Space-separated IP addresses of the Cassandra hosts (previously defined; do not use DNS names)
# Syntax is: IP_address:host_number,rack_number
CASS_HOSTS="$IP1:1,1 $IP2:1,1 $IP3:1,1"

# Set to enable Cassandra authentication.
# CASS_AUTH=y    # The default value is n.
# Cassandra uname/pword required if you enabled Cassandra authentication.
# CASS_USERNAME=
# CASS_PASSWORD=''

# Postgres username and password as set when you installed Edge.
# Default is apigee:postgres.
PG_USER=apigee
PG_PWD=postgres

# Use to enable Postgres master-standby replication
# when you have multiple Postgres nodes.
# PG_MASTER=IPorDNSofNewMaster
# PG_STANDBY=IPorDNSofOldMaster

# SMTP information.
SKIP_SMTP=n       # Skip now and configure later by specifying "y".
SMTPHOST=smtp.gmail.com
SMTPUSER=your@email.com
SMTPPASSWORD=yourEmailPassword
SMTPSSL=y
SMTPPORT=465      # If no SSL, use a different port, such as 25.
SMTPMAILFROM="My Company <myco@company.com>"

# The following four properties are only effective for Management server:
# Cassandra JMX uname/pword required if you enabled Cassandra JMX authentication.
# CASS_JMX_USERNAME =
# CASS_JMX_PASSWORD =

# Cassandra JMX SSL truststore details if you have enabled SSL based JMX in Cassandra.
# JMX Truststore file should be readable by Apigee user
# CASS_JMX_TRUSTSTORE =
# CASS_JMX_TRUSTSTORE_PASS =
    
# Set up username and password to access Qpid broker's management console

QPID_MGMT_USERNAME=qpid
QPID_MGMT_PASSWORD=pass1234

La tabella seguente contiene informazioni aggiuntive su queste proprietà:

Proprietà Nota
Nomi IP/DNS Non utilizzare una mappatura del nome host su 127.0.0.1 o un indirizzo IP di 127.0.0.1 quando specifichi l'indirizzo IP di un nodo.

Tieni presente che per le definizioni host Cassandra, utilizza solo indirizzi IP e non nomi DNS.

ENABLE_SYSTEM_CHECK

Se "y", verifica che il sistema soddisfi i requisiti di CPU e memoria per il componente da installare. Consulta i requisiti di installazione per conoscere i requisiti di ciascun componente.

Il valore predefinito è "n" per disabilitare il controllo.

ENABLE_DYNAMIC_HOSTIP

Se un server ha più schede di interfaccia, il comando "hostname -i" restituisce un elenco di indirizzi IP separati da spazi. Per impostazione predefinita, il programma di installazione di Edge utilizza il primo indirizzo IP restituito, che potrebbe non essere corretto in tutte le situazioni. In alternativa, puoi impostare la seguente proprietà nel file di configurazione dell'installazione.

Se impostato su "y", il programma di installazione ti chiede di selezionare l'indirizzo IP da utilizzare nell'installazione. Il valore predefinito è "n".

ADMIN_EMAIL
APIGEE_ADMINPW

La password dell'amministratore di sistema deve essere costituita da almeno 8 caratteri e contenere una lettera maiuscola, una lettera minuscola, una cifra o un carattere speciale. Se ometti la password, ti verrà richiesta.

Al termine dell'installazione, Apigee consiglia di rimuovere la password dal file di configurazione.

LICENSE_FILE

La posizione del file di licenza, che deve essere accessibile all'utente "apigee". Ad esempio, memorizzalo nella directory /tmp e chmod 777 sul file. Il file viene copiato nella directory di installazione Edge.

APIGEE_LDAPPW

Specifica la password di OpenLDAP.

Al termine dell'installazione, Apigee consiglia di rimuovere la password dal file di configurazione.

USE_LDAP_REMOTE_HOST
LDAP_HOST
LDAP_PORT

Se USE_LDAP_REMOTE_HOST è n, Edge installa automaticamente OpenLDAP quando installa il server di gestione.

Imposta USE_LDAP_REMOTE_HOST su y se ti connetti a un server LDAP remoto. OpenLDAP non è installato con il server di gestione.

Se ti connetti a un server OpenLDAP remoto, utilizza LDAP_HOST e LDAP_PORT per specificare l'indirizzo IP o il nome DNS e il numero di porta dell'host.

LDAP_TYPE
LDAP_SID
LDAP_PEER

Imposta LDAP_TYPE=1 per OpenLDAP senza replica. LDAP_TYPE=2 corrisponde a OpenLDAP con replica.

Se la topologia Edge utilizza un singolo server OpenLDAP, specifica 1. Se l'installazione Edge utilizza più nodi OpenLDAP, ad esempio un'installazione di produzione a 13 nodi, specifica 2.

Se abiliti la replica, imposta le seguenti proprietà:

  • LDAP_SID=1 - ID univoco per questo server LDAP. Ogni nodo LDAP utilizza un ID diverso. Ad esempio, impostato su 2 per il peer LDAP.
  • LDAP_PEER=10.0.0.1 - Nome IP o DNS del peer LDAP.
MP_POD Specifica il nome del processore di messaggi e del pod del router. Per impostazione predefinita, il nome è gateway.
REGION

Nome della regione. Per convenzione, i nomi sono generalmente nel formato dc-#, dove # corrisponde a un valore intero. Ad esempio, dc-1, dc-2 e così via. Puoi utilizzare dc-1 a meno che non venga installata in un ambiente multi-data center.

In un'installazione in più data center, il valore è dc-1, dc-2 e così via, a seconda del data center che stai installando. Tuttavia, non sei obbligato a utilizzare solo i nomi nel formato dc-#. Puoi utilizzare qualsiasi nome per la regione.

REGION_MAPPING

Se utilizzi nomi di regioni diversi da dc-1, dc-2 e così via, imposta questa proprietà per mappare il nome della tua regione al nome della regione nel formato dc-x appropriato. Questa proprietà è richiesta dal server di gestione per registrare in modo appropriato i datastore Cassandra in base ai data center e alle regioni di Cassandra.

ZK_HOSTS

Gli indirizzi IP o i nomi DNS dei nodi ZooKeeper. Gli indirizzi IP o i nomi DNS devono essere elencati nello stesso ordine su tutti i nodi di ZooKeeper.

Per HOSTIP usa lo stesso formato che usi per ZK_HOSTS. Ciò significa che se specifichi l'indirizzo IP per ZK_HOSTS, utilizza un indirizzo IP per HOSTIP. Se utilizzi un DNS, utilizza un nome DNS per entrambi.

In un ambiente multi-data center, elenca tutti i nodi ZooKeeper di entrambi i data center.

Specifica il modificatore ":observer" sui nodi ZooKeeper solo quando crei più data center, come descritto in un'installazione a 12 host. In una singola installazione di data center, ometti questo modificatore. Per maggiori informazioni, consulta Installazione in cluster a 12 host.

ZK_CLIENT_HOSTS

Gli indirizzi IP o i nomi DNS dei nodi ZooKeeper utilizzati da questo data center. Gli indirizzi IP o i nomi DNS devono essere elencati nello stesso ordine su tutti i nodi di ZooKeeper.

Per HOSTIP usa lo stesso formato che usi per ZK_CLIENT_HOSTS. Ciò significa che se specifichi l'indirizzo IP per ZK_CLIENT_HOSTS, utilizza un indirizzo IP per HOSTIP. Se utilizzi un DNS, utilizza un nome DNS per entrambi.

In una singola installazione di data center, si tratta degli stessi nodi specificati da ZK_HOSTS.

In un ambiente multi-data center, elenca solo i nodi ZooKeeper in questo data center. Per maggiori informazioni, consulta Installazione in cluster a 12 host.

CASS_CLUSTERNAME (Facoltativo) Specifica il nome del cluster Cassandra. Il nome predefinito è "Apigee".
CASS_HOSTS

Specifica un elenco separato da virgole di indirizzi IP host dei nodi Cassandra (non nomi DNS) e, facoltativamente, il relativo numero di data center e il rack a cui appartengono.

Per le topologie di produzione, questo elenco deve contenere almeno tre nodi. I primi due nodi vengono utilizzati come "server origine". Di conseguenza, gli indirizzi IP devono essere elencati nello stesso ordine in tutti i nodi Cassandra.

La sintassi di ogni voce dell'elenco è la seguente:

IP_address[:data_center_number,rack_number]

I nodi Cassandra possono specificare facoltativamente il data center e il rack del nodo Cassandra. Specifica il modificatore data_center_number solo quando crei più data center, come descritto in un'installazione a 12 host. In una singola installazione di data center, ometti questo modificatore.

Ad esempio '192.168.124.201:1,1 = data center 1 e rack/zona di disponibilità 1 e '192.168.124.204:2,1 = datacenter 2 e rack/zona di disponibilità 1.

In un ambiente multi-data center, per superare problemi di firewall, CASS_HOSTS deve essere ordinato in modo (come mostrato nell'esempio sopra) in modo che i nodi del data center attuale si trovino all'inizio. Per maggiori informazioni, consulta Installazione in cluster a 12 host.

Per informazioni su come specificare rack_number per un host Cassandra, consulta Aggiungere il supporto del rack Cassandra.

CASS_AUTH
CASS_USERNAME
CASS_PASSWORD

Se attivi l'autenticazione Cassandra, CASS_AUTH=y, puoi passare il nome utente e la password Cassandra utilizzando queste proprietà.

Al termine dell'installazione, Apigee consiglia di rimuovere la password dal file di configurazione.

CONFIG_DELTA_LOG

CONFIG_DELTA_LOG controlla il modo in cui vengono registrate le modifiche ai file di configurazione. Se imposti CONFIG_DELTA_LOG=y, le modifiche alla configurazione per un componente non vengono registrate.

PG_USER
PG_PWD

Per impostazione predefinita, il database PostgreSQL ha due utenti definiti: 'postgres' e 'apigee'.

PG_USER ti consente di modificare il nome utente dell'utente "apigee". Non puoi modificare il nome dell'utente "postgres".

Per impostazione predefinita, il database PostgreSQL ha due utenti definiti: 'postgres' e 'apigee'. Entrambi gli utenti hanno una password predefinita "postgres". Utilizza PG_PWD per impostare un valore diverso per la password per entrambi gli utenti al momento dell'installazione.

Al termine dell'installazione, Apigee consiglia di rimuovere la password dal file di configurazione.

PG_MASTER
PG_STANDBY

Imposta l'abilitazione della replica master-standby di Postgres, nel formato:

PG_MASTER=IPorDNSofNewMaster
PG_STANDBY=IPorDNSofOldMaster
SKIP_SMTP
SMTPHOST
SMTPUSER
SMTPPASSWORD
SMTPSSL
SMTPPORT
SMTPMAILFROM

Configura SMTP in modo che Edge possa inviare email per le password perse e altre notifiche.

Se le credenziali utente SMTP non sono necessarie, ometti SMTPUSER e SMTPPASSWORD.

Il campo SMTPMAILFROM è obbligatorio.

CASS_JMX_USERNAME Nome utente Cassandra JMX. Obbligatorio se hai attivato l'autenticazione JMX Cassandra.
CASS_JMX_PASSWORD Password Cassandra JMX. Obbligatorio se hai attivato l'autenticazione JMX Cassandra.
CASS_JMX_TRUSTSTORE Nome utente dell'archivio attendibilità SSL Cassandra JMX, se hai abilitato JMX basato su SSL in Cassandra. Il file dell'archivio attendibilità JMX dovrebbe essere leggibile dall'utente di Apigee.
CASS_JMX_TRUSTSTORE_PASS Password dell'archivio attendibile SSL Cassandra JMX, se hai attivato JMX basato su SSL in Cassandra.
QPID_MGMT_USERNAME
QPID_MGMT_PASSWORD
Queste credenziali forniscono l'accesso alla console di gestione web Qpid del broker Qpid. La console di gestione web offre un'interfaccia semplice e intuitiva per la gestione e il controllo del broker Qpid.

Oltre alle proprietà elencate qui, esistono proprietà per la configurazione di Apigee mTLS. Per ulteriori informazioni, consulta Configurare Apigee mTLS.