Cách định cấu hình Edge

Để định cấu hình Edge sau khi cài đặt, bạn sẽ sử dụng kết hợp các tệp .properties và các tiện ích Edge. Ví dụ: để định cấu hình TLS/SSL trên Giao diện người dùng Edge, bạn chỉnh sửa các tệp .properties để đặt các thuộc tính cần thiết. Để các thay đổi đối với tệp .properties có hiệu lực, bạn cần khởi động lại thành phần Edge bị ảnh hưởng.

Apigee gọi kỹ thuật chỉnh sửa tệp .properties là code with config (đôi khi được viết tắt là CwC). Về cơ bản, mã có cấu hình là một công cụ tra cứu khoá/giá trị dựa trên các chế độ cài đặt trong tệp .properties. Trong mã có cấu hình, các khoá được gọi là mã thông báo. Do đó, để định cấu hình Edge, bạn phải đặt mã thông báo trong các tệp .properties.

Mã có cấu hình cho phép các thành phần Edge đặt các giá trị mặc định được vận chuyển cùng với sản phẩm, cho phép nhóm cài đặt ghi đè các chế độ cài đặt đó dựa trên cấu trúc liên kết cài đặt, sau đó cho phép khách hàng ghi đè mọi thuộc tính mà họ chọn.

Nếu bạn coi đây là một hệ thống phân cấp, thì các chế độ cài đặt sẽ được sắp xếp như sau, trong đó chế độ cài đặt của khách hàng có mức độ ưu tiên cao nhất để ghi đè mọi chế độ cài đặt của nhóm cài đặt hoặc Apigee:

1. Khách hàng
2. Trình cài đặt
3. Thành phần

Xác định giá trị hiện tại của mã thông báo

Trước khi đặt giá trị mới cho một mã thông báo trong tệp .properties, trước tiên, bạn nên xác định giá trị hiện tại của mã thông báo đó bằng cách sử dụng lệnh sau:

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

Trong đó, component_name là tên của thành phần và token là mã thông báo cần kiểm tra.

Lệnh này tìm kiếm hệ thống phân cấp của các tệp .properties của thành phần để xác định giá trị hiện tại của mã thông báo.

Ví dụ sau đây kiểm tra giá trị hiện tại của mã thông báo conf_http_HTTPRequest.line.limit cho Bộ định tuyến:

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

Bạn sẽ thấy kết quả có dạng như sau:

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

Nếu giá trị của mã thông báo bắt đầu bằng #, thì mã thông báo đó đã được nhận xét và bạn phải sử dụng cú pháp đặc biệt để thay đổi mã thông báo đó. Để biết thêm thông tin, hãy xem phần Đặt một mã thông báo hiện đang được bình luận.

Nếu bạn không biết toàn bộ tên của mã thông báo, hãy sử dụng một công cụ như grep để tìm kiếm theo tên thuộc tính hoặc từ khoá. Để biết thêm thông tin, hãy xem phần Xác định vị trí mã thông báo.

Tệp thuộc tính

Có các tệp cấu hình thành phần có thể chỉnh sửa và không thể chỉnh sửa. Phần này mô tả các tệp này.

Tệp cấu hình thành phần có thể chỉnh sửa

Bảng sau đây liệt kê các thành phần Apigee và các tệp thuộc tính mà bạn có thể chỉnh sửa để định cấu hình các thành phần đó:

Nếu muốn đặt một thuộc tính trong một trong các tệp cấu hình thành phần này nhưng thuộc tính đó không tồn tại, bạn có thể tạo thuộc tính đó ở vị trí nêu trên.

Ngoài ra, bạn phải đảm bảo rằng tệp thuộc tính thuộc sở hữu của người dùng "apigee":

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

Tệp cấu hình thành phần không thể chỉnh sửa

Ngoài các tệp cấu hình thành phần có thể chỉnh sửa, còn có các tệp cấu hình mà bạn không thể chỉnh sửa.

Các tệp thông tin (không chỉnh sửa được) bao gồm:

