Tham chiếu tệp cấu hình Edge

Dưới đây là ví dụ về một tệp cấu hình hoàn chỉnh ở chế độ im lặng để cài đặt Edge gồm 9 nút. Chỉnh sửa tệp này nếu cần cho cấu hình của bạn. Sử dụng lựa chọn -f để setup.sh nhằm đưa tệp này vào. Để biết ví dụ về các tệp cấu hình dành riêng cho từng cấu trúc liên kết, hãy xem phần Cài đặt các thành phần 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

Bảng sau đây chứa thông tin bổ sung về các thuộc tính này:

Thuộc tính Lưu ý
Tên IP/DNS Không sử dụng một ánh xạ tên máy chủ đến 127.0.0.1 hoặc một địa chỉ IP là 127.0.0.1 khi chỉ định địa chỉ IP của một nút.

Xin lưu ý rằng đối với các định nghĩa máy chủ Cassandra, bạn chỉ được dùng địa chỉ IP, không được dùng tên DNS.

ENABLE_SYSTEM_CHECK

Nếu là "y", hãy kiểm tra để đảm bảo hệ thống đáp ứng các yêu cầu về CPU và bộ nhớ đối với thành phần đang được cài đặt. Hãy xem Yêu cầu về việc cài đặt để biết các yêu cầu đối với từng thành phần.

Giá trị mặc định là "n" để tắt chế độ kiểm tra.

ENABLE_DYNAMIC_HOSTIP

Nếu một máy chủ có nhiều thẻ giao diện, lệnh "hostname -i" sẽ trả về một danh sách địa chỉ IP được phân tách bằng dấu cách. Theo mặc định, trình cài đặt Edge sẽ sử dụng địa chỉ IP đầu tiên được trả về, có thể không chính xác trong mọi trường hợp. Ngoài ra, bạn có thể thiết lập thuộc tính sau trong tệp cấu hình cài đặt.

Khi bạn đặt thành "y", trình cài đặt sẽ nhắc bạn chọn địa chỉ IP để sử dụng trong quá trình cài đặt. Giá trị mặc định là "n".

ADMIN_EMAIL
APIGEE_ADMINPW

Mật khẩu của quản trị viên hệ thống phải dài ít nhất 8 ký tự và chứa một chữ cái viết hoa, một chữ cái viết thường, một chữ số hoặc một ký tự đặc biệt. Nếu bỏ qua mật khẩu, bạn sẽ được nhắc nhập mật khẩu.

Sau khi quá trình cài đặt hoàn tất, Apigee khuyên bạn nên xoá mật khẩu khỏi tệp cấu hình.

LICENSE_FILE

Vị trí của tệp giấy phép mà người dùng "apigee" phải có quyền truy cập. Ví dụ: lưu trữ tệp đó trong thư mục /tmp và chmod 777 trên tệp. Tệp này được sao chép vào thư mục cài đặt Edge.

APIGEE_LDAPPW

Chỉ định mật khẩu OpenLDAP.

Sau khi quá trình cài đặt hoàn tất, Apigee khuyên bạn nên xoá mật khẩu khỏi tệp cấu hình.

USE_LDAP_REMOTE_HOST
LDAP_HOST
LDAP_PORT

Nếu USE_LDAP_REMOTE_HOST là n, Edge sẽ tự động cài đặt OpenLDAP khi cài đặt Máy chủ quản lý.

Đặt USE_LDAP_REMOTE_HOST thành y nếu bạn đang kết nối với một máy chủ LDAP từ xa. OpenLDAP không được cài đặt cùng với Máy chủ quản lý.

Nếu bạn đang kết nối với một máy chủ OpenLDAP từ xa, hãy dùng LDAP_HOSTLDAP_PORT để chỉ định địa chỉ IP hoặc tên DNS và số cổng của máy chủ.

LDAP_TYPE
LDAP_SID
LDAP_PEER

Đặt LDAP_TYPE=1 cho OpenLDAP không có tính năng sao chép. LDAP_TYPE=2 tương ứng với OpenLDAP có tính năng sao chép.

Nếu cấu trúc liên kết Edge của bạn sử dụng một máy chủ OpenLDAP, hãy chỉ định 1. Nếu chế độ cài đặt Edge của bạn sử dụng nhiều nút OpenLDAP, chẳng hạn như trong chế độ cài đặt sản xuất 13 nút, hãy chỉ định 2.

Nếu bạn bật tính năng sao chép, hãy đặt các thuộc tính sau:

  • LDAP_SID=1 – Mã nhận dạng duy nhất cho máy chủ LDAP này. Mỗi nút LDAP sử dụng một mã nhận dạng riêng. Ví dụ: đặt thành 2 cho LDAP ngang hàng.
  • LDAP_PEER=10.0.0.1 – IP hoặc tên DNS của máy ngang LDAP.
