Visão geral da instalação de borda

Edge para nuvem privada v4.18.05

Uma instalação típica do Edge consiste em componentes do Edge distribuídos em vários nós. Depois de instalar o Edge em um nó, instale e configure um ou mais componentes do Edge no nó.

Processo de instalação

A instalação do Edge em um nó é um processo de várias etapas:

  1. Desative o SELinux no nó ou defina-o como modo permissivo. Consulte Instalar o utilitário apigee-setup do Edge para mais informações.
  2. Decida se você quer ativar a autenticação do Cassandra.
  3. Decida se você quer configurar a replicação mestre-em espera para o Postgres.
  4. Selecione sua configuração do Edge na lista de topologias recomendadas. Por exemplo, é possível instalar o Edge em um único nó para teste ou em 13 nós para produção. Consulte Topologias de instalação para mais informações.
  5. Em cada nó na topologia selecionada, instale o utilitário apigee-setup do Edge:
    • Faça o download do arquivo bootstrap_4.18.05.sh do Edge para /tmp/bootstrap_4.18.05.sh.
    • Instale o utilitário apigee-service do Edge e as dependências.
    • Instale o utilitário apigee-setup do Edge e as dependências.

      Consulte Instalar o utilitário apigee-setup do Edge para mais informações.

  6. Use o utilitário apigee-setup para instalar um ou mais componentes do Edge em cada nó com base na topologia selecionada.

    Consulte Instalar componentes do Edge em um nó.

  7. No nó do servidor de gerenciamento, use o utilitário apigee-setup para instalar o apigee-provision, os utilitários usados para criar e gerenciar organizações do Edge.

    Consulte Integrar uma organização para saber mais.

  8. Reinicie o componente da interface do Edge após a conclusão da instalação.

Quem pode realizar a instalação

Os arquivos de distribuição do Apigee Edge são instalados como um conjunto de RPMs e dependências. Para instalar, desinstalar e atualizar RPMs do Edge, os comandos precisam ser executados pelo usuário raiz ou por um usuário com acesso total ao sudo. Para acesso total ao sudo, isso significa que o usuário tem acesso ao sudo para realizar as mesmas operações que o root.

