Como instalar a nova experiência do Edge

Edge para nuvem privada v4.19.01

Neste documento, descrevemos como instalar a nova experiência do Edge para o Edge para nuvem privada. A nova experiência do Edge é a próxima geração de interface do Edge.

Para testar a nova experiência do Edge em uma instalação do Edge para nuvem privada, você precisa:

  • Ative o SAML na borda. A nova experiência do Edge só aceita SAML como mecanismo de autenticação.
  • Instale a nova experiência do Edge no próprio nó. Não é possível instalá-la em um nó que contenha outros componentes do Edge, incluindo o nó em que a IU do Edge está. Isso vai impedir que os usuários façam login na interface clássica do Edge.

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

Visão geral da instalação

Para instalar a nova experiência do Edge para o Edge para nuvem privada, você executa dois processos de instalação diferentes:

  • Instale a interface básica do Edge, chamada shoehorn, e configure-a para usar o SAML na autenticação com o Edge.
  • Instale a nova experiência do Edge e configure-a para usar o SAML para autenticação com o Edge. Depois de instalar a nova experiência do Edge, faça login e use-a para trabalhar com o Edge.

Pré-requisitos de instalação

  • Ative o SAML no Edge antes de instalar a nova experiência do Edge. A nova experiência do Edge aceita apenas o SAML como mecanismo de autenticação.

    Para informações sobre como ativar o SAML no Edge, consulte Como oferecer suporte ao SAML no Edge para nuvem privada.

  • A nova experiência do Edge só é compatível com o TLS v1.2. Como você se conecta ao IDP SAML por TLS, ele precisa ser compatível com o TLS v1.2.

  • É preciso instalar a nova experiência do Edge no próprio nó. Não é possível instalá-lo em um nó que contenha outros componentes do Edge, incluindo o nó em que a IU do Edge está.

    O nó 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.19.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 à nova experiência do Edge. Se você mudar a porta usando as propriedades descritas abaixo, verifique se ela está aberta.

Considerações antes de instalar a nova experiência do Edge

Como descrito acima nos pré-requisitos, a nova experiência do Edge exige que você ative o SAML no Edge. Isso significa que a autenticação do usuário é controlada por um IDP SAML, em que você configura o IDP SAML para usar endereços de e-mail como o ID do usuário. Portanto, todos os usuários da nova experiência do Edge precisam estar registrados no IdP SAML.

A IU clássica do Edge, que é a IU padrão instalada com o Edge para nuvem privada, não requer SAML. Ele pode usar SAML ou autenticação básica. Isso significa que você pode:

  • Ative o suporte ao SAML no Edge e na IU clássica e na nova experiência do Edge.

    Nesse cenário, todos os usuários da interface clássica e da nova experiência do Edge são registrados no IDP do SAML. Para informações sobre como adicionar novos usuários ao IDP SAML, consulte Registrar novos usuários do Edge.

  • Ative o suporte ao SAML no Edge, mas deixe a autenticação básica ativada. A nova experiência do Edge usa SAML, e a interface clássica ainda usa a autenticação básica.

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

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

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

Esteja ciente das seguintes mudanças no procedimento de instalação da versão Beta da nova experiência do Edge.

Mudanças na configuração de instalação do Edge 4.18.05

A versão 4.19.01 da nova experiência do Edge contém as seguintes alterações no arquivo de configuração da versão 4.18.05 do Edge:

Tipo de mudança Propriedades afetadas
Removido 
MANAGEMENT_UI_SSO_PUBLIC_KEY_CACHE_HOURS

Essa propriedade tem um valor predefinido de 0,5 (30 minutos) e não pode ser alterada.
Adicionado Agora é possível usar propriedades para ativar o TLS na nova experiência do Edge. Consulte Como configurar o TLS para a nova experiência do Edge para saber mais.

Mudanças na configuração de instalação do Edge 4.18.01

A versão 4.19.01 da nova experiência do Edge contém as seguintes alterações no arquivo de configuração da versão 4.18.01 do Edge:

Tipo de mudança Propriedades afetadas
Adicionado 
# Shoehorn UI configurations.
SHOEHORN_SCHEME
SHOEHORN_IP
SHOEHORN_PORT

# Classic UI configurations.
CLASSIC_UI_SCHEME
CLASSIC_UI_IP
CLASSIC_UI_PORT

