एज के साथ बातचीत करने के लिए, एसएएमएल का इस्तेमाल करने के लिए पोर्टल को कॉन्फ़िगर करना

Edge for Private Cloud v4.19.01

Apigee Developer Services पोर्टल (या आसान शब्दों में पोर्टल), Apigee Edge के क्लाइंट की तरह काम करता है. इसका मतलब है कि पोर्टल अपने-आप काम नहीं करता. इसके बजाय, पोर्टल पर इस्तेमाल होने वाली ज़्यादातर जानकारी को Edge पर सेव किया जाता है. ज़रूरत पड़ने पर पोर्टल, Edge से जानकारी हासिल करने या Edge को जानकारी भेजने का अनुरोध करता है.

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

अगर आपने Edge की पुष्टि करने के लिए एसएएमएल को चालू करने का विकल्प चुना है, तो Edge के लिए अनुरोध करते समय, एसएएमएल की पुष्टि करने की सुविधा का इस्तेमाल करने के लिए, पोर्टल को कॉन्फ़िगर किया जा सकता है. एसएएमएल का इस्तेमाल करने के लिए पोर्टल को कॉन्फ़िगर करने पर, Edge संगठन में मशीन से अपने-आप एक नया उपयोगकर्ता खाता बन जाता है. इसके बाद, पोर्टल इस खाते का इस्तेमाल, Edge को अनुरोध भेजने के लिए करता है. मशीन इस्तेमाल करने वाले लोगों के बारे में ज़्यादा जानने के लिए, अपने-आप होने वाले टास्क के साथ एसएएमएल का इस्तेमाल करना लेख पढ़ें.

पोर्टल के साथ एसएएमएल के काम करने के लिए ज़रूरी है कि आपने पहले से ही Edge मैनेजमेंट सर्वर नोड पर Edge एसएसओ (SSO) मॉड्यूल को इंस्टॉल और कॉन्फ़िगर किया हो. पोर्टल के लिए एसएएमएल की सुविधा को चालू करने की सामान्य प्रोसेस यहां दी गई है:

  1. Edge के लिए एसएएमएल को इंस्टॉल और कॉन्फ़िगर करना सेक्शन में बताए गए तरीके से, एसएएमएल को Edge पर कॉन्फ़िगर करें. ध्यान दें: पोर्टल इंस्टॉल करने के लिए, Edge पर 'बुनियादी पुष्टि' अब भी चालू होनी चाहिए. जब तक आप एसएएमएल का इस्तेमाल करने के लिए पोर्टल को कॉन्फ़िगर न कर लें, तब तक Edge पर पुष्टि करने की सुविधा को बंद न करें.
  2. पोर्टल इंस्टॉल करें और पक्का करें कि आपकी इंस्टॉलेशन ठीक से काम कर रही हो. निजी क्लाउड पोर्टल के लिए EDGE इंस्टॉल करना देखें.
  3. पोर्टल पर एसएएमएल को कॉन्फ़िगर करें.
  4. अब आप Edge पर सामान्य पुष्टि करने की सुविधा को बंद कर सकते हैं.

पोर्टल के लिए मशीन उपयोगकर्ता बनाया जा रहा है

एसएएमएल चालू होने पर, Edge मशीन उपयोगकर्ताओं की मदद से अपने-आप OAuth2 टोकन जनरेट करने की सुविधा देता है. मशीन इस्तेमाल करने वाला व्यक्ति, पासवर्ड तय किए बिना OAuth2 टोकन पा सकता है. इसका मतलब है कि OAuth2 टोकन पाने और उन्हें रीफ़्रेश करने की प्रोसेस को पूरी तरह से ऑटोमेट किया जा सकता है.

पोर्टल के लिए एसएएमएल कॉन्फ़िगरेशन प्रोसेस अपने-आप, पोर्टल से जुड़े संगठन में मशीन उपयोगकर्ता बना देती है. इसके बाद पोर्टल, Edge से कनेक्ट करने के लिए इस मशीन उपयोगकर्ता खाते का इस्तेमाल करता है. मशीन इस्तेमाल करने वाले लोगों के बारे में ज़्यादा जानने के लिए, अपने-आप होने वाले टास्क के साथ एसएएमएल का इस्तेमाल करना लेख पढ़ें.

पोर्टल डेवलपर खातों के लिए पुष्टि करने के बारे में जानकारी

एसएएमएल का इस्तेमाल करने के लिए पोर्टल को कॉन्फ़िगर करने पर, Edge से पुष्टि करने के लिए एसएएमएल का इस्तेमाल किया जा सकता है. इसके लिए पोर्टल को चालू किया जाता है, ताकि पोर्टल Edge को अनुरोध भेज सके. हालांकि, पोर्टल में एक तरह के उपयोगकर्ता भी मौजूद होते हैं, जिन्हें डेवलपर कहा जाता है.

डेवलपर, उन उपयोगकर्ताओं का समुदाय बनाते हैं जो आपके एपीआई का इस्तेमाल करके, ऐप्लिकेशन बनाते हैं. ऐप्लिकेशन डेवलपर आपके एपीआई के बारे में जानने और आपके एपीआई का इस्तेमाल करने वाले ऐप्लिकेशन रजिस्टर करने के लिए, डेवलपर समुदाय से इंटरैक्ट करने के लिए, और डैशबोर्ड पर उनके ऐप्लिकेशन के इस्तेमाल से जुड़े आंकड़ों की जानकारी देखने के लिए पोर्टल का इस्तेमाल करते हैं.

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

