Cara mengonfigurasi Edge

Edge for Private Cloud v4.18.05

Untuk mengonfigurasi Edge setelah penginstalan, Anda dapat menggunakan kombinasi .properties file dan Edge. Misalnya, untuk mengonfigurasi TLS/SSL di UI Edge, Anda mengedit .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 config adalah alat pencarian kunci/nilai berdasarkan pengaturan di file .properties. Dalam kode dengan {i>config<i}, kunci tersebut disebut sebagai token lebih lanjut. Oleh karena itu, untuk mengonfigurasi Edge, Anda perlu menetapkan token di .properties .

Kode dengan konfigurasi memungkinkan komponen Edge untuk mengatur nilai default yang dikirimkan bersama memungkinkan tim instalasi mengganti pengaturan berdasarkan topologi instalasi, lalu memungkinkan pelanggan mengganti properti yang mereka pilih.

Jika Anda menganggapnya sebagai hierarki, maka pengaturannya akan diatur sebagai berikut dengan setelan yang memiliki prioritas tertinggi untuk menggantikan 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 .properties 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 ke "apigee:apigee" atau, jika Anda mengubah pengguna yang menjalankan layanan Edge dari "apigee" pengguna, ubah file ke pengguna yang menjalankan layanan Edge.

Guna menyetel properti untuk komponen, edit file .properties yang sesuai untuk disetel token, lalu memulai 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 file Direktori /opt/apigee/customer/application telah dibaca. Artinya peningkatan akan mempertahankan properti apa pun yang Anda setel pada komponen.

Lokasi file .properties

Ada tiga direktori tingkat atas untuk file .properties untuk Edge komponen: instalasi, pemilik, dan pelanggan. Lokasi default ditampilkan sebagai berikut tabel:

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

Tempat component_name mengidentifikasi komponen. Nilai yang mungkin termasuk:

  • 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 di file .properties untuk komponen, Anda dapat menentukan nilainya saat ini terlebih dahulu dengan 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 conf_http_HTTPRequest.line.limit saat ini token 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 di file .properties

Untuk mengganti nilai token:

  1. Edit file .properties untuk komponen guna menyetel nilai token. Jika file tidak ada, maka buatlah.
  2. Mulai ulang komponen.
  3. Periksa nilai token.

Misalnya, untuk menetapkan batas baris permintaan bagi Router Edge:

  1. Edit file /opt/apigee/customer/application/router.properties untuk menyetel 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 mengambil daftar nilai yang dipisahkan koma. Misalnya, Token conf_security_rbac.restricted.resources mengambil daftar URI yang dibatasi sehingga hanya {i>sysadmin<i} yang dapat memanggil mereka. 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 menyetel token yang menggunakan daftar nilai, tambahkan nilai baru ke nilai saat ini token kata 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 ditampilkan di bawah ini:

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

Temukan token

Pada umumnya, token yang perlu Anda tetapkan diidentifikasi dalam panduan ini. Namun, jika Anda ingin untuk menentukan token yang digunakan untuk mengganti properti, lakukan grep di Folder source komponen.

Misalnya, jika Anda mengetahui bahwa dalam rilis Edge sebelumnya, Anda menyetel 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 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 diberi komentar

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

Untuk menetapkan token yang diberi komentar, Anda menggunakan sintaksis khusus, berupa:

conf/file.extension+propertyName=propertyValue

Misalnya, Anda ingin menetapkan properti bernama HTTPClient.proxy.host pada Message Pemroses. Lalu, Anda harus melakukan grep agar properti dapat menentukan tokennya:

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

Perintah grep menampilkan hasil dalam bentuk yang menyertakan nilai token. Pemberitahuan cara nama properti diberi komentar, seperti yang ditunjukkan dengan 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+, yang merupakan lokasi dan nama file konfigurasi yang berisi properti yang diikuti dengan "+".

Setelah memulai ulang Pemroses Pesan, 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 properti yang ditetapkan, dalam bentuk:

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