مرجع فایل پیکربندی Edge

در زیر نمونه‌ای از فایل پیکربندی بی‌صدای کامل برای نصب 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=":dc-1 :dc-2 ... :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=IPofNewMaster
# PG_STANDBY=IPofOldMaster

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

جدول زیر حاوی اطلاعات تکمیلی درباره این ویژگی‌ها است:

دارایی یادداشت
نام‌های IP/ساناد هنگام مشخص کردن نشانی IP گره، از نام میزبانی که به 127.0.0.1 یا نشانی IP‏ 127.0.0.1 نگاشت شده است استفاده نکنید.

توجه داشته باشید که برای تعریف میزبان Cassandra، فقط از نشانی‌های IP استفاده کنید؛ از نام‌های «ساناد» استفاده نکنید.

ENABLE_SYSTEM_CHECK

اگر «y» است، بررسی کنید که سیستم از الزامات CPU و حافظه برای مؤلفه درحال نصب برخوردار باشد. برای اطلاع از الزامات هر مؤلفه، به الزامات نصب مراجعه کنید.

مقدار پیش‌فرض «n» است تا بررسی غیرفعال شود.

ENABLE_DYNAMIC_HOSTIP

اگر سروری چند کارت رابط داشته باشد، فرمان «hostname -i» فهرستی از نشانی‌های IP را که با فاصله از هم جدا شده‌اند برمی‌گرداند. به‌طور پیش‌فرض، نصب‌کننده Edge از اولین نشانی IP برگردانده‌شده استفاده می‌کند که ممکن است در همه شرایط درست نباشد. به‌عنوان جایگزین، می‌توانید ویژگی زیر را در فایل پیکربندی نصب تنظیم کنید.

وقتی روی «y» تنظیم شود، نصب‌کننده از شما می‌خواهد نشانی IP موردنظر را برای استفاده در نصب انتخاب کنید. مقدار پیش‌فرض «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 با Management Server نصب نشده است.

اگر به سرور OpenLDAP راه دور متصل می‌شوید، از LDAP_HOST و LDAP_PORT برای مشخص کردن نشانی IP یا نام ساناد و شماره درگاه میزبان استفاده کنید.

LDAP_TYPE
LDAP_SID
LDAP_PEER

برای OpenLDAP بدون تکرار، LDAP_TYPE=1 را تنظیم کنید. LDAP_TYPE=2 با OpenLDAP با تکرار مطابقت دارد.

اگر توپولوژی Edge شما از یک سرور OpenLDAP استفاده می‌کند، عدد ۱ را مشخص کنید. اگر نصب Edge شما از چند گره OpenLDAP استفاده می‌کند، مثلاً در نصب تولیدی ۱۳ گره‌ای، ۲ را مشخص کنید.

اگر تکرار را فعال می‌کنید، ویژگی‌های زیر را تنظیم کنید:

  • LDAP_SID=1 - شناسه یکتا برای این سرور LDAP. هر گره LDAP از شناسه متفاوتی استفاده می‌کند. برای مثال، برای همتای LDAP روی ۲ تنظیم کنید.
  • LDAP_PEER=10.0.0.1 - IP یا نام DNS همتای 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 مناسب نگاشت کند. این ویژگی برای سرور «مدیریت» لازم است تا بتواند انبارهای داده Cassandra را به‌طور مناسب براساس مراکز داده و مناطق Cassandra ثبت کند.

ZK_HOSTS

نشانی‌های IP یا نام‌های DNS گره‌های ZooKeeper. نشانی‌های IP یا نام‌های DNS باید در همه گره‌های ZooKeeper با همان ترتیب فهرست شوند.

از همان قالبی برای HOSTIP استفاده کنید که برای ZK_HOSTS استفاده می‌کنید. یعنی اگر نشانی IP را برای ZK_HOSTS مشخص کنید، از نشانی IP برای HOSTIP استفاده کنید. اگر از ساناد استفاده می‌کنید، از نام ساناد برای هر دو استفاده کنید.

در محیط چندمرکز داده، همه گره‌های ZooKeeper را از هر دو مرکز داده فهرست کنید.

اصلاح‌کننده «:observer» را در گره‌های ZooKeeper فقط زمانی مشخص کنید که چندین مرکز داده را همان‌طور که در نصب ۱۲ میزبان شرح داده شده است ایجاد می‌کنید. در نصب مرکز داده تکی، آن اصلاح‌کننده را حذف کنید. برای اطلاعات بیشتر، نصب خوشه‌ای ۱۲ میزبانی را ببینید.

ZK_CLIENT_HOSTS

