Referencia del archivo de configuración perimetral

A continuación, se muestra un ejemplo de un archivo de configuración silencioso completo para una instalación de Edge de 9 nodos. Edita este archivo según sea necesario para tu configuración. Usa la opción -f para setup.sh a fin de incluir este archivo. Para ver ejemplos de archivos de configuración específicos de cada topología, consulta Cómo instalar componentes de 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=IPofNewMaster
# PG_STANDBY=IPofOldMaster

# 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 =

La siguiente tabla contiene información adicional sobre estas propiedades:

Propiedad Nota
Nombres de IP/DNS No uses una asignación de nombre de host a 127.0.0.1 o una dirección IP de 127.0.0.1 cuando especifiques la dirección IP de un nodo.

Ten en cuenta que, para las definiciones de host de Cassandra, usa solo direcciones IP; no uses nombres de DNS.

ENABLE_SYSTEM_CHECK

Si es "y", verifica que el sistema cumpla con los requisitos de CPU y memoria para el componente que se está instalando. Consulta los Requisitos de instalación para conocer los requisitos de cada componente.

El valor predeterminado es "n" para inhabilitar la verificación.

ENABLE_DYNAMIC_HOSTIP

Si un servidor tiene varias tarjetas de interfaz, el comando “hostname -i” muestra una lista de direcciones IP separadas por espacios. De forma predeterminada, el instalador de Edge usa la primera dirección IP que se muestra, que podría no ser correcta en todas las situaciones. Como alternativa, puedes establecer la siguiente propiedad en el archivo de configuración de instalación.

Cuando se establece en "y", el instalador te pide que selecciones la dirección IP para usar en la instalación. El valor predeterminado es "n".

ADMIN_EMAIL
APIGEE_ADMINPW

La contraseña del administrador del sistema debe tener 8 caracteres como mínimo y, a su vez, contener una letra mayúscula, una letra minúscula, un dígito o un carácter especial. Si omites la contraseña, se te solicitará.

Después de que se complete la instalación, Apigee recomienda que quites la contraseña del archivo de configuración.

LICENSE_FILE

Es la ubicación del archivo de licencia, que debe ser accesible para el usuario “apigee”. Por ejemplo, almacénelo en el directorio /tmp y chmod 777 en el archivo. El archivo se copia en el directorio de instalación de Edge.

APIGEE_LDAPPW

Especifica la contraseña de OpenLDAP.

Después de que se complete la instalación, Apigee recomienda que quites la contraseña del archivo de configuración.

USE_LDAP_REMOTE_HOST
LDAP_HOST
LDAP_PORT

Si USE_LDAP_REMOTE_HOST es n, Edge instalará automáticamente OpenLDAP cuando instale el servidor de administración.

Establece USE_LDAP_REMOTE_HOST en y si te conectas a un servidor LDAP remoto. OpenLDAP no está instalado con el servidor de administración.

Si te conectas a un servidor OpenLDAP remoto, usa LDAP_HOST y LDAP_PORT para especificar la dirección IP o el nombre de DNS y el número de puerto del host.

LDAP_TYPE
LDAP_SID
LDAP_PEER

Se configuró LDAP_TYPE=1 para OpenLDAP sin replicación. LDAP_TYPE=2 corresponde a OpenLDAP con replicación.

Si su topología de Edge usa un único servidor de OpenLDAP, especifique 1. Si tu instalación perimetral usa varios nodos de OpenLDAP, como en una instalación de producción de 13 nodos, especifica 2.

Si habilitas la replicación, configura las siguientes propiedades:

  • LDAP_SID=1: ID único para este servidor LDAP. Cada nodo de LDAP utiliza un ID diferente. Por ejemplo, establecer en 2 para el intercambio de tráfico de LDAP.
  • LDAP_PEER=10.0.0.1: Nombre de IP o DNS del par de LDAP.
MP_POD Especifique el nombre del Message Processor y el Pod del router. De forma predeterminada, el nombre es puerta de enlace.
REGION

Nombre de la región. Por convención, los nombres suelen tener el formato dc-#, donde # corresponde a un valor entero. Por ejemplo, dc-1, dc-2, etc. Puedes usar dc-1, a menos que la instalación se realice en un entorno de centro de datos múltiple.

En la instalación de varios centros de datos, el valor es dc-1, dc-2, etc., según el centro de datos que instales. Sin embargo, no estás restringido a usar solo nombres en el formato dc-#. Puedes usar cualquier nombre para la región.

REGION_MAPPING

Si usas nombres de región distintos de dc-1, dc-2, etc., configura esta propiedad para asignar el nombre de región al nombre de región correspondiente con el formato dc-x. El servidor de administración requiere esta propiedad para registrar de forma correcta los almacenes de datos de Cassandra basados en los centros de datos y las regiones de Cassandra.

ZK_HOSTS

Son las direcciones IP o los nombres de DNS de los nodos de ZooKeeper. Las direcciones IP o los nombres de DNS deben aparecer en el mismo orden en todos los nodos de ZooKeeper.

Usa el mismo formato para HOSTIP y para ZK_HOSTS. Es decir, si especificas la dirección IP de ZK_HOSTS, usa una dirección IP para HOSTIP. Si usas un DNS, usa un nombre de DNS para ambos.

En el entorno de varios centros de datos, enumera todos los nodos de ZooKeeper de ambos centros de datos.