MP_POD Chỉ định tên của nhóm Message Processor và Router. Theo mặc định, tên là gateway.
REGION

Tên khu vực. Theo quy ước, tên thường có dạng dc-#, trong đó # tương ứng với một giá trị nguyên. Ví dụ: dc-1, dc-2, v.v. Bạn có thể sử dụng dc-1 trừ phi cài đặt trong môi trường nhiều trung tâm dữ liệu.

Trong quá trình cài đặt nhiều trung tâm dữ liệu, giá trị là dc-1 hoặc dc-2, v.v. tuỳ thuộc vào trung tâm dữ liệu mà bạn đang cài đặt. Tuy nhiên, bạn không bị hạn chế chỉ sử dụng tên ở dạng dc-#. Bạn có thể sử dụng bất kỳ tên nào cho khu vực.

REGION_MAPPING

Nếu bạn đang sử dụng tên khu vực khác với dc-1, dc-2, v.v., hãy đặt thuộc tính này để liên kết tên khu vực của bạn với tên khu vực có định dạng dc-x thích hợp. Máy chủ Quản lý cần có thuộc tính này để đăng ký các kho dữ liệu Cassandra một cách thích hợp dựa trên các trung tâm dữ liệu và khu vực của Cassandra.

ZK_HOSTS

Địa chỉ IP hoặc tên DNS của các nút ZooKeeper. Địa chỉ IP hoặc tên DNS phải được liệt kê theo cùng một thứ tự trên tất cả các nút ZooKeeper.

Sử dụng cùng một định dạng cho HOSTIP như bạn sử dụng cho ZK_HOSTS. Tức là nếu bạn chỉ định địa chỉ IP cho ZK_HOSTS, hãy sử dụng địa chỉ IP cho HOSTIP. Nếu bạn sử dụng DNS, hãy sử dụng tên DNS cho cả hai.

Trong môi trường nhiều trung tâm dữ liệu, hãy liệt kê tất cả các nút ZooKeeper từ cả hai trung tâm dữ liệu.

Chỉ định hệ số sửa đổi ":observer" trên các nút ZooKeeper khi tạo nhiều trung tâm dữ liệu như mô tả trong quá trình cài đặt 12 máy chủ. Trong một lần cài đặt trung tâm dữ liệu duy nhất, hãy bỏ qua đối tượng sửa đổi đó. Để biết thêm thông tin, hãy xem phần Cài đặt cụm gồm 12 máy chủ.

ZK_CLIENT_HOSTS

Địa chỉ IP hoặc tên DNS của các nút ZooKeeper mà trung tâm dữ liệu này sử dụng. Địa chỉ IP hoặc tên DNS phải được liệt kê theo cùng một thứ tự trên tất cả các nút ZooKeeper.

Sử dụng cùng một định dạng cho HOSTIP như bạn sử dụng cho ZK_CLIENT_HOSTS. Tức là nếu bạn chỉ định địa chỉ IP cho ZK_CLIENT_HOSTS, hãy sử dụng địa chỉ IP cho HOSTIP. Nếu bạn sử dụng DNS, hãy sử dụng tên DNS cho cả hai.

Trong một lần cài đặt trung tâm dữ liệu duy nhất, đây là các nút giống như được chỉ định bởi ZK_HOSTS.

Trong môi trường có nhiều trung tâm dữ liệu, chỉ liệt kê các nút ZooKeeper trong trung tâm dữ liệu này. Để biết thêm thông tin, hãy xem phần Cài đặt cụm gồm 12 máy chủ.

CASS_CLUSTERNAME Bạn có thể chỉ định tên của cụm Cassandra (nếu muốn). Tên mặc định là "Apigee".
CASS_HOSTS

Chỉ định danh sách địa chỉ IP máy chủ của các nút Cassandra (không phải tên DNS) được phân tách bằng dấu phẩy, và không bắt buộc phải có số trung tâm dữ liệu và giá đỡ mà các nút đó thuộc về.

Đối với các cấu trúc liên kết sản xuất, phải có ít nhất 3 nút trong danh sách này. Hai nút đầu tiên được dùng làm "máy chủ gốc". Do đó, bạn phải liệt kê địa chỉ IP theo cùng một thứ tự trên tất cả các nút Cassandra.

Cú pháp cho từng mục trong danh sách như sau:

IP_address[:data_center_number,rack_number]

Các nút Cassandra có thể tuỳ ý chỉ định trung tâm dữ liệu và giá đỡ của nút Cassandra. Chỉ chỉ định hệ số sửa đổi data_center_number khi tạo nhiều trung tâm dữ liệu như mô tả trong quá trình cài đặt 12 máy chủ. Trong một lần cài đặt trung tâm dữ liệu duy nhất, hãy bỏ qua đối tượng sửa đổi đó.

