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

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

# 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=pass1234

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

प्रॉपर्टी ध्यान दें
आईपी/डीएनएस नाम किसी नोड के आईपी पते की जानकारी देते समय, 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

सिस्टम एडमिन के पासवर्ड में कम से कम आठ वर्ण होने चाहिए. इसमें एक बड़ा अक्षर, एक छोटा अक्षर, एक अंक या एक खास वर्ण शामिल होना चाहिए. पासवर्ड भूल जाने पर, आपसे पासवर्ड डालने के लिए कहा जाएगा.

इंस्टॉल करने के बाद, 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 के बारे में बताएं. अगर आपके एज इंस्टॉलेशन में एक से ज़्यादा OpenLDAP नोड का इस्तेमाल किया जाता है, जैसे कि 13-नोड प्रोडक्शन इंस्टॉलेशन में, तो 2 तय करें.

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

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

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

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

REGION_MAPPING

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

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 नोड के होस्ट आईपी पतों (न कि डीएनएस नाम) की कॉमा-सेपरेटेड लिस्ट के बारे में बताती है. साथ ही, यह उनके डेटा सेंटर के नंबर और रक से जुड़ी जानकारी भी देती है.

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

सूची में हर एंट्री के लिए सिंटैक्स इस तरह है:

IP_address[:data_center_number,rack_number]

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

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

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

Cassandra होस्ट के लिए 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' उपयोगकर्ता का उपयोगकर्ता नाम बदला जा सकता है. आपके पास, 'पोस्टग्रेज़' उपयोगकर्ता का नाम बदलने का विकल्प नहीं है.

डिफ़ॉल्ट रूप से, PostgreSQL डेटाबेस में दो उपयोगकर्ता तय किए जाते हैं: 'postgres' और 'apigee'. दोनों उपयोगकर्ताओं के पास 'पोस्टग्रे' का डिफ़ॉल्ट पासवर्ड है. ऐप्लिकेशन इंस्टॉल करते समय दोनों उपयोगकर्ताओं के लिए, पासवर्ड को अलग-अलग वैल्यू पर सेट करने के लिए 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 Cassandra JMX का उपयोगकर्ता नाम. Cassandra JMX की पुष्टि करने की सुविधा चालू करने पर ज़रूरी है.
CASS_JMX_PASSWORD Cassandra JMX का पासवर्ड. Cassandra JMX की पुष्टि करने की सुविधा चालू करने पर ज़रूरी है.
CASS_JMX_TRUSTSTORE अगर आपने Cassandra में एसएसएल आधारित JMX चालू किया है, तो Cassandra JMX एसएसएल एसएसएल ट्रस्टस्टोर उपयोगकर्ता नाम. JMX Truststore फ़ाइल, Apigee के उपयोगकर्ता के लिए पढ़ने लायक होनी चाहिए.
CASS_JMX_TRUSTSTORE_PASS अगर आपने कैसेंद्रा में एसएसएल आधारित JMX चालू किया है, तो Cassandra JMX एसएसएल एसएसएल ट्रस्टस्टोर पासवर्ड चालू किया जाएगा.
QPID_MGMT_USERNAME
QPID_MGMT_PASSWORD
ये क्रेडेंशियल, Qpid ब्रोकर के Qpid वेब मैनेजमेंट कंसोल को ऐक्सेस करने की सुविधा देते हैं. वेब मैनेजमेंट कंसोल, Qpid ब्रोकर के मैनेजमेंट और कंट्रोल के लिए आसान और आसान इंटरफ़ेस उपलब्ध कराता है.

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