# Information about Edge SSO module.
MANAGEMENT_UI_SKIP_VERIFY
Removido 
ROUTES_SHOEHORN
ROUTES_CLASSICUI
Substituída 
MANAGEMENT_UI_USE_HTTPS
 Substituído por: 
MANAGEMENT_UI_SCHEME

Arquivo de configuração de instalação

O arquivo de configuração contém todas as informações necessárias para instalar e configurar a nova experiência do Edge. É possível usar o mesmo arquivo de configuração para instalar e configurar a IU de base e a nova experiência do Edge.

Veja abaixo um exemplo de arquivo de configuração:

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

# IP of the New Edge experience node.
IP2=22.222.222.222

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

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

#
# New Edge experience configuration.
#

# Enable the New Edge experience.
EDGEUI_ENABLE_UNIFIED_UI=y
# Specify IP and port for the New Edge experience.
MANAGEMENT_UI_PORT=3001
MANAGEMENT_UI_IP=$IP2
# Specify a Private Cloud deployment.
MANAGEMENT_UI_APP_ENV=OPDK
# Disable TLS on the New Edge experience.
MANAGEMENT_UI_SCHEME=http

# Location of New Edge experience.
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=CHANGE_TO_YOUR_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 New Edge experience.
MANAGEMENT_UI_SSO_ENABLED=y
MANAGEMENT_UI_SSO_CLIENT_OVERWRITE=y
MANAGEMENT_UI_SSO_CLIENT_ID=newueclient
MANAGEMENT_UI_SSO_CLIENT_SECRET=secret111

#
# Shoehorn UI configuration
#
# Set to http even if you enable TLS on the New Edge experience.
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 New Edge experience.
#

# 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 SAML on the classic Edge 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

# Information about Edge SSO module.
# 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 Edge SSO module.
# If Edge 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 Edge SSO module.
SSO_ADMIN_NAME=ssoadmin
SSO_ADMIN_SECRET=Secret123

#
# Required SMTP information.
#

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

Instalar a interface básica do Edge (shoehorn)

É preciso instalar a IU de base do Edge, chamada shoehorn, antes de instalar a nova experiência do Edge.

Para instalar a interface básica:

  1. Instale a versão 4.19.01 do utilitário apigee-setup no nó, conforme descrito em Instalar o utilitário apigee-setup da borda.
  2. Limpar o Yum: 
    sudo yum clean all
  3. Crie o arquivo de configuração conforme descrito acima e verifique se ele pertence ao usuário "apigee": 
    chown apigee:apigee configFile

    em que configFile é o arquivo de configuração descrito acima em Arquivo de configuração de instalação.

  4. Altere o valor da propriedade MANAGEMENT_UI_SSO_CSRF_SECRET no arquivo de configuração para o secret de CSRF.
  5. Instale a versão Shoehorn da interface do Edge: 
    /opt/apigee/apigee-service/bin/apigee-service edge-ui install
  6. Configure a interface do Edge: 
    /opt/apigee/apigee-service/bin/apigee-service edge-ui setup -f configFile
  7. Ative o SAML na interface do Edge: 
    /opt/apigee/apigee-service/bin/apigee-service edge-ui configure-sso -f configFile

Instalar a nova experiência do Edge

Depois de instalar a IU básica do Edge, instale e configure a nova experiência do Edge.

Para instalar a nova experiência do Edge:

  1. Instale a nova experiência do Edge: 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui install
  2. Use o diretório edge-management-ui: 
    cd /opt/apigee/edge-management-ui
  3. Configure a nova experiência do Edge: 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui setup -f configFile

    em que configFile é o arquivo de configuração descrito acima em Arquivo de configuração de instalação.

  4. Ative o SAML na nova experiência do Edge: 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui configure-sso -f configFile
  5. Faça login na nova experiência do Edge abrindo o seguinte URL em um navegador: 
    http://newEdgeExperienceIP:3001

    em que newEdgeExperienceIP é o endereço IP do nó que hospeda a nova experiência do Edge. Suas credenciais SAML serão solicitadas. Depois de inserir suas credenciais, a nova experiência do Edge será exibida.

  6. Consulte A nova experiência do Edge para nuvem privada para mais informações, incluindo links para informações sobre como usar a nova experiência do Edge.

Desinstalar a nova experiência do Edge

Para desinstalar a nova experiência do Edge:

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

Para desinstalar a interface básica do Edge (shoehorn):

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

Para remover completamente o 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 da instalação: 
    sudo rm -rf /opt/apigee