Migrazione delle proprietà della UI classica alla nuova UI Edge

In Apigee Edge for Private Cloud 4.54.00, la UI classica (il componente edge-ui) viene rimossa e non è più disponibile. La nuova UI di Edge (il componente edge-management-ui) è l'unica UI per Edge for Private Cloud.

Non puoi utilizzare edge-ui in Edge for Private Cloud 4.54.00. Se hai personalizzato la UI classica impostando le proprietà in /opt/apigee/customer/application/ui.properties, la nuova UI di Edge non legge questo file. Dopo l'aggiornamento alla versione 4.54.00, devi impostare le proprietà equivalenti in /opt/apigee/customer/application/management-ui.properties.

Questa pagina elenca le proprietà della UI classica documentate per ui.properties, le proprietà equivalenti per la nuova UI Edge e le proprietà della UI classica non supportate nella nuova UI Edge.

La nuova UI di Edge utilizza lo stesso meccanismo di codice con configurazione (CwC) degli altri componenti Edge. Per saperne di più, consulta Come configurare Edge.

Confrontare le configurazioni dell'interfaccia utente classica e della nuova interfaccia utente Edge

La nuova UI Edge sostituisce il componente, il file delle proprietà, il nome del servizio, la porta predefinita e il formato del certificato TLS della UI classica. Consulta la tabella seguente per aggiornare gli script di automazione, le regole firewall e i file TLS prima di eseguire la migrazione delle proprietà:

Impostazione UI classica (4.53.01 e precedenti) Nuova UI di Edge (4.54.00)
Nome componente edge-ui edge-management-ui
File delle proprietà /opt/apigee/customer/application/ui.properties /opt/apigee/customer/application/management-ui.properties
Comando di riavvio apigee-service edge-ui restart apigee-service edge-management-ui restart
Porta predefinita 9000 3001
Configurazione TLS File dell'archivio chiavi Java (JKS) File di certificati e chiavi PEM. Consulta Configura TLS per la nuova UI di Edge.

Impostare le proprietà per la nuova UI Edge

Imposta le proprietà di configurazione della nuova UI Edge in /opt/apigee/customer/application/management-ui.properties e riavvia il servizio edge-management-ui in modo che le modifiche vengano applicate.

Per impostare una proprietà per la nuova UI di Edge:

  1. Apri il file management-ui.properties in un editor. Se il file non esiste, crealo: 
    vi /opt/apigee/customer/application/management-ui.properties
  2. Imposta la proprietà. Ad esempio: 
    conf_uebe_disableGeoMap=true
  3. Salva le modifiche.
  4. Assicurati che il file sia di proprietà dell'utente apigee: 
    chown apigee:apigee /opt/apigee/customer/application/management-ui.properties
  5. Riavvia la nuova UI di Edge: 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui restart

Segui queste regole di formattazione quando imposti le proprietà per la nuova UI Edge:

  • I nomi delle proprietà sono sensibili alle maiuscole. Ad esempio, conf_uebe_disableGeoMap è valido, ma conf_uebe_disablegeomap non lo è.
  • Racchiudi i valori di stringa tra virgolette doppie, ad esempio conf_uebe_branding_companyNameShort="My Company".
  • Non racchiudere i valori booleani (true o false) o i valori numerici tra virgolette. Se un valore booleano o numerico è racchiuso tra virgolette, la nuova UI di Edge non si avvia.

Per controllare il valore corrente di una proprietà, utilizza l'opzione -search. Ad esempio:

/opt/apigee/apigee-service/bin/apigee-service edge-management-ui \
  configure -search conf_uebe_disableGeoMap

Mappa le proprietà della UI classica alla nuova UI di Edge

Le tabelle seguenti mappano ogni proprietà dell'UI classica supportata in ui.properties alla proprietà equivalente della nuova UI Edge in management-ui.properties. La colonna Predefinito mostra il valore predefinito nella nuova UI di Edge.

Configura le proprietà delle caratteristiche

Mappa i flag di funzionalità della UI classica alle proprietà conf_uebe_* corrispondenti in management-ui.properties:

