Referensi File Konfigurasi Edge

Berikut adalah contoh file konfigurasi senyap lengkap untuk penginstalan Edge 9 node. Edit file ini sesuai kebutuhan untuk konfigurasi Anda. Gunakan opsi -f ke setup.sh untuk menyertakan file ini. Untuk mengetahui contoh file konfigurasi yang khusus untuk setiap topologi, lihat Menginstal komponen 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
    
    # FIPS_OS should be set to true when OPDK 4.53 or later is installed on 
    # FIPS enabled operating system
    FIPS_OS=false
    

Tabel berikut berisi informasi tambahan tentang properti ini:

Properti Catatan
Nama IP/DNS Jangan gunakan pemetaan nama host ke 127.0.0.1 atau alamat IP 127.0.0.1 saat menentukan alamat IP node.

Perhatikan bahwa untuk definisi host Cassandra, hanya gunakan alamat IP; jangan gunakan nama DNS.

ENABLE_SYSTEM_CHECK

Jika "y", pastikan sistem memenuhi persyaratan CPU dan memori untuk komponen yang diinstal. Lihat Persyaratan Penginstalan untuk mengetahui persyaratan setiap komponen.

Nilai defaultnya adalah "n" untuk menonaktifkan pemeriksaan.

ENABLE_DYNAMIC_HOSTIP

Jika server memiliki beberapa kartu antarmuka, perintah "hostname -i" akan menampilkan daftar alamat IP yang dipisahkan spasi. Secara default, penginstal Edge menggunakan alamat IP pertama yang ditampilkan, yang mungkin tidak benar dalam semua situasi. Sebagai alternatif, Anda dapat menetapkan properti berikut di file konfigurasi penginstalan.

Jika ditetapkan ke "y", penginstal akan meminta Anda untuk memilih alamat IP yang akan digunakan dalam penginstalan. Nilai defaultnya adalah "n".

ADMIN_EMAIL
APIGEE_ADMINPW

Sandi administrator sistem harus memiliki minimal 8 karakter dan berisi satu huruf besar, satu huruf kecil, satu angka, atau satu karakter khusus. Jika Anda menghapus sandi, Anda akan diminta untuk memasukkannya.

Setelah penginstalan selesai, Apigee merekomendasikan agar Anda menghapus sandi dari file konfigurasi.

LICENSE_FILE

Lokasi file lisensi, yang harus dapat diakses oleh pengguna "apigee". Misalnya, simpan di direktori /tmp dan chmod 777 pada file. File disalin ke direktori penginstalan Edge.

APIGEE_LDAPPW

Menentukan sandi OpenLDAP.

Setelah penginstalan selesai, Apigee merekomendasikan agar Anda menghapus sandi dari file konfigurasi.

USE_LDAP_REMOTE_HOST
LDAP_HOST
LDAP_PORT

Jika USE_LDAP_REMOTE_HOST adalah n, Edge akan otomatis menginstal OpenLDAP saat menginstal Server Pengelolaan.

Setel USE_LDAP_REMOTE_HOST ke y jika Anda terhubung ke server LDAP jarak jauh. OpenLDAP tidak diinstal dengan Server Pengelolaan.

Jika Anda terhubung ke server OpenLDAP jarak jauh, gunakan LDAP_HOST dan LDAP_PORT untuk menentukan alamat IP atau nama DNS dan nomor port host.

LDAP_TYPE
LDAP_SID
LDAP_PEER

Tetapkan LDAP_TYPE=1 untuk OpenLDAP tanpa replikasi. LDAP_TYPE=2 sesuai dengan OpenLDAP dengan replikasi.

Jika topologi Edge Anda menggunakan satu server OpenLDAP, tentukan 1. Jika penginstalan Edge Anda menggunakan beberapa node OpenLDAP, seperti dalam penginstalan produksi 13 node, tentukan 2.

