如何設定 Edge

安裝 Edge 後，您可以使用 .properties 檔案和 Edge 公用程式的組合來設定 Edge。舉例來說，如要在 Edge UI 上設定 TLS/SSL，請編輯 .properties 檔案，設定必要屬性。變更 .properties 檔案後，您必須重新啟動受影響的 Edge 元件。

Apigee 將編輯 .properties 檔案的技術稱為「程式碼搭配設定」 (有時簡稱為 CwC)。基本上，含有設定的程式碼是根據 .properties 檔案中的設定，進行鍵/值查閱的工具。在含有設定的程式碼中，這些鍵稱為「權杖」。因此，如要設定 Edge，請在 .properties 檔案中設定權杖。

使用設定的程式碼可讓 Edge 元件設定隨產品出貨的預設值，讓安裝團隊根據安裝拓撲覆寫這些設定，然後讓客戶覆寫他們選擇的任何屬性。

如果將設定視為階層，則排列方式如下，其中客戶設定的優先順序最高，可覆寫安裝團隊或 Apigee 的任何設定：

1. 客戶
2. 安裝程式
3. 元件

判斷權杖的目前值

在 .properties 檔案中為權杖設定新值之前，請先使用下列指令判斷權杖的目前值：

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

其中 component_name 是元件名稱，token 則是要檢查的權杖。

這個指令會搜尋元件的 .properties 檔案階層，判斷權杖的目前值。

以下範例會檢查 Router 的 conf_http_HTTPRequest.line.limit 權杖目前的值：

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

輸出內容應如下所示：

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

如果權杖的值以 # 開頭，表示該權杖已加上註解，您必須使用特殊語法才能變更。詳情請參閱「設定目前已註解的權杖」。

如果您不知道權杖的完整名稱，請使用 grep 等工具依屬性名稱或關鍵字搜尋。詳情請參閱「尋找權杖」。

屬性檔案

元件設定檔分為可編輯和不可編輯兩種。本節將說明這些檔案。

可編輯的元件設定檔

下表列出 Apigee 元件，以及可編輯以設定這些元件的屬性檔案：

如要在其中一個元件設定檔中設定屬性，但該屬性不存在，您可以在上述位置建立屬性。

此外，您必須確保屬性檔案的擁有者是「apigee」使用者：

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

無法編輯的元件設定檔

除了可編輯的元件設定檔外，還有無法編輯的設定檔。

資訊 (不可編輯) 檔案包括：

/opt/apigee/token

/opt/apigee/component_name/conf

設定權杖值

您只能修改 /opt/apigee/customer/application 目錄中的 .properties 檔案。每個元件在該目錄中都有自己的 .properties 檔案。例如 router.properties 和 management-server.properties。如需屬性檔案的完整清單，請參閱「.properties 檔案位置」。

如何建立 .properties 檔案：

1. 在編輯器中建立新的文字檔。檔案名稱必須與上表列出的顧客檔案名稱相符。
2. 將檔案擁有者變更為「apigee:apigee」，如下例所示：

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

   如果您將執行 Edge 服務的使用者從「apigee」使用者變更為其他使用者，請使用 chown 將擁有權變更為執行 Edge 服務的使用者。

升級 Edge 時，系統會讀取 /opt/apigee/customer/application 目錄中的 .properties 檔案。也就是說，升級後元件上設定的任何屬性都會保留。

如何設定權杖的值：

1. 編輯元件的 .properties 檔案。
2. 新增或變更權杖的值。以下範例將 conf_http_HTTPRequest.line.limit 屬性的值設為「10k」：

   conf_http_HTTPRequest.line.limit=10k

   如果權杖有多個值，請用半形逗號分隔每個值，如下例所示：

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

   如要將新值加入這類清單，通常會將新值附加至清單結尾。

3. 重新啟動元件：

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

   其中 component_name 是下列其中一項：

   • apigee-cassandra (Cassandra)
   • apigee-openldap (OpenLDAP)
   • apigee-postgresql (PostgreSQL 資料庫)
   • apigee-qpidd (魁北克)
   • apigee-sso (邊緣單一登入)
   • apigee-zookeeper (ZooKeeper)
   • edge-management-server (管理伺服器)
   • edge-management-ui (新版 Edge UI)
   • edge-message-processor (訊息處理器)
   • edge-postgres-server (Postgres 伺服器)
   • edge-qpid-server (快速伺服器)
   • edge-router (邊緣路由器)
   • edge-ui (傳統版 UI)

   舉例來說，編輯 router.properties 後，請重新啟動路由器：

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

4. (選用) 使用 configure -search 選項，確認權杖值已設為新值。例如：

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

   如要進一步瞭解 configure -search，請參閱「判斷權杖的目前值」。

尋找權杖

在大多數情況下，本指南會說明需要設定的權杖。不過，如果您需要覆寫現有權杖的值，但不確定權杖的完整名稱或位置，請使用 grep 搜尋元件的 source 目錄。

舉例來說，如果您知道在先前的 Edge 版本中設定了 session.maxAge property，並想知道用於設定該屬性的權杖值，請在 /opt/apigee/edge-ui/source 目錄中為該屬性使用 grep：

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

