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

Edge for Private Cloud v4.19.01

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