Configurar a nova interface do Edge

Este documento descreve como instalar e configurar a nova interface do Edge para o Apigee Edge para nuvem privada. Na versão 4.54.00, a nova interface do Edge consiste em dois componentes RPM:

  • edge-management-ui: o servidor de back-end da nova interface do Edge.
  • edge-management-ui-static: os recursos da Web estáticos para o front-end da nova interface do Edge.

A nova interface do Edge é instalada por padrão quando você executa setup.sh com o aio (tudo em um), sa (independente) ou ms (servidor de gerenciamento) ou pode ser instalada de forma independente em um nó usando o perfil ue.

Pré-requisitos

Antes de instalar ou configurar a nova interface do Edge em uma instalação do Apigee Edge para nuvem privada, verifique se o nó atende aos seguintes requisitos:

  • Requisitos de hardware e SO:
  • Autenticação:
    • Autenticação básica (padrão): ativada por padrão (AUTH_MODE=basic). Usa as credenciais do servidor de gerenciamento do Edge e do SymasLDAP sem exigir um provedor de identidade (IdP) externo.
    • SSO / IdP externo (opcional): você pode configurar o SSO da Apigee ou um IdP externo (como SAML ou OIDC). Se você se conectar a um IdP externo por TLS, ele precisará oferecer suporte ao TLS v1.2 ou mais recente.

Para mais informações sobre os recursos da nova interface do Edge, consulte A nova interface do Edge para nuvem privada.

Visão geral da instalação e configuração

De modo geral, o processo de instalação ou reconfiguração da nova interface do Edge usando o ue perfil é o seguinte:

  • Verifique se o utilitário apigee-setup está instalado no nó.
  • Crie um arquivo de configuração silenciosa e modifique-o com suas configurações.
  • Execute /opt/apigee/apigee-setup/bin/setup.sh -p ue -f configFile. Isso instala e configura edge-management-ui e edge-management-ui-static.
  • Faça login e teste a nova interface do Edge em http://new_edge_UI_IP:3001.

Se o servidor de gerenciamento e o servidor da nova interface do Edge estiverem atrás de um balanceador de carga com descarregamento de TLS no balanceador de carga, verifique se a configuração reflete as propriedades destacadas em Configurar a nova interface do Edge quando o término de TLS ocorre no balanceador de carga.

Arquivo de configuração da nova interface do Edge

O exemplo a seguir mostra um arquivo de configuração para instalar e configurar a nova interface do Edge com a autenticação básica padrão.

Configuração de autenticação básica (padrão)

# IP of the Edge Management Server.
IP1=management_server_IP

# IP of the New Edge UI node (can be the same as IP1 or a separate node).
IP2=new_edge_UI_server_IP

# Edge sys admin credentials.
ADMIN_EMAIL=your@email.com
APIGEE_ADMINPW=your_password    # If omitted, you are prompted for it.

# Edge Management Server information.
APIGEE_PORT_HTTP_MS=8080
MSIP=$IP1
MS_SCHEME=http

#
# New Edge UI configuration.
#
MANAGEMENT_UI_PORT=3001
MANAGEMENT_UI_IP=$IP2
MANAGEMENT_UI_APP_ENV=OPDK
MANAGEMENT_UI_SCHEME=http
MANAGEMENT_UI_PUBLIC_URIS=$MANAGEMENT_UI_SCHEME://$MANAGEMENT_UI_IP:$MANAGEMENT_UI_PORT

# Authentication mode (basic is default)
AUTH_MODE=basic

## SMTP Configuration
SKIP_SMTP=n       # Skip now and configure later by specifying "y".
SMTPHOST=smtp.example.com
SMTPUSER=your@email.com
SMTPPASSWORD=your_email_password
SMTPSSL=y
SMTPPORT=465      # If no SSL, use a different port, such as 25.
SMTPMAILFROM="My Company <myco@company.com>"

Instalar ou configurar a nova interface do Edge

Para instalar ou configurar a nova interface do Edge usando o perfil ue:

  1. Faça login no nó de destino como administrador.
  2. Instale a versão 4.54.00 do utilitário apigee-setup no nó, conforme descrito em Instalar o utilitário apigee-setup do Edge.
  3. Limpe todas as informações armazenadas em cache com o Yum executando o seguinte comando: 
    sudo yum clean all
  4. Crie o arquivo de configuração conforme descrito em Nova interface do Edge arquivo de configuração e verifique se ele pertence ao usuário "apigee": 
    chown apigee:apigee configFile
  5. No nó, execute o seguinte comando: 
    /opt/apigee/apigee-setup/bin/setup.sh -p ue -f configFile

    O utilitário apigee-setup instala e configura edge-management-ui e edge-management-ui-static.

  6. Faça login na nova interface do Edge abrindo o seguinte URL em um navegador: 
    http://new_edge_UI_IP:3001

    Em que new_edge_UI_IP é o endereço IP ou o nome do host do nó que hospeda a nova interface do Edge.

  7. Digite suas credenciais.

    A nova interface do Edge aparece. Para informações sobre como usar a nova interface do Edge, consulte A nova interface do Edge para nuvem privada.

    Se a nova interface do Edge não aparecer, verifique se a porta 3001 está aberta para conexões.

Opcional: se você quiser configurar o SSO da Apigee para autenticação, siga as etapas em Instalar e configurar o SSO da Apigee e Ativar um IdP externo na nova interface do Edge.

Desinstalar a nova interface do Edge

Para desinstalar a nova interface do Edge de um nó, desinstale os componentes edge-management-ui e edge-management-ui-static.

Para desinstalar os componentes da nova interface do Edge:

/opt/apigee/apigee-service/bin/apigee-service edge-management-ui uninstall
/opt/apigee/apigee-service/bin/apigee-service edge-management-ui-static uninstall

Para remover todos os componentes do Edge do nó:

  1. Interrompa todos os serviços do Edge em execução na máquina: 
    /opt/apigee/apigee-service/bin/apigee-all stop
  2. Limpe o cache do yum: 
    sudo yum clean all
  3. Remova todos os RPMs da Apigee: 
    sudo rpm -e $(rpm -qa | egrep "(apigee-|edge-)")
  4. Remova o diretório raiz de instalação: 
    sudo rm -rf /opt/apigee