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

في ما يلي مثال على ملف إعداد كامل بدون أي تدخل من المستخدم لعملية تثبيت Edge على 9 عقد. عدِّل هذا الملف حسب الضرورة لإعداداتك. استخدِم الخيار -f لـ setup.sh لتضمين هذا الملف. للحصول على أمثلة على ملفات الإعدادات الخاصة بكل مخطط، يُرجى الاطّلاع على تثبيت مكوّنات Edge.

    # IP address or DNS name of nodes.
    IP1=192.168.1.1  # Management Server, SymasLDAP, 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.
    
    # SymasLDAP information.
    # Set to y if you are connecting to a remote LDAP server.
    # If n, Edge installs SymasLDAP when it installs the Management Server.
    USE_LDAP_REMOTE_HOST=n
    
    # If connecting to remote SymasLDAP server, specify the IP/DNS name and port.
    # LDAP_HOST=$IP1    # IP or DNS name of SymasLDAP node.
    # LDAP_PORT=10389   # Default is 10389.
    APIGEE_LDAPPW=yourLdapPassword
    
    # Specify SymasLDAP 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

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

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

يُرجى العِلم أنّه بالنسبة إلى تعريفات مضيف Cassandra، يجب استخدام عناوين IP فقط، وعدم استخدام أسماء DNS.
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

تحدّد هذه السمة كلمة مرور SymasLDAP.

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

USE_LDAP_REMOTE_HOST
LDAP_HOST
LDAP_PORT

إذا كانت قيمة USE_LDAP_REMOTE_HOST هي n، يثبّت Edge برنامج SymasLDAP تلقائيًا عند تثبيت خادم الإدارة.

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

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

اضبط LDAP_TYPE=1 لـ SymasLDAP بدون نسخ مماثل. LDAP_TYPE=2 تتوافق مع SymasLDAP مع النسخ المتماثل.

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

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

  • LDAP_SID=1 - معرّف فريد لخادم LDAP هذا. يستخدم كل عقدة LDAP معرّفًا مختلفًا. على سبيل المثال، اضبطه على 2 لجهاز LDAP النظير.
  • LDAP_PEER=10.0.0.1 - عنوان 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 أو أسماء نظام أسماء النطاقات بالترتيب نفسه على جميع عُقد 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 rack.
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 اسم مستخدم Cassandra JMX مطلوب إذا فعّلت مصادقة Cassandra JMX.
CASS_JMX_PASSWORD كلمة مرور Cassandra JMX مطلوب إذا فعّلت مصادقة Cassandra JMX.
CASS_JMX_TRUSTSTORE اسم مستخدم ملف تخزين الشهادات الموثوقة لبروتوكول JMX المستند إلى طبقة المقابس الآمنة في Cassandra، إذا فعّلت بروتوكول JMX المستند إلى طبقة المقابس الآمنة في Cassandra يجب أن يكون ملف JMX Truststore قابلاً للقراءة من قِبل مستخدم Apigee.
CASS_JMX_TRUSTSTORE_PASS كلمة مرور مخزن الثقة لـ Cassandra JMX SSL، إذا فعّلت JMX المستند إلى SSL في Cassandra.
QPID_MGMT_USERNAME
QPID_MGMT_PASSWORD 		توفّر بيانات الاعتماد هذه إمكانية الوصول إلى Qpid Web Management Console الخاصة بالوسيط Qpid. توفّر "وحدة تحكّم الإدارة على الويب" واجهة بسيطة وسهلة الاستخدام لإدارة وسيط Qpid والتحكّم فيه.

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