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

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

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

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

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

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

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

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

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

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

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

> /<inst_root>/apigee/apigee-service/bin/apigee-service component restart

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

> /<inst_root>/apigee/apigee-service/bin/apigee-service edge-router restart

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

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

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

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

เจ้าของ

ไดเรกทอรีรูทของโทเค็นเริ่มต้น

ส่วนประกอบ

&lt;inst_root&gt;/apigee/&lt;prefix&gt;-&lt;component&gt;/conf

ที่ไหน /&lt;prefix&gt;-&lt;component&gt; ระบุคอมโพเนนต์ เช่น Edge-Router หรือ apigee-cassandra

การติดตั้ง

&lt;inst_root&gt;/apigee/token

ลูกค้า

<inst_root>/apigee/customer

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

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

> /<inst_dir>/apigee/apigee-service/bin/apigee-service comp configure -search token

โดยที่ comp คือชื่อของคอมโพเนนต์ และ token คือโทเค็นที่ต้องตรวจสอบ

คำสั่งนี้จะค้นหาลำดับชั้นของไฟล์ .properties เพื่อกำหนด ค่าปัจจุบันของโทเค็น

เช่น หากต้องการตรวจสอบค่าปัจจุบันของโทเค็น conf_router_HTTP.request.line.limit สำหรับ เราเตอร์:

> /<inst_dir>/apigee/apigee-service/bin/apigee-service edge-router configure -search conf_router_HTTP.request.line.limit

คุณควรเห็นผลลัพธ์ในแบบฟอร์ม:

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

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

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

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

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

  1. แก้ไข /&lt;inst_root&gt;/apigee/customer/application/router.properties เพื่อตั้งค่า conf_router_HTTP.request.line.limit โทเค็น:

    conf_router_HTTP.request.line.limit=8k
  2. รีสตาร์ท Edge Router โดยทำดังต่อไปนี้

    &gt; /<inst_root>/apigee/apigee-service/bin/apigee-service รีสตาร์ท Edge-Router อีกด้วย
  3. ตรวจสอบค่าของโทเค็น:

    &gt; /<inst_dir>/apigee/apigee-service/bin/apigee-service edge-Router กำหนดค่า -ค้นหา conf_router_HTTP.request.line.limit

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

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

> cd /<inst_root>/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 แก้ไข /&lt;inst_root&gt;/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 สำหรับพร็อพเพอร์ตี้ใน /<inst_root>/apigee/edge-ui/source ไดเรกทอรี:

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

คุณควรเห็นผลลัพธ์ในแบบฟอร์ม:

/<inst_root>/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 ในข้อความ ผู้ประมวลผลข้อมูล จากนั้นให้กด 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+ รวมถึงตำแหน่งและชื่อนำหน้า ของไฟล์การกำหนดค่าที่มีพร็อพเพอร์ตี้ตามด้วย "+"

หลังจากรีสตาร์ทตัวประมวลผลข้อความ ให้ตรวจสอบไฟล์ /opt/apigee/edge-message-processor/conf/http.properties

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

คุณจะเห็นชุดพร็อพเพอร์ตี้ในตอนท้ายของไฟล์ในรูปแบบ

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