/opt/apigee/token

/opt/apigee/component_name/conf

Đặt giá trị mã thông báo

Bạn chỉ có thể sửa đổi các tệp .properties trong thư mục /opt/apigee/customer/application. Mỗi thành phần đều có tệp .properties riêng trong thư mục đó. Ví dụ: router.properties và management-server.properties. Để xem danh sách đầy đủ các tệp thuộc tính, hãy xem Vị trí của tệp .properties.

Cách tạo tệp .properties:

1. Tạo một tệp văn bản mới trong trình chỉnh sửa. Tên tệp phải khớp với danh sách trong bảng ở trên đối với tệp khách hàng.
2. Thay đổi chủ sở hữu của tệp thành "apigee:apigee", như ví dụ sau đây:

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

   Nếu bạn đã thay đổi người dùng chạy dịch vụ Edge từ người dùng "apigee", hãy dùng chown để thay đổi quyền sở hữu thành người dùng đang chạy dịch vụ Edge.

Khi bạn nâng cấp Edge, các tệp .properties trong thư mục /opt/apigee/customer/application sẽ được đọc. Điều đó có nghĩa là quá trình nâng cấp sẽ giữ lại mọi thuộc tính mà bạn đặt trên thành phần.

Cách đặt giá trị của mã thông báo:

1. Chỉnh sửa tệp .properties của thành phần.
2. Thêm hoặc thay đổi giá trị của mã thông báo. Ví dụ sau đây đặt giá trị của thuộc tính conf_http_HTTPRequest.line.limit thành "10k":

   conf_http_HTTPRequest.line.limit=10k

   Nếu mã thông báo có nhiều giá trị, hãy phân tách từng giá trị bằng dấu phẩy, như ví dụ sau:

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

   Để thêm một giá trị mới vào danh sách như thế này, bạn thường nối giá trị mới vào cuối danh sách.

3. Khởi động lại thành phần:

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

   Trong đó, component_name là một trong những giá trị sau:

   • apigee-cassandra (Cassandra)
   • apigee-openldap (OpenLDAP)
   • apigee-postgresql (Cơ sở dữ liệu PostgreSQL)
   • apigee-qpidd (Qpidd)
   • apigee-sso (Edge SSO)
   • apigee-zookeeper (ZooKeeper)
   • edge-management-server (Máy chủ quản lý)
   • edge-management-ui (Giao diện người dùng Edge mới)
   • edge-message-processor (Bộ xử lý thông báo)
   • edge-postgres-server (Máy chủ Postgres)
   • edge-qpid-server (Máy chủ Qid)
   • edge-router (Bộ định tuyến Edge)
   • edge-ui (Giao diện người dùng cổ điển)

   Ví dụ: sau khi chỉnh sửa router.properties, hãy khởi động lại Bộ định tuyến:

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

4. (Không bắt buộc) Kiểm tra để đảm bảo giá trị mã thông báo được đặt thành giá trị mới bằng cách sử dụng lựa chọn configure -search. Ví dụ:

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

   Để biết thêm thông tin về configure -search, hãy xem phần Xác định giá trị hiện tại của mã thông báo.

Tìm mã thông báo

Trong hầu hết các trường hợp, các mã thông báo bạn cần đặt sẽ được xác định trong hướng dẫn này. Tuy nhiên, nếu bạn cần ghi đè giá trị của một mã thông báo hiện có mà bạn không chắc chắn về tên đầy đủ hoặc vị trí của mã thông báo đó, hãy sử dụng grep để tìm kiếm thư mục source của thành phần.

Ví dụ: nếu bạn biết rằng trong một bản phát hành trước của Edge, bạn đã đặt thuộc tính session.maxAge và muốn biết giá trị mã thông báo được dùng để đặt thuộc tính đó, thì grep cho thuộc tính trong thư mục /opt/apigee/edge-ui/source:

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

Bạn sẽ thấy kết quả ở dạng sau:

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