Proprietà UI classica Nuova proprietà dell'interfaccia utente di Edge Predefinito Note
conf_apigee_apigee.feature.disablegeomap conf_uebe_disableGeoMap false Imposta su true per nascondere le cartine geografiche. Nella UI classica di Edge for Private Cloud, le cartine geografiche erano disabilitate per impostazione predefinita. Se non hai attivato l'aggregazione geografica, imposta questa proprietà su true. Consulta Abilitazione dell'aggregazione geografica e delle cartine geografiche.
conf_apigee_apigee.feature.disablepasswordreset conf_uebe_disablePasswordReset false Imposta true per nascondere il link Reimposta password nella pagina di accesso.
conf_apigee-base_apigee.feature.enableforcerangelimit conf_uebe_enableForceRangeLimit true Imposta false per consentire report personalizzati per un intervallo di date superiore a 14 giorni.
conf_apigee-base_apigee.feature.enabletraceforinternaladdresses conf_uebe_trace_for_internal_addresses false Imposta su true per consentire allo strumento Trace di inviare richieste a indirizzi IP locali o interni.
conf_apigee-base_apigee.feature.enableopenapiforinternaladdresses conf_uebe_openapi_for_internal_addresses false Imposta true per consentire l'importazione delle specifiche OpenAPI da indirizzi IP locali o interni.
conf_apigee-base_apigee.feature.enablewsdlforinternaladdresses conf_uebe_wsdl_for_internal_addresses false Imposta su true per consentire l'importazione di file WSDL da indirizzi IP locali o IP interni.

Configurare le proprietà della sessione e di TLS

Mappa le proprietà di timeout della sessione e TLS della UI classica ai relativi equivalenti della nuova UI Edge in management-ui.properties:

Proprietà UI classica Nuova proprietà dell'interfaccia utente di Edge Predefinito Note
conf_application_session.maxage conf_uebe_authsessiontimeout 12 (ore) Tempo dopo il quale una sessione utente scade dopo l'accesso. Specifica un numero di ore (ad esempio, 12 o 0.5) o una durata con l'unità h (ore) o m (minuti) (ad esempio, 24h o 90m). I valori 12 e 12h sono equivalenti. L'unità d (giorni) non è supportata; ad esempio, sostituisci 1d con 24h. Se il valore non è valido, viene utilizzato il valore predefinito di 12 ore e non viene segnalato alcun errore. Si applica alle sessioni che utilizzano l'autenticazione di base.
conf_application_session.secure Nessuno richiesto Non applicabile La nuova UI Edge imposta automaticamente il flag Secure sui cookie di sessione quando TLS è abilitato (conf_uebe_usehttps=true) o quando la terminazione TLS avviene su un bilanciatore del carico (conf_uebe_tlsoffload=true).
conf/application.conf+trustxforwarded conf_uebe_usehttps=true e conf_uebe_tlsoffload=true false Imposta entrambe le proprietà quando la terminazione TLS avviene su un bilanciatore del carico. Il bilanciatore del carico deve inoltrare le richieste alla nuova UI Edge tramite HTTP e impostare l'intestazione X-Forwarded-Proto. Il comando configure-ssl imposta queste proprietà quando MANAGEMENT_UI_SCHEME=https e MANAGEMENT_UI_TLS_OFFLOAD=y. Consulta Configurare TLS per la nuova UI Edge.
conf/application.conf+play.ws.ssl.loose.acceptAnyCertificate conf_uebe_skipverify false Imposta il valore su true solo se il server di gestione utilizza un certificato autofirmato. Consulta Configurazione di TLS per l'API di gestione.

Configura proprietà e modelli email

Mappa le proprietà del mittente, dell'oggetto, del branding, dell'URL host e della scadenza del link delle email della UI classica alla nuova UI Edge:

Proprietà UI classica Nuova proprietà dell'interfaccia utente di Edge Predefinito Note
conf_apigee_apigee.mgmt.mailfrom conf_apigee_apigee.mgmt.mailfrom Apigee <sales@apigee.com> o il valore di SMTPMAILFROM specificato al momento dell'installazione Senza modifiche.
conf_apigee-base_apigee.emails.passwordreset.subject conf_apigee_apigee.emails.passwordReset.subject Password Reset Request Prendi nota del segmento di proprietà passwordReset in camel case.
conf_apigee-base_apigee.emails.useraddedexisting.subject conf_apigee_apigee.emails.userAddedExisting.subject You Have Been Added to an Organization {organization} Prendi nota del segmento di proprietà userAddedExisting in formato camelCase.
conf_apigee-base_apigee.emails.useraddednew.subject conf_apigee_apigee.emails.userAddedNew.subject An Account Has been Created for You at {companyNameShort} Prendi nota del segmento di proprietà userAddedNew in formato camelCase.
conf_apigee_apigee.branding.companynameshort conf_uebe_branding_companyNameShort Apigee Imposta il valore del segnaposto {companyNameShort} negli oggetti e nei modelli delle email.
conf_apigee_apigee.emails.hosturl conf_apigee_apigee.emails.hosturl Nessuno Senza modifiche. Se non impostati, i link di reimpostazione password utilizzano l'URL della nuova UI Edge specificato al momento dell'installazione, mentre i link di invito degli utenti utilizzano il nome host della richiesta. Imposta questa proprietà se gli utenti accedono alla nuova interfaccia utente Edge tramite un bilanciatore del carico o un nome DNS, ad esempio conf_apigee_apigee.emails.hosturl="https://ui.mycompany.com".
conf_apigee_apigee.forgotpassword.emaillinkexpiryseconds conf_apigee_apigee.forgotPassword.EmailLinkExpirySeconds 600 Si applica ai link per la reimpostazione della password e ai link di invito degli utenti.

La nuova UI di Edge utilizza modelli email integrati. Per utilizzare i modelli che hai personalizzato per la UI classica:

  1. Crea la directory /opt/apigee/edge-management-ui/email-templates.
  2. Copia i file password-reset.html, user-added-existing.html e user-added-new.html personalizzati dalla directory di backup che hai creato prima dell'aggiornamento (ad esempio, /opt/apigee/customer/backup/) a /opt/apigee/edge-management-ui/email-templates. I nomi file e i segnaposto dei modelli sono gli stessi della UI classica.
  3. Assicurati che la directory e i file siano di proprietà dell'utente apigee.
  4. Riavvia la nuova UI di Edge.

Per saperne di più, vedi Personalizzazione dei modelli di email Edge.

Configura le proprietà delle password generate automaticamente

Mappa le proprietà delle password generate automaticamente dalla UI classica alla nuova UI Edge:

Proprietà UI classica Nuova proprietà dell'interfaccia utente di Edge Predefinito
conf_apigee-base_apigee.forgotPassword.underscore.minimum conf_apigee_apigee.forgotPassword.underscore.minimum 0
conf_apigee-base_apigee.forgotPassword.specialchars.minimum conf_apigee_apigee.forgotPassword.specialchars.minimum 0
conf_apigee-base_apigee.forgotPassword.lowecase.minimum conf_apigee_apigee.forgotPassword.lowecase.minimum 0
conf_apigee-base_apigee.forgotPassword.uppercase.minimum conf_apigee_apigee.forgotPassword.uppercase.minimum 0

Configura la connessione al server di gestione e le proprietà del secret condiviso

Mappa le proprietà di connessione, credenziali e segreto dell'applicazione del server di gestione della UI classica alla nuova UI Edge:

Proprietà UI classica Nuova proprietà UI Edge Note
conf_apigee_apigee.mgmt.baseurl mgmt_baseurl URL dell'API di gestione, ad esempio https://FQ_domain_name:port/v1. Questo nome della proprietà non inizia con conf_. Se il server di gestione utilizza un certificato autofirmato, imposta anche conf_uebe_skipverify=true.
conf_apigee_apigee.mgmt.credential conf_uebe_mgmtCredential Credenziali sysadmin criptate. Devi criptare nuovamente le credenziali per la nuova UI Edge utilizzando ./bin/management-ui --encrypt; consulta Configurazione richiesta per credenziali sysadmin diverse.
conf_apigee_mail.smtp.credential conf_apigee_mail.smtp.credential Credenziali SMTP criptate.
conf_application_application.secret conf_uebe_applicationsecret Secret utilizzato per criptare le credenziali e i cookie di sessione. Generato al momento dell'installazione.

Rimuovi le proprietà dell'interfaccia utente classica che non richiedono alcuna azione

Le seguenti proprietà della UI classica non hanno un equivalente nella nuova UI di Edge perché il comportamento è sempre abilitato. Non includere queste proprietà in management-ui.properties (e rimuovile da eventuali script di configurazione automatica):