畫面會顯示下列格式的結果：

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

以下範例顯示 UI 的 session.maxAge 權杖值：

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

{T}{/T} 標記之間的字串是您可以在 UI 的 .properties 檔案中設定的權杖名稱。

設定目前已註解的權杖

Edge 設定檔中已註解掉部分權杖。如果您嘗試設定安裝或元件設定檔中註解掉的權杖，系統會忽略您的設定。

如要設定 Edge 設定檔中已註解的權杖值，請使用下列形式的特殊語法：

conf/filename+propertyName=propertyValue

舉例來說，如要在 Message Processor 上設定名為 HTTPClient.proxy.host 的屬性，請先 grep 該屬性，判斷其權杖：

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

grep 指令會傳回包含權杖名稱的結果。請注意，屬性名稱已加上註解，如 # 前置字串所示：

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=

如要設定這個屬性的值，請編輯 /opt/apigee/customer/application/message-processor.properties，但請使用特殊語法，如下列範例所示：

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

在這種情況下，您必須在屬性名稱加上 conf/http.properties+ 前置字串。這是包含屬性的設定檔位置和名稱，後面接著「+」。

重新啟動 Message Processor 後，請檢查檔案 /opt/apigee/edge-message-processor/conf/http.properties：

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

檔案結尾會顯示屬性集，格式如下：

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

為 Trace 使用者介面「傳送要求」部分的傳送要求設定轉送 Proxy

本節說明如何為 Trace 使用者介面「傳送要求」部分的請求設定轉送 Proxy，以及如何選擇性地提供 Proxy 憑證。如要設定轉送 Proxy，請按照下列步驟操作：

1. 編輯 /opt/apigee/customer/application/ui.properties，並確認檔案由 apigee:apigee 擁有。
2. 新增下列覆寫 (將值變更為特定 Proxy 設定)：

   conf_application_http.proxyhost=proxy.example.com
   conf_application_http.proxyport=8080
   conf_application_http.proxyuser=apigee
   conf_application_http.proxypassword=Apigee123!

3. 儲存並重新啟動傳統 UI。

在 Apigee Router/Nginx 中新增自訂記錄格式

在某些情況下，您可能需要變更預設的 Apigee Router/Nginx 記錄格式，或新增變數。如要更新預設的 Apigee Router/Nginx 記錄格式設定，請按照下列步驟操作：

1. 如果 router.properties 檔案不存在，請建立一個，路徑如下所示：

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

2. 在 router.properties 檔案中加入下列內容，建立名為 router_new 的新 log_format 設定：

   conf_load_balancing_load.balancing.driver.nginx.global.http.parameters.template.extra=log_format router_new 'time_iso8601\\\\thostname\\\\tremote_addr:remote_port\\\\t'\\\\n\\n 'upstream_addr\\\\trequest_time\\\\t-\\\\t-\\\\t'\\\\n\\n 'status\\\\tupstream_status\\\\trequest_length\\\\t'\\\\n\\n 'body_bytes_sent\\\\t'\\\\n\\n 'request\\\\tupstream_http_x_apigee_message_id\\\\t'\\\\n\\n 'http_user_agent\\\\thost\\thostname-pid-connection-connection_requests\\\\tmy_nginx_var_xff\\t'\\\\n\\n 'upstream_http_x_apigee_fault_flag\\\\tupstream_http_x_apigee_fault_source\\\\tupstream_http_x_apigee_fault_code\\\\t'\\\\n\\n 'upstream_http_x_apigee_fault_policy\\tupstream_http_x_apigee_fault_flow\\tupstream_http_x_apigee_fault_revision\\t'\\\\n\\n 'upstream_http_x_apigee_dp_color\\\\tmy_x_apigee_target_latency\\\\t'\\\\n\\n 'upstream_http_x_apigee_proxy\\\\tupstream_http_x_apigee_proxy_basepath\\\\t'\\\\n\\n 'self_region\\\\tself_pod\\\\tself_color\\\\tssl_protocol\\\\tssl_client_verify\\\\tssl_session_id\\\\tssl_session_reused\\\\tupstream_pod\\\\tupstream_region';\\\\n\\n\n
   conf_load_balancing_load.balancing.driver.nginx.access.log={conf_load_balancing_load.balancing.driver.nginx.log.dir}/{org}~{env}.{port}_access_log router_new

   視需要更新上述指令中的變數。您可以在下列檔案中找到 log_format 的預設設定值：

   /opt/apigee/edge-router/conf/load_balancing.properties

   Nginx 變數清單位於 http://nginx.org/en/docs/varindex.html。

3. 重新啟動路由器，以套用新設定：

   apigee-service edge-router restart

4. 檢查新 log_format 設定 (router_new) 是否已新增至 /opt/nginx/conf.d/0-default.conf 檔案：

       
   cat /opt/nginx/conf.d/0-default.conf | grep router_new -A 10

5. 傳送一些 API 要求至 API Proxy，並在檔案中驗證新的記錄格式

   /opt/apigee/var/log/edge-router/nginx/${org}~${env}.${port}_access_log file