Installa la nuova UI di Edge

Questo documento descrive come installare la UI Edge per Apigee Edge per il cloud privato. La UI Edge è la nuova generazione di UI per Edge.

Prerequisiti

Per provare la nuova UI Edge in un'installazione di Apigee Edge per il cloud privato, devi:

  • Installa la UI Edge sul proprio nodo. Non puoi installarla su un nodo che contiene altri componenti Edge, incluso il nodo su cui si trova l'UI classica esistente. In questo modo, gli utenti non saranno in grado di accedere all'interfaccia utente classica.

    Il nodo della UI perimetrale deve soddisfare i seguenti requisiti:

    • JAVA 1.8
    • 4 GByte di RAM
    • 2 core
    • 60 GB di spazio su disco
    • Devi prima installare la versione 4.52.02 dell'utilità apigee-setup sul nodo come descritto in Installare l'utilità apigee-setup Edge.
    • La porta 3001 deve essere aperta. Questa è la porta predefinita utilizzata per le richieste alla UI Edge. Se modifichi la porta utilizzando le proprietà descritte in Nuovo file di configurazione UE, assicurati che la porta sia aperta.
  • Attiva un IdP esterno su Edge. La UI Edge supporta SAML o LDAP come meccanismo di autenticazione.
  • (Solo IDP SAML) La UI Edge supporta solo TLS v1.2. Poiché ti connetti all'IdP SAML tramite TLS, se utilizzi SAML, l'IdP deve quindi supportare TLS v1.2.

Per ulteriori informazioni sulla UI Edge, vedi The new Edge UI for Private Cloud.

Panoramica dell'installazione

A livello generale, il processo di installazione della UI Edge per Apigee Edge per il cloud privato è il seguente:

  • Aggiungi un nuovo nodo al cluster
  • Accedi al nuovo nodo
  • Scarica l'utilità apigee-setup
  • Creare un file di configurazione e modificarlo con le tue impostazioni.
  • Esegui l'utilità apigee-setup
  • Accedi e testa la nuova UE

Quando viene eseguita sul nuovo nodo, l'utilità apigee-setup:

  • Installa l'interfaccia utente classica di base, detta shoehorn, e configura la UI classica in modo da utilizzare un IdP esterno per l'autenticazione con Edge.
  • Installa la nuova UI Edge e configura la UI Edge in modo che utilizzi il tuo IdP esterno per l'autenticazione con Edge.

Considerazioni da fare prima di installare la nuova UI Edge

Come descritto sopra nei prerequisiti, la UI di Edge richiede l'abilitazione di un IdP esterno su Edge. Ciò significa che l'autenticazione degli utenti è controllata dall'IdP, dove la configuri in modo che utilizzi gli indirizzi email come ID utente. Tutti gli utenti UI Edge devono quindi essere registrati nell'IdP.

La UI classica, ossia l'interfaccia utente predefinita che hai installato con Apigee Edge per il cloud privato, non richiede un IdP esterno. Può utilizzare un IdP o un'autenticazione di base. Ciò significa che puoi:

  • Abilita il supporto degli IdP esterni su Edge e sia nell'UI classica che in quella di Edge.

    In questo scenario, tutti gli utenti dell'UI classica e di quella perimetrale vengono registrati nell'IdP. Per informazioni sull'aggiunta di nuovi utenti all'IdP, consulta Registrare nuovi utenti Edge.

  • Attiva il supporto degli IdP esterni su Edge, ma lascia abilitata l'autenticazione di base. La UI Edge utilizza l'IdP, mentre la UI classica utilizza comunque l'autenticazione di base.

    In questo scenario, tutti gli utenti dell'interfaccia utente classica accedono con le credenziali di autenticazione Basic, dove le loro credenziali sono archiviate nel database Edge OpenLDAP. Gli utenti Edge UI sono registrati nell'IdP e accedono tramite SAML o LDAP.

    Tuttavia, un utente della UI classica non può accedere alla UI Edge finché non lo avrai aggiunto all'IdP, come descritto in Registrare nuovi utenti Edge.

Modifiche alla configurazione di installazione rispetto alle release precedenti

Considera le seguenti modifiche alla procedura di installazione dalle release beta della UI Edge.

Nuovo file di configurazione della UI Edge

Il seguente file di configurazione contiene tutte le informazioni necessarie per installare e configurare la nuova UI Edge. Puoi utilizzare lo stesso file di configurazione per installare e configurare sia la UI classica/shoehorn sia la UI 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"

Installa la UI Edge

Dopo aver creato e modificato il file di configurazione, puoi installare la nuova UI Edge su quel nuovo nodo.

Per installare la UI Edge:

  1. Aggiungi un nuovo nodo al cluster.
  2. Accedi al nuovo nodo come amministratore.
  3. Installa la versione 4.52.02 dell'utilità apigee-setup sul nodo, come descritto in Installare l'utilità Edge apigee-setup.
  4. Elimina tutte le informazioni memorizzate nella cache con Yum eseguendo questo comando: 
    sudo yum clean all
  5. Crea il file di configurazione come descritto in Nuovo file di configurazione della UI di Edge e assicurati che sia di proprietà dell'utente "apigee": 
    chown apigee:apigee configFile

    Assicurati di apportare al file di configurazione le seguenti modifiche:

    • Modifica il valore della proprietà MANAGEMENT_UI_SSO_CSRF_SECRET nel file di configurazione nel tuo secret CSRF.
    • Configura Edge in modo che utilizzi uno dei seguenti (la nuova UI di Edge richiede un IdP esterno):
      • SAML
      • LDAP

      Per maggiori informazioni, consulta la Panoramica dell'autenticazione degli IdP esterni.

  6. Configura l'IdP esterno con gli utenti a cui vuoi concedere l'accesso alla UI Edge. Per ulteriori informazioni, consulta Registrare nuovi utenti Edge.
  7. Sul nuovo nodo, esegui questo comando: 
    /opt/apigee/apigee-setup/bin/setup.sh -p ue -f configFile

    L'utilità apigee-setup installa l'interfaccia utente classica. Oltre all'interfaccia utente classica, il programma di installazione installa quindi la UI Edge.

  8. Accedi alla UI Edge aprendo il seguente URL in un browser: 
    http://new_edge_UI_IP:3001

    Dove new_edge_UI_IP è l'indirizzo IP del nodo che ospita la nuova UI Edge.

    Edge richiede le credenziali IdP esterne.

  9. Inserisci le tue credenziali.

    Viene visualizzata la nuova UI Edge. Per informazioni sull'utilizzo della UI Edge, vedi The new Edge UI for Private Cloud.

    Se la UI Edge non viene visualizzata, assicurati che la porta 3001 sia aperta per le connessioni esterne.

Disinstallare la nuova UI

Per disinstallare la nuova UI dal relativo nodo, devi disinstallare sia la nuova UI Edge sia la UI classica di base (shoehorn) installata sul nodo durante il processo di installazione.

Per disinstallare la nuova UI Edge:

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

Per disinstallare l'UI classica di base (shoehorn):

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

Per rimuovere tutti i componenti Edge dal nodo:

  1. Arresta tutti i servizi perimetrali in esecuzione sulla macchina: 
    /opt/apigee/apigee-service/bin/apigee-all stop
  2. Svuota la cache yum: 
    sudo yum clean all
  3. Rimuovi tutti gli RPM Apigee: 
    sudo rpm -e $(rpm -qa | egrep "(apigee-|edge-)")
  4. Rimuovi la directory root di installazione: 
    sudo rm -rf /opt/apigee