Menginstal UI Edge baru

Dokumen ini menjelaskan cara menginstal UI Edge untuk Apigee Edge untuk Private Cloud. UI Edge adalah antarmuka pembuatan UI untuk Edge.

Prasyarat

Untuk mencoba UI Edge baru di penginstalan Apigee Edge untuk Private Cloud, Anda harus:

• Instal UI Edge pada node-nya sendiri. Anda tidak dapat menginstalnya pada {i>node<i} yang berisi komponen Edge lainnya, termasuk simpul tempat UI Klasik yang sudah ada berada. Melakukan hal ini akan menyebabkan pengguna tidak dapat login ke UI Klasik.

  Node UI Edge harus memenuhi persyaratan berikut:

  • JAVA 1,8
  • RAM 4 GByte
  • 2 inti
  • Kapasitas disk 60 GB
  • Anda harus menginstal apigee-setup versi 4.52.00 terlebih dahulu pada node seperti yang dijelaskan di bagian Instal utilitas Edge apigee-setup.
  • Port 3001 harus terbuka. Ini adalah port default yang digunakan untuk permintaan ke UI Edge. Jika Anda mengubah porta dengan menggunakan properti yang dijelaskan di File konfigurasi UE baru, pastikan bahwa porta terbuka.
• Aktifkan IDP eksternal di Edge. UI Edge mendukung SAML atau LDAP sebagai mekanisme otentikasi.
• (Khusus IDP SAML) UI Edge hanya mendukung TLS v1.2. Karena Anda terhubung ke IDP SAML melalui TLS, jika Anda menggunakan SAML, IDP Anda harus mendukung TLS v1.2.

Untuk mengetahui informasi selengkapnya tentang UI Edge, lihat UI Edge baru untuk Private Cloud.

Ringkasan penginstalan

Pada level tinggi, proses penginstalan UI Edge untuk Apigee Edge untuk Private Cloud adalah sebagai berikut:

• Menambahkan node baru ke cluster Anda
• Login ke node baru
• Download utilitas apigee-setup
• Membuat file konfigurasi dan mengubahnya dengan setelan Anda
• Jalankan utilitas apigee-setup
• Login dan uji ke UE baru

Saat dieksekusi pada node baru, utilitas apigee-setup:

• Menginstal UI Klasik dasar, yang disebut shoehorn, dan mengonfigurasi UI Klasik untuk menggunakan IDP eksternal guna mengautentikasi dengan Edge.
• Menginstal UI Edge baru, dan mengonfigurasi UI Edge untuk menggunakan UI eksternal IDP untuk mengautentikasi dengan Edge.

Pertimbangan sebelum menginstal Edge baru UI

Seperti yang dijelaskan di atas dalam prasyarat, UI Edge mengharuskan Anda mengaktifkan IDP eksternal di Edge. Itu berarti otentikasi pengguna dikendalikan oleh IDP, di mana Anda mengkonfigurasi menggunakan alamat email sebagai ID pengguna. Semua pengguna UI Edge harus yang terdaftar di IDP.

UI Klasik, UI default yang Anda instal dengan Apigee Edge untuk Private Cloud, tidak memerlukan IDP. Autentikasi ini dapat menggunakan IDP atau Autentikasi dasar. Artinya, Anda dapat:

• Aktifkan dukungan IDP eksternal di Edge serta di UI Klasik dan UI Edge.

  Dalam skenario ini, semua pengguna UI Klasik dan UI Edge terdaftar di IDP. Sebagai informasi tentang penambahan pengguna baru ke IDP, lihat Mendaftarkan pengguna Edge baru.

• Mengaktifkan dukungan IDP eksternal di Edge, tetapi tetap mengaktifkan Autentikasi dasar. UI Edge menggunakan IDP dan UI Klasik masih menggunakan autentikasi Dasar.

  Dalam skenario ini, semua pengguna UI Klasik masuk dengan kredensial otentikasi Dasar, di mana kredensial mereka disimpan di {i>database<i} Edge OpenLDAP. Pengguna UI Edge terdaftar di IDP dan masuk dengan menggunakan SAML atau LDAP.

  Namun, pengguna UI Klasik tidak dapat masuk ke UI Edge sampai Anda menambahkannya pengguna tersebut ke IDP seperti yang dijelaskan dalam Mendaftarkan Edge baru pengguna.

