Edge para nuvem privada v4.18.01
Neste documento, descrevemos como instalar a versão Beta da 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á-lo em um nó que contém outros componentes 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 versão Beta da 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 autenticar 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.
Observação: em um ambiente de não produção, é possível deixar a autenticação básica ativada no Edge para que os usuários da IU clássica e da API Edge ainda possam usar a autenticação básica.
Para informações sobre como ativar o SAML no Edge, consulte Como oferecer suporte ao SAML no Edge para nuvem privada. - É 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. 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.18.01 do utilitário
apigee-setupno nó, conforme descrito em Instalar o utilitário apigee-setup do Edge.
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 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.
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 # URLs for the different UIs. # URL of classic Edge UI. ROUTES_CLASSICUI="http://$IP1:9000" # URL of New Edge experience. ROUTES_SHOEHORN="http://$IP2:9000" # New Edge experience configuration. # Enable the New Edge experience. EDGEUI_ENABLE_UNIFIED_UI=y # Access port for the New Edge experience. MANAGEMENT_UI_PORT=3001 MANAGEMENT_UI_APP_ENV=OPDK MANAGEMENT_UI_IP=$IP2 # Disable TLS on the New Edge experience. # This release does not support TLS. MANAGEMENT_UI_USE_HTTPS=n # 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 # 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 # Edge SSO configuration. # Some settings are for the classic UI, # but are still required to configure the New Edge experience. # Enable SSO. EDGEUI_SSO_ENABLED=y # Information about Classic UI EDGEUI_PUBLIC_URIS=http://$IP1:9000 # Information about publicly accessible URL for Classic UI. EDGEUI_SSO_REGISTERED_PUBLIC_URIS=$EDGEUI_PUBLIC_URIS # 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". # MANAGEMENT_UI_SKIP_VERIFY=y SSO_PUBLIC_URL_SCHEME=http # 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:
- Instale a versão 4.18.01 do utilitário
apigee-setupno nó, conforme descrito em Instalar o utilitário apigee-setup do Edge. - Limpar o Yum:
> sudo yum clean all
- 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.
- Instale a versão Shoehorn da interface do Edge:
> /opt/apigee/apigee-service/bin/apigee-service edge-ui install
- Configure a interface do Edge:
> /opt/apigee/apigee-service/bin/apigee-service edge-ui setup -f configFile
- 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:
- Instale a nova experiência do Edge:
> /opt/apigee/apigee-service/bin/apigee-service edge-management-ui install
- Use o diretório
edge-management-ui:> cd /opt/apigee/edge-management-ui
- 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.
- Ative o SAML na nova experiência do Edge:
> /opt/apigee/apigee-service/bin/apigee-service edge-management-ui configure-sso -f configFile
- 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.
- Consulte A nova experiência do Edge 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ó:
- Interrompa todos os serviços do Edge em execução na máquina:
> /opt/apigee/apigee-service/bin/apigee-all stop
- Limpe o cache do yum:
> sudo yum clean all
- Remova todos os RPMs da Apigee:
> sudo rpm -e $(rpm -qa | egrep "(apigee-|edge-|baas)")
- Remova o diretório raiz da instalação:
> sudo rm -rf /opt/apigee