Referência do arquivo de configuração do Edge

O exemplo abaixo mostra um arquivo de configuração silencioso completo para um Edge com nove nós. e instalação. Edite esse arquivo conforme necessário para sua configuração. Usar a opção -f como setup.sh para incluir esse arquivo. Para exemplos de arquivos de configuração que são específicas para cada topologia, consulte Instale os componentes do 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 =

A tabela a seguir contém informações adicionais sobre essas propriedades:

Propriedade Observação
Nomes IP/DNS Não use um mapeamento de nome de host para 127.0.0.1 ou um endereço IP 127.0.0.1 quando especificar o endereço IP de um nó.

Para definições de host do Cassandra, use apenas endereços IP. não usam DNS nomes de domínio.

ENABLE_SYSTEM_CHECK

Se for "y", verifique se o sistema atende aos requisitos de CPU e memória do componente que está sendo instalado. Consulte Instalação Requisitos de cada componente.

O valor padrão é "n" para desativar a verificação.

ENABLE_DYNAMIC_HOSTIP

Se um servidor tiver várias placas de interface, a opção retorna uma lista separada por espaços de endereços IP. Por padrão, o instalador do Edge usa o primeiro IP endereço retornado, o que pode não estar correto em todas as situações. Como alternativa, você pode definir a seguinte propriedade no arquivo de configuração de instalação.

Quando definido como "y", o instalador solicita que você selecione o endereço IP a ser usado no instalar. O valor padrão é "n".

ADMIN_EMAIL
APIGEE_ADMINPW

A senha do administrador do sistema deve ter pelo menos oito caracteres e conter um letra maiúscula, uma letra minúscula, um dígito ou um caractere especial. Se você omitir a senha, ela será solicitada.

Após a conclusão da instalação, a Apigee recomenda que você remova a senha dos o arquivo de configuração.

LICENSE_FILE

O local do arquivo de licença, que precisa ser acessado pela biblioteca "apigee" usuário. Por exemplo, armazene-o no diretório /tmp e chmod 777 no arquivo. O arquivo foi copiado para o diretório de instalação do Edge.

APIGEE_LDAPPW

Especifica a senha do OpenLDAP.

Após a conclusão da instalação, a Apigee recomenda que você remova a senha dos o arquivo de configuração.

USE_LDAP_REMOTE_HOST
LDAP_HOST
LDAP_PORT

Se USE_LDAP_REMOTE_HOST for n, o Edge instala o OpenLDAP automaticamente ao instalar o servidor de gerenciamento.

Defina USE_LDAP_REMOTE_HOST como y se você for conectando-se a um servidor LDAP remoto. O OpenLDAP não é instalado com o diretório de Servidor.

Se você estiver se conectando a um servidor OpenLDAP remoto, use LDAP_HOST e LDAP_PORT para especificar o endereço IP. ou nome DNS e número da porta do host.

LDAP_TYPE
LDAP_SID
LDAP_PEER

Defina LDAP_TYPE=1 para OpenLDAP sem replicação. LDAP_TYPE=2 corresponde ao OpenLDAP com replicação.

Se a topologia de borda usar um único servidor OpenLDAP, especifique 1. Se o Edge usa vários nós do OpenLDAP, como em uma instalação de produção de 13 nós, especificar 2.

Se você ativar a replicação, defina as seguintes propriedades:

  • LDAP_SID=1: único ID deste servidor LDAP. Cada nó LDAP usa um ID diferente. Por exemplo, defina como 2 para Par LDAP.
  • LDAP_PEER=10.0.0.1 - nome do IP ou DNS do peer LDAP.
MP_POD Especifique o nome do processador de mensagens e do pod do roteador. Por padrão, o nome é para outro gateway de VPN de alta disponibilidade.
REGION

Nome da região. Por convenção, os nomes estão normalmente no formato dc-#, em que # corresponde como um valor inteiro. Por exemplo, dc-1, dc-2 etc. Você pode usar dc-1, a menos que instale em em um ambiente com vários data centers.

Em uma instalação de vários data centers, o valor é dc-1, dc-2 etc., dependendo o data center que será instalado. No entanto, você não está restrito a usar apenas nomes no formato dc-#. É possível usar qualquer nome para a região.

REGION_MAPPING

Se você usa nomes de região diferentes de dc-1, dc-2 etc., defina esta propriedade para mapear o nome da região para o nome apropriado da região no formato dc-x. Essa propriedade é exigida pelo servidor de gerenciamento para registrar corretamente os dados do Cassandra. com base nos data centers e nas regiões do Cassandra.

ZK_HOSTS

Os endereços IP ou nomes DNS dos nós do ZooKeeper. Os endereços IP ou nomes DNS devem ser listados na mesma ordem em todos os nós do ZooKeeper.

Use o mesmo formato para HOSTIP e para ZK_HOSTS. Ou seja, se você especificar o endereço IP para ZK_HOSTS usar um endereço IP para HOSTIP. Se você usa um DNS, então use um nome DNS para ambos.