Perubahan konfigurasi penginstalan dari rilis sebelumnya

Perhatikan perubahan prosedur penginstalan berikut dari rilis Beta UI Edge.

MANAGEMENT_UI_SSO_PUBLIC_KEY_CACHE_HOURS

# Shoehorn/Classic 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

ROUTES_SHOEHORN
ROUTES_CLASSICUI

MANAGEMENT_UI_USE_HTTPS

MANAGEMENT_UI_SCHEME

File konfigurasi UI Edge baru

File konfigurasi berikut berisi semua informasi yang diperlukan untuk menginstal dan mengonfigurasi UI Edge baru. Anda bisa menggunakan file konfigurasi yang sama untuk menginstal dan mengonfigurasi keduanya UI shoehorn/Klasik dan 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

# Enable TLS on the Edge UI.
MANAGEMENT_UI_SCHEME=https

# 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

# CSRF configuration.
MANAGEMENT_UI_SSO_CSRF_SECRET=YOUR_CSRF_SECRET
MANAGEMENT_UI_SSO_CSRF_EXPIRATION_HOURS=24

# Strict Transport Security configuration.
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 be deleted and a 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"

Menginstal UI Edge

Setelah membuat dan memodifikasi file konfigurasi, Anda bisa menginstal UI Edge baru pada node baru.

Untuk menginstal UI Edge:

1. Tambahkan node baru ke cluster Anda.
2. Login ke node baru sebagai administrator.
3. Instal utilitas apigee-setup versi 4.52.00 pada node. seperti yang dijelaskan di Menginstal penyiapan apigee Edge utilitas.
4. Bersihkan semua informasi yang di-cache dengan Yum dengan menjalankan perintah berikut:

   sudo yum clean all

5. Buat file konfigurasi seperti yang dijelaskan dalam New File konfigurasi UI Edge dan pastikan file tersebut dimiliki oleh "apigee" pengguna:

   chown apigee:apigee configFile

   Pastikan Anda melakukan pengeditan berikut pada file konfigurasi:

   • Ubah nilai properti MANAGEMENT_UI_SSO_CSRF_SECRET di file konfigurasi ke secret CSRF Anda.
   • Konfigurasikan Edge untuk menggunakan salah satu fitur berikut (UI Edge baru memerlukan IDP eksternal):
     • SAML
     • LDAP

     Untuk informasi selengkapnya, lihat Ringkasan IDP eksternal autentikasi.

6. Konfigurasikan IDP eksternal Anda dengan pengguna yang Anda inginkan memiliki akses ke UI Edge. Sebagai informasi selengkapnya, lihat Mendaftarkan pengguna Edge baru.
7. Pada node baru, jalankan perintah berikut:

   /opt/apigee/apigee-setup/bin/setup.sh -p ue -f configFile

   Utilitas apigee-setup menginstal UI Klasik. Selain UI Klasik, {i>installer<i} kemudian menginstal UI Edge.

8. Login ke UI Edge dengan membuka URL berikut di browser:

   http://new_edge_UI_IP:3001

   Dengan new_edge_UI_IP adalah alamat IP node yang menghosting Edge baru UI.

   Edge meminta kredensial IDP eksternal Anda.

9. Masukkan kredensial Anda.

   UI Edge baru akan muncul. Untuk informasi tentang penggunaan UI Edge, lihat UI Edge baru untuk Private Cloud.

   Jika UI Edge tidak ditampilkan, pastikan port 3001 terbuka untuk koneksi eksternal.

Meng-uninstal UI baru

Untuk meng-uninstal UI baru dari node-nya, Anda harus meng-uninstal UI Edge yang baru dan UI Klasik dasar (shoehorn) yang diinstal pada node selama penginstalan UI {i>checkout<i}.

Untuk meng-uninstal UI Edge baru:

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

Untuk meng-uninstal UI Klasik dasar (shoehorn):

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

Untuk menghapus semua komponen Edge dari node:

1. Hentikan semua layanan Edge yang berjalan di komputer:

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

2. Hapus cache yum:

   sudo yum clean all

3. Hapus semua RPM Apigee:

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

4. Hapus direktori utama penginstalan:

   sudo rm -rf /opt/apigee