एज कॉन्फ़िगरेशन फ़ाइल का रेफ़रंस

यहां नौ नोड वाले Edge के इंस्टॉलेशन के लिए, पूरी साइलेंट कॉन्फ़िगरेशन फ़ाइल का उदाहरण दिया गया है. अपने कॉन्फ़िगरेशन के लिए, इस फ़ाइल में ज़रूरत के मुताबिक बदलाव करें. इस फ़ाइल को शामिल करने के लिए, -f से setup.sh पर जाएं. हर टोपोलॉजी के हिसाब से कॉन्फ़िगरेशन फ़ाइलों के उदाहरणों के लिए, Edge कॉम्पोनेंट इंस्टॉल करना देखें.

    # IP address or DNS name of nodes.
    IP1=192.168.1.1  # Management Server, OpenLDAP, UI, ZooKeeper, Cassandra (IP address only; do not use a DNS name)
    IP2=192.168.1.2  # ZooKeeper, Cassandra (IP address only; do not use a DNS name)
    IP3=192.168.1.3  # ZooKeeper, Cassandra (IP address only; do not use a DNS name)
    IP4=192.168.1.4  # Router, Message Processor
    IP5=192.168.1.5  # Router, Message Processor
    IP6=192.168.1.6  # Qpid
    IP7=192.168.1.7  # Qpid
    IP8=192.168.1.8  # Postgres
    IP9=192.168.1.9  # Postgres
    
    # Must resolve to IP address or DNS name of host - not to 127.0.0.1 or localhost.
    HOSTIP=$(hostname -i)
    
    # Specify "y" to check that the system meets the CPU and memory requirements
    # for the component being installed. See Installation Requirements for requirements
    # for each component. The default value is "n" to disable check.
    ENABLE_SYSTEM_CHECK=n
    
    # When "hostname -i" returns multiple IP addresses,
    # set to "y", to have the installer prompt you to select the IP address to use.
    ENABLE_DYNAMIC_HOSTIP=n
    
    # Set Edge sys admin credentials.
    ADMIN_EMAIL=your@email.com
    APIGEE_ADMINPW=yourPassword    # If omitted, you are prompted for it.
    
    # Location of Edge license file.
    LICENSE_FILE=/tmp/license.txt
    
    # Management Server information.
    MSIP=$IP1    # IP or DNS name of Management Server node.
    # Specify the port the Management Server listens on for API calls.
    # APIGEE_PORT_HTTP_MS=8080    # Default is 8080.
    
    # OpenLDAP information.
    # Set to y if you are connecting to a remote LDAP server.
    # If n, Edge installs OpenLDAP when it installs the Management Server.
    USE_LDAP_REMOTE_HOST=n
    
    # If connecting to remote OpenLDAP server, specify the IP/DNS name and port.
    # LDAP_HOST=$IP1    # IP or DNS name of OpenLDAP node.
    # LDAP_PORT=10389   # Default is 10389.
    APIGEE_LDAPPW=yourLdapPassword
    
    # Specify OpenLDAP without replication, 1, or with replication, 2.
    LDAP_TYPE=1
    
    # Set only if using replication.
    # LDAP_SID=1    # Unique ID for this LDAP server.
    # LDAP_PEER=    # IP or DNS name of LDAP peer.
    
    # The Message Processor and Router pod.
    MP_POD=gateway
    
    # The name of the region, corresponding to the data center name.
    REGION=dc-1 # Use dc-1 unless installing in a
                # multi-data center environment.
    
    # If you are using region names other than dc-1, dc-2 etc, set this property to map your region
    # name to the appropriate dc-x format region name. This property is required by Management server
    # to appropriately register Cassandra data stores based on Cassandra's data centers and regions.
    REGION_MAPPING="<custom-region-1>:dc-1 <custom-region-2>:dc-2 ... <custom-region-x>:dc-x"
    
    # ZooKeeper information.
    # See table below if installing in a multi-data center environment.
    ZK_HOSTS="$IP1 $IP2 $IP3"         # IP/DNS names of all ZooKeeper nodes.
    ZK_CLIENT_HOSTS="$IP1 $IP2 $IP3"  # IP/DNS names of all ZooKeeper nodes.
    
    # Cassandra information.
    CASS_CLUSTERNAME=Apigee    # Default name is Apigee.
    
    # Space-separated IP addresses of the Cassandra hosts (previously defined; do not use DNS names)
    # Syntax is: IP_address:host_number,rack_number
    CASS_HOSTS="$IP1:1,1 $IP2:1,1 $IP3:1,1"
    
    # Set to enable Cassandra authentication.
    # CASS_AUTH=y    # The default value is n.
    # Cassandra uname/pword required if you enabled Cassandra authentication.
    # CASS_USERNAME=
    # CASS_PASSWORD=''
    
    # Postgres username and password as set when you installed Edge.
    # Default is apigee:postgres.
    PG_USER=apigee
    PG_PWD=postgres
    
    # Use to enable Postgres master-standby replication
    # when you have multiple Postgres nodes.
    # PG_MASTER=IPorDNSofNewMaster
    # PG_STANDBY=IPorDNSofOldMaster
    
    # 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>"
    
    # The following four properties are only effective for Management server:
    # Cassandra JMX uname/pword required if you enabled Cassandra JMX authentication.
    # CASS_JMX_USERNAME =
    # CASS_JMX_PASSWORD =
    
    # Cassandra JMX SSL truststore details if you have enabled SSL based JMX in Cassandra.
    # JMX Truststore file should be readable by Apigee user
    # CASS_JMX_TRUSTSTORE =
    # CASS_JMX_TRUSTSTORE_PASS =
    
    # Set up username and password to access Qpid broker's management console
    
    QPID_MGMT_USERNAME=qpid
    QPID_MGMT_PASSWORD=Apigee1234
    
    # FIPS_OS should be set to true when OPDK 4.53 or later is installed on 
    # FIPS enabled operating system
    FIPS_OS=false
    