Ví dụ sau đây cho thấy giá trị của mã thông báo session.maxAge trên giao diện người dùng:

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

Chuỗi giữa các thẻ {T}{/T} là tên của mã thông báo mà bạn có thể đặt trong tệp .properties của giao diện người dùng.

Đặt một mã thông báo hiện đang được nhận xét

Một số mã thông báo được nhận xét trong tệp cấu hình Edge. Nếu bạn cố gắng đặt một mã thông báo bị đánh dấu là nhận xét trong tệp cấu hình thành phần hoặc tệp cấu hình cài đặt, thì chế độ cài đặt của bạn sẽ bị bỏ qua.

Để đặt giá trị của một mã thông báo được nhận xét trong tệp cấu hình Edge, hãy sử dụng cú pháp đặc biệt theo biểu mẫu sau:

conf/filename+propertyName=propertyValue

Ví dụ: để đặt thuộc tính có tên là HTTPClient.proxy.host trên Trình xử lý thông báo, trước tiên hãy grep cho thuộc tính để xác định mã thông báo của thuộc tính đó:

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

Lệnh grep trả về kết quả bao gồm tên mã thông báo. Lưu ý cách tên thuộc tính được nhận xét, như được chỉ ra bằng tiền tố #:

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=

Để đặt giá trị của thuộc tính này, hãy chỉnh sửa /opt/apigee/customer/application/message-processor.properties, nhưng sử dụng một cú pháp đặc biệt, như trong ví dụ sau:

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

Trong trường hợp này, bạn phải thêm tiền tố conf/http.properties+ vào tên thuộc tính. Đây là vị trí và tên của tệp cấu hình chứa thuộc tính, theo sau là "+".

Sau khi bạn khởi động lại Message Processor, hãy kiểm tra tệp /opt/apigee/edge-message-processor/conf/http.properties:

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

Ở cuối tệp, bạn sẽ thấy bộ thuộc tính ở dạng:

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

Định cấu hình proxy chuyển tiếp cho các yêu cầu trong phần Gửi yêu cầu của giao diện người dùng Trace

Phần này giải thích cách định cấu hình proxy chuyển tiếp cho các yêu cầu từ phần Gửi yêu cầu của Giao diện người dùng dấu vết bằng thông tin đăng nhập proxy không bắt buộc. Cách định cấu hình proxy chuyển tiếp:

1. Chỉnh sửa /opt/apigee/customer/application/ui.properties và đảm bảo apigee:apigee là chủ sở hữu của tệp.
2. Thêm các chế độ ghi đè sau (thay đổi giá trị thành cấu hình proxy cụ thể của bạn):

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

3. Lưu và khởi động lại giao diện người dùng cổ điển.

Thêm định dạng nhật ký tuỳ chỉnh trong Apigee Router/Nginx

Trong một số trường hợp, bạn có thể cần thay đổi định dạng nhật ký mặc định của Bộ định tuyến Apigee/Nginx hoặc thêm các biến. Cách cập nhật cấu hình định dạng nhật ký mặc định của Bộ định tuyến/Nginx Apigee:

1. Tạo tệp router.properties (nếu chưa có) theo đường dẫn bên dưới:

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

2. Thêm nội dung sau vào tệp router.properties để tạo cấu hình log_format mới có tên là router_new:

   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

   Cập nhật các biến trong các lệnh trên cho phù hợp. Bạn có thể tìm thấy các giá trị cấu hình mặc định cho log_format trong tệp bên dưới:

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

   Một danh sách các biến Nginx sẽ xuất hiện tại http://nginx.org/en/docs/varindex.html.

3. Khởi động lại Bộ định tuyến để áp dụng cấu hình mới:

   apigee-service edge-router restart

4. Kiểm tra xem cấu hình log_format mới (router_new) đã được thêm vào tệp /opt/nginx/conf.d/0-default.conf hay chưa:

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

5. Gửi một số yêu cầu API đến một proxy API và xác minh định dạng nhật ký mới trong tệp

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