डेवलपर की पुष्टि करने के लिए, एसएएमएल का इस्तेमाल करने के लिए भी पोर्टल को कॉन्फ़िगर किया जा सकता है. तीसरे पक्ष के Drupal मॉड्यूल का इस्तेमाल करके एसएएमएल को चालू करने के उदाहरण के लिए, डेवलपर पोर्टल के साथ एसएएमएल के ज़रिए एसएसओ (SSO) इंटिग्रेशन देखें.

Edge के साथ संपर्क करने के लिए, पोर्टल पर एसएएमएल को कॉन्फ़िगर करें

पोर्टल के लिए एसएएमएल को कॉन्फ़िगर करने के लिए, आपको पोर्टल को कॉन्फ़िगर करने के लिए एक कॉन्फ़िगरेशन फ़ाइल बनानी होगी:

# IP address of Edge Management Server and apigee-sso node.
IP1=22.222.22.222

# URL of Edge management API.
MGMT_URL=http://$IP1:8080/v1

# Org associated with the portal.
EDGE_ORG=myorg

# Information about apigee-sso.
# Externally accessible IP or DNS of apigee-sso.
SSO_PUBLIC_URL_HOSTNAME=$IP1
SSO_PUBLIC_URL_PORT=9099
# Default is http. Set to https if you enabled TLS on apigee-sso.
SSO_PUBLIC_URL_SCHEME=http

# SSO admin credentials as set when you installed apigee-sso.
SSO_ADMIN_NAME=ssoadmin
SSO_ADMIN_SECRET=Secret123

# Default is "n" to disable SAML support.
DEVPORTAL_SSO_ENABLED=y

# The name of the OAuth client used to connect to apigee-sso. 
# The default client name is portalcli.
PORTALCLI_SSO_CLIENT_NAME=portalcli
# Oauth client password using uppercase, lowercase, number, and special chars. 
PORTALCLI_SSO_CLIENT_SECRET=Abcdefg@1

# Email address and user info for the machine user created in 
# the Edge org specified above by EDGE_ORG. 
# This account is used by the portal to make requests to Edge.
# Add this email as an org admin before configuring the portal to use SAML. 
DEVPORTAL_ADMIN_EMAIL=DevPortal_SAML@google.com
DEVPORTAL_ADMIN_FIRSTNAME=DevPortal
DEVPORTAL_ADMIN_LASTNAME=SAMLAdmin
DEVPORTAL_ADMIN_PWD=Abcdefg@1

# If set, the existing portal OAuth client is deleted and new one is created.
# The default value is "n".
# Set to "y" when you configure SAML and change the value of 
# any of the PORTALCLI_* properties.
PORTALCLI_SSO_CLIENT_OVERWRITE=y

पोर्टल पर एसएएमएल सहायता चालू करने के लिए:

  1. Edge यूज़र इंटरफ़ेस (यूआई) में, मशीन के जिस उपयोगकर्ता के बारे में DEVPORTAL_ADMIN_EMAIL ने बताया है उसे पोर्टल से जुड़े संगठन में संगठन एडमिन के तौर पर जोड़ें.
  2. पोर्टल पर एसएएमएल को कॉन्फ़िगर करने के लिए, नीचे दिए गए निर्देश चलाएं:
    /opt/apigee/apigee-service/bin/apigee-service apigee-drupal-devportal configure-sso -f samlConfigFile

    जहां samlConfigFile, एसएएमएल कॉन्फ़िगरेशन फ़ाइल के लिए है.

  3. पोर्टल एडमिन के तौर पर पोर्टल में लॉग इन करें.
  4. मुख्य Drupal मेन्यू में, कॉन्फ़िगरेशन > डेव पोर्टल चुनें. पोर्टल को कॉन्फ़िगर करने की स्क्रीन दिखेगी. इसमें एसएएमएल सेटिंग भी शामिल हैं:

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

  5. किसी भी समय फिर से कनेक्शन की जांच करने के लिए, कनेक्शन की जांच करें बटन दबाएं.

इन वैल्यू को बाद में बदलने के लिए, कॉन्फ़िगरेशन फ़ाइल को अपडेट करें और फिर से निर्देश चलाएं.

पोर्टल पर एसएएमएल की सुविधा बंद करें

अगर पोर्टल और Edge के बीच बातचीत के लिए एसएएमएल को बंद किया जाता है, तो पोर्टल Edge को अनुरोध नहीं कर पाएगा. डेवलपर, पोर्टल में लॉग इन कर सकेंगे. हालांकि, वे प्रॉडक्ट देख नहीं पाएंगे और ऐप्लिकेशन नहीं बना पाएंगे.

पोर्टल पर एसएएमएल की सुविधा को बंद करने के लिए:

  1. उस कॉन्फ़िगरेशन फ़ाइल में बदलाव करें जिसका इस्तेमाल करके, आपने एसएएम को कॉन्फ़िगर करने के लिए इसे सेट किया था:
    DEVPORTAL_SSO_ENABLED=n
  2. पोर्टल को कॉन्फ़िगर करें:
    /opt/apigee/apigee-service/bin/apigee-service apigee-drupal-devportal configure-sso -f configFile