यहां दी गई टेबल में, इन प्रॉपर्टी के बारे में ज़्यादा जानकारी दी गई है:

प्रॉपर्टी ध्यान दें
आईपी/डीएनएस नाम किसी नोड का आईपी पता बताते समय, 127.0.0.1 पर मैप किए गए होस्ट नेम या 127.0.0.1 के आईपी पते का इस्तेमाल न करें.

ध्यान दें कि Cassandra होस्ट की परिभाषाओं के लिए, सिर्फ़ आईपी पतों का इस्तेमाल करें. डीएनएस नामों का इस्तेमाल न करें.

ENABLE_SYSTEM_CHECK

अगर "y" है, तो देखें कि सिस्टम, इंस्टॉल किए जा रहे कॉम्पोनेंट के लिए सीपीयू और मेमोरी की ज़रूरी शर्तें पूरी करता हो. हर कॉम्पोनेंट की ज़रूरी शर्तों के बारे में जानने के लिए, इंस्टॉलेशन की ज़रूरी शर्तें देखें.

जांच बंद करने के लिए, डिफ़ॉल्ट वैल्यू "n" होती है.

ENABLE_DYNAMIC_HOSTIP

अगर किसी सर्वर में एक से ज़्यादा इंटरफ़ेस कार्ड हैं, तो "hostname -i" कमांड, आईपी पतों की स्पेस से अलग की गई सूची दिखाता है. डिफ़ॉल्ट रूप से, Edge इंस्टॉलर, दिखाए गए पहले आईपी पते का इस्तेमाल करता है. ऐसा हो सकता है कि यह पता हर स्थिति में सही न हो. इसके अलावा, इंस्टॉलेशन कॉन्फ़िगरेशन फ़ाइल में, यहां दी गई प्रॉपर्टी को सेट किया जा सकता है.

"y" पर सेट होने पर, इंस्टॉलर आपको इंस्टॉल में इस्तेमाल करने के लिए आईपी पता चुनने का प्रॉम्प्ट देता है. इसकी डिफ़ॉल्ट वैल्यू "n" है.

ADMIN_EMAIL
APIGEE_ADMINPW

सिस्टम एडमिन का पासवर्ड कम से कम 8 वर्ण का होना चाहिए और उसमें एक अपरकेस अक्षर, एक छोटा अक्षर, एक अंक या एक खास वर्ण होना चाहिए. अगर आपने पासवर्ड डालना भूल दिया है, तो आपसे पासवर्ड डालने के लिए कहा जाएगा.

इंस्टॉलेशन पूरा होने के बाद, Apigee का सुझाव है कि आप कॉन्फ़िगरेशन फ़ाइल से पासवर्ड हटा दें.

LICENSE_FILE

लाइसेंस फ़ाइल की जगह, जिसे "apigee" उपयोगकर्ता ऐक्सेस कर सके. उदाहरण के लिए, इसे फ़ाइल पर /tmp डायरेक्ट्री और chmod 777 में सेव करें. फ़ाइल को Edge इंस्टॉलेशन डायरेक्ट्री में कॉपी किया जाता है.

