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

नीचे, नौ नोड वाले 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
####
# ONLY FOR AMAZON-LINUX-2023(AL2023) INCLUDE THE FLAG
# USE_CQLUTIL=y

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

प्रॉपर्टी नोट
आईपी/डीएनएस के नाम नोड का आईपी पता तय करते समय, 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 को अपने-आप इंस्टॉल कर देता है.

अगर आपको किसी रिमोट एलडीएपी सर्वर से कनेक्ट करना है, तो 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 - एलडीएपी पीयर का आईपी या डीएनएस नाम.
MP_POD मैसेज प्रोसेसर और राऊटर पॉड का नाम डालें. डिफ़ॉल्ट रूप से, इसका नाम gateway होता है.
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 Cassandra क्लस्टर का नाम बताएं. हालांकि, ऐसा करना ज़रूरी नहीं है. डिफ़ॉल्ट नाम "Apigee" होता है.
CASS_HOSTS

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

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

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

IP_address[:data_center_number,rack_number]

Cassandra नोड, Cassandra नोड के डेटा सेंटर और रैक के बारे में जानकारी दे सकते हैं. हालांकि, ऐसा करना ज़रूरी नहीं है. 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 तय करने के बारे में जानकारी पाने के लिए, Cassandra रैक के लिए सहायता जोड़ना लेख पढ़ें.

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

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