Requisitos de instalação

Edge para nuvem privada v4.18.01

Requisitos de hardware

Você precisa atender aos seguintes requisitos mínimos de hardware para uma infraestrutura altamente disponível em um ambiente de produção. Para todos os cenários de instalação descritos em Topologias de instalação, as tabelas a seguir listam os requisitos mínimos de hardware para os componentes de instalação.

Nessas tabelas, os requisitos de disco rígido são adicionados ao espaço exigido pelo sistema operacional. Dependendo dos aplicativos e do tráfego de rede, a instalação pode exigir mais ou menos recursos do que os listados abaixo.

Além disso, a lista a seguir apresenta os requisitos de hardware para instalar os Serviços de monetização:

Confira a seguir os requisitos de hardware para instalar o BaaS da API:

Requisitos do sistema operacional e de software de terceiros

Estas instruções de instalação e os arquivos de instalação fornecidos foram testados nos sistemas operacionais e softwares de terceiros listados em Softwares compatíveis e versões compatíveis.

Como criar o usuário da Apigee

O procedimento de instalação cria um usuário do sistema Unix chamado "apigee". Os diretórios e arquivos de borda são de propriedade da "apigee", assim como os processos do Edge. Isso significa que os componentes do Edge são executados como o usuário "apigee". Se necessário, eles poderão ser executados como um usuário diferente.

Diretório de instalação

Por padrão, o instalador grava todos os arquivos no diretório /opt/apigee. Não é possível alterar o local desse diretório. Embora não seja possível mudar esse diretório, você pode criar um link simbólico para mapear /opt/apigee para outro local, conforme descrito abaixo.

Nas instruções deste guia, o diretório de instalação é indicado como /opt/apigee.

Criando um link simbólico de /opt/apigee

Antes de criar o link simbólico, você precisa criar um usuário e um grupo com o nome "apigee". Esse é o mesmo grupo e usuário criados pelo Instalador do Edge.

Para criar o link simbólico, execute estas etapas antes de fazer o download do arquivo bootstrap_4.18.01.sh. Realize todas estas etapas como raiz:

1. Crie o usuário e o grupo "apigee":

   groupadd -r apigee > useradd -r -g apigee -d /opt/apigee -s /sbin/nologin -c "Apigee platform user" apigee

2. Crie um link simbólico de /opt/apigee para a raiz de instalação desejada:

   ln -Ts /srv/myInstallDir /opt/apigee

   em que /srv/myInstallDir é o local desejado dos arquivos do Edge.

3. Mude a propriedade da raiz de instalação e do link simbólico para o usuário "apigee":

   chown -h apigee:apigee /srv/myInstallDir /opt/apigee

Java

Você precisa de uma versão com suporte do Java 1.8 instalada em cada máquina antes da instalação. Os JDKs compatíveis são listados em Softwares e versões compatíveis.

Verifique se JAVA_HOME aponta para a raiz do JDK para o usuário que está executando a instalação.

SELinux

Dependendo das suas configurações do SELinux, o Edge pode encontrar problemas ao instalar e iniciar componentes do Edge. Se necessário, é possível desativar o SELinux ou defini-lo para o modo permissivo durante a instalação e, em seguida, reativá-lo após a instalação. Consulte Instalar o utilitário de configuração da Apigee do Edge para saber mais.

Configuração de rede

É recomendável verificar as configurações de rede antes da instalação. O instalador espera que todas as máquinas tenham endereços IP fixos. Use os seguintes comandos para validar a configuração:

• hostname retorna o nome da máquina.
• hostname -i retorna o endereço IP do nome do host que pode ser endereçado de outras máquinas.

Dependendo do tipo e da versão do sistema operacional, talvez seja necessário editar /etc/hosts e /etc/sysconfig/network se o nome do host não estiver definido corretamente. Consulte a documentação do seu sistema operacional para mais informações.

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

ENABLE_DYNAMIC_HOSTIP=y

Com essa propriedade definida como "y", o instalador solicita que você selecione o endereço IP a ser usado como parte da instalação. O valor padrão é "n". Consulte a Referência do arquivo de configuração de borda para saber mais.

Wrappers de TCP

Os wrapper de TCP podem bloquear a comunicação de algumas portas e afetar a instalação do OpenLDAP, Postgres e Cassandra. Nesses nós, verifique /etc/hosts.allow e /etc/hosts.deny para garantir que não haja restrições de porta nas portas OpenLDAP, Postgres e Cassandra necessárias.

