Cara mengonfigurasi Edge

Edge untuk Private Cloud v4.19.01

Untuk mengonfigurasi Edge setelah penginstalan, Anda menggunakan kombinasi file .properties dan utilitas Edge. Misalnya, untuk mengonfigurasi TLS/SSL pada UI Edge, Anda mengedit file .properties untuk menetapkan properti yang diperlukan. Perubahan pada file .properties mengharuskan Anda memulai ulang komponen Edge yang terpengaruh.

Apigee mengacu pada teknik pengeditan file .properties sebagai kode dengan konfigurasi (terkadang disingkat CwC). Pada dasarnya, kode dengan konfigurasi adalah alat pencarian kunci/nilai berdasarkan setelan dalam file .properties. Dalam kode dengan konfigurasi, kunci tersebut disebut sebagai token. Oleh karena itu, untuk mengonfigurasi Edge, Anda perlu menetapkan token dalam file .properties.

Kode dengan konfigurasi memungkinkan komponen Edge untuk menetapkan nilai default yang dikirimkan dengan produk, memungkinkan tim penginstalan mengganti setelan tersebut berdasarkan topologi penginstalan, lalu memungkinkan pelanggan mengganti properti apa pun yang mereka pilih.

Jika Anda menganggapnya sebagai hierarki, setelannya akan diatur sebagai berikut, dengan setelan pelanggan yang memiliki prioritas tertinggi untuk mengganti setelan apa pun dari tim penginstal atau Apigee:

1. Pelanggan
2. Penginstal
3. Komponen

Menentukan nilai token saat ini

Sebelum menetapkan nilai baru untuk token dalam file .properties, Anda harus terlebih dahulu menentukan nilai current dengan menggunakan perintah berikut:

/opt/apigee/apigee-service/bin/apigee-service component_name configure -search token

Dengan component_name sebagai nama komponen, dan token sebagai token yang akan diperiksa.

Perintah ini menelusuri hierarki file .properties komponen untuk menentukan nilai token saat ini.

Contoh berikut memeriksa nilai token conf_http_HTTPRequest.line.limit saat ini untuk Router:

/opt/apigee/apigee-service/bin/apigee-service edge-router configure -search conf_http_HTTPRequest.line.limit

Anda akan melihat output yang terlihat seperti berikut:

Found key conf_http_HTTPRequest.line.limit, with value, 4k, in /opt/apigee/edge-router/token/default.properties

Jika nilai token dimulai dengan #, nilai tersebut telah diberi komentar dan Anda harus menggunakan sintaksis khusus untuk mengubahnya. Untuk informasi selengkapnya, lihat Menetapkan token yang saat ini dikomentari.

Jika Anda tidak mengetahui seluruh nama token, gunakan alat seperti grep untuk menelusuri nama properti atau kata kunci. Untuk mengetahui informasi selengkapnya, lihat Menemukan token.

File properti

Ada file konfigurasi komponen yang dapat diedit dan tidak dapat diedit. Bagian ini menjelaskan file tersebut.

File konfigurasi komponen yang dapat diedit

Tabel berikut mencantumkan komponen Apigee dan file properti yang dapat Anda edit untuk mengonfigurasi komponen tersebut:

Jika ingin menetapkan properti di salah satu file konfigurasi komponen ini tetapi tidak ada, Anda dapat membuatnya di lokasi yang tercantum di atas.

Selain itu, Anda harus memastikan bahwa file properti dimiliki oleh pengguna "apigee":

chown apigee:apigee /opt/apigee/customer/application/configuration_file.properties

File konfigurasi komponen yang tidak dapat diedit

Selain file konfigurasi komponen yang dapat diedit, ada juga file konfigurasi yang tidak dapat Anda edit.

File informasi (tidak dapat diedit) meliputi:

/opt/apigee/token

/opt/apigee/component_name/conf

Menetapkan nilai token

Anda hanya dapat mengubah file .properties dalam direktori /opt/apigee/customer/application. Setiap komponen memiliki file .properties sendiri di direktori tersebut. Misalnya, router.properties dan management-server.properties. Untuk mengetahui daftar lengkap file properti, lihat Lokasi file .properties.

Untuk membuat file .properties:

1. Membuat file teks baru di editor. Nama file harus cocok dengan daftar yang ditampilkan dalam tabel di atas untuk file pelanggan.
2. Ubah pemilik file menjadi "apigee:apigee", seperti yang ditunjukkan contoh berikut:

   chown apigee:apigee /opt/apigee/customer/application/router.properties

   Jika Anda mengubah pengguna yang menjalankan layanan Edge dari pengguna "apigee", gunakan chown untuk mengubah kepemilikan kepada pengguna yang menjalankan layanan Edge.

Saat Anda mengupgrade Edge, file .properties di direktori /opt/apigee/customer/application akan dibaca. Artinya, upgrade tersebut akan mempertahankan semua properti yang Anda tetapkan pada komponen.

Untuk menetapkan nilai token:

