Instalar a nova IU do Edge

Neste documento, descrevemos como instalar a interface do Edge para o Apigee Edge para nuvem privada. A interface do usuário do Edge é a próxima geração de interface para o Edge.

Pré-requisitos

Para testar a nova interface do Edge em uma instalação do Apigee Edge para nuvem privada, faça o seguinte:

  • Instale a interface do Edge no próprio nó. Não é possível instalar em um nó que contenha outros componentes do Edge, incluindo o nó em que a interface clássica atual reside. Isso vai impedir que os usuários façam login na interface clássica.

    O nó da interface do Edge precisa atender aos seguintes requisitos:

    • JAVA 1.8
    • 4 GB de RAM
    • 2 núcleos
    • 60 GB de espaço em disco
    • Primeiro, instale a versão 4.53.01 do utilitário apigee-setup no nó, conforme descrito em Instalar o utilitário apigee-setup do Edge.
    • A porta 3001 precisa estar aberta. Essa é a porta padrão usada para solicitações à interface do Edge. Se você mudar a porta usando as propriedades descritas em Novo arquivo de configuração do UE, verifique se a porta está aberta.
  • Ative um IDP externo no Edge. A interface do Edge é compatível com SAML ou LDAP como mecanismo de autenticação.
  • (Somente IdP SAML) A interface do Edge só é compatível com TLS v1.2. Como você se conecta ao IdP SAML por TLS, se você usa SAML, seu IdP precisa oferecer suporte ao TLS v1.2.

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

Visão geral da instalação

De modo geral, o processo de instalação da interface do Edge para o Apigee Edge para nuvem privada é o seguinte:

  • Adicionar um novo nó ao cluster
  • Faça login no novo nó
  • Baixar o utilitário apigee-setup
  • Crie um arquivo de configuração e modifique-o com suas configurações.
  • Executar o utilitário apigee-setup
  • Faça login e teste a nova UE

Quando executado no novo nó, o utilitário apigee-setup:

  • Instala a interface clássica básica, chamada shoehorn, e configura a interface clássica para usar um IdP externo na autenticação com o Edge.
  • Instala a nova interface do Edge e a configura para usar seu IdP externo na autenticação com o Edge.

Considerações antes de instalar a nova interface do Edge

Conforme descrito acima nos pré-requisitos, a interface do Edge exige que você ative um IdP externo no Edge. Isso significa que a autenticação de usuário é controlada pelo IdP, em que você configura para usar endereços de e-mail como ID do usuário. Portanto, todos os usuários da interface do Edge precisam ser registrados no IdP.

A interface clássica, a interface padrão instalada com o Apigee Edge para nuvem privada, não exige um IdP externo. Ele pode usar um IDP ou a autenticação básica. Isso significa que você pode:

  • Ative o suporte a IdP externo no Edge e nas interfaces clássica e do Edge.

    Nesse cenário, todos os usuários da interface clássica e da interface do Edge estão registrados no IdP. Para informações sobre como adicionar novos usuários ao IdP, consulte Registrar novos usuários do Edge.

  • Ative o suporte a IdP externo no Edge, mas deixe a autenticação básica ativada. A interface do Edge usa o IdP, e a interface clássica ainda usa a autenticação básica.

    Nesse cenário, todos os usuários da interface clássica fazem login com credenciais de autenticação básica, em que as credenciais são armazenadas no banco de dados SymasLDAP do Edge. Os usuários da interface do Edge são registrados no IdP e fazem login usando SAML ou LDAP.

    No entanto, um usuário da interface clássica não poderá fazer login na interface do Edge até que você o adicione ao IdP, conforme descrito em Registrar novos usuários do Edge.

Mudanças na configuração de instalação em relação às versões anteriores

Confira as mudanças no procedimento de instalação das versões Beta da interface do Edge.

Novo arquivo de configuração da interface do Edge

O arquivo de configuração a seguir contém todas as informações necessárias para instalar e configurar a nova interface do Edge. É possível usar o mesmo arquivo de configuração para instalar e configurar a interface shoehorn/Classic e a interface do Edge.

# IP of the Edge Management Server.
# This node also hosts the Apigee SSO module and the current, or Classic, UI.
IP1=management_server_IP

# IP of the Edge UI node.
IP2=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

#
# Edge UI configuration.
#

# Enable the Edge UI.
EDGEUI_ENABLE_UNIFIED_UI=y
# Specify IP and port for the Edge UI.
# The management UI port must be open for requests to the Edge UI
MANAGEMENT_UI_PORT=3001
MANAGEMENT_UI_IP=$IP2
# Set to 'OPDK' to specify a Private Cloud deployment.
MANAGEMENT_UI_APP_ENV=OPDK
# Disable TLS on the Edge UI.
MANAGEMENT_UI_SCHEME=http

# Location of Edge UI.
MANAGEMENT_UI_PUBLIC_URIS=$MANAGEMENT_UI_SCHEME://$MANAGEMENT_UI_IP:$MANAGEMENT_UI_PORT
MANAGEMENT_UI_SSO_REGISTERED_PUBLIC_URIS=$MANAGEMENT_UI_PUBLIC_URIS
MANAGEMENT_UI_SSO_CSRF_SECRET=YOUR_CSRF_SECRET
# Duration of CSRF token.
MANAGEMENT_UI_SSO_CSRF_EXPIRATION_HOURS=24
# Defaults to 8760 hours, or 365 days.
MANAGEMENT_UI_SSO_STRICT_TRANSPORT_SECURITY_AGE_HOURS=8760

