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

Confira abaixo um exemplo de um arquivo de configuração silenciosa completo para uma instalação do Edge de 9 nós. Edite esse arquivo conforme necessário para sua configuração. Use a opção -f para setup.sh para incluir esse arquivo. Para conferir exemplos de arquivos de configuração específicos de cada topologia, consulte Instalar 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 =
    
    # Set up username and password to access Qpid broker's management console
    
    QPID_MGMT_USERNAME=qpid
    QPID_MGMT_PASSWORD=Apigee1234
    
    # FIPS_OS should be set to true when OPDK 4.53 or later is installed on 
    # FIPS enabled operating system
    FIPS_OS=false
    

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 de 127.0.0.1 ao especificar o endereço IP de um nó.

Para definições de host do Cassandra, use apenas endereços IP. Não use nomes DNS.

ENABLE_SYSTEM_CHECK

Se a resposta for "sim", verifique se o sistema atende aos requisitos de CPU e memória do componente que está sendo instalado. Consulte os Requisitos de instalação para conferir os requisitos de cada componente.

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

ENABLE_DYNAMIC_HOSTIP

Se um servidor tiver vários cartões de interface, o comando "hostname -i" retornará uma lista separada por espaços de endereços IP. Por padrão, o instalador do Edge usa o primeiro endereço IP retornado, que pode não estar correto em todas as situações. Como alternativa, você pode definir a propriedade a seguir no arquivo de configuração da instalação.

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

ADMIN_EMAIL
APIGEE_ADMINPW

A senha do administrador do sistema precisa ter pelo menos oito caracteres e conter uma 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 do arquivo de configuração.

LICENSE_FILE

O local do arquivo de licença, que precisa ser acessível ao usuário "apigee". Por exemplo, armazene-o no diretório /tmp e use chmod 777 no arquivo. O arquivo é 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 do arquivo de configuração.

USE_LDAP_REMOTE_HOST
LDAP_HOST
LDAP_PORT

Se USE_LDAP_REMOTE_HOST for n, o Edge vai instalar o OpenLDAP automaticamente quando instalar o servidor de gerenciamento.

Defina USE_LDAP_REMOTE_HOST como y se você estiver se conectando a um servidor LDAP remoto. O OpenLDAP não está instalado com o servidor de gerenciamento.

Se você estiver se conectando a um servidor OpenLDAP remoto, use LDAP_HOST e LDAP_PORT para especificar o endereço IP ou o nome DNS e o 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 do Edge usar um único servidor OpenLDAP, especifique 1. Se a instalação do Edge usar vários nós do OpenLDAP, como em uma instalação de produção com 13 nós, especifique 2.

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

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

Nome da região. Por convenção, os nomes estão normalmente no formato dc-#, em que # corresponde a um valor inteiro. Por exemplo, dc-1, dc-2 etc. É possível usar dc-1, a menos que a instalação seja em um ambiente com vários data centers.

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

REGION_MAPPING

Se você estiver usando nomes de região diferentes de dc-1, dc-2 etc., defina essa propriedade para mapear o nome da região para o nome apropriado da região no formato dc-x. Essa propriedade é necessária para que o servidor de gerenciamento registre corretamente os repositórios de 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 de DNS precisam ser listados na mesma ordem em todos os nós do ZooKeeper.

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

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

Especifique o modificador :observer nos nós do ZooKeeper somente ao criar vários data centers, conforme descrito em uma instalação de 12 hosts. Em uma única instalação de 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. Os endereços IP ou nomes DNS precisam ser listados na mesma ordem em todos os nós do ZooKeeper.

Use o mesmo formato para HOSTIP e ZK_CLIENT_HOSTS. Ou seja, se você especificar o endereço IP para ZK_CLIENT_HOSTS, use um endereço IP para HOSTIP. Se você usar um DNS, use 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 com 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 Opcionalmente, especifique o nome do cluster do Cassandra. O nome padrão é "Apigee".
CASS_HOSTS

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

Para topologias de produção, é necessário que haja pelo menos três nós nessa lista. Os dois primeiros nós são usados como "servidores de semente". Como resultado, os endereços IP precisam ser listados na 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 uma única instalação de 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 de vários data centers, para superar problemas de firewall, CASS_HOSTS precisa ser ordenado de uma forma (como mostrado no exemplo acima) para que os nós do data center atual sejam colocados 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 a rack do Cassandra.

CASS_AUTH
CASS_USERNAME
CASS_PASSWORD

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

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

CONFIG_DELTA_LOG

O CONFIG_DELTA_LOG controla como as mudanças nos arquivos de configuração são registradas. Se você definir CONFIG_DELTA_LOG=y, as mudanças de configuração de um componente não serã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. Não é possível alterar o nome do usuário "postgres".

Por padrão, o banco de dados PostgreSQL tem dois usuários definidos: "postgres" e "apigee". Ambos os usuários têm uma senha padrão de "postgres". Use PG_PWD para definir a senha como um valor diferente para os dois usuários no momento da instalação.

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

PG_MASTER
PG_STANDBY

Definir para ativar a replicação mestre-standby do Postgres, no formulário:

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 para senhas perdidas e outras notificações.

Se as credenciais do usuário SMTP não forem necessá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ê ativou a autenticação JMX do Cassandra.
CASS_JMX_TRUSTSTORE Nome de usuário do repositório de confiança SSL do Cassandra JMX, se você tiver ativado o JMX baseado em SSL no Cassandra. O arquivo JMX Truststore precisa ser legível pelo usuário da Apigee.
CASS_JMX_TRUSTSTORE_PASS Senha do repositório de confiança SSL do Cassandra JMX, se você tiver ativado o JMX baseado em SSL no Cassandra.
QPID_MGMT_USERNAME
QPID_MGMT_PASSWORD
Essas credenciais fornecem acesso ao console de gerenciamento da Web do Qpid do provedor. O Web Management Console fornece uma interface simples e intuitiva para gerenciamento e controle do agente Qpid.
FIPS_OS FIPS_OS pode ser verdadeiro ou falso, com um padrão falso. Defina como verdadeiro para o Edge for Private Cloud versão 4.53.00 ou posterior em sistemas operacionais com FIPS ativado.

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