הפניה לקובץ תצורה של 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

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

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

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

ENABLE_SYSTEM_CHECK

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

ערך ברירת המחדל הוא 'n' כדי להשבית את הבדיקה.

ENABLE_DYNAMIC_HOSTIP

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

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

ADMIN_EMAIL
APIGEE_ADMINPW

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

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

LICENSE_FILE

המיקום של קובץ הרישיון, אשר חייב להיות נגיש למשתמש ה-API. לדוגמה, מאחסנים אותו בספרייה /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 מציינים את השם של מעבד ההודעות ושל רצף הנתב. כברירת מחדל, השם הוא שער.
REGION

שם האזור. לפי המוסכמה, השמות בדרך כלל מופיעים בצורה dc-# כאשר # תואם לערך של מספר שלם. לדוגמה, dc-1 , dc-2 וכו'. אפשר להשתמש ב-dc-1 אלא אם מתקינים אותו בסביבה של מרכז נתונים מרובה.

בהתקנה של כמה מרכז נתונים, הערך הוא dc-1 או dc-2 וכו', בהתאם למרכז הנתונים שמתקינים. עם זאת, אינך מוגבל לשימוש רק בשמות בצורת dc-#. אפשר להשתמש בכל שם עבור האזור.

REGION_MAPPING

אם משתמשים בשמות אזורים שאינם dc-1, dc-2 וכו', צריך להגדיר את המאפיין הזה כך שימפות את שם האזור לשם האזור המתאים בפורמט dc-x. המאפיין הזה נדרש על ידי שרת הניהול כדי לרשום כראוי מאגרים של נתונים ב-Cassandra, על סמך מרכזי הנתונים והאזורים של קסנדרה.

ZK_HOSTS

כתובות ה-IP או שמות ה-DNS של צומתיzoKeeper. כתובות ה-IP או שמות ה-DNS חייבים להיות רשומים באותו סדר בכל הצמתים שלzoKeeper.

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

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

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

ZK_CLIENT_HOSTS

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

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

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

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

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

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

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

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