Configure the New Edge UI

This document describes how to install and configure the New Edge UI for Apigee Edge for Private Cloud. In version 4.54.00, the New Edge UI consists of two RPM components:

edge-management-ui: The New Edge UI backend server.
edge-management-ui-static: The static web assets for the New Edge UI frontend.

The New Edge UI is installed by default when you run setup.sh with the aio (all-in-one), sa (standalone), or ms (Management Server) profile, or can be installed independently on a node using the ue profile.

Prerequisites

Before installing or configuring the New Edge UI in an Apigee Edge for Private Cloud installation, ensure the node meets the following requirements:

Hardware and OS requirements:
- 4 GB of RAM
- 2 CPU cores
- 60 GB disk space
- The 4.54.00 version of the apigee-setup utility installed on the node as described at Install the Edge apigee-setup utility.
- Port 3001 must be open. This is the default port used for requests to the New Edge UI. If you change the port by using the properties described in New Edge UI configuration file, make sure that port is open.
Authentication:
- Basic authentication (default): Enabled by default (AUTH_MODE=basic). Uses the Edge Management Server and SymasLDAP credentials without requiring an external Identity Provider (IDP).
- SSO / external IDP (optional): You can optionally configure Apigee SSO or an external IDP (such as SAML or OIDC). If you connect to an external IDP over TLS, your IDP must support TLS v1.2 or higher.

For more information on New Edge UI features, see The New Edge UI for Private Cloud.

Installation and configuration overview

At a high level, the process for installing or reconfiguring the New Edge UI using the ue profile is as follows:

Ensure the apigee-setup utility is installed on the node.
Create a silent configuration file and modify it with your settings.
Run /opt/apigee/apigee-setup/bin/setup.sh -p ue -f configFile. This installs and configures both edge-management-ui and edge-management-ui-static.
Log in and test the New Edge UI at http://new_edge_UI_IP:3001.

If your Management Server and New Edge UI server are behind a load balancer with TLS offloading happening at the load balancer, ensure the configuration reflects the properties highlighted in Configure the New Edge UI when TLS terminates on the load balancer.

New Edge UI configuration file

The following example shows a configuration file for installing and configuring the New Edge UI with default Basic authentication.

Basic authentication configuration (default)

# IP of the Edge Management Server.
IP1=management_server_IP

# IP of the New Edge UI node (can be the same as IP1 or a separate node).
IP2=new_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

#
# New Edge UI configuration.
#
MANAGEMENT_UI_PORT=3001
MANAGEMENT_UI_IP=$IP2
MANAGEMENT_UI_APP_ENV=OPDK
MANAGEMENT_UI_SCHEME=http
MANAGEMENT_UI_PUBLIC_URIS=$MANAGEMENT_UI_SCHEME://$MANAGEMENT_UI_IP:$MANAGEMENT_UI_PORT

# Authentication mode (basic is default)
AUTH_MODE=basic

## SMTP Configuration
SKIP_SMTP=n       # Skip now and configure later by specifying "y".
SMTPHOST=smtp.example.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>"

Install or configure the New Edge UI

To install or configure the New Edge UI using the ue profile:

Log in to the target node as an administrator.
Install the 4.54.00 version of the apigee-setup utility on the node, as described at Install the Edge apigee-setup utility.
Clean all cached information with Yum by running the following command:
```
sudo yum clean all
```
Create the configuration file as described in New Edge UI configuration file and ensure that it is owned by the "apigee" user:
```
chown apigee:apigee configFile
```
On the node, run the following command:
```
/opt/apigee/apigee-setup/bin/setup.sh -p ue -f configFile
```
The apigee-setup utility installs and configures edge-management-ui and edge-management-ui-static.

Note: If you follow Configure the New Edge UI when TLS terminates on the load balancer to enable TLS offloading, ensure that you also run Step 2 (configure-ssl) in that section.
Log in to the New Edge UI by opening the following URL in a browser:
```
http://new_edge_UI_IP:3001
```
Where new_edge_UI_IP is the IP address or hostname of the node hosting the New Edge UI.
Enter your credentials.
The New Edge UI appears. For information on using the New Edge UI, see The New Edge UI for Private Cloud.

If the New Edge UI does not display, ensure that port 3001 is open for connections.

Optional: If you want to configure Apigee SSO for authentication, follow the steps in Install and configure Apigee SSO and Enable an external IDP on the New Edge UI.

Uninstall the New Edge UI

To uninstall the New Edge UI from a node, uninstall both the edge-management-ui and edge-management-ui-static components.

To uninstall the New Edge UI components:

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

To remove all Edge components from the node:

Stop all Edge services running on the machine:

/opt/apigee/apigee-service/bin/apigee-all stop

Clear the yum cache:
```
sudo yum clean all
```

Remove all the Apigee RPMs:

sudo rpm -e $(rpm -qa | egrep "(apigee-|edge-)")

Remove the installation root directory:
```
sudo rm -rf /opt/apigee
```