Jika Anda mengaktifkan replikasi, tetapkan properti berikut:

  • LDAP_SID=1 - ID unik untuk server LDAP ini. Setiap node LDAP menggunakan ID yang berbeda. Misalnya, ditetapkan ke 2 untuk peer LDAP.
  • LDAP_PEER=10.0.0.1 - Nama IP atau DNS peer LDAP.
MP_POD Tentukan nama pod Message Processor dan Router. Secara default, namanya adalah gateway.
REGION

Nama wilayah. Berdasarkan konvensi, nama biasanya dalam bentuk dc-# dengan # sesuai dengan nilai bilangan bulat. Misalnya, dc-1, dc-2, dll. Anda dapat menggunakan dc-1 kecuali jika menginstal di lingkungan multi-data center.

Dalam penginstalan beberapa data center, nilainya adalah dc-1, atau dc-2, dll., bergantung pada data center yang Anda instal. Namun, Anda tidak hanya dibatasi untuk menggunakan nama dalam bentuk dc-#. Anda dapat menggunakan nama apa pun untuk region.

REGION_MAPPING

Jika Anda menggunakan nama region selain dc-1, dc-2, dll., tetapkan properti ini untuk memetakan nama region Anda ke nama region format dc-x yang sesuai. Properti ini diperlukan oleh server Pengelolaan untuk mendaftarkan penyimpanan data Cassandra dengan benar berdasarkan pusat data dan region Cassandra.

ZK_HOSTS

Alamat IP atau nama DNS node ZooKeeper. Alamat IP atau nama DNS harus tercantum dalam urutan yang sama di semua node ZooKeeper.

Gunakan format yang sama untuk HOSTIP seperti yang Anda gunakan untuk ZK_HOSTS. Artinya, jika Anda menentukan alamat IP untuk ZK_HOSTS, gunakan alamat IP untuk HOSTIP. Jika Anda menggunakan DNS, gunakan nama DNS untuk keduanya.

Dalam lingkungan multi-pusat data, cantumkan semua node ZooKeeper dari kedua pusat data.

Tentukan pengubah ":observer" pada node ZooKeeper hanya saat membuat beberapa pusat data seperti yang dijelaskan dalam penginstalan 12 host. Dalam satu penginstalan pusat data, hapus pengubah tersebut. Untuk informasi selengkapnya, lihat Penginstalan cluster 12 host.

ZK_CLIENT_HOSTS

Alamat IP atau nama DNS node ZooKeeper yang digunakan oleh pusat data ini. Alamat IP atau nama DNS harus dicantumkan dalam urutan yang sama di semua node ZooKeeper.

Gunakan format yang sama untuk HOSTIP seperti yang Anda gunakan untuk ZK_CLIENT_HOSTS. Artinya, jika Anda menentukan alamat IP untuk ZK_CLIENT_HOSTS, gunakan alamat IP untuk HOSTIP. Jika Anda menggunakan DNS, gunakan nama DNS untuk keduanya.

Dalam satu penginstalan pusat data, ini adalah node yang sama seperti yang ditentukan oleh ZK_HOSTS.

Dalam lingkungan multi-pusat data, cantumkan hanya node ZooKeeper di pusat data ini. Untuk informasi selengkapnya, lihat Penginstalan cluster 12 host.

CASS_CLUSTERNAME Atau, tentukan nama cluster Cassandra. Nama defaultnya adalah "Apigee".
CASS_HOSTS

Menentukan daftar alamat IP host node Cassandra (bukan nama DNS) yang dipisahkan koma, dan secara opsional nomor pusat data dan rak tempat node tersebut berada.

Untuk topologi produksi, harus ada minimal tiga node dalam daftar ini. Dua node pertama digunakan sebagai "server seed". Akibatnya, alamat IP harus dicantumkan dalam urutan yang sama di semua node Cassandra.

Sintaksis untuk setiap entri dalam daftar adalah sebagai berikut:

IP_address[:data_center_number,rack_number]

Node Cassandra secara opsional dapat menentukan pusat data dan rak node Cassandra. Tentukan pengubah data_center_number hanya saat membuat beberapa pusat data seperti yang dijelaskan dalam penginstalan 12 host. Dalam satu penginstalan pusat data, hapus pengubah tersebut.