Em um ambiente de vários data centers, liste todos os nós do ZooKeeper dos dois dados em data centers locais.

Especifique o elemento ":observer" nos nós ZooKeeper somente quando criando vários data centers, conforme descrito em uma instalação de 12 hosts. Em um único data center, omita esse modificador. Para mais informações, consulte Instalação em cluster de 12 hosts.

ZK_CLIENT_HOSTS

Os endereços IP ou nomes DNS dos nós do ZooKeeper usados pelo data center. O IP ou nomes DNS precisam ser listados na mesma ordem em todos os nós do ZooKeeper.

Use o mesmo formato para HOSTIP e para ZK_CLIENT_HOSTS. Ou seja, Se você especificar o endereço IP para ZK_CLIENT_HOSTS, use um endereço para HOSTIP. Se você usa um DNS e, em seguida, usa um nome DNS para ambos.

Em uma única instalação de data center, esses são os mesmos nós especificados por ZK_HOSTS:

Em um ambiente de vários data centers, liste apenas os nós do ZooKeeper nesse data center. Para mais informações, consulte Instalação em cluster de 12 hosts.

CASS_CLUSTERNAME Também é possível especificar o nome do cluster do Cassandra. O nome padrão é "Apigee".
CASS_HOSTS

Especifica uma lista separada por vírgulas de nós do Cassandra endereços IP de host (e não nomes DNS), e, opcionalmente, seu número do data center e o rack ao qual pertencem.

Para topologias de produção, deve haver pelo menos três nós nesta lista. A primeira dois nós são usados como "servidores de origem". Como resultado, os endereços IP devem ser listados no campo mesma ordem em todos os nós do Cassandra.

A sintaxe de cada entrada na lista é a seguinte:

IP_address[:data_center_number,rack_number]

Os nós do Cassandra têm a opção de especificar o data center e o rack do nó do Cassandra. Especifique o modificador data_center_number apenas ao criar vários data centers, conforme descrito em uma instalação de 12 hosts. Em um único data center omita esse modificador.

Por exemplo, "192.168.124.201:1, 1 = data center 1 e rack/zona de disponibilidade 1 e '192.168.124.204:2,1 = data center 2 e rack/zona de disponibilidade 1.

Em um ambiente com vários data centers, para resolver problemas de firewall, CASS_HOSTS devem ser ordenados de tal modo (como mostrado no exemplo acima) de modo que os nós do serviço atual data center são colocadas no início. Para mais informações, consulte Instalação em cluster de 12 hosts.

Para informações sobre como especificar o rack_number para um host do Cassandra, consulte Adicionar suporte para rack do Cassandra.

CASS_AUTH
CASS_USERNAME
CASS_PASSWORD

Se você ativar a autenticação do Cassandra, CASS_AUTH=y, poderá passar o usuário do Cassandra e senha usando essas propriedades.

Após a conclusão da instalação, a Apigee recomenda que você remova a senha dos o arquivo de configuração.

CONFIG_DELTA_LOG

CONFIG_DELTA_LOG controla como as mudanças em de configuração do Terraform são registrados. Se você definir CONFIG_DELTA_LOG=y, as mudanças de configuração de um componente não são registradas.

PG_USER
PG_PWD

Por padrão, o banco de dados PostgreSQL tem dois usuários definidos: 'postgres' e "apigee".

PG_USER permite mudar o nome de usuário da Apigee usuário. Não é possível mude o nome do "postgres" usuário.

Por padrão, o banco de dados PostgreSQL tem dois usuários definidos: 'postgres' e "apigee". A senha padrão dos dois usuários é "postgres". Use PG_PWD para definir senha com um valor diferente para ambos os usuários no momento da instalação.

Após a conclusão da instalação, a Apigee recomenda que você remova a senha dos o arquivo de configuração.

PG_MASTER
PG_STANDBY

Defina para ativar a replicação mestre em espera do Postgres no formato:

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

Configure o SMTP para que o Edge possa enviar e-mails sobre senhas perdidas e outras notificações.

Se as credenciais de usuário SMTP não forem obrigatórias, omita SMTPUSER e SMTPPASSWORD.

O campo SMTPMAILFROM é obrigatório.

CASS_JMX_USERNAME Nome de usuário do Cassandra JMX. Obrigatório se você tiver ativado a autenticação JMX do Cassandra.
CASS_JMX_PASSWORD Senha do Cassandra JMX. Obrigatório se você tiver ativado a autenticação JMX do Cassandra.
CASS_JMX_TRUSTSTORE Nome de usuário do Cassandra JMX SSL truststore, se você tiver ativado o JMX baseado em SSL no Cassandra. O arquivo JMX Truststore precisa ser legível para o usuário da Apigee.
CASS_JMX_TRUSTSTORE_PASS Senha do Cassandra JMX SSL truststore, se você tiver ativado o JMX baseado em SSL no Cassandra.

Além das propriedades listadas aqui, há propriedades para configurar o mTLS da Apigee. Para mais informações, consulte Configurar mTLS da Apigee.