## SSO configuration for the Edge UI.
MANAGEMENT_UI_SSO_ENABLED=y

# Only required if MANAGEMENT_UI_SSO_ENABLED is 'y'
MANAGEMENT_UI_SSO_CLIENT_OVERWRITE=y

MANAGEMENT_UI_SSO_CLIENT_ID=newueclient
MANAGEMENT_UI_SSO_CLIENT_SECRET=your_client_sso_secret

#
# Shoehorn UI configuration
#
# Set to http even if you enable TLS on the Edge UI.
SHOEHORN_SCHEME=http
SHOEHORN_IP=$MANAGEMENT_UI_IP
SHOEHORN_PORT=9000

#
# Edge Classic UI configuration.
# Some settings are for the Classic UI, but are still required to configure the Edge UI.
#

# These settings assume that Classic UI is installed on the Management Server.
CLASSIC_UI_IP=$MSIP
CLASSIC_UI_PORT=9000
CLASSIC_UI_SCHEME=http
EDGEUI_PUBLIC_URIS=$CLASSIC_UI_SCHEME://$CLASSIC_UI_IP:$CLASSIC_UI_PORT

# Information about publicly accessible URL for Classic UI.
EDGEUI_SSO_REGISTERED_PUBLIC_URIS=$EDGEUI_PUBLIC_URIS

# Enable SSO
EDGEUI_SSO_ENABLED=y

# The name of the OAuth client used to connect to apigee-sso.
# The default client name is 'edgeui'.
# Apigee recommends that you use the same settings as you used
# when enabling your IDP on the Classic UI.
EDGEUI_SSO_CLIENT_NAME=edgeui
# Oauth client password using uppercase, lowercase, number, and special chars.
EDGEUI_SSO_CLIENT_SECRET=ssoClient123
# If set, existing EDGEUI client will deleted and new one will be created.
EDGEUI_SSO_CLIENT_OVERWRITE=y

# Apigee SSO Component configuration
# Externally accessible IP or DNS of Edge SSO module.
SSO_PUBLIC_URL_HOSTNAME=$IP1
SSO_PUBLIC_URL_PORT=9099
# Default is http. Set to https if you enabled TLS on the Apigee SSO module.
# If Apigee SSO uses a self-signed cert, you must also set MANAGEMENT_UI_SKIP_VERIFY to "y".
SSO_PUBLIC_URL_SCHEME=http
# MANAGEMENT_UI_SKIP_VERIFY=y
# SSO admin credentials as set when you installed Apigee SSO module.
SSO_ADMIN_NAME=ssoadmin
SSO_ADMIN_SECRET=your_sso_admin_secret

#
##      SSO Configuration (define external IDP)           #
#
# Use one of the following configuration blocks to        #
# define your IDP settings:                               #
#  - SAML configuration properties                        #
#  - LDAP Direct Binding configuration properties         #
#  - LDAP Indirect Binding configuration properties       #

INSERT_IDP_CONFIG_BLOCK_HERE (SAML, LDAP direct, or LDAP indirect)

## SMTP Configuration (required)
#
SKIP_SMTP=n       # Skip now and configure later by specifying "y".
SMTPHOST=smtp.gmail.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 a interface do Edge

Depois de criar e modificar o arquivo de configuração, instale a nova interface do Edge nesse novo nó.

Para instalar a interface do Edge:

  1. Adicione um novo nó ao cluster.
  2. Faça login no novo nó como administrador.
  3. Instale a versão 4.53.01 do utilitário apigee-setup no nó, conforme descrito em Instalar o utilitário apigee-setup do Edge.
  4. Limpe todas as informações em cache com o Yum executando o seguinte comando: 
    sudo yum clean all
  5. Crie o arquivo de configuração conforme descrito em Novo arquivo de configuração da interface do Edge e verifique se ele pertence ao usuário "apigee": 
    chown apigee:apigee configFile

    Faça as seguintes edições no arquivo de configuração:

    • Mude o valor da propriedade MANAGEMENT_UI_SSO_CSRF_SECRET no arquivo de configuração para seu segredo de CSRF.
    • Configure o Edge para usar uma das seguintes opções. A nova interface do Edge exige um IdP externo:
      • SAML
      • LDAP

      Para mais informações, consulte Visão geral da autenticação de IDPs externos.

  6. Configure seu IdP externo com os usuários que você quer que tenham acesso à interface do Edge. Para mais informações, consulte Registrar novos usuários do Edge.
  7. No novo nó, execute o seguinte comando: 
    /opt/apigee/apigee-setup/bin/setup.sh -p ue -f configFile

    O utilitário apigee-setup instala a interface clássica. Além da interface clássica, o instalador também instala a interface do Edge.

  8. Faça login na 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 do nó que hospeda a nova interface do Edge.

    O Edge solicita suas credenciais de IdP externo.

  9. Digite suas credenciais.

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

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

Desinstalar a nova interface

Para desinstalar a nova interface do nó, é necessário desinstalar a nova interface do Edge e a interface clássica básica (shoehorn) instalada no nó durante o processo de instalação da interface.

Para desinstalar a nova interface do Edge:

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

Para desinstalar a IU clássica básica (shoehorn):

/opt/apigee/apigee-service/bin/apigee-service edge-ui 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 do Apigee: 
    sudo rpm -e $(rpm -qa | egrep "(apigee-|edge-)")
  4. Remova o diretório raiz de instalação: 
    sudo rm -rf /opt/apigee