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

Edge for Private Cloud v4.18.05

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

# 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. पोर्टल पर SAML को कॉन्फ़िगर करने के लिए, यह कमांड चलाएं: 
    /opt/apigee/apigee-service/bin/apigee-service apigee-drupal-devportal configure-sso -f samlConfigFile

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

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

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

  5. कनेक्शन की जांच करें बटन को दबाकर, कभी भी कनेक्शन की फिर से जांच की जा सकती है.

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

पोर्टल पर SAML को बंद करना

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

पोर्टल पर एसएएमएल को बंद करने के लिए:

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