مرجع ملف إعداد Edge

في ما يلي مثال على ملف إعداد صامت كامل لعملية تثبيت Edge على 9 عقد. عدِّل هذا الملف حسب الحاجة لإعداداتك. استخدِم الخيار -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

يحتوي الجدول التالي على معلومات إضافية حول هذه السمات:

الموقع ملاحظة
أسماء عناوين IP/نظام أسماء النطاقات لا تستخدم تعيين اسم مضيف إلى 127.0.0.1 أو عنوان IP بقيمة 127.0.0.1 عند تحديد عنوان IP لعقدة.

يُرجى العِلم أنّه بالنسبة إلى تعريفات مضيف Cassandra، يجب استخدام عناوين IP فقط، وعدم استخدام أسماء نظام أسماء النطاقات.

ENABLE_SYSTEM_CHECK

إذا كانت الإجابة "نعم"، تأكَّد من أنّ النظام يستوفي متطلبات وحدة المعالجة المركزية والذاكرة الخاصة بالمكوّن الذي يتم تثبيته. يمكنك الاطّلاع على متطلبات التثبيت لمعرفة متطلبات كل مكوّن.

القيمة التلقائية هي "n" لإيقاف عملية التحقّق.

ENABLE_DYNAMIC_HOSTIP

إذا كان الخادم يتضمّن بطاقات واجهة متعدّدة، سيعرض الأمر "hostname -i" قائمة بعناوين IP مفصولة بمسافات. يستخدم برنامج تثبيت Edge تلقائيًا عنوان IP الأول الذي يتم عرضه، والذي قد لا يكون صحيحًا في بعض الحالات. يمكنك بدلاً من ذلك ضبط السمة التالية في ملف إعداد التثبيت.

عند ضبطها على "y"، تطلب منك أداة التثبيت اختيار عنوان IP لاستخدامه في عملية التثبيت. القيمة التلقائية هي "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 تلقائيًا عند تثبيت خادم الإدارة.

اضبط USE_LDAP_REMOTE_HOST على y إذا كنت تتصل بخادم LDAP بعيد. لا يتم تثبيت OpenLDAP مع خادم الإدارة.

في حال الاتصال بخادم OpenLDAP بعيد، استخدِم LDAP_HOST وLDAP_PORT لتحديد عنوان IP أو اسم DNS ورقم المنفذ للمضيف.

LDAP_TYPE
LDAP_SID
LDAP_PEER

اضبط LDAP_TYPE=1 من أجل OpenLDAP بدون تكرار. LDAP_TYPE=2 يتوافق مع OpenLDAP مع النسخ المتماثل.

إذا كانت طوبولوجيا Edge تستخدم خادم OpenLDAP واحدًا، حدِّد 1. إذا كان تثبيت Edge يستخدم عُقد OpenLDAP متعددة، كما هو الحال في عملية تثبيت إنتاجية تتضمّن 13 عقدة، حدِّد القيمة 2.

في حال تفعيل النسخ المتماثل، اضبط الخصائص التالية:

  • LDAP_SID=1 - معرّف فريد لخادم LDAP هذا. تستخدم كل عقدة LDAP معرّفًا مختلفًا. على سبيل المثال، اضبط القيمة على 2 لجهاز LDAP نظير.
  • استبدِل LDAP_PEER بعنوان IP أو اسم نظام أسماء النطاقات (DNS) الخاص بجهاز LDAP النظير.
MP_POD حدِّد اسم مجموعة Message Processor وRouter. تكون التسمية تلقائيًا هي 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 أو أسماء نظام أسماء النطاقات لعُقد ZooKeeper يجب إدراج عناوين IP أو أسماء نظام أسماء النطاقات (DNS) بالترتيب نفسه على جميع عُقد ZooKeeper.

استخدِم الصيغة نفسها في HOSTIP كما في ZK_HOSTS. أي إذا حدّدت عنوان IP لـ ZK_HOSTS، استخدِم عنوان IP لـ HOSTIP. إذا كنت تستخدم نظام أسماء نطاقات، استخدِم اسم نظام أسماء نطاقات لكليهما.

في بيئة تتضمّن مراكز بيانات متعدّدة، أدرِج جميع عُقد ZooKeeper من كلا مركزي البيانات.

