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

Edge cho đám mây riêng tư phiên bản 4.19.01

Để định cấu hình Edge sau khi cài đặt, bạn cần sử dụng kết hợp các tệp .properties và 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 cầ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 yêu cầu bạn khởi động lại thành phần Edge bị ảnh hưởng.

Apigee đề cập đến kỹ thuật chỉnh sửa tệp .properties dưới dạng mã có cấu hình (đôi khi viết tắt là CwC). Về cơ bản, mã có cấu hình là công cụ tra cứu khoá/giá trị dựa trên các chế độ cài đặt trong các tệp .properties. Trong mã có cấu hình, các khoá này đượ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ệ 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 sẽ 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ã 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ã đó bằng cách 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á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 sẽ 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ì tức là giá trị đó đã được nhận xét và bạn phải sử dụng cú pháp đặc biệt để thay đổi giá trị đó. Để biết thêm thông tin, hãy xem phần Thiết lập mã thông báo đang bị nhận xét.

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 Tìm 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à 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 đó:

Thành phần Tên thành phần Tệp cấu hình có thể chỉnh sửa
Cassandra apigee-cassandra /opt/apigee/customer/application/cassandra.properties
Giao diện người dùng Edge edge-ui /opt/apigee/customer/application/ui.properties
Đăng nhập một lần (SSO) ở Edge apigee-sso /opt/apigee/customer/application/sso.properties
Máy chủ quản lý edge-management-server /opt/apigee/customer/application/management-server.properties
Bộ xử lý thư edge-message-processor /opt/apigee/customer/application/message-processor.properties
apigee-monit apigee-monit /opt/apigee/customer/application/monit.properties
UE mới apigee-management-ui không áp dụng (sử dụng tệp cấu hình cài đặt)
OpenLDAP apigee-openldap /opt/apigee/customer/application/openldap.properties
Máy chủ Postgres edge-postgres-server /opt/apigee/customer/application/postgres-server.properties
Cơ sở dữ liệu PostgreSQL apigee-postgresql /opt/apigee/customer/application/postgressql.properties
Máy chủ Qpid edge-qpid-server /opt/apigee/customer/application/qpid-server.properties
Đã chuyển đổi mã nguồn (Qpidd) apigee-qpidd /opt/apigee/customer/application/qpidd.properties
Bộ định tuyến edge-router /opt/apigee/customer/application/router.properties
Người trông coi động vật apigee-zookeeper /opt/apigee/customer/application/zookeeper.properties

Nếu muốn thiết lập thuộc tính vào 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 do người dùng "apigee" sở hữu:

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, bạn cũng không thể chỉnh sửa các tệp cấu hình.

Tệp thông tin (không thể chỉnh sửa) bao gồm những tệp sau:

Chủ sở hữu Tên tệp hoặc thư mục
Cài đặt
/opt/apigee/token
Thành phần
/opt/apigee/component_name/conf

Trong đó component_name xác định thành phần. Các giá trị có thể bao gồm:

  • 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)

Đặ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.propertiesmanagement-server.properties. Để xem danh sách đầy đủ các tệp thuộc tính, hãy tham khảo bài viết Vị trí của các tệp .properties.

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

  1. Tạo 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 hiển thị trong bảng ở trên cho các tệp khách hàng.
  2. Thay đổi chủ sở hữu của tệp thành "apigee:apigee", như trong ví dụ sau:
    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 sử 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à bản nâng cấp sẽ giữ lại mọi thuộc tính mà bạn đã thiết lập cho 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 nhận nhiều giá trị, hãy phân tách từng giá trị bằng dấu phẩy, như trong ví dụ sau:

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

    Để thêm giá trị mới vào danh sách như giá trị này, thường thì bạn sẽ thêm 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 trạng thái 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 rằng giá trị mã thông báo được đặt thành giá trị mới bằng cách sử dụng tuỳ 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ó có tên đầy đủ hoặc vị trí mà bạn không chắc chắn, hãy sử dụng grep để tìm kiếm trong thư mục source của thành phần.

Ví dụ: nếu biết rằng trong 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 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ả ở biểu mẫu sau:

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

Ví dụ sau đây cho thấy giá trị mã thông báo session.maxAge của 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.

Thiết lập một mã thông báo đang bị nhận xét

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

Để đặt giá trị của 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 dạng sau:

conf/filename+propertyName=propertyValue

Ví dụ: để đặt thuộc tính có tên HTTPClient.proxy.host trên Bộ 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:

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

Lệnh grep trả về kết quả có chứa tên mã thông báo. Hãy lưu ý cách nhận xét tên thuộc tính, thể hiện 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ư ví dụ dưới đây:

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 tài sản. Đây là vị trí và tên của tệp cấu hình chứa thuộc tính, theo sau là dấu "+".

Sau khi bạn khởi động lại Bộ xử lý tin nhắn, 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 nhóm tài sản có dạng như sau:

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