Proprietà UI classica Comportamento nella nuova UI di Edge
conf_apigee_apigee.feature.expireSessionCookiesInternally La scadenza della sessione viene sempre convalidata sul server.
conf_apigee_apigee.feature.trackSessionCookies Le informazioni sulla sessione vengono sempre archiviate nella memoria del server. Se utilizzi più istanze della nuova UI Edge dietro un bilanciatore del carico, configura il bilanciatore del carico in modo che utilizzi le sessioni fisse.

Rimuovi le proprietà dell'interfaccia utente classica non supportate

Le seguenti proprietà della UI classica non sono supportate e non hanno equivalenti nella nuova UI Edge. Non includere queste proprietà in management-ui.properties (e rimuovile da eventuali script di configurazione automatizzati):

Proprietà UI classica Descrizione
conf_apigee_apigee.feature.apitimeout, conf_apigee_play.ws.timeout.idle, conf_apigee_play.ws.timeout.connection Il timeout per le chiamate API di gestione non è configurabile nella nuova UI di Edge.
conf_application_http.proxyhost, conf_application_http.proxyport, conf_application_http.proxyuser, conf_application_http.proxypassword La nuova UI di Edge non supporta un proxy di inoltro per le richieste dello strumento Trace.
conf_apigee-base_apigee.feature.enableconsentbanner, conf_apigee-base_apigee.consentbanner.buttoncaption, conf_apigee-base_apigee.consentbanner.body Il banner del consenso non è supportato nella nuova UI di Edge.
conf_apigee-base_apigee.feature.apiproxypaginationenabled, conf_apigee-base_apigee.pagination.apiproxypaginationbatchsize Nella nuova UI di Edge, l'elenco dei proxy API viene sempre caricato nelle pagine. La dimensione della pagina non è configurabile.
conf_logger_settings_application_log_level, conf_logger_settings_play_log_level, conf_application_logger.application Il livello di log non è configurabile nella nuova UI di Edge. I file di log vengono scritti in /opt/apigee/var/log/edge-management-ui.
bin_setenv_min_mem, bin_setenv_max_mem, bin_setenv_meta_space_size, bin_setenv_ext_jvm_opts La nuova UI Edge non viene eseguita in una macchina virtuale Java. Le impostazioni della memoria Java non vengono applicate.

Esamina un esempio di migrazione

L'esempio seguente confronta un file ui.properties della UI classica con il file management-ui.properties equivalente per la nuova UI Edge.

UI classica, /opt/apigee/customer/application/ui.properties:

conf_apigee_apigee.feature.disablegeomap=false
conf_apigee-base_apigee.feature.enabletraceforinternaladdresses="true"
conf_application_session.maxage="1d"
conf_apigee-base_apigee.emails.passwordreset.subject="Reset your My Company password"
conf_apigee_apigee.branding.companynameshort="My Company"
conf_apigee_apigee.emails.hosturl="https://ui.mycompany.com"

Nuova UI Edge, /opt/apigee/customer/application/management-ui.properties:

conf_uebe_disableGeoMap=false
conf_uebe_trace_for_internal_addresses=true
conf_uebe_authsessiontimeout=24
conf_apigee_apigee.emails.passwordReset.subject="Reset your My Company password"
conf_uebe_branding_companyNameShort="My Company"
conf_apigee_apigee.emails.hosturl="https://ui.mycompany.com"

Tieni presente che il valore booleano true non è racchiuso tra virgolette e che il timeout della sessione 1d viene sostituito con 24.

Dopo aver salvato il file, riavvia la nuova UI Edge:

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

Elenco di controllo di riepilogo

Utilizza il seguente elenco di controllo per completare la migrazione alla nuova UI di Edge in Apigee Edge for Private Cloud 4.54.00:

  1. Esegui il backup di /opt/apigee/customer/application/ui.properties e di tutti i modelli di email personalizzati da /opt/apigee/edge-ui/email-templates prima di eseguire l'upgrade.
  2. Aggiungi le proprietà mappate a /opt/apigee/customer/application/management-ui.properties senza citare valori booleani o numerici e ometti le proprietà dell'interfaccia utente classica non supportate.
  3. Copia i modelli di email personalizzati dalla directory di backup in /opt/apigee/edge-management-ui/email-templates.
  4. Crittografa nuovamente le credenziali sysadmin con ./bin/management-ui --encrypt se imposti conf_uebe_mgmtCredential.
  5. Imposta la proprietà del file su apigee:apigee e riavvia edge-management-ui.