iptables

Verifique se não há políticas de iptables impedindo a conectividade entre os nós nas portas de borda necessárias. Se necessário, interrompa o iptables durante a instalação usando o comando:

sudo/etc/init.d/iptables stop

No CentOS 7.x:

systemctl stop firewalld

Verifique se o roteador de borda pode acessar /etc/rc.d/init.d/functions

Os nós do roteador de borda e do portal do BaaS usam o roteador Nginx e exigem acesso de leitura a /etc/rc.d/init.d/functions.

Se o processo de segurança exigir que você defina permissões em /etc/rc.d/init.d/functions, não as defina como 700. Caso contrário, o roteador não será iniciado. As permissões podem ser definidas como 744 para conceder acesso de leitura a /etc/rc.d/init.d/functions.

Cassandra

Todos os nós do Cassandra precisam estar conectados a um anel. O Cassandra armazena réplicas de dados em vários nós para garantir confiabilidade e tolerância a falhas. A estratégia de replicação para cada keyspace de borda determina os nós do Cassandra em que as réplicas são colocadas. Para saber mais,consulte Sobre o fator de replicação e o nível de consistência do Cassandra.

O Cassandra ajusta automaticamente o tamanho da pilha Java com base na memória disponível. Para mais informações, consulte Como ajustar recursos do Java. No caso de queda no desempenho ou alto consumo de memória.

Depois de instalar o Edge para nuvem privada, verifique se o Cassandra está configurado corretamente examinando o arquivo /opt/apigee/apigee-cassandra/conf/cassandra.yaml. Por exemplo, verifique se o script de instalação do Edge para nuvem privada definiu as seguintes propriedades:

• cluster_name
• initial_token
• partitioner
• seeds
• listen_address
• rpc_address
• snitch

Banco de dados PostgreSQL

Depois de instalar o Edge, é possível ajustar as seguintes configurações do banco de dados PostgreSQL com base na quantidade de RAM disponível no sistema:

conf_postgresql_shared_buffers = 35% of RAM      # min 128kB
conf_postgresql_effective_cache_size = 45% of RAM
conf_postgresql_work_mem = 512MB       # min 64kB

Para definir esses valores:

1. Edite o arquivo postgresql.properties:

   vi /opt/apigee/customer/application/postgresql.properties

   Se o arquivo não existir, crie-o.

2. Defina as propriedades listadas acima.
3. Salve suas edições.
4. Reinicie o banco de dados PostgreSQL:

   /opt/apigee/apigee-service/bin/apigee-service apigee-postgresql restart

Limites do sistema

Verifique se você definiu os seguintes limites do sistema nos nós do Cassandra e do Message Processor:

• Nos nós do Cassandra, defina os limites de soft e rígido, sem arquivo e de espaço de endereço (as) para o usuário da instalação (o padrão é "apigee") em /etc/security/limits.d/90-apigee-edge-limits.conf, conforme mostrado abaixo:

  apigee soft memlock unlimited
  apigee hard memlock unlimited
  apigee soft nofile 32768
  apigee hard nofile 65536
  apigee soft as unlimited
  apigee hard as unlimited

• Nos nós do processador de mensagens, defina o número máximo de descritores de arquivos abertos como 64 mil em /etc/security/limits.d/90-apigee-edge-limits.conf, conforme mostrado abaixo:

  apigee soft nofile 32768
  apigee hard nofile 65536

  Se necessário, aumente esse limite. Por exemplo, se você tiver um grande número de arquivos temporários abertos ao mesmo tempo.

jsvc

"jsvc" é um pré-requisito para usar o BaaS da API. A versão 1.0.15-dev é instalada quando você instala o BaaS da API.

Serviços de segurança de rede (NSS, na sigla em inglês)

Os serviços de segurança de rede (NSS, na sigla em inglês) são um conjunto de bibliotecas com suporte ao desenvolvimento de aplicativos cliente e servidor com segurança ativada. Verifique se você instalou o NSS v3.19 ou mais recente.

Para verificar sua versão atual:

yum info nss

Para atualizar o NSS:

yum update nss

Consulte este artigo (em inglês) da RedHat para saber mais.

Desativar a busca DNS no IPv6 ao usar o NSCD (Name Service Cache Daemon)

Se você instalou e ativou o NSCD (Name Service Cache Daemon), os processadores de mensagens farão duas buscas DNS: uma para IPv4 e outra para IPv6. Desative a busca DNS no IPv6 ao usar NSCD.

