วิธีกําหนดค่า Edge

หากต้องการกำหนดค่า Edge หลังการติดตั้ง คุณต้องใช้.properties ร่วมกับยูทิลิตีของ Edge เช่น หากต้องการกำหนดค่า TLS/SSL ใน UI ของ Edge คุณจะต้องแก้ไขไฟล์ .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 ของคอมโพเนนต์เพื่อ กำหนดค่าปัจจุบันของโทเค็น

ตัวอย่างต่อไปนี้จะตรวจสอบค่าปัจจุบันของโทเค็น 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

ตั้งค่าโทเค็น

คุณแก้ไขไฟล์ .properties ได้ในไดเรกทอรี /opt/apigee/customer/application เท่านั้น แต่ละคอมโพเนนต์มีไฟล์ .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 ระบบจะอ่านไฟล์ .properties ในไดเรกทอรี /opt/apigee/customer/application ซึ่งหมายความว่าการอัปเกรดจะ คงพร็อพเพอร์ตี้ใดก็ตามที่คุณตั้งค่าไว้ในคอมโพเนนต์

วิธีกำหนดค่าของโทเค็น

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 (คาสซานดรา)
   • apigee-openldap (OpenLDAP)
   • apigee-postgresql (ฐานข้อมูล PostgreSQL)
   • apigee-qpidd (Qpidd)
   • apigee-sso (SSO ของ Edge)
   • apigee-zookeeper (ZooKeeper)
   • edge-management-server (เซิร์ฟเวอร์การจัดการ)
   • edge-management-ui (UI ใหม่ของ Edge)
   • edge-message-processor (ตัวประมวลผลข้อความ)
   • edge-postgres-server (เซิร์ฟเวอร์ Postgres)
   • edge-qpid-server (เซิร์ฟเวอร์ Qpid)
   • edge-router (เราเตอร์ Edge)
   • 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 และต้องการทราบค่าโทเค็นที่ใช้ในการตั้งค่า ให้ใช้ grep สำหรับพร็อพเพอร์ตี้ในไดเรกทอรี /opt/apigee/edge-ui/source

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

คุณควรเห็นผลลัพธ์ในรูปแบบต่อไปนี้

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

ตัวอย่างต่อไปนี้แสดงค่าของโทเค็น session.maxAge ของ UI

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

สตริงระหว่างแท็ก {T}{/T} คือชื่อของโทเค็นที่คุณตั้งค่าได้ ในไฟล์ .properties ของ UI

ตั้งค่าโทเค็นที่ถูกแสดงความคิดเห็นออกในขณะนี้

โทเค็นบางรายการจะถูกแสดงเป็นความคิดเห็นในไฟล์การกำหนดค่า Edge หากคุณพยายามตั้งค่าโทเค็นที่ มีการแสดงความคิดเห็นในไฟล์การกำหนดค่าการติดตั้งหรือคอมโพเนนต์ ระบบจะไม่สนใจการตั้งค่าของคุณ

หากต้องการตั้งค่าโทเค็นที่ถูกแสดงความคิดเห็นในไฟล์การกำหนดค่า Edge ให้ใช้ไวยากรณ์พิเศษ ในรูปแบบต่อไปนี้

conf/filename+propertyName=propertyValue

เช่น หากต้องการตั้งค่าพร็อพเพอร์ตี้ชื่อ HTTPClient.proxy.host ใน Message Processor ให้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

กำหนดค่าพร็อกซีส่งต่อสำหรับคำขอจากส่วน "ส่งคำขอ" ของ UI การติดตาม

ส่วนนี้อธิบายวิธีกำหนดค่าพร็อกซีส่งต่อสำหรับคำขอจากส่วน "ส่งคำขอ" ของ UI การติดตามพร้อมข้อมูลเข้าสู่ระบบพร็อกซีที่ไม่บังคับ วิธีกำหนดค่าพร็อกซีแบบส่งต่อ

1. แก้ไข /opt/apigee/customer/application/ui.properties และตรวจสอบว่าไฟล์เป็นของ apigee:apigee
2. เพิ่มการลบล้างต่อไปนี้ (เปลี่ยนค่าเป็นการกำหนดค่าพร็อกซีที่เฉพาะเจาะจง)

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

3. บันทึกและรีสตาร์ท UI แบบคลาสสิก

เปิด/ปิดใช้การแบ่งหน้าและกำหนดค่าขนาดกลุ่มสำหรับหน้าแสดงรายการพร็อกซี API

ส่วนนี้อธิบายวิธีเปิดหรือปิดใช้ API ที่มีการแบ่งหน้าสำหรับรายการพร็อกซี API และวิธีกำหนดค่าขนาดกลุ่มของ API ที่มีการแบ่งหน้า เราได้เพิ่มการลบล้างที่กำหนดค่าได้ใหม่ 2 รายการเพื่อเปิด/ปิดใช้การแบ่งหน้า และกำหนดค่าขนาดกลุ่มของ API ที่แบ่งหน้า

1. สร้าง/แก้ไข /opt/apigee/customer/application/ui.properties และตรวจสอบว่า apigee:apigee เป็นเจ้าของไฟล์
2. เพิ่มการลบล้างต่อไปนี้เพื่อเปิดหรือปิดใช้การแบ่งหน้าสำหรับหน้าแสดงรายการพร็อกซี API

   conf_apigee-base_apigee.feature.apiproxypaginationenabled={true or false}

3. เพิ่มการลบล้างต่อไปนี้เพื่อกำหนดค่าขนาดกลุ่มของ API ที่แบ่งหน้าสำหรับหน้าพร็อกซี(ไม่บังคับ)

   conf_apigee-base_apigee.pagination.apiproxypaginationbatchsize={batch_override_value}

4. บันทึกและรีสตาร์ท UI แบบคลาสสิก

เปิดหรือปิดใช้โปรโตคอล http/2 ใน UI ของ Edge เวอร์ชันใหม่

ส่วนนี้จะอธิบายวิธีเปิดหรือปิดใช้โปรโตคอล http/2

1. สร้าง/แก้ไข /opt/apigee/customer/application/management-ui.properties และตรวจสอบว่า apigee:apigee เป็นเจ้าของไฟล์
2. เพิ่มการลบล้างต่อไปนี้เพื่อเปิดหรือปิดใช้โปรโตคอล http/2

   conf_uebe_disable_http2={true or false}

3. บันทึกและรีสตาร์ท UI ของ Edge ใหม่

เพิ่มรูปแบบบันทึกที่กำหนดเองใน Apigee Router/Nginx

ในบางกรณี คุณอาจต้องเปลี่ยนรูปแบบบันทึกของ Apigee Router/Nginx เริ่มต้น หรือ เพิ่มตัวแปร หากต้องการอัปเดตการกำหนดค่ารูปแบบบันทึกของ Apigee Router/Nginx เริ่มต้น ให้ทำดังนี้

1. สร้างไฟล์ router.properties หากยังไม่มี โดยใช้เส้นทางที่แสดงด้านล่าง

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

2. เพิ่มเนื้อหาต่อไปนี้ลงในไฟล์ router.properties เพื่อสร้างการกำหนดค่า log_format ใหม่ที่มีชื่อ 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

   อัปเดตตัวแปรในคำสั่งด้านบนตามความเหมาะสม คุณดูค่าการกําหนดค่าเริ่มต้นสําหรับ 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 และยืนยันรูปแบบบันทึกใหม่ในไฟล์

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