Référence de fichier de configuration de périphérie

Vous trouverez ci-dessous un exemple de fichier de configuration silencieuse complet pour un périphérique Edge à 9 nœuds. l'installation. Modifiez ce fichier si nécessaire pour votre configuration. Utiliser l'option -f à setup.sh pour inclure ce fichier. Pour les exemples de fichiers de configuration propres à chaque topologie, consultez Installez les composants 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=Apigee1234

Le tableau suivant contient des informations supplémentaires sur ces propriétés:

Propriété Remarque
Noms IP/DNS N'utilisez pas de mappage de nom d'hôte vers 127.0.0.1 ni une adresse IP de 127.0.0.1 lorsque spécifiant l'adresse IP d'un nœud.

Notez que pour les définitions d'hôte Cassandra, utilisez uniquement des adresses IP. n'utilisent pas de DNS noms.

ENABLE_SYSTEM_CHECK

Si la valeur "y" est affichée, vérifiez que le système répond aux exigences de processeur et de mémoire du composant. en cours d'installation. Reportez-vous à la section Installation Conditions requises pour chaque composant.

La valeur par défaut est "n" pour désactiver la vérification.

ENABLE_DYNAMIC_HOSTIP

Si un serveur possède plusieurs cartes d'interface, le "nom d'hôte -i" renvoie une d'adresses IP séparées par des espaces. Par défaut, le programme d'installation Edge utilise la première adresse IP , ce qui n'est pas toujours correct. Vous pouvez également vous pouvez définir la propriété suivante dans le fichier de configuration d'installation.

Si la valeur est définie sur "y", le programme d'installation vous invite à sélectionner l'adresse IP à utiliser dans l'installation. La valeur par défaut est "n".

ADMIN_EMAIL
APIGEE_ADMINPW

Le mot de passe de l'administrateur système doit comporter au moins huit caractères et en contenir un. une lettre majuscule, une lettre minuscule, un chiffre ou un caractère spécial. Si vous omettez le mot de passe, vous serez invité à le saisir.

Une fois l'installation terminée, Apigee vous recommande de supprimer le mot de passe le fichier de configuration.

LICENSE_FILE

L'emplacement du fichier de licence, qui doit être accessible à "apigee" utilisateur. Par exemple, stockez-le dans le répertoire /tmp et chmod 777 sur le fichier. Le fichier est copié au répertoire d'installation Edge.

APIGEE_LDAPPW

Spécifie le mot de passe OpenLDAP.

Une fois l'installation terminée, Apigee vous recommande de supprimer le mot de passe le fichier de configuration.

USE_LDAP_REMOTE_HOST
LDAP_HOST
LDAP_PORT

Si USE_LDAP_REMOTE_HOST est n, Edge installe automatiquement OpenLDAP lorsqu’il installe le serveur de gestion.

Définissez USE_LDAP_REMOTE_HOST sur y si vous êtes de connexion à un serveur LDAP distant. OpenLDAP n'est pas installé avec le serveur de gestion.

Si vous vous connectez à un serveur OpenLDAP distant, utilisez LDAP_HOST et LDAP_PORT pour spécifier l'adresse IP le nom DNS et le numéro de port de l'hôte.

LDAP_TYPE
LDAP_SID
LDAP_PEER

Définir LDAP_TYPE=1 pour OpenLDAP sans réplication. LDAP_TYPE=2 correspond à OpenLDAP avec la réplication.

Si votre topologie Edge utilise un seul serveur OpenLDAP, indiquez 1. Si votre Edge utilise plusieurs nœuds OpenLDAP, comme dans une installation de production à 13 nœuds, spécifiez 2.

Si vous activez la réplication, définissez les propriétés suivantes:

  • LDAP_SID=1 - Unique Identifiant de ce serveur LDAP. Chaque nœud LDAP utilise un identifiant différent. Par exemple, définissez sur 2 pour pair LDAP.
  • LDAP_PEER=10.0.0.1 : adresse IP ou nom DNS du pair LDAP
MP_POD Spécifiez le nom du pod du processeur de messages et du routeur. Par défaut, le nom est de passerelle VPN haute disponibilité.
REGION

Nom de la région. Par convention, les noms se présentent généralement sous la forme dc-#, où # correspond en une valeur entière. (par exemple, dc-1, dc-2, etc.). Vous pouvez utiliser dc-1 à moins d'installer dans un environnement avec plusieurs centres de données.

Dans une installation avec plusieurs centres de données, la valeur est dc-1, dc-2, etc. selon le centre de données que vous installez. Cependant, vous n'êtes pas obligé d'utiliser uniquement des noms au format dc-#. Vous pouvez utiliser n'importe quel nom pour la région.

REGION_MAPPING

Si vous utilisez des noms de région autres que dc-1, dc-2, etc., définissez cette propriété sur le mappage le nom de votre région au nom de région approprié au format dc-x. Cette propriété est requise par le serveur de gestion pour enregistrer correctement les données Cassandra basés sur les centres de données et les régions de Cassandra.

ZK_HOSTS

Adresses IP ou noms DNS des nœuds ZooKeeper. Les adresses IP ou noms DNS doivent être répertoriés dans le même ordre sur tous les nœuds ZooKeeper.

Utilisez le même format pour HOSTIP que pour ZK_HOSTS Autrement dit, si vous spécifiez l'adresse IP pour ZK_HOSTS. Utilisez une adresse IP pour HOSTIP Si vous utilisez un DNS, utilisez un nom DNS pour les deux.

Dans un environnement avec plusieurs centres de données, listez tous les nœuds ZooKeeper des deux données. centres de données.