Para desativar a busca DNS no IPv6:

1. Em cada nó do processador de mensagens, edite /etc/nscd.conf
2. Defina a seguinte propriedade:

   enable-cache hosts no

Desativar o IPv6 no Google Cloud Platform para RedHat/CentOS 7

Se você estiver instalando o Edge no RedHat 7 ou o CentOS 7 no Google Cloud Platform, desative o IPv6 em todos os nós Qpid.

Consulte a documentação do RedHat ou CentOS da sua versão específica do sistema operacional para instruções sobre como desativar o IPv6. Por exemplo, você pode:

1. Abra /etc/hosts em um editor.
2. Insira um caractere "#" na coluna uma das seguintes linhas para comentar:

   #::1 localhost localhost.localdomain localhost6 localhost6.localdomain6

3. Salve o arquivo.

AMI da AWS

Se você estiver instalando o Edge em uma Amazon Machine Image (AMI) da AWS para o Red Hat Enterprise Linux 7.x, primeiro execute o seguinte comando:

yum-config-manager --enable rhui-REGION-rhel-server-extras rhui-REGION-rhel-server-optional

Ferramentas

O instalador usa as seguintes ferramentas do UNIX na versão padrão, conforme fornecido pela EL5 ou EL6.

ntpdate

É recomendável que os horários dos servidores sejam sincronizados. Se ainda não estiver configurado, o utilitário ntpdate poderá servir para essa finalidade, que verifica se os servidores estão sincronizados. Use yum install ntp para instalar o utilitário. Isso é muito útil para replicar configurações do OpenLDAP. Você configurou o fuso horário do servidor em UTC.

Openldap 2.4

A instalação no local requer o OpenLDAP 2.4. Se o servidor tiver uma conexão com a Internet, o script de instalação do Edge vai fazer o download e instalar o OpenLDAP. Se o servidor não tiver uma conexão com a Internet, verifique se o OpenLDAP já está instalado antes de executar o script de instalação do Edge. No php/CentOS, execute yum install openldap-clients openldap-servers para instalar o OpenLDAP.

Para instalações de 13 hosts e instalações de 12 hosts com dois data centers, é necessário a replicação OpenLDAP, porque há vários nós hospedando o OpenLDAP.

Firewalls e hosts virtuais

O termo virtual geralmente fica sobrecarregado no campo de TI e, portanto, ocorre com o Apigee Edge para implantação de nuvem privada e hosts virtuais. Para esclarecer, há dois usos principais do termo virtual:

• Máquinas virtuais (VM): não são obrigatórias, mas algumas implantações usam tecnologia de VM para criar servidores isolados para os componentes da Apigee. Os hosts de VM, assim como os físicos, podem ter interfaces de rede e firewalls.
• Hosts virtuais: endpoints da Web, análogos a um host virtual do Apache.

Um roteador em uma VM pode expor vários hosts virtuais, desde que eles sejam diferentes no alias do host ou na porta da interface.

Apenas como um exemplo de nomenclatura, um único servidor físico A pode estar executando duas VMs, chamadas "VM1" e "VM2". Vamos supor que "VM1" exponha uma interface Ethernet virtual, que recebe o nome "eth0" na VM e que recebe o endereço IP 111.111.111.111 pela máquina de virtualização ou por um servidor DHCP de rede. Depois, suponha que a VM2 exponha uma interface Ethernet virtual também chamada "eth0" e receba um endereço IP 111.111.111.222.

Podemos ter um roteador da Apigee em execução em cada uma das duas VMs. Os roteadores expõem os endpoints do host virtual, como neste exemplo hipotético:

O roteador da Apigee na VM1 expõe três hosts virtuais na interface eth0 (que tem algum endereço IP específico), api.mycompany.com:80, api.mycompany.com:443 e test.mycompany.com:80.

O roteador na VM2 expõe api.mycompany.com:80 (mesmo nome e porta expostos pela VM1).

O sistema operacional do host físico pode ter um firewall de rede. Nesse caso, esse firewall precisa ser configurado para passar o tráfego TCP vinculado às portas que estão sendo expostas nas interfaces virtualizadas (111.111.111.111:{80, 443} e 111.111.111.222:80). Além disso, cada sistema operacional da VM pode fornecer o próprio firewall na interface eth0, e eles também precisam permitir a conexão do tráfego das portas 80 e 443.

