Installazione di New Edge Experience

Edge for Private Cloud v4.19.01

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

Per provare la nuova esperienza Edge in un'installazione di Edge for Private Cloud, devi:

  • Abilita SAML su Edge. La nuova esperienza Edge supporta solo SAML come meccanismo di autenticazione.
  • Installa la nuova esperienza Edge sul proprio nodo. Non puoi installarlo su un nodo che contiene altri componenti Edge, incluso il nodo su cui si trova la UI Edge esistente. In questo modo, gli utenti non potranno accedere alla UI di Edge Classic.

Per saperne di più sulla nuova esperienza Edge, consulta La nuova esperienza Edge per cloud privato.

Panoramica dell'installazione

Per installare la nuova esperienza Edge per Edge for Private Cloud, devi eseguire due diversi processi di installazione:

  • Installa la UI Edge di base, chiamata shoehorn, e configurala per utilizzare SAML per l'autenticazione con Edge.
  • Installa la nuova esperienza Edge e configurala in modo che utilizzi SAML per l'autenticazione con Edge. Dopo aver installato la nuova esperienza Edge, puoi accedere e utilizzarla per lavorare con Edge.

Prerequisiti per l'installazione

  • Devi abilitare SAML su Edge prima di installare la nuova esperienza Edge. La nuova esperienza Edge supporta solo SAML come meccanismo di autenticazione.

    Per informazioni sull'attivazione di SAML su Edge, consulta Supporto di SAML su Edge for Private Cloud.

  • La nuova esperienza Edge supporta solo TLS v1.2. Poiché ti connetti all'IDP SAML tramite TLS, l'IDP SAML deve supportare TLS v1.2.

  • Devi installare la nuova esperienza Edge sul proprio nodo. Non puoi installarlo su un nodo che contiene altri componenti Edge, incluso il nodo su cui si trova la UI Edge esistente.

    Il nodo deve soddisfare i seguenti requisiti:

    • JAVA 1.8
    • 4 GB di RAM
    • 2 core
    • 60 GB di spazio su disco
    • Devi prima installare la versione 4.19.01 dell'utilità apigee-setup sul nodo, come descritto in Installa l'utilità apigee-setup di Edge.
    • La porta 3001 deve essere aperta. Questa è la porta predefinita utilizzata per le richieste alla nuova esperienza Edge. Se modifichi la porta utilizzando le proprietà descritte di seguito, assicurati che sia aperta.

Considerazioni prima di installare la nuova esperienza Edge

Come descritto sopra nei prerequisiti, la nuova esperienza Edge richiede l'abilitazione di SAML su Edge. Ciò significa che l'autenticazione degli utenti è controllata da un IDP SAML, in cui configuri l'IDP SAML in modo che utilizzi gli indirizzi email come ID utente. Tutti gli utenti della nuova esperienza Edge devono quindi essere registrati nell'IDP SAML.

La UI classica di Edge, ovvero la UI predefinita che hai installato con Edge for Private Cloud, non richiede SAML. Può utilizzare l'autenticazione SAML o di base. Ciò significa che puoi:

  • Attiva il supporto di SAML su Edge e sia sulla UI classica sia sulla nuova esperienza Edge.

    In questo scenario, tutti gli utenti della UI classica e della nuova esperienza Edge sono registrati nell'IDP SAML. Per informazioni sull'aggiunta di nuovi utenti all'IDP SAML, consulta Registra nuovi utenti Edge.

  • Attiva il supporto SAML su Edge, ma lascia attiva l'autenticazione di base. La nuova esperienza Edge utilizza SAML e la UI classica utilizza ancora l'autenticazione di base.

    In questo scenario, tutti gli utenti della UI classica accedono con credenziali di autenticazione di base, dove le credenziali sono archiviate nel database OpenLDAP di Edge. Gli utenti della nuova esperienza Edge sono registrati nell'IdP SAML e accedono utilizzando SAML.

    Tuttavia, un utente della UI classica non può accedere alla nuova esperienza Edge finché non lo aggiungi all'IdP SAML come descritto in Registra nuovi utenti Edge.

Modifiche alla configurazione dell'installazione rispetto alle release precedenti