APIGEE_LDAPPW

OpenLDAP पासवर्ड बताता है.

इंस्टॉलेशन पूरा होने के बाद, Apigee का सुझाव है कि आप कॉन्फ़िगरेशन फ़ाइल से पासवर्ड हटा दें.

USE_LDAP_REMOTE_HOST
LDAP_HOST
LDAP_PORT

अगर USE_LDAP_REMOTE_HOST n है, तो मैनेजमेंट सर्वर इंस्टॉल करने पर Edge, OpenLDAP को अपने-आप इंस्टॉल कर देता है.

अगर आपको किसी रिमोट LDAP सर्वर से कनेक्ट करना है, तो USE_LDAP_REMOTE_HOST को y पर सेट करें. मैनेजमेंट सर्वर के साथ OpenLDAP इंस्टॉल नहीं किया गया है.

अगर किसी रिमोट OpenLDAP सर्वर से कनेक्ट किया जा रहा है, तो होस्ट के आईपी पते या डीएनएस नेम और पोर्ट नंबर की जानकारी देने के लिए, LDAP_HOST और LDAP_PORT का इस्तेमाल करें.

LDAP_TYPE
LDAP_SID
LDAP_PEER

बिना डुप्लीकेट कॉपी वाले OpenLDAP के लिए, LDAP_TYPE=1 सेट करें. LDAP_TYPE=2, रेगुलराइज़ेशन के साथ OpenLDAP से मेल खाता है.

अगर आपकी Edge टोपोलॉजी में एक OpenLDAP सर्वर का इस्तेमाल किया जाता है, तो 1 डालें. अगर आपके Edge के इंस्टॉलेशन में एक से ज़्यादा OpenLDAP नोड का इस्तेमाल किया जाता है, जैसे कि 13-नोड वाले प्रोडक्शन इंस्टॉलेशन में, तो 2 डालें.

अगर आपने एक जैसे डेटा को कई जगहों पर स्टोर करने की सुविधा चालू की है, तो इन प्रॉपर्टी को सेट करें:

  • LDAP_SID=1 - इस LDAP सर्वर के लिए यूनीक आईडी. हर एलडीपी नोड, अलग आईडी का इस्तेमाल करता है. उदाहरण के लिए, LDAP पीयर के लिए 2 पर सेट करें.
  • LDAP_PEER=10.0.0.1 - LDAP मिलते-जुलते ऐप्लिकेशन का आईपी या डीएनएस नाम.
MP_POD मैसेज प्रोसेसर और राऊटर पॉड का नाम डालें. डिफ़ॉल्ट रूप से, इसका नाम gateway होता है.
REGION

इलाके का नाम. आम तौर पर, नाम dc-# के फ़ॉर्मैट में होते हैं. इसमें #, पूर्णांक वैल्यू से जुड़ा होता है. उदाहरण के लिए, dc-1, dc-2 वगैरह. dc-1 का इस्तेमाल तब तक किया जा सकता है, जब तक कि इसे कई डेटा सेंटर वाले एनवायरमेंट में इंस्टॉल नहीं किया जाता.

एक से ज़्यादा डेटा सेंटर इंस्टॉल करने पर, वैल्यू dc-1 या dc-2 वगैरह होती है. यह इस बात पर निर्भर करता है कि कौनसा डेटा सेंटर इंस्टॉल किया जा रहा है. हालांकि, आपके पास dc-# फ़ॉर्मैट में नाम इस्तेमाल करने के अलावा,

REGION_MAPPING

अगर dc-1, dc-2 वगैरह के अलावा किसी और इलाके का नाम इस्तेमाल किया जा रहा है, तो इस प्रॉपर्टी को अपने इलाके के नाम को dc-x फ़ॉर्मैट में मैप करने के लिए सेट करें. मैनेजमेंट सर्वर को यह प्रॉपर्टी ज़रूरी है, ताकि कैसंड्रा के डेटा सेंटर और इलाकों के आधार पर कैसंड्रा के डेटा स्टोर को सही तरीके से रजिस्टर किया जा सके.

ZK_HOSTS

ZooKeeper नोड के आईपी पते या डीएनएस नाम. सभी ZooKeeper नोड पर, आईपी पते या डीएनएस नेम एक ही क्रम में होने चाहिए.