Misalnya '192.168.124.201:1,1 = pusat data 1 dan zona rak/ketersediaan 1, dan '192.168.124.204:2,1 = pusat data 2 dan zona rak/ketersediaan 1.

Dalam lingkungan multi-datacenter, untuk mengatasi masalah firewall, CASS_HOSTS harus diurutkan dengan cara (seperti yang ditunjukkan pada contoh di atas) sehingga node datacenter saat ini ditempatkan di awal. Untuk informasi selengkapnya, lihat Penginstalan cluster 12 host.

Untuk informasi tentang cara menentukan rack_number untuk host Cassandra, lihat Menambahkan dukungan rak Cassandra.

CASS_AUTH
CASS_USERNAME
CASS_PASSWORD

Jika mengaktifkan autentikasi Cassandra, CASS_AUTH=y, Anda dapat meneruskan nama dan sandi pengguna Cassandra menggunakan properti ini.

Setelah penginstalan selesai, Apigee merekomendasikan agar Anda menghapus sandi dari file konfigurasi.

CONFIG_DELTA_LOG

CONFIG_DELTA_LOG mengontrol cara perubahan pada file konfigurasi dicatat ke dalam log. Jika Anda menetapkan CONFIG_DELTA_LOG=y, perubahan konfigurasi untuk suatu komponen tidak akan dicatat dalam log.

PG_USER
PG_PWD

Secara default, database PostgreSQL memiliki dua pengguna yang ditentukan: 'postgres' dan 'apigee'.

PG_USER memungkinkan Anda mengubah nama pengguna 'apigee'. Anda tidak dapat mengubah nama pengguna 'postgres'.

Secara default, database PostgreSQL memiliki dua pengguna yang ditentukan: 'postgres' dan 'apigee'. Kedua pengguna memiliki sandi default 'postgres'. Gunakan PG_PWD untuk menetapkan sandi ke nilai yang berbeda untuk kedua pengguna pada waktu penginstalan.

Setelah penginstalan selesai, Apigee merekomendasikan agar Anda menghapus sandi dari file konfigurasi.

PG_MASTER
PG_STANDBY

Ditetapkan untuk mengaktifkan replikasi master-standby Postgres, dalam bentuk:

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

Konfigurasi SMTP agar Edge dapat mengirim email untuk sandi yang hilang dan notifikasi lainnya.

Jika kredensial pengguna SMTP tidak diperlukan, hapus SMTPUSER dan SMTPPASSWORD.

SMTPMAILFROM wajib diisi.

CASS_JMX_USERNAME Nama pengguna JMX Cassandra. Wajib jika Anda mengaktifkan autentikasi JMX Cassandra.
CASS_JMX_PASSWORD Sandi JMX Cassandra. Wajib jika Anda mengaktifkan autentikasi JMX Cassandra.
CASS_JMX_TRUSTSTORE Nama pengguna truststore SSL JMX Cassandra, jika Anda telah mengaktifkan JMX berbasis SSL di Cassandra. File JMX Truststore harus dapat dibaca oleh pengguna Apigee.
CASS_JMX_TRUSTSTORE_PASS Sandi truststore SSL JMX Cassandra, jika Anda telah mengaktifkan JMX berbasis SSL di Cassandra.
QPID_MGMT_USERNAME
QPID_MGMT_PASSWORD
Kredensial ini memberikan akses ke Qpid Web Management Console broker Qpid. Web Management Console menyediakan antarmuka yang sederhana dan intuitif untuk pengelolaan dan kontrol broker Qpid.
FIPS_OS FIPS_OS dapat berupa benar atau salah, dengan nilai default salah. Tetapkan ke true untuk Edge for Private Cloud versi 4.53.00 atau yang lebih baru di sistem operasi yang mengaktifkan FIPS.

Selain properti yang tercantum di sini, ada juga properti untuk mengonfigurasi Apigee mTLS. Untuk informasi selengkapnya, lihat Mengonfigurasi mTLS Apigee.