הפניה לקובץ תצורה של Edge

בהמשך מוצגת דוגמה לקובץ תצורה מלא להתקנה של 9 צמתים של 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="<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=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 =
    
# Use this property to enable logging of delta changes to configuration files. To disable, set the value to 'n'.
CONFIG_DELTA_LOG=y

בטבלה הבאה מפורט מידע נוסף על המאפיינים האלה:

נכס הערה
שמות IP/DNS אל תשתמשו במיפוי של שם מארח ל-127.0.0.1 או בכתובת IP של 127.0.0.1 כשמציינים את כתובת ה-IP של צומת.

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

ENABLE_SYSTEM_CHECK

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

ערך ברירת המחדל הוא '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=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 או שמות ה-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, וגם '192.168.124.204:2,1 = datacenter 2 and rack/availability zone 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

מגדירים את ההגדרה הזו כדי להפעיל את העתקה (replication) של Postgres בין שרתים ראשיים לבין שרתים במצב המתנה, בצורה הבאה:

PG_MASTER=IPofNewMaster
PG_STANDBY=IPofOldMaster
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 ב-SSL של Cassandra, אם הפעלתם JMX מבוסס SSL ב-Cassandra. קובץ JMX Truststore צריך להיות קריא למשתמש Apigee.
CASS_JMX_TRUSTSTORE_PASS סיסמה של מאגר אמון SSL של JMX ב-Cassandra, אם הפעלתם JMX מבוסס-SSL ב-Cassandra.
CONFIG_DELTA_LOG קובע אם יופיעו ביומן דיווחים על שינויים בהגדרות. מגדירים את הערך הזה כ-'y' כדי להדפיס את שינויי התצורה. כדי להשבית את ההדפסה של שינויי ההגדרה, מגדירים את הערך כ-'n'.

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