HOSTIP के लिए वही फ़ॉर्मैट इस्तेमाल करें जो आपने ZK_HOSTS के लिए इस्तेमाल किया है. इसका मतलब है कि अगर आपने ZK_HOSTS के लिए आईपी पता डाला है, तो HOSTIP के लिए भी आईपी पता डालें. अगर डीएनएस का इस्तेमाल किया जाता है, तो दोनों के लिए डीएनएस नेम का इस्तेमाल करें.

एक से ज़्यादा डेटा सेंटर वाले एनवायरमेंट में, दोनों डेटा सेंटर के सभी ZooKeeper नोड की सूची बनाएं.

ZooKeeper नोड पर ":observer" मॉडिफ़ायर सिर्फ़ तब तय करें, जब कई डेटा सेंटर बनाए जा रहे हों. इस बारे में, 12-होस्ट वाले इंस्टॉलेशन में बताया गया है. किसी एक डेटा सेंटर के इंस्टॉलेशन में, उस मॉडिफ़ायर को छोड़ दें. ज़्यादा जानकारी के लिए, 12-होस्ट क्लस्टर वाला इंस्टॉलेशन देखें.

ZK_CLIENT_HOSTS

इस डेटा सेंटर में इस्तेमाल किए जाने वाले ZooKeeper नोड के आईपी पते या डीएनएस नेम. सभी ZooKeeper नोड पर, आईपी पते या डीएनएस नेम एक ही क्रम में होने चाहिए.

HOSTIP के लिए वही फ़ॉर्मैट इस्तेमाल करें जो आपने ZK_CLIENT_HOSTS के लिए इस्तेमाल किया है. इसका मतलब है कि अगर आपने ZK_CLIENT_HOSTS के लिए आईपी पता डाला है, तो HOSTIP के लिए भी आईपी पता डालें. अगर आपने डीएनएस का इस्तेमाल किया है, तो दोनों के लिए डीएनएस नेम का इस्तेमाल करें.

एक ही डेटा सेंटर इंस्टॉलेशन में, ये वही नोड होते हैं जिनके बारे में ZK_HOSTS में बताया गया है.

एक से ज़्यादा डेटा सेंटर वाले एनवायरमेंट में, इस डेटा सेंटर में सिर्फ़ ZooKeeper नोड की सूची बनाएं. ज़्यादा जानकारी के लिए, 12-होस्ट क्लस्टर वाला इंस्टॉलेशन देखें.

CASS_CLUSTERNAME विकल्प के तौर पर, कैसंड्रा क्लस्टर का नाम बताएं. डिफ़ॉल्ट नाम "Apigee" है.
CASS_HOSTS

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

प्रोडक्शन टॉपोलॉजी के लिए, इस सूची में कम से कम तीन नोड होने चाहिए. पहले दो नोड का इस्तेमाल, "सीड सर्वर" के तौर पर किया जाता है. इस वजह से, सभी कसांद्रा नोड पर आईपी पते एक ही क्रम में लिस्ट होने चाहिए.

सूची में मौजूद हर एंट्री का सिंटैक्स इस तरह का होता है:

IP_address[:data_center_number,rack_number]

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

उदाहरण के लिए, '192.168.124.201:1,1 = डेटासेंटर 1 और रैक/उपलब्धता ज़ोन 1, और '192.168.124.204:2,1 = डेटासेंटर 2 और रैक/उपलब्धता ज़ोन 1.

एक से ज़्यादा डेटासेंटर वाले एनवायरमेंट में, फ़ायरवॉल से जुड़ी समस्याओं को हल करने के लिए, CASS_HOSTS को इस तरह से क्रम में लगाया जाना चाहिए (जैसा कि ऊपर दिए गए उदाहरण में दिखाया गया है) कि मौजूदा डेटासेंटर के नोड सबसे पहले रखे जाएं. ज़्यादा जानकारी के लिए, 12-होस्ट क्लस्टर वाला इंस्टॉलेशन देखें.

कैसंड्रा होस्ट के लिए rack_number तय करने के बारे में जानकारी पाने के लिए, कैसंड्रा रैक के लिए सपोर्ट जोड़ना देखें.

CASS_AUTH
CASS_USERNAME
CASS_PASSWORD

अगर आपने Cassandra ऑथेंटिकेशन, CASS_AUTH=y को चालू किया है, तो इन प्रॉपर्टी का इस्तेमाल करके Cassandra उपयोगकर्ता का नाम और पासवर्ड पास किया जा सकता है.

इंस्टॉलेशन पूरा होने के बाद, Apigee का सुझाव है कि आप कॉन्फ़िगरेशन फ़ाइल से पासवर्ड हटा दें.

CONFIG_DELTA_LOG

