Como instalar a nova experiência de borda (Beta)

Edge para nuvem privada v4.18.05

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

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

  • Ativar o SAML no Edge. A nova experiência do Edge só permite o SAML como mecanismo de autenticação.
  • Instale a experiência do novo Edge no próprio nó. Não é possível instalá-lo em um nó que contenha outros componentes de borda.

Para saber mais sobre a nova experiência do Edge, consulte A nova experiência do Edge para a nuvem privada.

Visão geral da instalação

Para instalar a versão Beta da nova experiência do Edge para a nuvem privada, execute dois processos de instalação diferentes:

  • Instale a IU de base do Edge, chamada shoehorn, e configure essa IU para usar SAML na autenticação do Edge.
  • Instale a nova experiência do Edge e configure-a para usar SAML na 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 só oferece suporte ao 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 a nuvem privada.

  • Você precisa instalar a nova experiência do Edge no próprio nó. Não é possível instalá-lo em um nó que contenha outros componentes de borda. O nó precisa atender aos seguintes requisitos:

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

Conforme 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 ID do usuário. Todos os usuários da nova experiência do Edge precisam estar registrados no IdP SAML.

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

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

    Neste cenário, todos os usuários da IU clássica e da experiência com o novo Edge estão registrados no IdP SAML. Para informações sobre como adicionar novos usuários ao IdP SAML, consulte Registrar novos usuários do Edge.

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

    Neste 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 OpenLDAP do Edge. Os novos usuários da 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 ele seja adicionado ao IdP SAML, conforme descrito em Registrar novos usuários do Edge.

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

A versão 4.18.05 da nova experiência do Edge contém as seguintes mudanças no arquivo de configuração a partir da versão 4.18.01 do Edge. Essas propriedades são descritas em detalhes na seção a seguir:

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
Removida
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 experiência do novo Edge.

Um exemplo de arquivo de configuração é mostrado abaixo:

# 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.
# This release does not support TLS.
MANAGEMENT_UI_SCHEME=http

# Location of New Edge experience.
MANAGEMENT_UI_PUBLIC_URIS=http://$IP2:3001
MANAGEMENT_UI_SSO_REGISTERED_PUBLIC_URIS=$MANAGEMENT_UI_PUBLIC_URIS
MANAGEMENT_UI_SSO_CSRF_SECRET=secret222
MANAGEMENT_UI_SSO_CSRF_EXPIRATION_HOURS=24
MANAGEMENT_UI_SSO_STRICT_TRANSPORT_SECURITY_AGE_HOURS=24
MANAGEMENT_UI_SSO_PUBLIC_KEY_CACHE_HOURS=0.5

# 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.
#

# The first two properties use the same values as the New Edge experience.
SHOEHORN_SCHEME=$MANAGEMENT_UI_SCHEME
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)

Instale a interface básica do Edge, chamada shoehorn, antes de instalar a experiência do novo Edge.

Para instalar a interface de base:

  1. Instale a versão 4.18.05 do utilitário apigee-setup no nó, conforme descrito em Instalar o utilitário de configuração da Apigee Edge.
  2. Limpar 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. Instale a versão Shoehorn da interface do Edge:
    /opt/apigee/apigee-service/bin/apigee-service edge-ui install
  5. Configure a interface do Edge:
    /opt/apigee/apigee-service/bin/apigee-service edge-ui setup -f configFile
  6. Ativar 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, você poderá instalar e configurar a nova experiência do Edge.

Para instalar a nova experiência do Edge, faça o seguinte:

  1. Instale a nova experiência do Edge:
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui install
  2. Mude para 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. Ativar 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. Você precisará informar suas credenciais de SAML. Depois que você digita suas credenciais, a nova experiência do Edge é exibida.

  6. Consulte A nova experiência de borda para nuvem privada (Beta) 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 todas as 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