حدِّد المعدِّل ":observer" على عقد ZooKeeper فقط عند إنشاء عدة مراكز بيانات كما هو موضّح في عملية التثبيت على 12 مضيفًا. في عملية تثبيت في مركز بيانات واحد، احذف هذا المعدِّل. لمزيد من المعلومات، يُرجى الاطّلاع على عملية التثبيت المجمّعة على 12 مضيفًا.

ZK_CLIENT_HOSTS

عناوين IP أو أسماء نظام أسماء النطاقات لعُقد ZooKeeper التي يستخدمها مركز البيانات هذا يجب إدراج عناوين IP أو أسماء نظام أسماء النطاقات (DNS) بالترتيب نفسه على جميع عُقد ZooKeeper.

استخدِم الصيغة نفسها في HOSTIP كما في ZK_CLIENT_HOSTS. أي أنّه في حال تحديد عنوان IP لـ ZK_CLIENT_HOSTS، يجب استخدام عنوان IP لـ HOSTIP. إذا كنت تستخدم نظام أسماء النطاقات، استخدِم اسم نظام أسماء النطاقات لكليهما.

في عملية تثبيت مركز بيانات واحد، تكون هذه هي العُقد نفسها المحدّدة بواسطة ZK_HOSTS.

في بيئة تتضمّن مراكز بيانات متعدّدة، أدرِج عقد ZooKeeper في مركز البيانات هذا فقط. لمزيد من المعلومات، يُرجى الاطّلاع على عملية التثبيت المجمّعة على 12 مضيفًا.

CASS_CLUSTERNAME يمكنك اختياريًا تحديد اسم مجموعة Cassandra. الاسم التلقائي هو "Apigee".
CASS_HOSTS

تحدّد هذه السمة قائمة مفصولة بفواصل لعناوين IP الخاصة بمضيفات عقد Cassandra (وليس أسماء نظام أسماء النطاقات)، ويمكنك اختياريًا تحديد رقم مركز البيانات والحامل الذي تنتمي إليه.

بالنسبة إلى مخططات الشبكات الخاصة بالإنتاج، يجب أن تتضمّن هذه القائمة ثلاث عُقد على الأقل. يتم استخدام العقدتَين الأوليَين كـ "خوادم أساسية". نتيجةً لذلك، يجب إدراج عناوين IP بالترتيب نفسه على جميع عُقد 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 مضيفًا.

للحصول على معلومات حول تحديد 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، وذلك بالتنسيق التالي:

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

إعداد SMTP ليتمكّن Edge من إرسال رسائل إلكترونية بشأن كلمات المرور المفقودة والإشعارات الأخرى

إذا لم تكن بيانات اعتماد مستخدم SMTP مطلوبة، احذف SMTPUSER وSMTPPASSWORD.

يجب ملء الحقل "SMTPMAILFROM".

CASS_JMX_USERNAME اسم مستخدم JMX في Cassandra مطلوب إذا فعّلت مصادقة Cassandra JMX.
CASS_JMX_PASSWORD كلمة مرور Cassandra JMX. مطلوب إذا فعّلت مصادقة Cassandra JMX.
CASS_JMX_TRUSTSTORE اسم مستخدم متجر الشهادات الموثوقة لبروتوكول JMX المستند إلى طبقة المقابس الآمنة في Cassandra، في حال فعّلت بروتوكول JMX المستند إلى طبقة المقابس الآمنة في Cassandra. يجب أن يكون ملف JMX Truststore قابلاً للقراءة من قِبل مستخدم Apigee.
CASS_JMX_TRUSTSTORE_PASS كلمة مرور ملف تخزين الشهادات الموثوقة لبروتوكول JMX المستند إلى طبقة المقابس الآمنة في Cassandra، في حال فعّلت بروتوكول JMX المستند إلى طبقة المقابس الآمنة في Cassandra.
QPID_MGMT_USERNAME
QPID_MGMT_PASSWORD
توفّر بيانات الاعتماد هذه إمكانية الوصول إلى Qpid Web Management Console الخاصة ببرنامج Qpid الوسيط. توفّر "وحدة تحكّم إدارة الويب" واجهة بسيطة وسهلة الاستخدام لإدارة وسيط Qpid والتحكّم فيه.
USE_CQLUTIL تتيح هذه العلامة إعدادات الضبط الأساسية لتتوافق مع بيئة AL2023.

بالإضافة إلى الخصائص المدرَجة هنا، هناك خصائص لإعداد Apigee mTLS. لمزيد من المعلومات، يُرجى الاطّلاع على ضبط Apigee mTLS.