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

इस दस्तावेज़ में प्राइवेट क्लाउड के लिए Apigee Edge के लिए Edge यूज़र इंटरफ़ेस (यूआई) इंस्टॉल करने का तरीका बताया गया है. Edge यूज़र इंटरफ़ेस (यूआई), Edge के लिए अगली-पीढ़ी की टेक्नोलॉजी वाला यूआई है.

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

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

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

    Edge यूज़र इंटरफ़ेस (यूआई) का नोड इन ज़रूरतों को पूरा करता है:

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

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

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

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

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

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

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

नया Edge यूआई इंस्टॉल करने से पहले ध्यान देने वाली बातें

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

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

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

    इस स्थिति में, क्लासिक यूज़र इंटरफ़ेस (यूआई) और एज यूज़र इंटरफ़ेस (यूआई) के सभी उपयोगकर्ता, आईडीपी (IdP) में रजिस्टर होते हैं. आईडीपी में नए उपयोगकर्ता जोड़ने के बारे में जानकारी के लिए, Edge के नए उपयोगकर्ताओं को रजिस्टर करना देखें.

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

    इस स्थिति में, क्लासिक यूज़र इंटरफ़ेस (यूआई) के सभी उपयोगकर्ता, पुष्टि करने के बेसिक क्रेडेंशियल से लॉग इन करते हैं. यहां उनके क्रेडेंशियल, Edge OpenLDAP डेटाबेस में सेव होते हैं. Edge यूज़र इंटरफ़ेस (यूआई) के उपयोगकर्ता, आईडीपी (IdP) में रजिस्टर होते हैं और एसएएमएल या एलडीएपी का इस्तेमाल करके, लॉग इन करते हैं.

    हालांकि, क्लासिक यूज़र इंटरफ़ेस (यूआई) का उपयोगकर्ता, Edge यूज़र इंटरफ़ेस (यूआई) में तब तक लॉग इन नहीं कर सकता, जब तक उस उपयोगकर्ता को आईडीपी (IdP) में नहीं जोड़ा जाता. इसका तरीका नए एज उपयोगकर्ताओं को रजिस्टर करना सेक्शन में बताया गया है.

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

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

New 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 यूज़र इंटरफ़ेस (यूआई) इंस्टॉल करें

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

Edge यूआई इंस्टॉल करने के लिए:

  1. अपने क्लस्टर में एक नया नोड जोड़ें.
  2. नए नोड में एडमिन के तौर पर लॉग इन करें.
  3. नोड पर apigee-setup सुविधा का 4.52.02 वर्शन इंस्टॉल करें. ऐसा करने के लिए, Edge apigee-setup यूटिलिटी इंस्टॉल करना वाले लेख में बताया गया तरीका अपनाएं.
  4. यह निर्देश देकर, कैश मेमोरी में सेव की गई सभी जानकारी को Yum से मिटाएं:
    sudo yum clean all
  5. New Edge यूज़र इंटरफ़ेस (यूआई) की कॉन्फ़िगरेशन फ़ाइल में बताए गए तरीके से कॉन्फ़िगरेशन फ़ाइल बनाएं और पक्का करें कि इस पर "apigee" उपयोगकर्ता का मालिकाना हक हो:
    chown apigee:apigee configFile

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

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

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

  6. अपने बाहरी आईडीपी को उन उपयोगकर्ताओं के साथ कॉन्फ़िगर करें जिन्हें Edge यूज़र इंटरफ़ेस (यूआई) का ऐक्सेस देना है. ज़्यादा जानकारी के लिए, Edge के नए उपयोगकर्ताओं को रजिस्टर करना देखें.
  7. नए नोड पर, नीचे दिया गया निर्देश चलाएं:
    /opt/apigee/apigee-setup/bin/setup.sh -p ue -f configFile

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

  8. Edge यूज़र इंटरफ़ेस (यूआई) में लॉग इन करने के लिए, ब्राउज़र में इस यूआरएल को खोलें:
    http://new_edge_UI_IP:3001

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

    Edge आपको बाहरी आईडीपी (IdP) क्रेडेंशियल डालने के लिए कहता है.

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

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

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

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

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

नया Edge यूआई अनइंस्टॉल करने के लिए:

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

बुनियादी क्लासिक यूज़र इंटरफ़ेस (यूआई) को अनइंस्टॉल करने के लिए (शूहॉर्न):

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

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

  1. मशीन पर चल रही Edge की सभी सेवाएं बंद करें:
    /opt/apigee/apigee-service/bin/apigee-all stop
  2. लज़ीज़ कैश मेमोरी मिटाएं:
    sudo yum clean all
  3. सभी Apigee आरपीएम हटाएं:
    sudo rpm -e $(rpm -qa | egrep "(apigee-|edge-)")
  4. इंस्टॉलेशन रूट डायरेक्ट्री हटाएं:
    sudo rm -rf /opt/apigee