नया Edge यूज़र इंटरफ़ेस (यूआई) इंस्टॉल करें

इस दस्तावेज़ में, Apigee Edge for Private Cloud के लिए Edge यूज़र इंटरफ़ेस (यूआई) इंस्टॉल करने का तरीका बताया गया है. Edge UI, Edge के लिए अगली जनरेशन का यूज़र इंटरफ़ेस है.

ज़रूरी शर्तें

Apigee Edge for Private Cloud इंस्टॉलेशन में नए Edge यूज़र इंटरफ़ेस (यूआई) को आज़माने के लिए, आपको यह काम करना होगा:

• Edge UI को उसके नोड पर इंस्टॉल करें. इसे ऐसे नोड पर इंस्टॉल नहीं किया जा सकता जिसमें अन्य Edge कॉम्पोनेंट शामिल हों. इसमें वह नोड भी शामिल है जिस पर मौजूदा Classic UI मौजूद है. ऐसा करने से, उपयोगकर्ता क्लासिक यूज़र इंटरफ़ेस (यूआई) में लॉग इन नहीं कर पाएंगे.

  Edge UI के नोड को ये ज़रूरी शर्तें पूरी करनी होंगी:

  • JAVA 1.8
  • 4 जीबी रैम
  • दो कोर
  • डिस्क में 60 जीबी खाली जगह
  • आपको नोड पर apigee-setup यूटिलिटी का 4.53.01 वर्शन इंस्टॉल करना होगा. इसके लिए, Edge apigee-setup यूटिलिटी इंस्टॉल करें पर जाएं.
  • पोर्ट 3001 खुला होना चाहिए. यह Edge यूज़र इंटरफ़ेस (यूआई) को किए जाने वाले अनुरोधों के लिए इस्तेमाल किया जाने वाला डिफ़ॉल्ट पोर्ट है. अगर New UE configuration file में बताई गई प्रॉपर्टी का इस्तेमाल करके पोर्ट बदला जाता है, तो पक्का करें कि पोर्ट खुला हो.
• Edge पर किसी बाहरी IDP को चालू करें. Edge UI, पुष्टि करने के तरीके के तौर पर SAML या LDAP का इस्तेमाल करता है.
• (सिर्फ़ SAML आईडीपी के लिए) Edge UI सिर्फ़ TLS v1.2 के साथ काम करता है. एसएएमएल आईडीपी से टीएलएस के ज़रिए कनेक्ट किया जाता है. इसलिए, अगर एसएएमएल का इस्तेमाल किया जाता है, तो आपके आईडीपी को टीएलएस v1.2 के साथ काम करना चाहिए.

Edge यूज़र इंटरफ़ेस (यूआई) के बारे में ज़्यादा जानने के लिए, Private Cloud के लिए नया Edge यूज़र इंटरफ़ेस (यूआई) लेख पढ़ें.

इंस्टॉल करने के बारे में खास जानकारी

Apigee Edge for Private Cloud के लिए Edge यूज़र इंटरफ़ेस (यूआई) इंस्टॉल करने की प्रोसेस यहां दी गई है:

• अपने क्लस्टर में एक नया नोड जोड़ना
• नए नोड में लॉग इन करें
• apigee-setup यूटिलिटी डाउनलोड करें
• कॉन्फ़िगरेशन फ़ाइल बनाना और उसमें अपनी सेटिंग के हिसाब से बदलाव करना
• apigee-setup टूल को एक्ज़ीक्यूट करना
• लॉग इन करें और नए यूज़र एक्सपीरियंस को आज़माएं

नए नोड पर लागू होने पर, apigee-setup यूटिलिटी:

• यह कुकी, shoehorn नाम का बेसिक Classic UI इंस्टॉल करती है. साथ ही, यह Classic UI को कॉन्फ़िगर करती है, ताकि Edge के साथ पुष्टि करने के लिए बाहरी आईडीपी का इस्तेमाल किया जा सके.
• यह कुकी, नया Edge यूज़र इंटरफ़ेस (यूआई) इंस्टॉल करती है. साथ ही, Edge यूज़र इंटरफ़ेस (यूआई) को कॉन्फ़िगर करती है, ताकि Edge के साथ पुष्टि करने के लिए आपके बाहरी आईडीपी का इस्तेमाल किया जा सके.

Edge के नए यूज़र इंटरफ़ेस (यूआई) को इंस्टॉल करने से पहले ध्यान रखने वाली बातें

