Cara mengonfigurasi Edge

Edge for Private Cloud v4.18.05

Untuk mengonfigurasi Edge setelah penginstalan, Anda menggunakan kombinasi file .properties dan utilitas Edge. Misalnya, untuk mengonfigurasi TLS/SSL di 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. Pada dasarnya, kode dengan konfigurasi adalah alat pencarian kunci/nilai berdasarkan setelan dalam file .properties. Dalam kode dengan konfigurasi, kunci disebut sebagai token. Oleh karena itu, untuk mengonfigurasi Edge, Anda menetapkan token dalam file .properties.

Kode dengan konfigurasi memungkinkan komponen Edge menetapkan nilai default yang disertakan 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, setelan akan diatur sebagai berikut dengan setelan pelanggan memiliki prioritas tertinggi untuk mengganti setelan apa pun dari tim penginstal atau Apigee:

  1. Pelanggan
  2. Penginstal
  3. Apigee

Cara menggunakan file .properties

Sebagai pelanggan, Anda hanya dapat mengubah file .properties di direktori /opt/apigee/customer/application. Setiap komponen memiliki file .properties-nya sendiri di direktori tersebut. Misalnya, router.properties dan management-server.properties.

Misalnya, untuk membuat file .properties:

  1. Buat file di editor sebagai pengguna mana pun.
  2. Gunakan chown untuk mengubah pemilik file menjadi "apigee:apigee" atau, jika Anda mengubah pengguna yang menjalankan layanan Edge dari pengguna "apigee", chown file ke pengguna yang menjalankan layanan Edge.

Untuk menetapkan properti bagi komponen, edit file .properties yang sesuai untuk menetapkan token, lalu mulai ulang komponen:

/opt/apigee/apigee-service/bin/apigee-service component restart

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

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

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

Lokasi file .properties

Ada tiga direktori tingkat teratas untuk file .properties untuk komponen Edge: penginstalan, pemilik, dan pelanggan. Lokasi default ditampilkan dalam tabel berikut:

Pemilik Direktori Root Token Default
Komponen 
/opt/apigee/component_name/conf

Dengan component_name mengidentifikasi komponen. Nilai yang memungkinkan mencakup:

  • 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)
Penginstalan 
/opt/apigee/token
Pelanggan 
/opt/apigee/customer

Menentukan nilai token saat ini

Sebelum menetapkan token dalam file .properties untuk komponen, Anda dapat menentukan nilai saat ini terlebih dahulu menggunakan perintah berikut:

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

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

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

Misalnya, untuk 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 dalam bentuk:

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

Menetapkan token dalam file .properties

Untuk mengganti nilai token:

  1. Edit file .properties untuk komponen guna menetapkan nilai token. Jika file tidak ada, buat file tersebut.
  2. Mulai ulang komponen.
  3. Periksa nilai token.

Misalnya, untuk menetapkan batas baris permintaan untuk Router Edge:

  1. Edit file /opt/apigee/customer/application/router.properties untuk menetapkan token conf_http_HTTPRequest.line.limit: 
    conf_http_HTTPRequest.line.limit=8k
  2. Mulai ulang Router Edge: 
    /opt/apigee/apigee-service/bin/apigee-service edge-router restart
  3. Periksa nilai token: 
    /opt/apigee/apigee-service/bin/apigee-service edge-router configure -search conf_http_HTTPRequest.line.limit

Menetapkan token yang menggunakan beberapa nilai

Beberapa token menggunakan comma separated list. Misalnya, token conf_security_rbac.restricted.resources mengambil daftar URI yang dibatasi sehingga hanya sysadmin yang dapat memanggilnya. Untuk melihat nilai conf_security_rbac.restricted.resources:

cd /opt/apigee/edge-management-server
grep -ri "conf_security_rbac.restricted.resources" *

Outputnya berisi hal berikut:

token/default.properties:conf_security_rbac.restricted.resources=/environments,/environments/*,/environments/*/virtualhosts,/environments/*/virtualhosts/*,/pods,/environments/*/servers,/rebuildindex,/users/*/status

Untuk menetapkan token yang menggunakan daftar nilai, tambahkan nilai baru ke nilai token saat ini dalam file .properties. Oleh karena itu, untuk menambahkan URI /myuri/* ke conf_security_rbac.restricted.resources, edit file /opt/apigee/customer/application/management-server.properties seperti yang ditunjukkan di bawah:

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

Menemukan token

Biasanya, token yang perlu Anda tetapkan diidentifikasi dalam panduan ini. Namun, jika Anda perlu menentukan token yang digunakan untuk mengganti properti, lakukan grep di folder source komponen.

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

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

Anda akan melihat hasil dalam bentuk:

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

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

Menetapkan token yang saat ini dijadikan sebagai komentar

Beberapa token dijadikan sebagai komentar dalam file konfigurasi Edge. Jika Anda mencoba menetapkan token yang dijadikan sebagai komentar, setelan tersebut akan diabaikan.

Untuk menetapkan token yang dijadikan sebagai komentar, Anda menggunakan sintaksis khusus, dalam bentuk:

conf/file.extension+propertyName=propertyValue

Misalnya, Anda ingin menetapkan properti bernama HTTPClient.proxy.host di Message Processor. Kemudian, Anda grep untuk properti guna menentukan tokennya:

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

Perintah grep menampilkan hasil dalam bentuk yang menyertakan nilai token. Perhatikan bagaimana nama properti dijadikan sebagai komentar, seperti yang ditunjukkan oleh awalan # pada nama properti:

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 properti, edit /opt/apigee/customer/application/message-processor.properties untuk menetapkan properti sebagai:

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

Perhatikan bagaimana nama properti diawali dengan conf/http.properties+, lokasi dan nama file konfigurasi yang berisi properti 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 bentuk:

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