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 por vários nós. Depois de instalar o Edge em um nó, instale e configure um ou mais componentes do Edge nele.

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 configure-o para o modo permissivo. Consulte Instalar o utilitário de configuração da Apigee do Edge para saber mais.
  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 a configuração do Edge na lista de topologias recomendadas. Por exemplo, é possível instalar o Edge em um único nó para testes ou em 13 nós para produção. Consulte Topologias de instalação para saber mais.
  5. Em cada nó da 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 e as dependências do Edge apigee-service.
    • Instale o utilitário e as dependências do Edge apigee-setup.

      Consulte Instalar o utilitário de configuração da Apigee do Edge para saber mais.

  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ó "Servidor de gerenciamento", use o utilitário apigee-setup para instalar o provisionamento da Apigee, que é usado para criar e gerenciar organizações de Edge.

    Consulte Integrar uma organização para saber mais.

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

Quem pode executar 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 sudo completo, isso significa que o usuário tem acesso de sudo para executar as mesmas operações que o usuário raiz.

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

  • Utilitário apigee-service:
    • Comandos apigee-service: install, uninstall, update.
    • Comandos apigee-all: install, uninstall, update.
  • setup.sh para instalar os componentes do Edge, a menos que você já tenha usado "apigee-service install" para instalar as RPMs necessárias. Em seguida, acesso raiz ou de sudo total, se não for necessário.
  • Use o 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 ser executado 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 total ao sudo para o usuário "apigee". Esses comandos incluem:

  • Comandos utilitários apigee-service, incluindo:
    • Comandos apigee-service como start, stop, restart, configure.
    • 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 total ao sudo para o 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.

Definição de permissões em arquivos de configuração

Os arquivos ou recursos usados pelos comandos do Edge precisam estar acessíveis para o 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, você pode mudar o proprietário para "apigee:apigee" para garantir que ele possa ser acessado pelos 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 está executando o serviço do Edge do usuário "apigee", use o comando "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 usuários raiz e não raiz

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

  1. Tarefas realizadas pela raiz:
    1. Faça o download 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 para o 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

      As RPMs de borda que você instala no nó dependem da 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 instalar as RPMs do Edge no nó, o usuário com acesso total ao sudo para o usuário "apigee" concluirá o processo de configuração:
    1. Use o utilitário setup.sh para concluir a configuração dos componentes de borda no nó. O formato do comando depende dos componentes instalados 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 executar 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 de instalação

É necessário transmitir um arquivo de configuração para o utilitário apigee-setup que contenha as informações sobre a instalação do Edge. O único requisito em instalações silenciosas é que o arquivo de configuração precisa estar 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 como "apigee:apigee".

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

Consulte Instalar componentes do Edge em um nó para saber mais.

Como lidar com uma falha na instalação

No caso de uma falha durante a instalação de um componente do Edge, tente corrigir o problema e, em seguida, execute o instalador novamente. O instalador foi projetado para ser executado repetidamente quando ele detectar 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 de IU do Edge em cada nó em que ele estiver sendo executado.

Instalação na Internet ou sem Internet

Para instalar o Edge em um nó, o nó 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 as dependências e RPMs do Edge.

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

    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 todas as RPMs do Edge, mas você precisa garantir que todas as outras dependências estejam disponíveis nos repositórios na rede interna.

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

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

Um dos motivos para usar um repositório local ou espelhado é para 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 de 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 da versão explícito de cada dependência.

Se você estiver executando uma instalação em uma máquina com acesso à Internet, o nó poderá fazer o download das RPMs e das dependências necessárias. No entanto, se estiver instalando a partir de um nó sem acesso à Internet, você normalmente configura um repositório interno que contém 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 bem-sucedida.

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 do 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 de Borda, 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 registros de apigee-setup e o script setup.sh é gravado em /tmp/setup-root.log.

Os arquivos de registro de cada componente estão contidos 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 a localização 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 Nginx. Para registros adicionais, 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 Apigee Postgres /opt/apigee/var/log/edge-postgres-server
interface 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
Quádiz /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 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
Quádiz /opt/apigee/data/apigee-qpid/data
Banco de dados PostgreSQL /opt/apigee/data/apigee-postgres/pgdata

Tarefas de pós-instalação

Após a conclusão da instalação, você poderá realizar outras ações nos componentes do Edge.

Reiniciar o componente de interface do Edge

Após a conclusão da instalação, reinicie o componente da interface do Edge em cada nó:

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

Como configurar os 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 o TLS/SSL na IU do Edge, edite os arquivos .properties para definir as propriedades necessárias. As mudanças 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 retém as propriedades que você definiu no componente.

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

Como invocar comandos em componentes do Edge

Utilitários de gerenciamento de instalações de borda em /opt/apigee/apigee-service/bin que podem ser usados para gerenciar uma instalação do Edge. Por exemplo, é possível usar 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 apigee-service é executado. 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 de borda, execute o seguinte comando:

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

Você pode determinar a lista de componentes instalados no nó examinando 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 terceirizado usado pelo Edge. Por exemplo, apigee-cassandra.
  • edge: um componente 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 de um componente depende dele, mas todos os componentes oferecem suporte às ações abaixo:

  • 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 verificará se o sistema atende aos requisitos de CPU e memória para o componente que está sendo instalado. O valor padrão é "n" para desativar a verificação.