ज़रूरी शर्तों में ऊपर बताए गए तरीके के मुताबिक, Edge UI के लिए ज़रूरी है कि आपने Edge पर बाहरी आईडीपी चालू किया हो. इसका मतलब है कि उपयोगकर्ता की पुष्टि करने की प्रोसेस को आईडीपी कंट्रोल करता है. यहां आपको ईमेल पतों को उपयोगकर्ता आईडी के तौर पर इस्तेमाल करने के लिए, आईडीपी को कॉन्फ़िगर करना होता है. इसलिए, Edge UI के सभी उपयोगकर्ताओं को आईडीपी में रजिस्टर करना होगा.

Apigee Edge for Private Cloud के साथ इंस्टॉल किया गया डिफ़ॉल्ट यूज़र इंटरफ़ेस (यूआई), क्लासिक यूज़र इंटरफ़ेस (यूआई) है. इसके लिए, बाहरी आईडीपी की ज़रूरत नहीं होती. यह आईडीपी या सामान्य पुष्टि करने की सुविधा का इस्तेमाल कर सकता है. इसका मतलब है कि आपके पास इनमें से कोई एक विकल्प है:

• Edge पर और Classic UI और Edge UI, दोनों पर बाहरी आईडीपी की सुविधा चालू करें.

  इस स्थिति में, Classic UI और Edge UI का इस्तेमाल करने वाले सभी उपयोगकर्ता, आईडीपी में रजिस्टर होते हैं. आईडीपी में नए उपयोगकर्ताओं को जोड़ने के बारे में जानकारी पाने के लिए, नए Edge उपयोगकर्ताओं को रजिस्टर करना लेख पढ़ें.

• Edge पर बाहरी आईडीपी के साथ काम करने की सुविधा चालू करें. हालांकि, सामान्य पुष्टि करने की सुविधा चालू रखें. Edge यूज़र इंटरफ़ेस (यूआई), आईडीपी का इस्तेमाल करता है. वहीं, क्लासिक यूज़र इंटरफ़ेस (यूआई) अब भी सामान्य पुष्टि करने की सुविधा का इस्तेमाल करता है.

  इस स्थिति में, Classic UI का इस्तेमाल करने वाले सभी लोग, बुनियादी पुष्टि करने वाले क्रेडेंशियल से लॉग इन करते हैं. यहां उनके क्रेडेंशियल, Edge SymasLDAP डेटाबेस में सेव किए जाते हैं. Edge UI के उपयोगकर्ता, आईडीपी में रजिस्टर होते हैं. वे एसएएमएल या एलडीएपी का इस्तेमाल करके लॉग इन करते हैं.

  हालांकि, Classic UI का इस्तेमाल करने वाला कोई व्यक्ति, Edge UI में तब तक लॉग इन नहीं कर सकता, जब तक आपने उसे आईडीपी में नहीं जोड़ लिया हो. आईडीपी में उपयोगकर्ता को जोड़ने का तरीका, Edge के नए उपयोगकर्ताओं को रजिस्टर करना लेख में बताया गया है.

पिछली रिलीज़ के मुकाबले, इंस्टॉलेशन कॉन्फ़िगरेशन में हुए बदलाव

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

Edge के नए यूज़र इंटरफ़ेस (यूआई) की कॉन्फ़िगरेशन फ़ाइल

नीचे दी गई कॉन्फ़िगरेशन फ़ाइल में, नए Edge यूज़र इंटरफ़ेस (यूआई) को इंस्टॉल और कॉन्फ़िगर करने के लिए ज़रूरी सभी जानकारी मौजूद है. एक ही कॉन्फ़िगरेशन फ़ाइल का इस्तेमाल करके, शूहॉर्न/क्लासिक यूज़र इंटरफ़ेस (यूआई) और 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
# Disable TLS on the Edge UI.
MANAGEMENT_UI_SCHEME=http

# 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
MANAGEMENT_UI_SSO_CSRF_SECRET=YOUR_CSRF_SECRET
# Duration of CSRF token.
MANAGEMENT_UI_SSO_CSRF_EXPIRATION_HOURS=24
# Defaults to 8760 hours, or 365 days.
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 deleted and 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"

Edge UI इंस्टॉल करना

कॉन्फ़िगरेशन फ़ाइल बनाने और उसमें बदलाव करने के बाद, उस नए नोड पर नया Edge UI इंस्टॉल किया जा सकता है.

Edge यूज़र इंटरफ़ेस इंस्टॉल करने के लिए:

