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

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

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

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

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

  1. ลูกค้า
  2. ผู้ติดตั้ง
  3. ส่วนประกอบ

ระบุค่าปัจจุบันของโทเค็น

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

/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 และไฟล์พร็อพเพอร์ตี้ที่คุณแก้ไขเพื่อกำหนดค่าคอมโพเนนต์เหล่านั้นได้

ส่วนประกอบ ชื่อคอมโพเนนต์ ไฟล์การกำหนดค่าที่แก้ไขได้
Cassandra apigee-cassandra /opt/apigee/customer/application/cassandra.properties
SSO ของ Apigee apigee-sso /opt/apigee/customer/application/sso.properties
เซิร์ฟเวอร์การจัดการ edge-management-server /opt/apigee/customer/application/management-server.properties
Message Processor edge-message-processor /opt/apigee/customer/application/message-processor.properties
apigee-monit apigee-monit /opt/apigee/customer/application/monit.properties
UI แบบคลาสสิก (ไม่ส่งผลต่อ UI ใหม่ของ Edge) edge-ui /opt/apigee/customer/application/ui.properties
Edge UI (UI ของ Edge ใหม่เท่านั้น ไม่ส่งผลต่อ UI แบบคลาสสิก) apigee-management-ui ไม่มี (ใช้ไฟล์การกำหนดค่าการติดตั้ง)
OpenLDAP apigee-openldap /opt/apigee/customer/application/openldap.properties
เซิร์ฟเวอร์ Postgres edge-postgres-server /opt/apigee/customer/application/postgres-server.properties
ฐานข้อมูล PostgreSQL apigee-postgresql /opt/apigee/customer/application/postgressql.properties
เซิร์ฟเวอร์ Qpid edge-qpid-server /opt/apigee/customer/application/qpid-server.properties
คพิดด์ apigee-qpidd /opt/apigee/customer/application/qpidd.properties
เราเตอร์ edge-router /opt/apigee/customer/application/router.properties
ผู้ดูแลสวนสัตว์ apigee-zookeeper /opt/apigee/customer/application/zookeeper.properties

หากต้องการตั้งค่าพร็อพเพอร์ตี้ในไฟล์การกำหนดค่าคอมโพเนนต์ไฟล์ใดไฟล์หนึ่งเหล่านี้แต่ไม่มีอยู่ ให้สร้างพร็อพเพอร์ตี้ในตำแหน่งที่ระบุไว้ด้านบน

นอกจากนี้ คุณต้องตรวจสอบว่าผู้ใช้ "apigee" เป็นเจ้าของไฟล์พร็อพเพอร์ตี้ โดยทำดังนี้

chown apigee:apigee /opt/apigee/customer/application/configuration_file.properties

ไฟล์การกำหนดค่าคอมโพเนนต์ที่แก้ไขไม่ได้

นอกเหนือจากไฟล์การกำหนดค่าคอมโพเนนต์ที่แก้ไขได้ ยังมีไฟล์การกำหนดค่าที่คุณแก้ไขไม่ได้อีกด้วย

ไฟล์ข้อมูล (แก้ไขไม่ได้) ประกอบด้วยรายการต่อไปนี้

เจ้าของ ชื่อไฟล์หรือไดเรกทอรี
การติดตั้ง
/opt/apigee/token
ส่วนประกอบ
/opt/apigee/component_name/conf

ตำแหน่งที่ 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 แบบคลาสสิก)

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

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

หลังจากรีสตาร์ทตัวประมวลผลข้อความแล้ว ให้ตรวจสอบไฟล์ /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 แบบคลาสสิก