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

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

אם התשובה היא "כן", בודקים אם המערכת עומדת בדרישות המעבד (CPU) והזיכרון של הרכיב שמותקן. בקטע דרישות ההתקנה מפורטות הדרישות לכל רכיב.

ערך ברירת המחדל הוא 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

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

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

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 peer.
  • LDAP_PEER=10.0.0.1 – כתובת IP או שם DNS של שרת LDAP.
MP_POD מציינים את השם של pod מעבד הבקשות ו-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), ובאופן אופציונלי את מספר מרכז הנתונים והמתלה שאליו הם שייכים.

בטופולוגיות של סביבת ייצור, צריכים להיות לפחות שלושה צמתים ברשימה הזו. שני הצמתים הראשונים משמשים כ "שרתי seed". לכן, כתובות ה-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 מארחים.

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

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