1. Edit file .properties komponen.
2. Tambahkan atau ubah nilai token. Contoh berikut menetapkan nilai properti conf_http_HTTPRequest.line.limit ke "10k":

   conf_http_HTTPRequest.line.limit=10k

   Jika token menggunakan beberapa nilai, pisahkan setiap nilai dengan koma, seperti yang ditunjukkan contoh berikut:

   conf_security_rbac.restricted.resources=/environments,/environments/*,/environments/*/virtualhosts,/environments/*/virtualhosts/*,/pods,/environments/*/servers,/rebuildindex,/users/*/status,/myuri/*

   Untuk menambahkan nilai baru ke daftar seperti ini, Anda biasanya dapat menambahkan nilai baru ini ke bagian akhir daftar.

3. Mulai ulang komponen:

   /opt/apigee/apigee-service/bin/apigee-service component_name restart

   Dengan component_name adalah salah satu dari yang berikut:

   • apigee-cassandra (Cassandra)
   • apigee-openldap (OpenLDAP)
   • apigee-postgresql (Database PostgreSQL)
   • apigee-qpidd (Qpidd)
   • apigee-sso (SSO Edge)
   • apigee-zookeeper (ZooKeeper)
   • edge-management-server (Server Pengelolaan)
   • edge-management-ui (UI Edge baru)
   • edge-message-processor (Pemroses Pesan)
   • edge-postgres-server (Server Postgres)
   • edge-qpid-server (Server Qpid)
   • edge-router (Router Tepi)
   • edge-ui (UI Klasik)

   Misalnya, setelah mengedit router.properties, mulai ulang Router:

   /opt/apigee/apigee-service/bin/apigee-service edge-router restart

4. (Opsional) Pastikan nilai token ditetapkan ke nilai baru menggunakan opsi configure -search. Contoh:

   /opt/apigee/apigee-service/bin/apigee-service edge-router configure -search conf_http_HTTPRequest.line.limit

   Untuk informasi selengkapnya tentang configure -search, lihat Menentukan nilai token saat ini.

Menemukan token

Pada umumnya, token yang perlu Anda tetapkan diidentifikasi dalam panduan ini. Namun, jika Anda perlu mengganti nilai token yang ada yang nama lengkap atau lokasinya tidak Anda ketahui, gunakan grep untuk menelusuri direktori source komponen.

Misalnya, jika Anda mengetahui bahwa dalam rilis Edge sebelumnya, Anda menetapkan properti session.maxAge dan ingin mengetahui nilai token yang digunakan untuk menetapkannya, lalu grep untuk properti di direktori /opt/apigee/edge-ui/source:

grep -ri "session.maxAge" /opt/apigee/edge-ui/source

Anda akan melihat hasilnya dalam formulir berikut:

/opt/apigee/component_name/source/conf/application.conf:property_name={T}token_name{/T}

Contoh berikut menunjukkan nilai token session.maxAge UI:

/opt/apigee/edge-ui/source/conf/application.conf:session.maxAge={T}conf_application_session.maxage{/T}

String di antara tag {T}{/T} adalah nama token yang dapat Anda tetapkan dalam file .properties UI.

Menetapkan token yang saat ini diberi komentar

Beberapa token diberi komentar dalam file konfigurasi Edge. Jika Anda mencoba menetapkan token yang diberi komentar dalam file konfigurasi instal atau komponen, setelan Anda akan diabaikan.

Untuk menetapkan nilai token yang dikomentari dalam file konfigurasi Edge, gunakan sintaksis khusus dalam formulir berikut:

conf/filename+propertyName=propertyValue

Misalnya, untuk menetapkan properti HTTPClient.proxy.host pada Pemroses Pesan, grep pertama untuk properti guna menentukan tokennya:

grep -ri /opt/apigee/edge-message-processor/ -e "HTTPClient.proxy.host"

Perintah grep menampilkan hasil yang menyertakan nama token. Perhatikan cara nama properti diberi komentar, seperti yang ditunjukkan oleh awalan #:

source/conf/http.properties:#HTTPClient.proxy.host={T}conf_http_HTTPClient.proxy.host{/T}
token/default.properties:conf_http_HTTPClient.proxy.host=
conf/http.properties:#HTTPClient.proxy.host=

Untuk menetapkan nilai properti ini, edit /opt/apigee/customer/application/message-processor.properties, tetapi gunakan sintaksis khusus, seperti yang ditunjukkan contoh berikut:

conf/http.properties+HTTPClient.proxy.host=myhost.name.com

Dalam hal ini, Anda harus mengawali nama properti dengan conf/http.properties+. Ini adalah lokasi dan nama file konfigurasi yang berisi properti yang diikuti dengan "+".

Setelah Anda memulai ulang Message Processor, periksa file /opt/apigee/edge-message-processor/conf/http.properties:

cat /opt/apigee/edge-message-processor/conf/http.properties

Di akhir file, Anda akan melihat kumpulan properti, dalam format:

conf/http.properties:HTTPClient.proxy.host=myhost.name.com