نشانی‌های IP یا نام‌های DNS گره‌های ZooKeeper که این مرکز داده از آن‌ها استفاده می‌کند. نشانی‌های IP یا نام‌های ساناد باید در همه گره‌های ZooKeeper با ترتیب یکسان فهرست شوند.

از همان قالبی برای HOSTIP استفاده کنید که برای ZK_CLIENT_HOSTS استفاده می‌کنید. یعنی، اگر نشانی IP را برای ZK_CLIENT_HOSTS مشخص کنید، از نشانی IP برای HOSTIP استفاده کنید. اگر از ساناد استفاده می‌کنید، از نام ساناد برای هر دو استفاده کنید.

در نصب مرکز داده تکی، این گره‌ها همان گره‌هایی هستند که توسط ZK_HOSTS مشخص شده‌اند.

در محیط چند مرکز داده، فقط گره‌های ZooKeeper را در این مرکز داده فهرست کنید. برای اطلاعات بیشتر، نصب خوشه‌ای ۱۲ میزبانی را ببینید.

CASS_CLUSTERNAME درصورت تمایل، نام خوشه Cassandra را مشخص کنید. نام پیش‌فرض «Apigee» است.
CASS_HOSTS

فهرست جداشده با کاما از نشانی‌های IP میزبان گره‌های Cassandra (نه نام‌های ساناد) و به‌طور اختیاری شماره مرکز داده آن‌ها و قفسه‌ای را که به آن تعلق دارند مشخص می‌کند.

برای توپولوژی‌های تولید، باید حداقل سه گره در این فهرست وجود داشته باشد. دو گره اول به‌عنوان «سرورهای بذر» استفاده می‌شوند. درنتیجه، نشانی‌های IP باید با همان ترتیب در همه گره‌های Cassandra فهرست شوند.

نحو هر ورودی در فهرست به‌صورت زیر است:

IP_address[:data_center_number,rack_number]

گره‌های Cassandra می‌توانند به‌طور اختیاری مرکز داده و قفسه گره Cassandra را مشخص کنند. اصلاح‌کننده data_center_number را فقط هنگام ایجاد چندین مرکز داده، همان‌طور که در نصب ۱۲ میزبان شرح داده شده است، مشخص کنید. در نصب یک مرکز داده، آن اصلاح‌کننده را حذف کنید.

برای مثال، «192.168.124.201:1,1» یعنی مرکز داده ۱ و قفسه/منطقه دردسترس ۱، و «192.168.124.204:2,1» یعنی مرکز داده ۲ و قفسه/منطقه دردسترس ۱.

در محیط چندمرکز داده، برای غلبه بر مشکلات دیوار آتش، CASS_HOSTS باید به‌گونه‌ای سفارش داده شود (همان‌طور که در مثال بالا نشان داده شده است) که گره‌های مرکز داده فعلی در ابتدا قرار بگیرند. برای اطلاعات بیشتر، نصب خوشه‌ای ۱۲ میزبانی را ببینید.

برای اطلاعات درباره مشخص کردن rack_number برای میزبان Cassandra، به افزودن پشتیبانی قفسه 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 master-standby، در فرم:

PG_MASTER=IPofNewMaster
PG_STANDBY=IPofOldMaster
SKIP_SMTP
SMTPHOST
SMTPUSER
SMTPPASSWORD
SMTPSSL
SMTPPORT
SMTPMAILFROM

SMTP را پیکربندی کنید تا Edge بتواند برای گذرواژه‌های گم‌شده و سایر اعلان‌ها ایمیل ارسال کند.

اگر اطلاعات کاربری کاربر SMTP لازم نیست، SMTPUSER و SMTPPASSWORD را حذف کنید.

‫SMTPMAILFROM الزامی است.

CASS_JMX_USERNAME نام کاربری Cassandra JMX. اگر اصالت‌سنجی Cassandra JMX را فعال کرده باشید، الزامی است.
CASS_JMX_PASSWORD گذرواژه Cassandra JMX. اگر اصالت‌سنجی Cassandra JMX را فعال کرده باشید، الزامی است.
CASS_JMX_TRUSTSTORE نام کاربری مخزن اعتماد SSL JMX Cassandra، اگر JMX مبتنی بر SSL را در Cassandra فعال کرده باشید. فایل JMX Truststore باید توسط کاربر Apigee قابل‌خواندن باشد.
CASS_JMX_TRUSTSTORE_PASS گذرواژه مخزن اعتماد Cassandra JMX SSL، اگر JMX مبتنی بر SSL را در Cassandra فعال کرده باشید.

علاوه‌بر ویژگی‌های فهرست‌شده در اینجا، ویژگی‌هایی برای پیکربندی Apigee mTLS وجود دارد. برای اطلاعات بیشتر، پیکربندی Apigee mTLS را ببینید.