Ví dụ: "192.168.124.201:1,1 = trung tâm dữ liệu 1 và giá đỡ/vùng có thể truy cập 1, và "192.168.124.204:2,1 = trung tâm dữ liệu 2 và giá đỡ/vùng có thể truy cập 1.

Trong môi trường có nhiều trung tâm dữ liệu, để khắc phục các vấn đề về tường lửa, CASS_HOSTS phải được sắp xếp theo cách (như trong ví dụ trên) sao cho các nút của trung tâm dữ liệu hiện tại được đặt ở đầu. Để biết thêm thông tin, hãy xem phần Cài đặt cụm gồm 12 máy chủ.

Để biết thông tin về cách chỉ định rack_number cho một máy chủ Cassandra, hãy xem phần Thêm tính năng hỗ trợ giá đỡ Cassandra.

CASS_AUTH
CASS_USERNAME
CASS_PASSWORD

Nếu bật tính năng xác thực Cassandra, CASS_AUTH=y, bạn có thể truyền tên người dùng và mật khẩu Cassandra bằng cách sử dụng các thuộc tính này.

Sau khi quá trình cài đặt hoàn tất, Apigee khuyên bạn nên xoá mật khẩu khỏi tệp cấu hình.

CONFIG_DELTA_LOG

CONFIG_DELTA_LOG kiểm soát cách ghi nhật ký các thay đổi đối với tệp cấu hình. Nếu bạn đặt CONFIG_DELTA_LOG=y, thì các thay đổi về cấu hình cho một thành phần sẽ không được ghi lại.

PG_USER
PG_PWD

Theo mặc định, cơ sở dữ liệu PostgreSQL có 2 người dùng được xác định: "postgres" và "apigee".

PG_USER cho phép bạn thay đổi tên người dùng của người dùng "apigee". Bạn không thể thay đổi tên của người dùng "postgres".

Theo mặc định, cơ sở dữ liệu PostgreSQL có 2 người dùng được xác định: "postgres" và "apigee". Cả hai người dùng đều có mật khẩu mặc định là "postgres". Sử dụng PG_PWD để đặt mật khẩu thành một giá trị khác cho cả hai người dùng tại thời điểm cài đặt.

Sau khi quá trình cài đặt hoàn tất, Apigee khuyên bạn nên xoá mật khẩu khỏi tệp cấu hình.

PG_MASTER
PG_STANDBY

Đặt để bật tính năng sao chép dự phòng chính của Postgres, ở dạng:

PG_MASTER=IPorDNSofNewMaster
PG_STANDBY=IPorDNSofOldMaster
SKIP_SMTP
SMTPHOST
SMTPUSER
SMTPPASSWORD
SMTPSSL
SMTPPORT
SMTPMAILFROM

Định cấu hình SMTP để Edge có thể gửi email cho mật khẩu bị mất và các thông báo khác.

Nếu không bắt buộc phải có thông tin đăng nhập của người dùng SMTP, hãy bỏ qua SMTPUSERSMTPPASSWORD.

Phải nhập thông tin vào trường SMTPMAILFROM.

CASS_JMX_USERNAME Tên người dùng JMX của Cassandra. Bắt buộc nếu bạn đã bật tính năng xác thực JMX của Cassandra.
CASS_JMX_PASSWORD Mật khẩu Cassandra JMX. Bắt buộc nếu bạn đã bật tính năng xác thực JMX của Cassandra.
CASS_JMX_TRUSTSTORE Tên người dùng truststore SSL JMX Cassandra, nếu bạn đã bật JMX dựa trên SSL trong Cassandra. Người dùng Apigee có thể đọc tệp JMX Truststore.
CASS_JMX_TRUSTSTORE_PASS Mật khẩu truststore SSL JMX của Cassandra, nếu bạn đã bật JMX dựa trên SSL trong Cassandra.
QPID_MGMT_USERNAME
QPID_MGMT_PASSWORD
Những thông tin đăng nhập này cho phép truy cập vào Qpid Web Management Console của Qpid Broker. Bảng điều khiển quản lý trên web cung cấp một giao diện đơn giản và trực quan để quản lý và kiểm soát Qpid Broker.
USE_CQLUTIL Cờ này cho phép chế độ thiết lập cấu hình cơ bản phù hợp với môi trường AL2023.

Ngoài các thuộc tính được liệt kê ở đây, còn có các thuộc tính để định cấu hình Apigee mTLS. Để biết thêm thông tin, hãy xem phần Định cấu hình mTLS của Apigee.