如何設定 Edge

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

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 檔案階層,藉此判斷權杖目前的值。

以下範例會檢查路由器的 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 元件和屬性檔案:

元件 元件名稱 可編輯的設定檔
Cassandra apigee-cassandra /opt/apigee/customer/application/cassandra.properties
Apigee 單一登入 (SSO) apigee-sso /opt/apigee/customer/application/sso.properties
管理伺服器 edge-management-server /opt/apigee/customer/application/management-server.properties
訊息處理器 edge-message-processor /opt/apigee/customer/application/message-processor.properties
apigee-monit apigee-monit /opt/apigee/customer/application/monit.properties
傳統版 UI (不會影響新版 Edge UI) edge-ui /opt/apigee/customer/application/ui.properties
Edge UI (僅限新版 Edge UI;不影響傳統版 UI) apigee-management-ui 不適用 (使用安裝設定檔)
OpenLDAP apigee-openldap /opt/apigee/customer/application/openldap.properties
Postgres 伺服器 edge-postgres-server /opt/apigee/customer/application/postgres-server.properties
PostgreSQL 資料庫 apigee-postgresql /opt/apigee/customer/application/postgresql.properties
Qpid 伺服器 edge-qpid-server /opt/apigee/customer/application/qpid-server.properties
Qpidd apigee-qpidd /opt/apigee/customer/application/qpidd.properties
路由器 edge-router /opt/apigee/customer/application/router.properties
Zookeeper apigee-zookeeper /opt/apigee/customer/application/zookeeper.properties

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

此外,您必須確保屬性檔案由「apigee」使用者擁有:

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

無法編輯的元件設定檔

除了可編輯的元件設定檔以外,也有設定檔無法編輯。

資訊 (不可編輯) 檔案包括以下內容:

擁有者 檔案名稱或目錄
安裝
/opt/apigee/token
元件
/opt/apigee/component_name/conf

其中 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)

設定符記值

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

如何建立 .properties 檔案:

  1. 在編輯器中建立新的文字檔案。檔案名稱必須與上表中顯示的客戶檔案名稱相符。
  2. 將檔案擁有者變更為「apigee:apigee」,如以下範例所示:
    chown apigee:apigee /opt/apigee/customer/application/router.properties

    如果您在「apigee」使用者變更了執行 Edge 服務的使用者,請使用 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 屬性,並想知道用來設定該屬性的權杖值,請針對 /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} 標記之間的字串是您可在使用者介面的 .properties 檔案中設定的權杖名稱。

設定目前已加上註解的權杖

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

如要設定 Edge 設定檔中註解排除的符記值,請使用下列格式使用特殊語法:

conf/filename+propertyName=propertyValue

舉例來說,如要在訊息處理器上設定名為 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+。這是包含屬性 (後面加上「+」) 的設定檔位置和名稱。

重新啟動訊息處理器後,請檢查 /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 UI 的「傳送要求」部分設定要求的轉送 Proxy

本節說明如何為透過 Trace UI 的「傳送要求」部分傳送要求,為要求設定轉送 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
    檔案的新記錄格式