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

Edge for Private Cloud เวอร์ชัน 4.17.09

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

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

โค้ดที่มีการกำหนดค่าช่วยให้คอมโพเนนต์ Edge ตั้งค่าเริ่มต้นที่มาพร้อมกับผลิตภัณฑ์ได้ ช่วยให้ทีมติดตั้งลบล้างการตั้งค่าเหล่านั้นตามโทโพโลยีการติดตั้งได้ และช่วยให้ลูกค้าลบล้างพร็อพเพอร์ตี้ที่เลือกได้

หากคุณมองว่าเป็นการจัดลำดับชั้น การตั้งค่าจะจัดเรียงดังนี้ โดยการตั้งค่าของลูกค้าจะมีลำดับความสำคัญสูงสุดในการลบล้างการตั้งค่าใดๆ จากทีมผู้ติดตั้งหรือ Apigee

1. ลูกค้า
2. ผู้ติดตั้ง
3. Apigee

วิธีใช้ไฟล์ .properties

ในฐานะลูกค้า คุณจะแก้ไขได้เฉพาะไฟล์ .properties ในไดเรกทอรี /opt/apigee/customer/application เท่านั้น แต่ละคอมโพเนนต์จะมีไฟล์ .properties ของตัวเองในไดเรกทอรีนั้น เช่น router.properties และ management-server.properties

ตัวอย่างเช่น หากต้องการสร้างไฟล์ .properties ให้ทำดังนี้

1. สร้างไฟล์ในเครื่องมือแก้ไขในฐานะผู้ใช้รายใดก็ได้
2. เปลี่ยนเจ้าของไฟล์เป็น apigee:apigee หรือหากคุณเปลี่ยนผู้ใช้ที่เรียกใช้บริการ Edge จากผู้ใช้ apigee ให้เปลี่ยนเจ้าของไฟล์เป็นผู้ใช้ที่เรียกใช้บริการ Edge

หากต้องการตั้งค่าพร็อพเพอร์ตี้สำหรับคอมโพเนนต์ ให้แก้ไขไฟล์ .properties ที่เกี่ยวข้องเพื่อตั้งค่าโทเค็น แล้วรีสตาร์ทคอมโพเนนต์ โดยทำดังนี้

> /opt/apigee/apigee-service/bin/apigee-service component restart

ตัวอย่างเช่น หลังจากแก้ไข router.properties ให้รีสตาร์ทเราเตอร์โดยทำดังนี้

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

เมื่อคุณอัปเกรด Edge ระบบจะอ่านไฟล์ .properties ในไดเรกทอรี /opt/apigee/customer/application ซึ่งหมายความว่าการอัปเกรดจะคงพร็อพเพอร์ตี้ที่คุณตั้งค่าไว้ในคอมโพเนนต์

ตำแหน่งของไฟล์ .properties

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

คำเตือน: ลูกค้า Edge จะแก้ไขได้เฉพาะไฟล์ .properties ในส่วน /opt/apigee/customer เท่านั้น แม้ว่าคุณจะดูไฟล์ในไดเรกทอรีคอมโพเนนต์และการติดตั้งได้ แต่อย่าแก้ไขไฟล์ใดๆ

การกำหนดมูลค่าปัจจุบันของโทเค็น

ก่อนที่จะตั้งค่าโทเค็นในไฟล์ .properties สำหรับคอมโพเนนต์ คุณสามารถกำหนดค่าปัจจุบันก่อนได้โดยใช้คำสั่งต่อไปนี้

> /opt/apigee/apigee-service/bin/apigee-service comp configure -search token

โดยที่ comp คือชื่อของคอมโพเนนต์ และ 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

การตั้งค่าโทเค็นในไฟล์ .properties

วิธีลบล้างค่าของโทเค็น

1. แก้ไขไฟล์ .properties สำหรับคอมโพเนนต์เพื่อตั้งค่าโทเค็น หากไม่มีไฟล์ดังกล่าว ให้สร้างขึ้นมา
2. รีสตาร์ทคอมโพเนนต์
3. ตรวจสอบค่าโทเค็น

เช่น หากต้องการตั้งค่าขีดจำกัดบรรทัดคำขอสำหรับ Edge Router ให้ทำดังนี้

1. แก้ไขไฟล์ /opt/apigee/customer/application/router.properties เพื่อตั้งค่าโทเค็น conf_http_HTTPRequest.line.limit ดังนี้
   
   conf_http_HTTPRequest.line.limit=8k
2. รีสตาร์ท Edge Router:
   
   > /opt/apigee/apigee-service/bin/apigee-service edge-router restart
3. ตรวจสอบค่าของโทเค็น:
   
   > /opt/apigee/apigee-service/bin/apigee-service edge-router configure -search conf_http_HTTPRequest.line.limit

การตั้งค่าโทเค็นที่รับค่าได้หลายค่า

โทเค็นบางรายการจะใช้รายการค่าที่คั่นด้วยคอมมา เช่น โทเค็น conf_security_rbac.restricted.resources จะใช้รายการ URI ที่ถูกจำกัดเพื่อให้มีเพียงผู้ดูแลระบบเท่านั้นที่เรียกใช้ได้ หากต้องการดูค่าของ conf_security_rbac.restricted.resources ให้ทำดังนี้

> cd /opt/apigee/edge-management-server
> grep -ri "conf_security_rbac.restricted.resources" *

เอาต์พุตประกอบด้วยข้อมูลต่อไปนี้

token/default.properties:conf_security_rbac.restricted.resources=/environments,/environments/*,/environments/*/virtualhosts,/environments/*/virtualhosts/*,/pods,/environments/*/servers,/rebuildindex,/users/*/status

หากต้องการตั้งค่าโทเค็นที่ใช้รายการค่า ให้เพิ่มค่าใหม่ต่อท้ายค่าปัจจุบันของโทเค็นในไฟล์ .properties ดังนั้น หากต้องการเพิ่ม URI /myuri/* ลงใน conf_security_rbac.restricted.resources ให้แก้ไขไฟล์ /opt/apigee/customer/application/management-server.properties ดังที่แสดงด้านล่าง

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

การค้นหาโทเค็น

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

ตัวอย่างเช่น หากคุณทราบว่าใน Edge รุ่นก่อนหน้า คุณได้ตั้งค่าพร็อพเพอร์ตี้ session.maxAge และต้องการทราบค่าโทเค็นที่ใช้ตั้งค่า ให้ grep พร็อพเพอร์ตี้ในไดเรกทอรี /opt/apigee/edge-ui/source

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

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

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

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

การตั้งค่าโทเค็นที่ทำเครื่องหมายเป็นความคิดเห็นอยู่

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

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

conf/file.extension+propertyName=propertyValue

เช่น คุณต้องการตั้งค่าพร็อพเพอร์ตี้ชื่อ HTTPClient.proxy.host ใน Message Processor จากนั้นคุณจะ grep พร็อพเพอร์ตี้เพื่อระบุโทเค็นของพร็อพเพอร์ตี้ ดังนี้

> cd /opt/apigee/edge-message-processor
> grep -ri "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