הפניה לקובץ תצורה של 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/DNS כשמציינים את כתובת ה-IP של צומת, אסור להשתמש במיפוי של שם מארח ל-127.0.0.1 או בכתובת IP של 127.0.0.1.

הערה: בהגדרות של מארח Cassandra, צריך להשתמש רק בכתובות IP ולא בשמות DNS.

ENABLE_SYSTEM_CHECK

אם התשובה היא y, בודקים שהמערכת עומדת בדרישות המעבד והזיכרון של הרכיב שמנסים להתקין. בקטע דרישות ההתקנה מפורטות הדרישות לכל רכיב.

ערך ברירת המחדל הוא n (לביטול הבדיקה).

ENABLE_DYNAMIC_HOSTIP

אם לשרת יש כמה כרטיסי ממשק, הפקודה hostname -i מחזירה רשימה של כתובות IP שמופרדות ברווחים. כברירת מחדל, תוכנת ההתקנה של Edge משתמשת בכתובת ה-IP הראשונה שמוחזרת, ויכול להיות שהיא לא נכונה בכל המצבים. לחלופין, אפשר להגדיר את המאפיין הבא בקובץ ההגדרה של ההתקנה.

אם ההגדרה היא y, תוכנת ההתקנה תבקש מכם לבחור את כתובת ה-IP שבה רוצים להשתמש בהתקנה. ערך ברירת המחדל הוא n.

ADMIN_EMAIL
APIGEE_ADMINPW

הסיסמה של מנהל המערכת צריכה להיות באורך של 8 תווים לפחות, ולכלול אות גדולה אחת, אות קטנה אחת, ספרה אחת או תו מיוחד אחד. אם לא תזינו את הסיסמה, תתבקשו להזין אותה.

אחרי שההתקנה מסתיימת, מומלץ להסיר את הסיסמה מקובץ ההגדרה.

LICENSE_FILE

המיקום של קובץ הרישיון, שצריך להיות נגיש למשתמש apigee. לדוגמה, אפשר לאחסן אותו בספרייה ‎ /tmp ולהשתמש בפקודה chmod 777 בקובץ. הקובץ מועתק לספריית ההתקנה של Edge.

APIGEE_LDAPPW

מציינת את הסיסמה של OpenLDAP.

אחרי שההתקנה מסתיימת, מומלץ להסיר את הסיסמה מקובץ ההגדרה.

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 peer.
  • LDAP_PEER=10.0.0.1 – כתובת ה-IP או שם ה-DNS של עמית LDAP.
MP_POD מציינים את השם של ה-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. אם אתם משתמשים ב-DNS, צריך להשתמש בשם DNS בשניהם.

בסביבה עם כמה מרכזי נתונים, צריך לפרט את כל צמתי ZooKeeper משני מרכזי הנתונים.

צריך לציין את התוסף ‎:observer בצמתי ZooKeeper רק כשיוצרים כמה מרכזי נתונים כמו שמתואר בהתקנה של 12 מארחים. בהתקנה של מרכז נתונים יחיד, משמיטים את התוסף הזה. מידע נוסף זמין במאמר בנושא התקנה באשכול של 12 מארחים.

ZK_CLIENT_HOSTS

כתובות ה-IP או שמות ה-DNS של צמתי ZooKeeper שמשמשים את מרכז הנתונים הזה. כתובות ה-IP או שמות ה-DNS צריכים להופיע באותו סדר בכל צמתי ZooKeeper.

צריך להשתמש באותו פורמט במאפיין HOSTIP כמו במאפיין ZK_CLIENT_HOSTS. כלומר, אם מציינים את כתובת ה-IP של ZK_CLIENT_HOSTS, צריך להשתמש בכתובת IP של HOSTIP. אם אתם משתמשים ב-DNS, צריך להשתמש בשם DNS בשניהם.

בהתקנה במרכז נתונים יחיד, אלה אותם צמתים שצוינו על ידי ZK_HOSTS.

בסביבה מרובת מרכזי נתונים, צריך לציין רק את צמתי ZooKeeper במרכז הנתונים הזה. מידע נוסף זמין במאמר בנושא התקנה באשכול של 12 מארחים.

CASS_CLUSTERNAME אפשר לציין את השם של אשכול Cassandra. שם ברירת המחדל הוא Apigee.
CASS_HOSTS

מציינת רשימה מופרדת בפסיקים של כתובות ה-IP של המארחים של צמתי Cassandra (לא שמות DNS), ואופציונלית את מספר מרכז הנתונים והמתלה שאליו הם שייכים.

בטופולוגיות של סביבת ייצור, צריכים להיות לפחות שלושה צמתים ברשימה הזו. שני הצמתים הראשונים משמשים כ'שרתי זרע'. כתוצאה מכך, כתובות ה-IP צריכות להופיע באותו סדר בכל צמתי Cassandra.

התחביר של כל רשומה ברשימה הוא:

IP_address[:data_center_number,rack_number]

אפשר לציין את מרכז הנתונים ואת המתלה של צומת Cassandra. צריך לציין את המשנה data_center_number רק כשיוצרים כמה מרכזי נתונים כמו שמתואר בהתקנה של 12 מארחים. אם מדובר בהתקנה במרכז נתונים יחיד, לא צריך להוסיף את המשנה הזה.

לדוגמה,‎192.168.124.201:1, 1 = datacenter 1 and rack/availability zone 1,and‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎

בסביבה עם כמה מרכזי נתונים, כדי לפתור בעיות בחומת האש, צריך להזמין את CASS_HOSTS באופן כזה (כמו בדוגמה שלמעלה) שהצמתים של מרכז הנתונים הנוכחי יוצבו בהתחלה. מידע נוסף זמין במאמר בנושא התקנה באשכול של 12 מארחים.

מידע על הגדרת rack_number למארח Cassandra מופיע במאמר הוספת תמיכה ב-Cassandra rack.

CASS_AUTH
CASS_USERNAME
CASS_PASSWORD

אם מפעילים אימות של Cassandra‏, CASS_AUTH=y, אפשר להעביר את שם המשתמש והסיסמה של Cassandra באמצעות המאפיינים האלה.

אחרי שההתקנה מסתיימת, מומלץ להסיר את הסיסמה מקובץ ההגדרה.

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 כדי להגדיר סיסמה עם ערך שונה לשני המשתמשים בזמן ההתקנה.

אחרי שההתקנה מסתיימת, מומלץ להסיר את הסיסמה מקובץ ההגדרה.

PG_MASTER
PG_STANDBY

הגדרה להפעלת שכפול של Postgres master-standby, בתבנית:

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 SSL truststore, אם הפעלתם JMX מבוסס SSL ב-Cassandra. משתמש Apigee צריך להיות בעל הרשאת קריאה לקובץ JMX Truststore.
CASS_JMX_TRUSTSTORE_PASS סיסמה של Cassandra JMX SSL truststore, אם הפעלתם JMX מבוסס-SSL ב-Cassandra.
QPID_MGMT_USERNAME
QPID_MGMT_PASSWORD
פרטי הכניסה האלה מספקים גישה ל Qpid Web Management Console של ברוקר Qpid. מסוף הניהול באינטרנט מספק ממשק פשוט ואינטואיטיבי לניהול ולשליטה ב-Qpid broker.
USE_CQLUTIL הדגל הזה מאפשר להגדרת התצורה הבסיסית להתאים לסביבת AL2023.

בנוסף למאפיינים שמפורטים כאן, יש מאפיינים להגדרת Apigee mTLS. מידע נוסף זמין במאמר בנושא הגדרת Apigee mTLS.