1. अपने क्लस्टर में एक नया नोड जोड़ें.
2. एडमिन के तौर पर नए नोड में लॉग इन करें.
3. नोड पर apigee-setup यूटिलिटी का 4.53.01 वर्शन इंस्टॉल करें. इसके लिए, Edge apigee-setup यूटिलिटी इंस्टॉल करना लेख में दिया गया तरीका अपनाएं.
4. Yum का इस्तेमाल करके, कैश मेमोरी में सेव की गई सभी जानकारी मिटाएं. इसके लिए, यह कमांड चलाएं:

   sudo yum clean all

5. नई Edge UI कॉन्फ़िगरेशन फ़ाइल में बताए गए तरीके से कॉन्फ़िगरेशन फ़ाइल बनाएं. साथ ही, पक्का करें कि इसका मालिकाना हक "apigee" उपयोगकर्ता के पास हो:

   chown apigee:apigee configFile

   पक्का करें कि आपने कॉन्फ़िगरेशन फ़ाइल में ये बदलाव किए हों:

   • कॉन्फ़िगरेशन फ़ाइल में मौजूद MANAGEMENT_UI_SSO_CSRF_SECRET प्रॉपर्टी की वैल्यू को अपने सीएसआरएफ़ सीक्रेट में बदलें.
   • Edge को इनमें से किसी एक का इस्तेमाल करने के लिए कॉन्फ़िगर करें. Edge के नए यूज़र इंटरफ़ेस (यूआई) के लिए, बाहरी आईडीपी की ज़रूरत होती है:
     • एसएएमएल
     • LDAP

     ज़्यादा जानकारी के लिए, बाहरी आईडीपी की मदद से पुष्टि करने के बारे में खास जानकारी देखें.

6. अपने बाहरी आईडीपी को उन उपयोगकर्ताओं के साथ कॉन्फ़िगर करें जिन्हें आपको Edge UI का ऐक्सेस देना है. ज़्यादा जानकारी के लिए, Edge के नए उपयोगकर्ताओं को रजिस्टर करना लेख पढ़ें.
7. नए नोड पर, यह कमांड चलाएं:

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

   apigee-setup यूटिलिटी, क्लासिक यूज़र इंटरफ़ेस (यूआई) इंस्टॉल करती है. इसके बाद, इंस्टॉलर Edge UI को Classic UI के ऊपर इंस्टॉल करता है.

8. किसी ब्राउज़र में यह यूआरएल खोलकर, Edge UI में लॉग इन करें:

   http://new_edge_UI_IP:3001

   यहां new_edge_UI_IP, नए Edge यूज़र इंटरफ़ेस (यूआई) को होस्ट करने वाले नोड का आईपी पता है.

   Edge आपसे बाहरी आईडीपी के क्रेडेंशियल मांगेगा.

9. अपने क्रेडेंशियल डालें.

   Edge का नया यूज़र इंटरफ़ेस (यूआई) दिखता है. Edge यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करने के बारे में जानकारी पाने के लिए, Private Cloud के लिए नया Edge यूज़र इंटरफ़ेस (यूआई) लेख पढ़ें.

   अगर Edge यूज़र इंटरफ़ेस (यूआई) नहीं दिखता है, तो पक्का करें कि बाहरी कनेक्शन के लिए पोर्ट 3001 खुला हो.

नए यूज़र इंटरफ़ेस (यूआई) को अनइंस्टॉल करना

नोड से नए यूज़र इंटरफ़ेस (यूआई) को अनइंस्टॉल करने के लिए, आपको नए Edge यूज़र इंटरफ़ेस (यूआई) और यूज़र इंटरफ़ेस (यूआई) को इंस्टॉल करने की प्रोसेस के दौरान नोड पर इंस्टॉल किए गए बेस क्लासिक यूज़र इंटरफ़ेस (यूआई) (shoehorn) को अनइंस्टॉल करना होगा.

Edge के नए यूज़र इंटरफ़ेस (यूआई) को अनइंस्टॉल करने के लिए:

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

बेसिक Classic UI (shoehorn) को अनइंस्टॉल करने के लिए:

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

नोड से सभी Edge कॉम्पोनेंट हटाने के लिए:

1. मशीन पर चल रही सभी Edge सेवाओं को बंद करें:

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

2. yum की कैश मेमोरी मिटाएं:

   sudo yum clean all

3. Apigee के सभी RPM हटाएं:

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

4. इंस्टॉलेशन की रूट डायरेक्ट्री हटाएं:

   sudo rm -rf /opt/apigee