Migrate to the New Edge UI

Beginning with Apigee Edge for Private Cloud 4.54.00, the Classic UI (edge-ui) is removed and the New Edge UI (edge-management-ui) is the default management interface. This section provides guidance for migrating from the Classic UI to the New Edge UI, including deployments that use an IDP such as LDAP or SAML.

For more information, see:

Who can perform the migration

To migrate to the New Edge UI, you must be logged in as the user who originally installed Edge or as a root user. After you run the installer for the New Edge UI, any authorized user can configure it.

Before you begin

Before migrating from the Classic UI to the New Edge UI, read the following general guidelines:

  • Back up your existing Classic UI configuration

    Before you upgrade to 4.54.00, Apigee recommends that you back up your existing Classic UI configuration files so you can carry over custom settings (such as SMTP, TLS, session timeout, and branding properties) to /opt/apigee/customer/application/management-ui.properties.

  • Ports/firewalls

    By default, the Classic UI used port 9000. The New Edge UI uses port 3001 (configurable using conf_uebe_port).

  • Removing the Classic UI

    If you are installing the New Edge UI on a node that previously hosted the Classic UI, uninstall the Classic UI (edge-ui) before installing the New Edge UI (edge-management-ui).

  • Authentication (Basic authentication, LDAP, or SAML)

    In Edge for Private Cloud 4.54.00, the New Edge UI supports both Basic authentication (AUTH_MODE=basic) and external IDP authentication through Apigee SSO (AUTH_MODE=sso):

    • Basic authentication: Uses the internal OpenLDAP (apigee-openldap) implementation without requiring SSO.
    • LDAP IDP (using Apigee SSO): Uses either an external LDAP IDP or the internal OpenLDAP (apigee-openldap) implementation with Apigee SSO.
    • SAML IDP (using Apigee SSO): Uses an external SAML IDP with Apigee SSO.

    For more information, see Install and configure IDPs.

  • Same IDP

    This section assumes that you will use the same IDP after migration. For example, if you previously used an external LDAP IDP with the Classic UI, then you will continue to use an external LDAP IDP with the New Edge UI.

Migrate with an internal LDAP IDP

If you use the internal OpenLDAP (apigee-openldap) implementation, you can either use Basic authentication directly in the New Edge UI (see Configure the New Edge UI), or configure Apigee SSO with internal LDAP using the following guidelines:

Migrate with an external LDAP IDP

Use the following guidelines when migrating from the Classic UI to the New Edge UI in a configuration that uses an external LDAP implementation as an IDP:

  • LDAP configuration

    Configure Apigee SSO and the New Edge UI using Configure the New Edge UI, Install and configure Apigee SSO, and Configure your LDAP IDP.

  • Management Server configuration

    After you enable Apigee SSO, remove any legacy Classic UI external LDAP properties from the /opt/apigee/customer/application/management-server.properties file and restart the Management Server.

  • Basic authentication for the management API

    Basic authentication works for machine users but not external LDAP users. This is critical if your CI/CD process uses Basic authentication to access the system.

  • OAuth2 authentication for the management API

    External LDAP users access the management API using OAuth2 tokens.

Migrate with an external SAML IDP

When migrating to the New Edge UI, there are no changes to the installation instructions for a SAML IDP. See Configure your SAML IDP.