Qualquer usuário que queira executar os comandos ou scripts a seguir precisa ser raiz ou um usuário com acesso total ao sudo:

  • apigee-service:
    • Comandos apigee-service: install, uninstall, update.
    • Comandos apigee-all: install, uninstall, update.
  • Script setup.sh para instalar componentes do Edge (a menos que você já tenha usado "apigee-service install" para instalar os RPMs necessários. O acesso root ou sudo completo não é necessário.
  • Script update.sh para atualizar os componentes do Edge

Além disso, o instalador do Edge cria um novo usuário no sistema, chamado "apigee". Muitos comandos do Edge invocam o sudo para serem executados como o usuário "apigee".

Qualquer usuário que queira executar todos os outros comandos além dos mostrados acima precisa ser um usuário com acesso sudo completo ao usuário "apigee". Esses comandos incluem:

  • Comandos do utilitário apigee-service, incluindo:
    • Comandos apigee-service, como start, stop, restart, configure.
    • Comandos apigee-all, como start, stop, restart, configure.

Como criar um usuário com acesso total ao sudo para o usuário "apigee"

Para configurar um usuário para ter acesso sudo completo ao usuário "apigee", use o comando "visudo" para editar o arquivo sudoers e adicionar:

installUser        ALL=(apigee)      NOPASSWD: ALL

Em que installUser é o nome de usuário da pessoa que trabalha com o Edge.

Como definir permissões em arquivos de configuração

Todos os arquivos ou recursos usados pelos comandos do Edge precisam estar acessíveis ao usuário "apigee". Isso inclui o arquivo de licença do Edge e todos os arquivos de configuração.

Ao criar um arquivo de configuração, é possível mudar o proprietário para "apigee:apigee" para garantir que ele seja acessível aos comandos do Edge:

  1. Crie o arquivo em um editor como qualquer usuário.
  2. chown o proprietário do arquivo para "apigee:apigee" ou, se você tiver alterado o usuário que executa o serviço do Edge do usuário "apigee", use chown no arquivo para o usuário que está executando o serviço do Edge.

Como separar as tarefas de instalação do Edge entre o usuário raiz e o não raiz

Embora seja mais simples realizar todo o processo de instalação do Edge como raiz ou por um usuário que tenha acesso total ao sudo, isso nem sempre é possível. Em vez disso, é possível separar o processo em tarefas executadas pelo usuário raiz e tarefas executadas por um usuário com acesso total ao sudo para o usuário "apigee".

  1. Tarefas realizadas pelo root:
    1. Baixe e execute o arquivo bootstrap_4.18.05.sh:
      curl https://software.apigee.com/bootstrap_4.18.05.sh -o /tmp/bootstrap_4.18.05.sh
      sudo bash /tmp/bootstrap_4.18.05.sh apigeeuser=uName apigeepassword=pWord

      Esta etapa instala o utilitário apigee-service e cria o usuário "apigee".

    2. Configure um usuário para ter acesso total ao sudo ao usuário "apigee", conforme descrito em Como criar um usuário com acesso total ao sudo ao usuário "apigee".
    3. Instale o utilitário apigee-setup:
      /opt/apigee/apigee-service/bin/apigee-service apigee-setup install
    4. Use o utilitário apigee-setup para instalar RPMs do Edge no nó:
      /opt/apigee/apigee-service/bin/apigee-service compName install

      Os RPMs do Edge que você instala no nó dependem da sua topologia. A lista de componentes disponíveis inclui: apigee-provision, apigee-validate, apigee-zookeeper, apigee-cassandra, apigee-openldap, edge-management-server, edge-ui, edge-router, edge-message-processor, apigee-postgresql, apigee-qpidd, edge-postgres-server, edge-qpid-server.

  2. Depois que o usuário raiz instala os RPMs do Edge no nó, o usuário com acesso sudo completo ao usuário "apigee" conclui o processo de configuração:
    1. Use o utilitário setup.sh para concluir a configuração dos componentes do Edge no nó. A forma do comando depende dos componentes que você instalou no nó. Para uma lista completa, consulte Instalar componentes do Edge em um nó.

      Por exemplo, para concluir a instalação do ZooKeeper e do Cassandra, use o seguinte comando:

      /opt/apigee/apigee-setup/bin/setup.sh -p ds -f configFile

      Em que configFile é o arquivo de configuração do Edge.

      Ou, para realizar uma instalação completa, use o seguinte comando:

      /opt/apigee/apigee-setup/bin/setup.sh -p aio -f configFile

Local dos arquivos de configuração da instalação

É preciso transmitir um arquivo de configuração para o utilitário apigee-setup que contém as informações sobre a instalação do Edge. O único requisito para instalações silenciosas é que o arquivo de configuração seja acessível ou legível pelo usuário "apigee". Por exemplo, coloque o arquivo no diretório /usr/local/var ou /usr/local/share no nó e chown para "apigee:apigee".

Todas as informações no arquivo de configuração são obrigatórias, exceto a senha do administrador do sistema do Edge. Se você omitir a senha, o utilitário apigee-setup vai solicitar que você a insira na linha de comando.

Consulte Instalar componentes do Edge em um nó para mais informações.

Como lidar com uma falha de instalação

No caso de uma falha durante a instalação de um componente do Edge, tente corrigir o problema e execute o instalador novamente. O instalador foi projetado para ser executado repetidamente em casos em que detecta uma falha ou se você quiser alterar ou atualizar um componente após a instalação.

Depois de instalar ou fazer upgrade, reinicie o componente da IU do Edge em cada nó em que ele está em execução.

Instalação com ou sem Internet

Para instalar o Edge em um nó, ele precisa acessar o repositório da Apigee:

  • Nós com uma conexão de Internet externa

    Os nós com uma conexão de Internet externa acessam o repositório da Apigee para instalar os RPMs e as dependências do Edge.

  • Nós sem uma conexão de Internet externa

    Os nós sem uma conexão de Internet externa podem acessar uma versão espelhada do repositório da Apigee que você configurou internamente. Esse repositório contém todos os RPMs do Edge, mas você precisa garantir que todas as outras dependências estejam disponíveis nos repositórios da rede interna.

    Para criar o repositório interno da Apigee, é necessário um nó com acesso externo à Internet para fazer o download dos RPMs e das dependências do Edge. Depois de criar o repositório interno, é possível movê-lo para outro nó ou torná-lo acessível aos nós do Edge para instalação.

Como usar um repositório local do Edge para manter sua versão do Edge

Um dos motivos para usar um repositório local ou espelhado é instalar o Edge em nós sem conexão de Internet externa, conforme descrito na seção anterior.

Como resolver dependências de instalação do RPM

Os arquivos de distribuição do Apigee Edge são instalados como um conjunto de arquivos RPM, cada um com a própria cadeia de dependências de instalação. Muitas dessas dependências são definidas por componentes de terceiros que estão fora do controle da Apigee e podem mudar a qualquer momento. Portanto, a documentação não lista o número de versão explícito de cada dependência.

Se você estiver realizando uma instalação em uma máquina com acesso à Internet, o nó poderá fazer o download dos RPMs e das dependências necessárias. No entanto, se você estiver instalando de um nó sem acesso à Internet, normalmente vai configurar um repositório interno com todas as dependências necessárias. A única maneira de garantir que todas as dependências sejam incluídas no repositório local é tentar uma instalação, identificar as dependências ausentes e copiá-las para o repositório local até que a instalação seja concluída.

Comandos comuns do Yum

As ferramentas de instalação do Edge para Linux dependem do Yum para instalar e atualizar componentes. Talvez seja necessário usar vários comandos Yum para gerenciar uma instalação em um nó.

  • Limpe todos os caches do Yum:
    sudo yum clean all
  • Para atualizar um componente do Edge:
    sudo yum update componentName

    Exemplo:

    sudo yum update apigee-setup
    sudo yum update edge-management-server

Estrutura do sistema de arquivos

O Edge instala todos os arquivos no diretório /opt/apigee.

Neste guia e no Guia de operações do Edge, o diretório de instalação raiz é indicado como:

/opt/apigee

A instalação usa a seguinte estrutura de sistema de arquivos para implantar o Apigee Edge para nuvem privada.

Arquivos de registro

O arquivo de registro de apigee-setup e o script setup.sh são gravados em /tmp/setup-root.log.

Os arquivos de registro de cada componente estão no diretório /opt/apigee/var/log. Cada componente tem o próprio subdiretório. Por exemplo, os registros do servidor de gerenciamento estão no diretório:

/opt/apigee/var/log/edge-management-server

As tabelas a seguir listam o local dos arquivos de registro:

Componente Local

Servidor de gerenciamento

/opt/apigee/var/log/edge-management-server

Roteador

/opt/apigee/var/log/edge-router

O roteador de borda é implementado usando o Nginx. Para mais registros, consulte:

/opt/apigee/var/log/edge-router/nginx
/opt/nginx/logs

processador de mensagens

/opt/apigee/var/log/edge-message-processor

Servidor Qpid da Apigee

/opt/apigee/var/log/edge-qpid-server
Servidor Postgres da Apigee /opt/apigee/var/log/edge-postgres-server
IU do Edge /opt/apigee/var/log/edge-ui
ZooKeeper /opt/apigee/var/log/apigee-zookeeper
OpenLDAP /opt/apigee/var/log/apigee-openldap
Cassandra /opt/apigee/var/log/apigee-cassandra
Qpidd /opt/apigee/var/log/apigee-qpidd
Banco de dados PostgreSQL /opt/apigee/var/log/apigee-postgresql

Dados

Componente Local
Servidor de gerenciamento /opt/apigee/data/edge-management-server
Roteador /opt/apigee/data/edge-router
processador de mensagens /opt/apigee/data/edge-message-processor
Agente do Qpid da Apigee /opt/apigee/data/edge-qpid-server
Agente do Apigee Postgres /opt/apigee/data/edge-postgres-server
ZooKeeper /opt/apigee/data/apigee-zookeeper
OpenLDAP /opt/apigee/data/apigee-openldap
Cassandra /opt/apigee/data/apigee-cassandra/data
Qpidd /opt/apigee/data/apigee-qpid/data
Banco de dados PostgreSQL /opt/apigee/data/apigee-postgres/pgdata

Tarefas pós-instalação

Após a conclusão da instalação, é possível realizar outras ações nos componentes do Edge.

Reinicie o componente da interface do Edge.

Depois que a instalação for concluída, reinicie o componente da interface do Edge em cada nó:

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

Como configurar componentes do Edge após a instalação

Para configurar o Edge após a instalação, use uma combinação de arquivos .properties e utilitários do Edge. Por exemplo, para configurar TLS/SSL na IU do Edge, edite os arquivos .properties para definir as propriedades necessárias. As alterações nos arquivos .properties exigem que você reinicie o componente do Edge afetado.

Os arquivos .properties estão localizados no diretório /opt/apigee/customer/application. Cada componente tem o próprio arquivo .properties nesse diretório. Por exemplo, router.properties e management-server.properties.

Para definir uma propriedade para um componente, edite o arquivo .properties correspondente e reinicie o componente:

/opt/apigee/apigee-service/bin/apigee-service component restart

Exemplo:

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

Quando você atualiza o Edge, os arquivos .properties no diretório /opt/apigee/customer/application são lidos. Isso significa que a atualização mantém todas as propriedades definidas no componente.

Consulte Como configurar o Edge para mais informações sobre a configuração do Edge.

Como invocar comandos em componentes do Edge

O Edge instala utilitários de gerenciamento em /opt/apigee/apigee-service/bin que podem ser usados para gerenciar uma instalação do Edge. Por exemplo, use o utilitário apigee-all para iniciar, interromper, reiniciar ou determinar o status de todos os componentes do Edge no nó:

/opt/apigee/apigee-service/bin/apigee-all stop|start|restart|status|version

Use o utilitário apigee-service para controlar e configurar componentes individuais. O utilitário apigee-service tem o formato:

/opt/apigee/apigee-service/bin/apigee-service component_name action

Em que component_name identifica o componente. O componente precisa estar no nó em que você executa apigee-service. Dependendo da configuração, os valores de component_name podem incluir:

  • apigee-cassandra (Cassandra)
  • apigee-openldap (OpenLDAP)
  • apigee-postgresql (banco de dados PostgreSQL)
  • apigee-qpidd (Qpidd)
  • apigee-sso (SSO de borda)
  • apigee-zookeeper (ZooKeeper)
  • edge-management-server (Servidor de gerenciamento)
  • edge-management-ui (nova IU do Edge)
  • edge-message-processor (processador de mensagens)
  • edge-postgres-server (Servidor Postgres)
  • edge-qpid-server (servidor Qpid)
  • edge-router (roteador Edge)
  • edge-ui (IU clássica)

Além desses componentes, também é possível invocar apigee-service nos componentes apigee-provision e apigee-validate, dependendo da sua configuração.

Por exemplo, para reiniciar o roteador do Edge, execute o seguinte comando:

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

Para determinar a lista de componentes instalados no nó, examine o diretório /opt/apigee. Esse diretório contém um subdiretório para cada componente do Edge instalado no nó. Cada subdiretório é prefixado por:

  • apigee: um componente de terceiros usado pelo Edge. Por exemplo, apigee-cassandra.
  • edge: um componente do Edge da Apigee. Por exemplo, edge-management-server.
  • edge-mint: um componente de monetização. Por exemplo, edge-mint-management-server.

A lista completa de ações para um componente depende do próprio componente, mas todos os componentes são compatíveis com as seguintes ações:

  • start, stop, restart
  • status, version
  • backup, restore
  • install, uninstall

Ativar a verificação do sistema na instalação

O arquivo de configuração de instalação do Edge é compatível com a seguinte propriedade:

ENABLE_SYSTEM_CHECK=y

Se você definir essa propriedade como "y", o instalador vai verificar se o sistema atende aos requisitos de CPU e memória do componente que está sendo instalado. O valor padrão é "n" para desativar a verificação.