Especifica el modificador ":observer" en los nodos de ZooKeeper solo cuando se crean varios centros de datos, como se describe en una instalación de 12 hosts. En la instalación de un solo centro de datos, omite ese modificador. Para obtener más información, consulta Instalación en clústeres de 12 hosts.

ZK_CLIENT_HOSTS

Son las direcciones IP o los nombres de DNS de los nodos de ZooKeeper que usa este centro de datos. Las direcciones IP o los nombres de DNS deben aparecer en el mismo orden en todos los nodos de ZooKeeper.

Usa el mismo formato para HOSTIP y para ZK_CLIENT_HOSTS. Es decir, si especificas la dirección IP de ZK_CLIENT_HOSTS, usa una dirección IP para HOSTIP. Si usas un DNS, usa un nombre de DNS para ambos.

En la instalación de un solo centro de datos, estos son los mismos nodos que especifica ZK_HOSTS.

En un entorno de varios centros de datos, enumere solo los nodos de ZooKeeper en este centro de datos. Para obtener más información, consulta Instalación en clústeres de 12 hosts.

CASS_CLUSTERNAME De manera opcional, especifica el nombre del clúster de Cassandra. El nombre predeterminado es “Apigee”.
CASS_HOSTS

Especifica una lista separada por comas de direcciones IP de host de nodos de Cassandra (no nombres de DNS), y, de manera opcional, el número de su centro de datos y el rack al que pertenecen.

Para las topologías de producción, debe haber al menos tres nodos en esta lista. Los dos primeros nodos se usan como “servidores iniciales”. Como resultado, las direcciones IP deben aparecer en el mismo orden en todos los nodos de Cassandra.

La sintaxis de cada entrada en la lista es la siguiente:

IP_address[:data_center_number,rack_number]

De manera opcional, los nodos de Cassandra pueden especificar el centro de datos y el bastidor. Especifica el modificador data_center_number solo cuando crees varios centros de datos, como se describe en una instalación de 12 hosts. En la instalación de un solo centro de datos, omite ese modificador.

Por ejemplo, “192.168.124.201:1,1 = centro de datos 1 y zona de rack/disponibilidad 1”, y “192.168.124.204:2,1 = centro de datos 2 y zona de rack/disponibilidad 1.

En un entorno de varios centros de datos, para superar problemas de firewall, CASS_HOSTS se debe ordenar de una manera (como se muestra en el ejemplo anterior) de modo que los nodos del centro de datos actual se coloquen al principio. Para obtener más información, consulta Instalación en clústeres de 12 hosts.

Si deseas obtener información sobre cómo especificar rack_number para un host de Cassandra, consulta Agrega compatibilidad con el bastidor de Cassandra.

CASS_AUTH
CASS_USERNAME
CASS_PASSWORD

Si habilitas la autenticación de Cassandra, CASS_AUTH=y, puedes pasar el nombre de usuario y la contraseña de Cassandra mediante estas propiedades.

Después de que se complete la instalación, Apigee recomienda que quites la contraseña del archivo de configuración.

CONFIG_DELTA_LOG

CONFIG_DELTA_LOG controla cómo se registran los cambios en los archivos de configuración. Si configuras CONFIG_DELTA_LOG=y, no se registrarán los cambios de configuración de un componente.

PG_USER
PG_PWD

De forma predeterminada, la base de datos de PostgreSQL tiene dos usuarios definidos: “postgres” y “apigee”.

PG_USER le permite cambiar el nombre de usuario del usuario “apigee”. No puedes cambiar el nombre del usuario “postgres”.

De forma predeterminada, la base de datos de PostgreSQL tiene dos usuarios definidos: “postgres” y “apigee”. Ambos usuarios tienen la contraseña predeterminada “postgres”. Usa PG_PWD a fin de establecer la contraseña en un valor diferente para ambos usuarios en el momento de la instalación.

Después de que se complete la instalación, Apigee recomienda que quites la contraseña del archivo de configuración.

PG_MASTER
PG_STANDBY

Configura para habilitar la replicación en espera maestra de Postgres de la siguiente forma:

PG_MASTER=IPofNewMaster
PG_STANDBY=IPofOldMaster
SKIP_SMTP
SMTPHOST
SMTPUSER
SMTPPASSWORD
SMTPSSL
SMTPPORT
SMTPMAILFROM

Configura SMTP para que Edge pueda enviar correos electrónicos de contraseñas perdidas y otras notificaciones.

Si las credenciales de usuario de SMTP no son obligatorias, omite SMTPUSER y SMTPPASSWORD.

Campo obligatorio: SMTPMAILFROM

CASS_JMX_USERNAME Nombre de usuario de Cassandra JMX. Es obligatorio si habilitaste la autenticación JMX de Cassandra.
CASS_JMX_PASSWORD Contraseña de Cassandra JMX. Es obligatorio si habilitaste la autenticación JMX de Cassandra.
CASS_JMX_TRUSTSTORE Nombre de usuario del almacén de confianza SSL de Cassandra, si habilitaste JMX basado en SSL en Cassandra. El usuario de Apigee debe poder leer el archivo JMX Truststore.
CASS_JMX_TRUSTSTORE_PASS Contraseña de almacén de confianza SSL de Cassandra, si habilitaste JMX basado en SSL en Cassandra.

Además de las propiedades mencionadas aquí, hay propiedades para configurar Apigee mTLS. Para obtener más información, consulte Configurar Apigee mTLS.