Spécifiez l'opérateur ":observer" sur les nœuds ZooKeeper uniquement si créant plusieurs centres de données comme indiqué dans une installation à 12 hôtes. Pour une installation dans un seul centre de données, omettez ce modificateur. Pour en savoir plus, consultez Installation en cluster à 12 hôtes.

ZK_CLIENT_HOSTS

Adresses IP ou noms DNS des nœuds ZooKeeper utilisés par le centre de données. L'adresse IP ou DNS doivent être répertoriés dans le même ordre sur tous les nœuds ZooKeeper.

Utilisez le même format pour HOSTIP que pour ZK_CLIENT_HOSTS. En d'autres termes, si vous spécifiez l'adresse IP pour ZK_CLIENT_HOSTS, utilisez une adresse IP pour HOSTIP. Si vous utilisez un DNS, puis utilisez un nom DNS pour les deux.

Dans une installation de centre de données unique, il s'agit des mêmes nœuds que ceux spécifiés par ZK_HOSTS

Dans un environnement comprenant plusieurs centres de données, ne répertoriez que les nœuds ZooKeeper de ce centre de données. Pour en savoir plus, consultez Installation en cluster à 12 hôtes.

CASS_CLUSTERNAME Vous pouvez éventuellement spécifier le nom du cluster Cassandra. Le nom par défaut est "Apigee".
CASS_HOSTS

Spécifie une liste de nœuds Cassandra séparés par une virgule les adresses IP de l'hôte (pas les noms DNS), et éventuellement le numéro de son centre de données rack auquel ils appartiennent.

Pour les topologies de production, cette liste doit comporter au moins trois nœuds. Les deux premiers nœuds sont utilisés comme "serveurs de référence". Par conséquent, les adresses IP doivent être listées dans le même ordre sur tous les nœuds Cassandra.

La syntaxe de chaque entrée de la liste est la suivante:

IP_address[:data_center_number,rack_number]

Les nœuds Cassandra peuvent éventuellement spécifier le centre de données et le rack du nœud Cassandra. Spécifiez le modificateur data_center_number uniquement lorsque vous créez plusieurs centres de données, comme décrit dans une installation à 12 hôtes. Dans un seul centre de données l'installation, omettez ce modificateur.

Par exemple, "192.168.124.201:1,1" = centre de données 1 et rack/zone de disponibilité 1, et '192.168.124.204:2,1 = centre de données 2 et rack/zone de disponibilité 1.

Dans un environnement multicentre de données, pour résoudre les problèmes de pare-feu, CASS_HOSTS doit être ordonné de façon à ce que les nœuds de la couche le centre de données sont placées au début. Pour en savoir plus, consultez Installation en cluster à 12 hôtes.

Pour en savoir plus sur la spécification de rack_number pour un hôte Cassandra, consultez Ajoutez la compatibilité avec le rack Cassandra.

CASS_AUTH
CASS_USERNAME
CASS_PASSWORD

Si vous activez l'authentification Cassandra (CASS_AUTH=y), vous pouvez transmettre le rôle d'utilisateur Cassandra nom et mot de passe à l'aide de ces propriétés.

Une fois l'installation terminée, Apigee vous recommande de supprimer le mot de passe du fichier de configuration.

CONFIG_DELTA_LOG

CONFIG_DELTA_LOG contrôle comment les modifications de configuration sont consignés. Si vous définissez CONFIG_DELTA_LOG=y, les modifications de configuration d'un composant ne sont pas consignées.

PG_USER
PG_PWD

Par défaut, la base de données PostgreSQL comporte deux utilisateurs définis : "postgres" et "apigee".

PG_USER vous permet de modifier le nom d'utilisateur de "apigee" utilisateur. Vous ne pouvez pas change le nom de "postgres" utilisateur.

Par défaut, la base de données PostgreSQL comporte deux utilisateurs définis : "postgres" et "apigee". Le mot de passe par défaut des deux utilisateurs est "postgres". Utilisez PG_PWD pour définir la mot de passe à une valeur différente pour les deux utilisateurs au moment de l'installation.

Une fois l'installation terminée, Apigee vous recommande de supprimer le mot de passe du fichier de configuration.

PG_MASTER
PG_STANDBY

Définissez cette option pour activer la réplication maître-nœud de disponibilité en attente Postgres, sous la forme suivante :

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

Configurez SMTP afin que Edge puisse envoyer des e-mails en cas de mots de passe perdus et autres notifications.

Si les identifiants d'utilisateur SMTP ne sont pas requis, omettez SMTPUSER et SMTPPASSWORD

Le champ "SMTPMAILFROM" est obligatoire.

CASS_JMX_USERNAME Nom d'utilisateur Cassandra JMX. Obligatoire si vous avez activé l'authentification Cassandra JMX.
CASS_JMX_PASSWORD Mot de passe Cassandra JMX. Obligatoire si vous avez activé l'authentification Cassandra JMX.
CASS_JMX_TRUSTSTORE Nom d'utilisateur du truststore SSL Cassandra JMX, si vous avez activé JMX basé sur SSL dans Cassandra. Le fichier JMX Truststore doit être lisible par un utilisateur d'Apigee.
CASS_JMX_TRUSTSTORE_PASS Mot de passe du magasin de confiance SSL Cassandra JMX, si vous avez activé le protocole JMX SSL dans Cassandra.
QPID_MGMT_USERNAME
QPID_MGMT_PASSWORD
Ces identifiants permettent d'accéder à la console de gestion Web Qpid du courtier Qpid. La console de gestion Web offre une interface simple et intuitive pour la gestion et le contrôle du courtier Qpid.

En plus des propriétés répertoriées ici, il existe des propriétés permettant de configurer Apigee mTLS. Pour en savoir plus, consultez Configurer Apigee mTLS.