O caminho base é o terceiro componente envolvido no roteamento de chamadas de API para diferentes proxies de API que você pode ter implantado. Os pacotes de proxy de API podem compartilhar um endpoint se tiverem caminhos base diferentes. Por exemplo, um caminho de base pode ser definido como http://api.mycompany.com:80/ e outro como http://api.mycompany.com:80/salesdemo.

Nesse caso, você precisa de um balanceador de carga ou diretor de tráfego de algum tipo dividindo o tráfego http://api.mycompany.com:80/ entre os dois endereços IP (111.111.111.111 na VM1 e 111.111.111.222 na VM2). Essa função é específica para sua instalação específica e é configurada pelo grupo de rede local.

Ele é definido quando você implanta uma API. No exemplo acima, é possível implantar duas APIs, mycompany e testmycompany, para a organização mycompany-org com o host virtual que tem o alias de host de api.mycompany.com e a porta definida como 80. Se você não declarar um caminho base na implantação, o roteador não saberá para qual API enviar as solicitações recebidas.

No entanto, se você implantar a API testmycompany com o URL base de /salesdemo, os usuários vão acessar essa API usando http://api.mycompany.com:80/salesdemo. Se você implantar sua API "mycompany" com o URL base de /, seus usuários acessarão a API pelo URL http://api.mycompany.com:80/.

Requisitos de porta de borda

A necessidade de gerenciar o firewall vai além dos hosts virtuais. Os firewalls de VM e de host físico precisam permitir o tráfego para as portas exigidas pelos componentes para se comunicarem entre si.

A imagem a seguir mostra os requisitos de portas para cada componente do Edge:

Observações neste diagrama:

• * A porta 8082 no processador de mensagens só precisa ser aberta para acesso pelo roteador quando você configurar o TLS/SSL entre ele e o processador de mensagens. Se você não configurar o TLS/SSL entre o roteador e o processador de mensagens, a porta 8082 da configuração padrão ainda precisará estar aberta no processador de mensagens para gerenciar o componente, mas o roteador não exigirá acesso a ele.
• As portas com o prefixo "M" são usadas para gerenciar o componente e precisam estar abertas no componente para serem acessadas pelo servidor de gerenciamento.
• Os componentes a seguir exigem acesso à porta 8080 no servidor de gerenciamento: Router, Message Processor, UI, Postgres e Qpid.
• Um processador de mensagens precisa abrir a porta 4528 como a porta de gerenciamento. Se você tiver vários processadores de mensagens, todos poderão acessar uns aos outros pela porta 4528 (indicado pela seta de loop no diagrama acima na porta 4528 do processador de mensagens). Se você tiver vários data centers, a porta precisa ser acessível para todos os processadores de mensagens de todos os data centers.
• Embora não seja necessário, você pode abrir a porta 4527 no roteador para acesso por qualquer processador de mensagens. Caso contrário, você pode receber mensagens de erro nos arquivos de registro do processador de mensagens.
• Um roteador precisa abrir a porta 4527 como a porta de gerenciamento. Se você tiver vários roteadores, todos eles precisarão acessar uns aos outros pela porta 4527 (indicada pela seta de loop no diagrama acima para a porta 4527 do roteador).
• A interface do Edge requer acesso ao roteador, nas portas expostas por proxies de API, para oferecer suporte ao botão Enviar na ferramenta de trace.
• O servidor de gerenciamento requer acesso à porta JMX nos nós do Cassandra.
• O acesso às portas JMX pode ser configurado para exigir nome de usuário e senha. Consulte Como monitorar para ver mais informações.
• Também é possível configurar o acesso TLS/SSL para determinadas conexões, que podem usar portas diferentes. Consulte TLS/SSL para mais informações.
• Se você estiver configurando dois nós do Postgres para usar a replicação mestre em espera, precisará abrir a porta 22 em cada nó para ter acesso SSH. Também é possível abrir portas em nós individuais para permitir o acesso SSH.
• É possível configurar o Servidor de gerenciamento e a IU de borda para enviar e-mails por meio de um servidor SMTP externo. Se você fizer isso, verifique se o servidor de gerenciamento e a IU podem acessar a porta necessária no servidor SMTP. Para SMTP sem TLS, o número da porta geralmente é 25. Para SMTP com TLS ativado, ele geralmente é 465, mas verifique com seu provedor SMTP.

A tabela abaixo mostra por componente do Edge as portas que precisam ser abertas nos firewalls:

curl -v http://routerIP:15999/v1/servers/self/reachable

A tabela a seguir mostra as mesmas portas, listadas numericamente, com os componentes de origem e destino:

Um processador de mensagens mantém um pool de conexão dedicado aberto para o Cassandra, que é configurado para nunca atingir o tempo limite. Quando um firewall está entre um processador de mensagens e o servidor do Cassandra, ele pode atingir o tempo limite da conexão. No entanto, o processador de mensagens não foi projetado para restabelecer as conexões com o Cassandra.

Para evitar essa situação, a Apigee recomenda que o servidor, o processador de mensagens e os roteadores do Cassandra estejam na mesma sub-rede para que um firewall não esteja envolvido na implantação desses componentes.

Se um firewall estiver entre o roteador e os processadores de mensagens e tiver um tempo limite de tcp inativo definido, nossas recomendações são:

1. Defina net.ipv4.tcp_keepalive_time = 1800 nas configurações de sysctl no SO Linux, em que 1800 precisa ser menor que o tempo limite de tcp inativo do firewall. Essa configuração precisa manter a conexão em um estado estabelecido para que o firewall não a desconecte.
2. Em todos os processadores de mensagens, edite /opt/apigee/customer/application/message-processor.properties para adicionar a propriedade a seguir. Se o arquivo não existir, crie-o.

   conf_system_cassandra.maxconnecttimeinmillis=-1

3. Reinicie o processador de mensagens:

   /opt/apigee/apigee-service/bin/apigee-service edge-message-processor restart

4. Em todos os roteadores, edite /opt/apigee/customer/application/router.properties para adicionar a propriedade a seguir. Se o arquivo não existir, crie-o.

   conf_system_cassandra.maxconnecttimeinmillis=-1

5. Reinicie o roteador:

   /opt/apigee/apigee-service/bin/apigee-service edge-router restart

Se você instalar a configuração em cluster do host 12 com dois data centers, verifique se os nós nos dois data centers podem se comunicar pelas portas mostradas abaixo:

Requisitos de porta do BaaS da API

Se você decidir instalar a API BaaS, vai adicionar os componentes da pilha de API BaaS e do portal de BaaS de API. Esses componentes usam as portas mostradas na figura abaixo:

Observações neste diagrama:

• O portal da API BaaS nunca faz solicitações diretamente para um nó da pilha do BaaS. Quando um desenvolvedor faz login no portal, o app é transferido por download para o navegador. O app do portal em execução no navegador faz solicitações aos nós da pilha BaaS.
• Uma instalação de produção do BaaS da API usa um balanceador de carga entre o nó do portal do BaaS da API e os nós da pilha da API do BaaS. Ao configurar o portal e fazer chamadas da API BaaS, especifique o endereço IP ou o nome DNS do balanceador de carga, não dos nós da pilha.
• Todos os nós da pilha precisam abrir a porta 2551 para acessar a partir de todos os outros nós da pilha (indicado pela seta de loop no diagrama acima da porta 2551 nos nós da pilha). Se você tiver vários data centers, a porta precisa ser acessível de todos os nós da pilha em todos os data centers.
• É preciso configurar todos os nós da pilha Baas para enviar e-mails por um servidor SMTP externo. Para SMTP sem TLS, o número da porta geralmente é 25. Para SMTP com TLS ativado, ele geralmente é 465, mas verifique com seu provedor SMTP.
• Os nós do Cassandra podem ser dedicados à API BaaS ou compartilhados com o Edge.

A tabela abaixo mostra por componente as portas padrão que precisam ser abertas nos firewalls:

Licenciamento

Cada instalação do Edge requer um arquivo de licença exclusivo recebido da Apigee. Você precisará fornecer o caminho para o arquivo de licença ao instalar o servidor de gerenciamento, por exemplo, /tmp/license.txt.

O instalador copia o arquivo de licença para /opt/apigee/customer/conf/license.txt.

Se o arquivo de licença for válido, o servidor de gerenciamento validará a expiração e a contagem permitida do processador de mensagens (MP, na sigla em inglês). Se alguma das configurações de licença expirar, os registros poderão ser encontrados no seguinte local: /opt/apigee/var/log/edge-management-server/logs. Nesse caso, entre em contato com o suporte do Apigee Edge para saber detalhes da migração.

Se você ainda não tem uma licença, entre em contato com a equipe de vendas da Apigee.