مرجع ملف إعداد 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=pass1234

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

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

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

ENABLE_SYSTEM_CHECK

إذا كان الحرف "y"، تحقق من أن النظام يستوفي متطلبات وحدة المعالجة المركزية (CPU) والذاكرة للمكون الذي يتم تثبيته. ويمكنك الاطّلاع على متطلبات التثبيت لمعرفة متطلبات كل مكوّن.

القيمة الافتراضية هي "n" لإيقاف التحقق.

ENABLE_DYNAMIC_HOSTIP

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

عند ضبط القيمة على "y"، تطلب منك أداة التثبيت اختيار عنوان IP لاستخدامه في عملية التثبيت. القيمة الافتراضية هي "n".

ADMIN_EMAIL
APIGEE_ADMINPW

يجب ألا تقل كلمة مرور مشرف النظام عن 8 أحرف وأن تحتوي على حرف كبير أو حرف صغير أو رقم واحد أو رمز خاص. إذا حذفت كلمة المرور، سيُطلب منك ذلك.

بعد اكتمال التثبيت، تنصح Apigee بإزالة كلمة المرور من ملف الإعداد.

LICENSE_FILE

موقع ملف الترخيص الذي يجب أن يتمكن مستخدم "واجهة برمجة التطبيقات" من الوصول إليه على سبيل المثال، قم بتخزينه في الدليل /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 أو اسم نظام أسماء النطاقات ورقم منفذ المضيف.

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=10.0.0.1 - اسم IP أو DNS لنظير LDAP.
MP_POD حدِّد اسم مجموعة معالج الرسائل وجهاز التوجيه. ويكون الاسم هو "البوابة" تلقائيًا.
REGION

اسم المنطقة حسب الاصطلاح، تكون الأسماء عادةً بالصيغة dc-# حيث تتجاوب # مع قيمة عدد صحيح. على سبيل المثال، dc-1 وdc-2 وما إلى ذلك. يمكنك استخدام dc-1 ما لم يتم التثبيت في بيئة مركز بيانات متعددة.

في عملية تثبيت متعددة لمركز بيانات، تكون القيمة dc-1 أو dc-2 وما إلى ذلك وفقًا لمركز البيانات الذي تثبِّته. ومع ذلك، لا يمكنك استخدام الأسماء فقط بالشكل dc-#. ويمكنك استخدام أي اسم للمنطقة.

REGION_MAPPING

إذا كنت تستخدم أسماء مناطق أخرى غير dc-1 وdc-2 وما إلى ذلك، اضبط هذه السمة لتعيين اسم منطقتك على اسم المنطقة المناسب لتنسيق dc-x. يحتاج خادم الإدارة إلى هذه السمة لتسجيل مخازن بيانات "كاساندرا" بشكل صحيح استنادًا إلى مراكز بيانات "كاساندرا" ومناطقها.

ZK_HOSTS

عناوين IP أو أسماء نظام أسماء النطاقات الخاصة بعُقد ZooKeeper. يجب إدراج عناوين IP أو أسماء نظام أسماء النطاقات بالترتيب نفسه في جميع عُقد ZooKeeper.

استخدِم التنسيق HOSTIP نفسه المستخدَم في ZK_HOSTS. بعبارة أخرى، إذا حددت عنوان IP للنطاق ZK_HOSTS، استخدِم عنوان IP للنطاق HOSTIP. إذا كنت تستخدم نظام أسماء نطاقات، استخدِم اسمًا لنظام أسماء النطاقات لكليهما.

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

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

ZK_CLIENT_HOSTS

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

استخدِم التنسيق HOSTIP نفسه المستخدَم في ZK_CLIENT_HOSTS. بتعبير آخر، إذا حدّدت عنوان IP للنطاق ZK_CLIENT_HOSTS، استخدِم عنوان IP للنطاق HOSTIP. إذا كنت تستخدم نظام أسماء نطاقات، استخدِم اسم نظام أسماء النطاقات لكليهما.

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

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

CASS_CLUSTERNAME اختياريًا، حدِّد اسم مجموعة كاساندرا. الاسم التلقائي هو "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، يمكنك ضبط اسم المستخدم وكلمة المرور الخاصَين بـ "كاساندرا" باستخدام هذه السمات.

بعد اكتمال التثبيت، تنصح 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

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

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

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

CASS_JMX_USERNAME اسم مستخدم Cassandra JMX مطلوب في حال تفعيل مصادقة Cassandra JMX.
CASS_JMX_PASSWORD كلمة مرور Cassandra JMX مطلوب في حال تفعيل مصادقة Cassandra JMX.
CASS_JMX_TRUSTSTORE اسم مستخدم Cassandra JMX Truststore SSL، إذا تم تفعيل JMX المستندة إلى طبقة المقابس الآمنة في كاساندرا. يجب أن يكون ملف JMX Truststore قابلاً للقراءة بواسطة مستخدم Apigee.
CASS_JMX_TRUSTSTORE_PASS كلمة مرور Cassandra JMX SSL الموثوقة، إذا كنت قد فعّلت JMX المستندة إلى طبقة المقابس الآمنة في Cassandra.
QPID_MGMT_USERNAME
QPID_MGMT_PASSWORD
توفّر بيانات الاعتماد هذه إمكانية الوصول إلى وحدة التحكم في إدارة الويب Qpid التابعة لوسيط Qpid. توفر وحدة التحكم في إدارة الويب واجهة بسيطة وسهلة لإدارة وسيط Qpid والتحكم فيه.

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