Tieni presente le seguenti modifiche alla procedura di installazione della versione beta della nuova esperienza Edge.

Modifiche alla configurazione dell'installazione da Edge 4.18.05

La release Edge 4.19.01 della nuova esperienza Edge contiene le seguenti modifiche al file di configurazione della release Edge 4.18.05:

Tipo di modifica Proprietà interessate
Rimosso 
MANAGEMENT_UI_SSO_PUBLIC_KEY_CACHE_HOURS

Questa proprietà ha un valore predefinito di 0,5 (30 minuti) e non può essere modificata.
Aggiunta Ora puoi utilizzare le proprietà per attivare TLS nella nuova esperienza Edge. Per saperne di più, consulta Configurazione di TLS per la nuova esperienza Edge.

Modifiche alla configurazione dell'installazione da Edge 4.18.01

La release Edge 4.19.01 della nuova esperienza Edge contiene le seguenti modifiche al file di configurazione della release Edge 4.18.01:

Tipo di modifica Proprietà interessate
Aggiunta 
# 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
Rimosso 
ROUTES_SHOEHORN
ROUTES_CLASSICUI
Batteria sostituita 
MANAGEMENT_UI_USE_HTTPS
 Sostituito da: 
MANAGEMENT_UI_SCHEME

File di configurazione dell'installazione

Il file di configurazione contiene tutte le informazioni necessarie per installare e configurare la nuova esperienza Edge. Puoi utilizzare lo stesso file di configurazione per installare e configurare sia la UI di base sia la nuova esperienza Edge.

Di seguito è riportato un file di configurazione di esempio:

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

Installa la UI di Edge di base (shoehorn)

Prima di poter installare la nuova esperienza Edge, devi installare la UI Edge di base, chiamata shoehorn.

Per installare la UI di base:

  1. Installa la versione 4.19.01 dell'utilità apigee-setup sul nodo come descritto in Installa l'utilità apigee-setup di Edge.
  2. Pulisci Yum: 
    sudo yum clean all
  3. Crea il file di configurazione come descritto sopra e assicurati che sia di proprietà dell'utente "apigee": 
    chown apigee:apigee configFile

    dove configFile è il file di configurazione descritto sopra in File di configurazione dell'installazione.

  4. Modifica il valore della proprietà MANAGEMENT_UI_SSO_CSRF_SECRET nel file di configurazione in modo che corrisponda al tuo secret CSRF.
  5. Installa la versione Shoehorn della UI di Edge: 
    /opt/apigee/apigee-service/bin/apigee-service edge-ui install
  6. Configura la UI di Edge: 
    /opt/apigee/apigee-service/bin/apigee-service edge-ui setup -f configFile
  7. Abilita SAML nell'interfaccia utente di Edge: 
    /opt/apigee/apigee-service/bin/apigee-service edge-ui configure-sso -f configFile

Installa la nuova esperienza Edge

Dopo aver installato la UI di Edge di base, puoi installare e configurare la nuova esperienza Edge.

Per installare la nuova esperienza Edge:

  1. Installa la nuova esperienza Edge: 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui install
  2. Passa alla directory edge-management-ui: 
    cd /opt/apigee/edge-management-ui
  3. Configura la nuova esperienza Edge: 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui setup -f configFile

    dove configFile è il file di configurazione descritto sopra in File di configurazione dell'installazione.

  4. Attiva SAML nella nuova esperienza Edge: 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui configure-sso -f configFile
  5. Accedi alla nuova esperienza Edge aprendo il seguente URL in un browser: 
    http://newEdgeExperienceIP:3001

    dove newEdgeExperienceIP è l'indirizzo IP del nodo che ospita la nuova esperienza Edge. Ti verranno chieste le credenziali SAML. Dopo aver inserito le credenziali, viene visualizzata la nuova esperienza Edge.

  6. Per ulteriori informazioni, consulta La nuova esperienza Edge per cloud privato, inclusi i link per informazioni sull'utilizzo della nuova esperienza Edge.

Disinstalla la nuova esperienza Edge

Per disinstallare la nuova esperienza Edge:

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

Per disinstallare la UI Edge di base (shoehorn):

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

Per rimuovere completamente Edge dal nodo:

  1. Arresta tutti i servizi Edge 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