Menginstal Pengalaman Edge Baru (Beta)

Edge for Private Cloud v4.18.05

Dokumen ini menjelaskan cara menginstal rilis Beta pengalaman New Edge untuk Edge for Private Cloud. Pengalaman New Edge adalah UI generasi berikutnya untuk Edge.

Untuk mencoba pengalaman New Edge dalam penginstalan Edge for Private Cloud, Anda harus:

  • Mengaktifkan SAML di Edge. Pengalaman New Edge hanya mendukung SAML sebagai mekanisme autentikasi.
  • Instal pengalaman New Edge di node-nya sendiri. Anda tidak dapat menginstalnya di node yang berisi komponen Edge lainnya.

Untuk mengetahui informasi selengkapnya tentang pengalaman New Edge, lihat Pengalaman New Edge untuk Cloud Pribadi.

Ringkasan penginstalan

Untuk menginstal versi Beta pengalaman New Edge untuk Edge for Private Cloud, Anda melakukan dua proses penginstalan yang berbeda:

  • Instal UI Edge dasar, yang disebut shoehorn, dan konfigurasikan UI Edge dasar untuk menggunakan SAML guna melakukan autentikasi dengan Edge.
  • Instal pengalaman New Edge, dan konfigurasikan pengalaman New Edge untuk menggunakan SAML guna melakukan autentikasi dengan Edge. Setelah menginstal pengalaman New Edge, Anda dapat login dan menggunakannya untuk bekerja dengan Edge.

Prasyarat penginstalan

  • Anda harus mengaktifkan SAML di Edge sebelum menginstal pengalaman New Edge. Pengalaman New Edge hanya mendukung SAML sebagai mekanisme autentikasinya.

    Untuk mengetahui informasi tentang cara mengaktifkan SAML di Edge, lihat Mendukung SAML di Edge untuk Private Cloud.

  • Anda harus menginstal pengalaman New Edge di nodenya sendiri. Anda tidak dapat menginstalnya di node yang berisi komponen Edge lainnya. Node harus memenuhi persyaratan berikut:
    • JAVA 1.8
    • RAM 4 GB
    • 2-core
    • Kapasitas disk 60 GB
    • Anda harus menginstal utilitas apigee-setup versi 4.18.05 terlebih dahulu di node seperti yang dijelaskan di Menginstal utilitas apigee-setup Edge.

Pertimbangan sebelum menginstal pengalaman New Edge

Seperti yang dijelaskan di atas dalam prasyarat, pengalaman New Edge mengharuskan Anda mengaktifkan SAML di Edge. Artinya, autentikasi pengguna dikontrol oleh IDP SAML, tempat Anda mengonfigurasi IDP SAML untuk menggunakan alamat email sebagai ID pengguna. Oleh karena itu, semua pengguna pengalaman New Edge harus terdaftar di IDP SAML.

UI klasik Edge, UI default yang Anda instal dengan Edge untuk cloud pribadi, tidak memerlukan SAML. Sistem ini dapat menggunakan SAML atau autentikasi dasar. Artinya, Anda dapat:

  • Mengaktifkan dukungan SAML di Edge serta di UI klasik dan pengalaman New Edge.

    Dalam skenario ini, semua pengguna UI klasik dan pengalaman New Edge terdaftar di IDP SAML. Untuk mengetahui informasi tentang cara menambahkan pengguna baru ke IDP SAML, lihat Mendaftarkan pengguna Edge baru.

  • Aktifkan dukungan SAML di Edge, tetapi biarkan autentikasi dasar diaktifkan. Pengalaman New Edge menggunakan SAML dan UI klasik masih menggunakan autentikasi dasar.

    Dalam skenario ini, semua pengguna UI klasik login dengan kredensial autentikasi dasar, dengan kredensial mereka disimpan di database OpenLDAP Edge. Pengguna pengalaman New Edge terdaftar di IDP SAML dan login menggunakan SAML.

    Namun, pengguna UI klasik tidak dapat login ke pengalaman New Edge hingga Anda menambahkan pengguna tersebut ke IDP SAML seperti yang dijelaskan dalam Mendaftarkan pengguna Edge baru.

Perubahan konfigurasi penginstalan dari Edge 4.18.01

Rilis Edge 4.18.05 dari pengalaman New Edge berisi perubahan berikut pada file konfigurasi dari rilis Edge 4.18.01. Properti ini dijelaskan secara mendetail di bagian berikut:

Jenis perubahan Properti yang terpengaruh
Ditambahkan 
# 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
Dihapus 
ROUTES_SHOEHORN
ROUTES_CLASSICUI
Diganti 
MANAGEMENT_UI_USE_HTTPS
 Digantikan oleh: 
MANAGEMENT_UI_SCHEME

File konfigurasi penginstalan

File konfigurasi berisi semua informasi yang diperlukan untuk menginstal dan mengonfigurasi pengalaman New Edge. Anda dapat menggunakan file konfigurasi yang sama untuk menginstal dan mengonfigurasi UI dasar dan pengalaman New Edge.

Contoh file konfigurasi ditampilkan di bawah:

# 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.
# This release does not support TLS.
MANAGEMENT_UI_SCHEME=http

# Location of New Edge experience.
MANAGEMENT_UI_PUBLIC_URIS=http://$IP2:3001
MANAGEMENT_UI_SSO_REGISTERED_PUBLIC_URIS=$MANAGEMENT_UI_PUBLIC_URIS
MANAGEMENT_UI_SSO_CSRF_SECRET=secret222
MANAGEMENT_UI_SSO_CSRF_EXPIRATION_HOURS=24
MANAGEMENT_UI_SSO_STRICT_TRANSPORT_SECURITY_AGE_HOURS=24
MANAGEMENT_UI_SSO_PUBLIC_KEY_CACHE_HOURS=0.5

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

# The first two properties use the same values as the New Edge experience.
SHOEHORN_SCHEME=$MANAGEMENT_UI_SCHEME
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"

Menginstal UI Edge dasar (shoehorn)

Anda harus menginstal UI Edge dasar, yang disebut shoehorn, sebelum dapat menginstal pengalaman New Edge.

Untuk menginstal UI dasar:

  1. Instal utilitas apigee-setup versi 4.18.05 pada node seperti yang dijelaskan di Menginstal utilitas apigee-setup Edge.
  2. Membersihkan Yum: 
    sudo yum clean all
  3. Buat file konfigurasi seperti yang dijelaskan di atas dan pastikan file tersebut dimiliki oleh pengguna "apigee": 
    chown apigee:apigee configFile

    dengan configFile sebagai file konfigurasi yang dijelaskan di atas dalam File konfigurasi penginstalan.

  4. Instal UI Edge versi Shoehorn: 
    /opt/apigee/apigee-service/bin/apigee-service edge-ui install
  5. Konfigurasikan Edge UI: 
    /opt/apigee/apigee-service/bin/apigee-service edge-ui setup -f configFile
  6. Aktifkan SAML di Edge UI: 
    /opt/apigee/apigee-service/bin/apigee-service edge-ui configure-sso -f configFile

Menginstal pengalaman New Edge

Setelah menginstal UI Edge dasar, Anda dapat menginstal dan mengonfigurasi pengalaman New Edge.

Untuk menginstal pengalaman New Edge:

  1. Menginstal pengalaman New Edge: 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui install
  2. Ubah ke direktori edge-management-ui: 
    cd /opt/apigee/edge-management-ui
  3. Konfigurasikan pengalaman New Edge: 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui setup -f configFile

    dengan configFile sebagai file konfigurasi yang dijelaskan di atas dalam File konfigurasi penginstalan.

  4. Aktifkan SAML di pengalaman New Edge: 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui configure-sso -f configFile
  5. Login ke pengalaman New Edge dengan membuka URL berikut di browser: 
    http://newEdgeExperienceIP:3001

    dengan newEdgeExperienceIP adalah alamat IP node yang menghosting pengalaman New Edge. Anda akan diminta memasukkan kredensial SAML Anda. Setelah memasukkan kredensial, pengalaman New Edge akan muncul.

  6. Lihat Pengalaman New Edge untuk cloud pribadi (Beta) untuk mengetahui informasi selengkapnya, termasuk link untuk informasi tentang penggunaan pengalaman New Edge.

Meng-uninstal pengalaman New Edge

Untuk meng-uninstal pengalaman New Edge:

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

Untuk meng-uninstal Edge UI dasar (shoehorn):

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

Untuk menghapus Edge sepenuhnya dari node:

  1. Hentikan semua layanan Edge yang berjalan di mesin: 
    /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 root penginstalan: 
    sudo rm -rf /opt/apigee