CONFIG_DELTA_LOG यह कंट्रोल करता है कि कॉन्फ़िगरेशन फ़ाइलों में किए गए बदलावों को कैसे लॉग किया जाए. CONFIG_DELTA_LOG=y सेट करने पर, किसी कॉम्पोनेंट के कॉन्फ़िगरेशन में किए गए बदलाव लॉग नहीं किए जाते.

PG_USER
PG_PWD

डिफ़ॉल्ट रूप से, PostgreSQL डेटाबेस में दो उपयोगकर्ता तय होते हैं: 'postgres' और 'apigee'.

PG_USER की मदद से, 'apigee' उपयोगकर्ता का उपयोगकर्ता नाम बदला जा सकता है. 'postgres' उपयोगकर्ता का नाम नहीं बदला जा सकता.

डिफ़ॉल्ट रूप से, PostgreSQL डेटाबेस में दो उपयोगकर्ता तय होते हैं: 'postgres' और 'apigee'. दोनों उपयोगकर्ताओं का डिफ़ॉल्ट पासवर्ड 'postgres' है. इंस्टॉल के समय दोनों उपयोगकर्ताओं के लिए, पासवर्ड को अलग-अलग वैल्यू पर सेट करने के लिए PG_PWD का इस्तेमाल करें.

इंस्टॉलेशन पूरा होने के बाद, Apigee का सुझाव है कि आप कॉन्फ़िगरेशन फ़ाइल से पासवर्ड हटा दें.

PG_MASTER
PG_STANDBY

Postgres के मास्टर-स्टैंडबाय रिप्लिकेशन को चालू करने के लिए, इस फ़ॉर्म में सेट करें:

PG_MASTER=IPorDNSofNewMaster
PG_STANDBY=IPorDNSofOldMaster
SKIP_SMTP
SMTPHOST
SMTPUSER
SMTPPASSWORD
SMTPSSL
SMTPPORT
SMTPMAILFROM

एसएमटीपी को कॉन्फ़िगर करें, ताकि Edge, पासवर्ड खो जाने और अन्य सूचनाओं के लिए ईमेल भेज सके.

अगर एसएमटीपी उपयोगकर्ता क्रेडेंशियल ज़रूरी नहीं हैं, तो SMTPUSER और SMTPPASSWORD को हटा दें.

SMTPMAILFROM ज़रूरी है.

CASS_JMX_USERNAME कैसंड्रा JMX उपयोगकर्ता नाम. अगर आपने Cassandra JMX पुष्टि करने की सुविधा चालू की है, तो यह ज़रूरी है.
CASS_JMX_PASSWORD Cassandra JMX का पासवर्ड. अगर आपने Cassandra JMX पुष्टि करने की सुविधा चालू की है, तो यह ज़रूरी है.
CASS_JMX_TRUSTSTORE अगर आपने Cassandra में एसएसएल पर आधारित JMX को चालू किया है, तो Cassandra JMX एसएसएल ट्रस्टस्टोर का उपयोगकर्ता नाम. JMX ट्रस्टस्टोर फ़ाइल को Apigee उपयोगकर्ता पढ़ सकता है.
CASS_JMX_TRUSTSTORE_PASS अगर आपने कैसंड्रा में एसएसएल आधारित जेएमएक्स चालू किया है, तो कैसंद्रा जेएमएक्स एसएसएल ट्रस्टस्टोर पासवर्ड.
QPID_MGMT_USERNAME
QPID_MGMT_PASSWORD
इन क्रेडेंशियल से, Qpid ब्रोकर के Qpid वेब मैनेजमेंट कंसोल को ऐक्सेस किया जा सकता है. वेब मैनेजमेंट कंसोल, Qpid ब्रोकर को मैनेज करने और कंट्रोल करने के लिए, आसान और सहज इंटरफ़ेस उपलब्ध कराता है.
FIPS_OS FIPS_OS का मान सही या गलत हो सकता है. हालांकि, इसका डिफ़ॉल्ट मान 'गलत' हो सकता है. FIPS की सुविधा वाले ऑपरेटिंग सिस्टम पर, Edge for Private Cloud के वर्शन 4.53.00 या उसके बाद के वर्शन के लिए, इसे 'सही' पर सेट करें.

यहां दी गई प्रॉपर्टी के अलावा, Apigee mTLS को कॉन्फ़िगर करने की प्रॉपर्टी भी मौजूद हैं. ज़्यादा जानकारी के लिए, Apigee mTLS कॉन्फ़िगर करना लेख पढ़ें.