ข้อมูลอ้างอิง

คุณกำลังดูเอกสารประกอบ Apigee Edge
ไปที่ เอกสารประกอบเกี่ยวกับ Apigee X.
ข้อมูล

apigee-remote-service-cli อินเทอร์เฟซบรรทัดคำสั่ง (CLI) ช่วยให้คุณ จัดสรรและจัดการอะแดปเตอร์ Apigee สำหรับ Envoy

คำสั่งการเชื่อมโยง

การเชื่อมโยงจะเชื่อมโยงบริการที่ทำให้ใช้งานได้กับ Mesh ของ Istio กับผลิตภัณฑ์ Apigee API CLI ช่วยให้คุณสร้าง นำออก แสดงรายการ และยืนยันการเชื่อมโยงได้

เพิ่มการเชื่อมโยง

เพิ่มการเชื่อมโยงเป้าหมายบริการระยะไกลกับผลิตภัณฑ์ API

การใช้งาน

สำหรับ Edge Public Cloud

apigee-remote-service-cli bindings add [service_name] [product_name]  -o [organization] -e [environment] -u [username] -p [password] -c [config]

สำหรับ Edge Private Cloud

apigee-remote-service-cli bindings add [service_name] [product_name]  -o [organization] -e [environment] -u [username] -p [password] -r [runtime] -c [config]

สถานที่:

  • target_name คือชื่อของเป้าหมายบริการระยะไกลที่จะเชื่อมโยงกับผลิตภัณฑ์
  • product_name คือชื่อผลิตภัณฑ์ที่จะเชื่อมโยงกับบริการ

ธง

พารามิเตอร์ ประเภท คำอธิบาย
-c, --config สตริง (ต้องระบุ) เส้นทางไปยังไฟล์การกำหนดค่า Apigee Remote Service
เคล็ดลับ: แฟล็กนี้ทำให้คุณสามารถข้ามพารามิเตอร์คำสั่งอื่นๆ ส่วนใหญ่ได้ เนื่องจาก CLI จะดึง URL จากไฟล์การกำหนดค่าได้โดยตรง โปรดดู กำลังใช้ตัวเลือก --config
-e, --env สตริง (ต้องระบุ) สภาพแวดล้อมในองค์กร
-h, --help แสดงความช่วยเหลือสำหรับพารามิเตอร์คำสั่ง
--insecure อนุญาตการเชื่อมต่อเซิร์ฟเวอร์ที่ไม่ปลอดภัยเมื่อใช้ SSL
--legacy ตั้งค่าสถานะนี้หากคุณใช้ Apigee Edge Cloud ตั้งค่า URL การจัดการและรันไทม์ สำหรับ Edge Cloud
--mfa โทเค็นการให้สิทธิ์แบบหลายปัจจัยของ Apigee (ใช้กับ --legacy เท่านั้น)
--opdk ตั้งค่าสถานะนี้หากคุณใช้ Apigee Edge สำหรับ Private Cloud
-o, --org สตริง (จำเป็น) องค์กร Apigee คุณต้องเป็นผู้ดูแลระบบขององค์กร
-p, --password สตริง (จำเป็นสำหรับการตรวจสอบสิทธิ์ขั้นพื้นฐานเท่านั้น) รหัสผ่าน Apigee ของคุณ คุณสามารถเลือกระบุ รหัสผ่านในไฟล์ .netrc หากดำเนินการดังกล่าว คุณไม่จำเป็นต้อง ระบุรหัสผ่านของคุณในบรรทัดคำสั่ง ดูเพิ่มเติม ใช้ .netrc สำหรับข้อมูลเข้าสู่ระบบ
-r, --runtime สตริง (Private Cloud เท่านั้น) ระบุ URL รันไทม์สำหรับอินสแตนซ์ Private Cloud
-t, --token สตริง (ต้องระบุสำหรับการตรวจสอบสิทธิ์โทเค็น OAuth เท่านั้น) โทเค็น OAuth หรือ SAML ที่คุณสร้าง จากข้อมูลบัญชี Apigee สำหรับข้อมูลเกี่ยวกับการสร้างโทเค็น โปรดดูที่ การใช้ get_token และ เข้าถึง Management API ด้วย SAML
-u, --username สตริง (จำเป็นสำหรับการตรวจสอบสิทธิ์ขั้นพื้นฐานเท่านั้น) ชื่อผู้ใช้ Apigee ของคุณ (โดยทั่วไปคืออีเมล) หรือจะเลือกระบุชื่อผู้ใช้ในไฟล์ .netrc ก็ได้ หากคุณทำเช่นนั้น คุณไม่จำเป็นต้องระบุชื่อผู้ใช้ในบรรทัดคำสั่ง โปรดดู การใช้ .netrc สำหรับข้อมูลรับรอง
-v, --verbose (ไม่บังคับ) สร้างเอาต์พุตแบบละเอียด

ตัวอย่าง

./apigee-remote-service-cli bindings add httpbin.org envoy-test -o myorg -e test -u user@example.com -c config.yaml -p xxxxxx
product envoy-test is now bound to: httpbin.org

แสดงรายการการผูก

แสดงรายการผลิตภัณฑ์ API ทั้งหมดที่เชื่อมโยงกับบริการระยะไกล

การใช้งาน

สำหรับ Edge Public Cloud

apigee-remote-service-cli bindings list -o [organization] -e [environment] -u [username] -p [password]

สำหรับ Edge Private Cloud

apigee-remote-service-cli bindings list -o [organization] -e [environment] -u [username] -p [password] -r [runtime] 

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
-c, --config สตริง (ต้องระบุ) เส้นทางไปยังไฟล์การกำหนดค่า Apigee Remote Service
เคล็ดลับ: แฟล็กนี้ทำให้คุณสามารถข้ามพารามิเตอร์คำสั่งอื่นๆ ส่วนใหญ่ได้ เนื่องจาก CLI จะดึง URL จากไฟล์การกำหนดค่าได้โดยตรง โปรดดู กำลังใช้ตัวเลือก --config
-e, --env สตริง (ต้องระบุ) สภาพแวดล้อมในองค์กร
-h, --help แสดงความช่วยเหลือสำหรับพารามิเตอร์คำสั่ง
--insecure อนุญาตการเชื่อมต่อเซิร์ฟเวอร์ที่ไม่ปลอดภัยเมื่อใช้ SSL
--legacy ตั้งค่าสถานะนี้หากคุณใช้ Apigee Edge Cloud ตั้งค่า URL การจัดการและรันไทม์ สำหรับ Edge Cloud
--mfa โทเค็นการให้สิทธิ์แบบหลายปัจจัยของ Apigee (ใช้กับ --legacy เท่านั้น)
--opdk ตั้งค่าสถานะนี้หากคุณใช้ Apigee Edge สำหรับ Private Cloud
-o, --org สตริง (จำเป็น) องค์กร Apigee คุณต้องเป็นผู้ดูแลระบบขององค์กร
-p, --password สตริง (จำเป็นสำหรับการตรวจสอบสิทธิ์ขั้นพื้นฐานเท่านั้น) รหัสผ่าน Apigee ของคุณ คุณสามารถเลือกระบุ รหัสผ่านในไฟล์ .netrc หากดำเนินการดังกล่าว คุณไม่จำเป็นต้อง ระบุรหัสผ่านของคุณในบรรทัดคำสั่ง ดูเพิ่มเติม ใช้ .netrc สำหรับข้อมูลเข้าสู่ระบบ
-r, --runtime สตริง (Private Cloud เท่านั้น) ระบุ URL รันไทม์สำหรับอินสแตนซ์ Private Cloud
-t, --token สตริง (ต้องระบุสำหรับการตรวจสอบสิทธิ์โทเค็น OAuth เท่านั้น) โทเค็น OAuth หรือ SAML ที่คุณสร้าง จากข้อมูลบัญชี Apigee สำหรับข้อมูลเกี่ยวกับการสร้างโทเค็น โปรดดูที่ การใช้ get_token และ เข้าถึง Management API ด้วย SAML
-u, --username สตริง (จำเป็นสำหรับการตรวจสอบสิทธิ์ขั้นพื้นฐานเท่านั้น) ชื่อผู้ใช้ Apigee ของคุณ (โดยทั่วไปคืออีเมล) หรือจะเลือกระบุชื่อผู้ใช้ในไฟล์ .netrc ก็ได้ หากคุณทำเช่นนั้น คุณไม่จำเป็นต้องระบุชื่อผู้ใช้ในบรรทัดคำสั่ง โปรดดู การใช้ .netrc สำหรับข้อมูลรับรอง
-v, --verbose (ไม่บังคับ) สร้างเอาต์พุตแบบละเอียด

ตัวอย่าง

apigee-remote-service-cli bindings list -o myorg -e test -u user@example.com -c config.yaml -p abc123
PI Products
============
Bound
-----
envoy-test:
  Quota: 5 requests every 1 minute
  Target bindings:
    httpbin.org
  Paths:
httpbin:
  Quota: 5 requests every 1 minute
  Target bindings:
    httpbin.org
  Paths:
    /httpbin
    /

Unbound
-------
product-1:
  Quota: 100 requests every 1 hour
product-2:
  Quota: 1000 requests every 1 month
product-3:
product-4:

นำการเชื่อมโยงออก

นำการเชื่อมโยง Remote Service for Envoy ออกจากผลิตภัณฑ์ API

การใช้งาน

สำหรับ Edge Public Cloud

apigee-remote-service-cli bindings remove [service_name] [product_name]  -o [organization] -e [environment] -u [username] -p [password] -c [config]

สำหรับ Edge Private Cloud

apigee-remote-service-cli bindings remove [service_name] [product_name]  -o [organization] -e [environment] -u [username] -p [password] -r [runtime] -c [config]

สถานที่:

  • target_name คือชื่อของเป้าหมายบริการระยะไกลที่จะยกเลิกการเชื่อมโยงกับผลิตภัณฑ์
  • product_name คือชื่อผลิตภัณฑ์ที่จะยกเลิกการเชื่อมโยงเป้าหมาย

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
-c, --config สตริง (ต้องระบุ) เส้นทางไปยังไฟล์การกำหนดค่า Apigee Remote Service
เคล็ดลับ: แฟล็กนี้ทำให้คุณสามารถข้ามพารามิเตอร์คำสั่งอื่นๆ ส่วนใหญ่ได้ เนื่องจาก CLI จะดึง URL จากไฟล์การกำหนดค่าได้โดยตรง โปรดดู กำลังใช้ตัวเลือก --config
-e, --env สตริง (ต้องระบุ) สภาพแวดล้อมในองค์กร
-h, --help แสดงความช่วยเหลือสำหรับพารามิเตอร์คำสั่ง
--insecure อนุญาตการเชื่อมต่อเซิร์ฟเวอร์ที่ไม่ปลอดภัยเมื่อใช้ SSL
--legacy ตั้งค่าสถานะนี้หากคุณใช้ Apigee Edge Cloud ตั้งค่า URL การจัดการและรันไทม์ สำหรับ Edge Cloud
--mfa โทเค็นการให้สิทธิ์แบบหลายปัจจัยของ Apigee (ใช้กับ --legacy เท่านั้น)
--opdk ตั้งค่าสถานะนี้หากคุณใช้ Apigee Edge สำหรับ Private Cloud
-o, --org สตริง (จำเป็น) องค์กร Apigee คุณต้องเป็นผู้ดูแลระบบขององค์กร
-p, --password สตริง (จำเป็นสำหรับการตรวจสอบสิทธิ์ขั้นพื้นฐานเท่านั้น) รหัสผ่าน Apigee ของคุณ คุณสามารถเลือกระบุ รหัสผ่านในไฟล์ .netrc หากดำเนินการดังกล่าว คุณไม่จำเป็นต้อง ระบุรหัสผ่านของคุณในบรรทัดคำสั่ง ดูเพิ่มเติม ใช้ .netrc สำหรับข้อมูลเข้าสู่ระบบ
-r, --runtime สตริง (Private Cloud เท่านั้น) ระบุ URL รันไทม์สำหรับอินสแตนซ์ Private Cloud
-t, --token สตริง (ต้องระบุสำหรับการตรวจสอบสิทธิ์โทเค็น OAuth เท่านั้น) โทเค็น OAuth หรือ SAML ที่คุณสร้าง จากข้อมูลบัญชี Apigee สำหรับข้อมูลเกี่ยวกับการสร้างโทเค็น โปรดดูที่ การใช้ get_token และ เข้าถึง Management API ด้วย SAML
-u, --username สตริง (จำเป็นสำหรับการตรวจสอบสิทธิ์ขั้นพื้นฐานเท่านั้น) ชื่อผู้ใช้ Apigee ของคุณ (โดยทั่วไปคืออีเมล) หรือจะเลือกระบุชื่อผู้ใช้ในไฟล์ .netrc ก็ได้ หากคุณทำเช่นนั้น คุณไม่จำเป็นต้องระบุชื่อผู้ใช้ในบรรทัดคำสั่ง โปรดดู การใช้ .netrc สำหรับข้อมูลรับรอง
-v, --verbose (ไม่บังคับ) สร้างเอาต์พุตแบบละเอียด

ตัวอย่าง

./apigee-remote-service-cli bindings remove httpbin.org envoy-test -o myorg -e test -u user@example.com -c config.yaml -p xxxxxx
product envoy-test is no longer bound to: httpbin.org

ยืนยันการเชื่อมโยง

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

การใช้งาน

สำหรับ Edge Public Cloud

apigee-remote-service-cli bindings verify [product_name]  -o [organization] -e [environment] -u [username] -p [password] -c [config]

สำหรับ Edge Private Cloud

apigee-remote-service-cli bindings verify [product_name]  -o [organization] -e [environment] -u [username] -p [password] -r [runtime] -c [config]

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
-c, --config สตริง (ต้องระบุ) เส้นทางไปยังไฟล์การกำหนดค่า Apigee Remote Service
เคล็ดลับ: แฟล็กนี้ทำให้คุณสามารถข้ามพารามิเตอร์คำสั่งอื่นๆ ส่วนใหญ่ได้ เนื่องจาก CLI จะดึง URL จากไฟล์การกำหนดค่าได้โดยตรง โปรดดู กำลังใช้ตัวเลือก --config
-e, --env สตริง (ต้องระบุ) สภาพแวดล้อมในองค์กร
-h, --help แสดงความช่วยเหลือสำหรับพารามิเตอร์คำสั่ง
--insecure อนุญาตการเชื่อมต่อเซิร์ฟเวอร์ที่ไม่ปลอดภัยเมื่อใช้ SSL
--legacy ตั้งค่าสถานะนี้หากคุณใช้ Apigee Edge Cloud ตั้งค่า URL การจัดการและรันไทม์ สำหรับ Edge Cloud
--mfa โทเค็นการให้สิทธิ์แบบหลายปัจจัยของ Apigee (ใช้กับ --legacy เท่านั้น)
--opdk ตั้งค่าสถานะนี้หากคุณใช้ Apigee Edge สำหรับ Private Cloud
-o, --org สตริง (จำเป็น) องค์กร Apigee คุณต้องเป็นผู้ดูแลระบบขององค์กร
-r, --runtime สตริง (Private Cloud เท่านั้น) ระบุ URL รันไทม์สำหรับอินสแตนซ์ Private Cloud
-t, --token สตริง (ต้องระบุสำหรับการตรวจสอบสิทธิ์โทเค็น OAuth เท่านั้น) โทเค็น OAuth หรือ SAML ที่คุณสร้าง จากข้อมูลบัญชี Apigee สำหรับข้อมูลเกี่ยวกับการสร้างโทเค็น โปรดดูที่ การใช้ get_token และ เข้าถึง Management API ด้วย SAML
-v, --verbose (ไม่บังคับ) สร้างเอาต์พุตแบบละเอียด

ตัวอย่าง

./apigee-remote-service-cli bindings verify my-product -o myorg -e test -u user@example.com -c config.yaml -p xxxxxx
  app my-app associated with product my-product is verified

คำสั่งช่วยเหลือ

จะมีความช่วยเหลือออนไลน์สำหรับทุกคำสั่ง apigee-remote-service-cli เพียงพิมพ์:

apigee-remote-service-cli help

หากต้องการความช่วยเหลือเกี่ยวกับคำสั่ง ให้พิมพ์

apigee-remote-service-cli [command] help

เช่น

apigee-remote-service-cli provision help

คำสั่งจัดสรร

คำสั่ง apigee-remote-service-cli provision จะติดตั้งพร็อกซีใน Apigee องค์กร Edge, ตั้งค่าใบรับรอง และสร้างข้อมูลเข้าสู่ระบบที่คุณต้อง กำหนดค่าอะแดปเตอร์ Apigee สำหรับ Envoy

การใช้งาน

หากคุณใช้ Edge Public Cloud ให้ทำดังนี้

apigee-remote-service-cli provision -o $ORG -e $ENV -u $USERNAME -p $PASSWORD

หากคุณใช้ Edge Private Cloud ให้ทําดังนี้

apigee-remote-service-cli provision --opdk -o $ORG -e $ENV -u $USERNAME --management $MGMT_SERVER_URL --runtime $RUNTIME_URL -p $PASSWORD

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
-c, --config สตริง เส้นทางไปยังไฟล์กำหนดค่า Apigee Remote Service ดูเพิ่มเติมที่ กำลังใช้ตัวเลือก --config
-e, --environment สตริง (ต้องระบุ) สภาพแวดล้อมในองค์กร
-f, --force-proxy-install (ไม่บังคับ) บังคับให้ติดตั้งพร็อกซี remote-service อีกครั้งหากใช่ ติดตั้งในองค์กรแล้ว
-h, --help แสดงความช่วยเหลือสำหรับพารามิเตอร์คำสั่ง
-k, --key สตริง ระบุคีย์ที่แสดงผลจาก คำสั่ง apigee-remote-service-cli provision
--legacy ตั้งค่าสถานะนี้หากคุณใช้ Apigee Edge Cloud ตั้งค่า URL การจัดการและรันไทม์ สำหรับ Edge Cloud
--mfa โทเค็นการให้สิทธิ์แบบหลายปัจจัยของ Apigee (ใช้กับ --legacy เท่านั้น)
-m, --management สตริง (ต้องระบุหากคุณอยู่ใน Apigee Private Cloud) URL พื้นฐานการจัดการ Apigee ของคุณ ค่าเริ่มต้น: https://api.enterprise.apigee.com
-n, --namespace สตริง ปล่อยการกำหนดค่าเป็น Envoy ConfigMap ในเนมสเปซที่ระบุ ค่าเริ่มต้น: apigee
--opdk สตริง Apigee OPDK
-o, --organization สตริง (ต้องระบุ) องค์กร Apigee ของคุณ คุณต้องเป็นผู้ดูแลระบบขององค์กร
-p, --password สตริง (จำเป็นสำหรับการตรวจสอบสิทธิ์ขั้นพื้นฐานเท่านั้น) รหัสผ่าน Apigee ของคุณ คุณสามารถเลือกระบุ รหัสผ่านในไฟล์ .netrc หากดำเนินการดังกล่าว คุณไม่จำเป็นต้อง ระบุรหัสผ่านของคุณในบรรทัดคำสั่ง ดูเพิ่มเติม ใช้ .netrc สำหรับข้อมูลเข้าสู่ระบบ
--rotate-int int หาก n > 0 สร้างคีย์ส่วนตัวใหม่และเก็บคีย์สาธารณะ n ไว้ (แบบผสมเท่านั้น)
-r, --runtime สตริง (Private Cloud เท่านั้น) ระบุ URL รันไทม์สำหรับอินสแตนซ์ Private Cloud
-s, --secret สตริง ระบุข้อมูลลับที่ส่งคืนจาก apigee-remote-service-cli provision คำสั่ง
--strength int (ไม่บังคับ) ระบุระดับความปลอดภัยของการเข้ารหัสสำหรับใบรับรอง SSL ที่ใช้ในการจัดสรร อะแดปเตอร์ 2048 เริ่มต้น
-t, --token สตริง (ไฮบริดเท่านั้น) Apigee OAuth หรือโทเค็น SAML
-u, --username สตริง (จำเป็นสำหรับการตรวจสอบสิทธิ์ขั้นพื้นฐานเท่านั้น) ชื่อผู้ใช้ Apigee ของคุณ (โดยทั่วไปคืออีเมล) หรือจะเลือกระบุชื่อผู้ใช้ในไฟล์ .netrc ก็ได้ โปรดดูเพิ่มเติมที่การใช้ .netrc สำหรับข้อมูลรับรอง
-v, --verbose (ไม่บังคับ) สร้างเอาต์พุตแบบละเอียด
--virtual-hosts สตริง ลบล้างโฮสต์เสมือนเริ่มต้น ซึ่งก็คือ default,secure ใช้ตัวเลือกนี้หากคุณ มีโฮสต์เสมือนที่ระบุไว้สำหรับสภาพแวดล้อมองค์กร Edge นอกเหนือจากค่าเริ่มต้นเหล่านี้ ดูข้อมูลได้จากเอกสารประกอบ Edge เกี่ยวกับโฮสต์เสมือน
--years int (ไม่บังคับ) จำนวนปีก่อนใบรับรอง SSL ที่ใช้ในการจัดสรร หมดอายุ ค่าเริ่มต้น: 1

ตัวอย่าง

อย่าลืมบันทึกเอาต์พุตของคำสั่ง provision ในไฟล์ที่ใช้ เป็นอินพุตสำหรับอะแดปเตอร์ Apigee สำหรับการดำเนินการ Envoy อื่นๆ

ตัวอย่าง Edge Public Cloud

apigee-remote-service-cli provision --legacy --mfa $MFA --username $USER --password $PASSWORD --organization $ORG --environment $ENV > config.yaml

คำสั่งตัวอย่าง

สร้างตัวอย่างไฟล์การกำหนดค่าสำหรับการติดตั้งใช้งาน Envoy หรือ Istio แบบเนทีฟ

การใช้งาน

apigee-remote-service-cli samples create [flags]

คำอธิบาย

คำสั่งนี้ต้องใช้ไฟล์ config.yaml ที่ถูกต้องซึ่งสร้างผ่านการจัดสรร โดยค่าเริ่มต้น ไฟล์ตัวอย่างจะแสดงผลไปยังไดเรกทอรีชื่อ ./samples คำสั่ง สร้างไดเรกทอรีนี้ให้คุณ

หากคุณใช้ Envoy แบบเนทีฟ คำสั่งจะใช้โฮสต์บริการเป้าหมายและชื่อที่ต้องการสำหรับ คลัสเตอร์ของตัวเอง และยังตั้งค่าการเชื่อมต่อ SSL ที่กำหนดเองจากพร็อกซี Envoy ไปยังบริการระยะไกลด้วย หากโฟลเดอร์ที่มี tls.key และ tls.crt จัดหาผ่าน --tls

หากคุณใช้ Istio ซึ่งพร็อกซี Envoy จะทำหน้าที่เป็นไฟล์ช่วยเหลือ หากไม่ได้ระบุเป้าหมาย ระบบจะสร้างตัวอย่าง httpbin หากไม่ใช่ คุณต้องรับผิดชอบในการเตรียมพร้อม ไฟล์การกำหนดค่าที่เกี่ยวข้องกับการทำให้บริการเป้าหมายใช้งานได้

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
-c, --config สตริง (ต้องระบุ) เส้นทางไปยังไฟล์กำหนดค่า Apigee Remote Service
เคล็ดลับ: แฟล็กนี้ทำให้คุณสามารถข้ามพารามิเตอร์คำสั่งอื่นๆ ส่วนใหญ่ได้ เนื่องจาก CLI จะดึง URL จากไฟล์การกำหนดค่าได้โดยตรง โปรดดู กำลังใช้ตัวเลือก --config
-f, --force บังคับให้เขียนทับไดเรกทอรีที่มีอยู่
-h, --help แสดงความช่วยเหลือสำหรับพารามิเตอร์คำสั่ง
--host โฮสต์บริการเป้าหมาย (ค่าเริ่มต้น "httpbin.org")
-n, --name ชื่อบริการเป้าหมาย (ค่าเริ่มต้น "httpbin")
--out ไดเรกทอรีที่ใช้สร้างตัวอย่างไฟล์การกำหนดค่า ค่าเริ่มต้น: ./samples
-t, --template

ชื่อเทมเพลต หากคุณติดตั้งใช้งาน Istio (ไฮบริดเท่านั้น) ให้เลือก ตัวเลือก Istio ที่มีอยู่ ใช้ตัวเลือกเนทีฟสำหรับการติดตั้งใช้งาน Envoy แบบเนทีฟ ตัวเลือกที่ใช้ได้มีดังนี้

  • istio-1.6 (ค่าเริ่มต้น)
  • istio-1.7
  • native
--tls ไดเรกทอรีที่จะเก็บคีย์ TLS และไฟล์ crt

ตัวอย่าง

apigee-remote-service-cli samples create -c ./config.yaml

คำสั่งโทเค็น

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

สร้างโทเค็น JWT

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

การใช้งาน

สำหรับ Edge Public Cloud
apigee-remote-service-cli token create -c [config_file] --id [consumer_key] --secret [consumer_secret] -o [org] -e [env]
สำหรับ Edge Private Cloud
apigee-remote-service-cli token create -c [config_file] --id [consumer_key] --secret [consumer_secret] -r [runtime] -o [org] -e [env]

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
-c, --config สตริง (ต้องระบุ) เส้นทางไปยังไฟล์การกำหนดค่า Apigee Remote Service
เคล็ดลับ: แฟล็กนี้ทำให้คุณสามารถข้ามพารามิเตอร์คำสั่งอื่นๆ ส่วนใหญ่ได้ เนื่องจาก CLI จะดึง URL จากไฟล์การกำหนดค่าได้โดยตรง โปรดดู กำลังใช้ตัวเลือก --config
-e, --env สตริง (ต้องระบุ) สภาพแวดล้อมในองค์กร
-h, --help แสดงความช่วยเหลือสำหรับพารามิเตอร์คำสั่ง
--insecure อนุญาตการเชื่อมต่อเซิร์ฟเวอร์ที่ไม่ปลอดภัยเมื่อใช้ SSL
-o, --org สตริง (จำเป็น) องค์กร Apigee คุณต้องเป็นผู้ดูแลระบบขององค์กร
-r, --runtime สตริง (Private Cloud เท่านั้น) ระบุ URL รันไทม์สำหรับอินสแตนซ์ Private Cloud
-v, --verbose (ไม่บังคับ) สร้างเอาต์พุตแบบละเอียด

ตัวอย่าง

apigee-remote-service-cli token create -o myorg -e test -i YUmlZAcBKNsTAelJqPZFl3sh58ObATX9 -s icTARgaKHqvUH1dq -c config.yaml

เอาต์พุต

เมื่อทำสำเร็จ คุณจะเห็นเอาต์พุตโทเค็น JST คล้ายกับตัวอย่างต่อไปนี้
eyJraWQiOiIxIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJhY2Nlc3NfdG9rZW4iOiJ0a2tlVzVKQTY2a0pZYTB4bFV1cVBsUW1BMU43IiwiYXVkIjoiaXN0aW8iLCJuYmYiOjE1MzAxMzg1OTEsImFwaV9wcm9kdWN0X2xpc3QiOlsiaXN0aW8tcHJvZHVjdCJdLCJhcHBsaWNhdGlvbl9uYW1lIjoiaXN0aW8tYXBwIiwiZGV2ZWxvcGVyX2VtYWlsIjoicFluZ2Zsb3lkQGdvb2dsZS5jb20iLCJpc3MiOiJodHRwczovL2FwaWdlZXNlYXJjaC10ZXN0LmFwaWdlZS5uZXQvaXN0aW8tYXV0aC90b2tlbiIsImV4cCI6MTUzMDEzOTQ5MSwiaWF0IjoxNTMwMTM4NTkxLCJqdGkiOiIxODgzMzViZi0wMmE4LTRjZGUsOGFkOS0yMWJmNDZjNmRjZDkiLCJjbGllbnRfaWQiOiJZVW1sWkFjQktOc1RBZWxKcVBZRmwzc2g1OE9iQVRYOSJ9.AL7pKSTmond-NSPRNNHVbIzTdAnZjOXcjQ-BbOJ_8lsQvF7PuiOUrGIhY5XTcJusisKgbCdtIxBl8Wq1EiQ_fKnUc3JYYOqzpTB5bGoFy0Yqbfu96dneuWyzgZnoQBkqwZkbQTIg7WNTGx1TJX-UTePvBPxAefiAbaEUcigX9tTsXPoRJZOTrm7IOeKpxpB_gQYkxQtV1_NbERxjTPyMbHdMWal9_xRVzSt7mpTGudMN9OR-VtQ1uXA67GOqhZWcOzq57qImOiCMbaoKnKUADevyWjX_VscN5ZZUtzQUQhTrmv8aR69-uVhMIPKp9juMyYKaYn2IsYZEeCWfhfV45Q

ตรวจสอบโทเค็น JWT

คุณสามารถตรวจสอบโทเค็น JWT ได้ด้วยคำสั่งนี้ โปรดดูเพิ่มเติมในหัวข้อตรวจสอบโทเค็น

การใช้งาน

สำหรับ Edge Public Cloud
apigee-remote-service-cli token inspect -o [organization] -e [environment] -f [token_file]
สำหรับ Edge Private Cloud
apigee-remote-service-cli token inspect -o [organization] -e [environment] -f [token_file] --runtime [host_alias]

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
-c, --config สตริง (ต้องระบุ) เส้นทางไปยังไฟล์การกำหนดค่า Apigee Remote Service
เคล็ดลับ: แฟล็กนี้ทำให้คุณสามารถข้ามพารามิเตอร์คำสั่งอื่นๆ ส่วนใหญ่ได้ เนื่องจาก CLI จะดึง URL จากไฟล์การกำหนดค่าได้โดยตรง โปรดดู กำลังใช้ตัวเลือก --config
-e, --env สตริง (ต้องระบุ) สภาพแวดล้อมในองค์กร
-h, --help แสดงความช่วยเหลือสำหรับพารามิเตอร์คำสั่ง
--insecure อนุญาตการเชื่อมต่อเซิร์ฟเวอร์ที่ไม่ปลอดภัยเมื่อใช้ SSL
-o, --org สตริง (จำเป็น) องค์กร Apigee คุณต้องเป็นผู้ดูแลระบบขององค์กร
-r, --runtime สตริง (Private Cloud เท่านั้น) ระบุ URL รันไทม์สำหรับอินสแตนซ์ Private Cloud
-v, --verbose (ไม่บังคับ) สร้างเอาต์พุตแบบละเอียด

ตัวอย่าง

apigee-remote-service-cli token inspect -c config.yaml <<< $TOKEN

เอาต์พุต

เมื่อทำสำเร็จ คุณจะเห็นผลลัพธ์ที่คล้ายกับข้อความต่อไปนี้
{
	"aud": [
		"remote-service-client"
	],
	"exp": 1591741549,
	"iat": 1591740649,
	"iss": "https://apigee-docs-test.apigee.net/remote-service/token",
	"jti": "99325d2e-6440-4278-9f7f-b252a1a79e53",
	"nbf": 1591740649,
	"access_token": "VfzpXzBGAQ07po0bPMKY4JgQjus",
	"api_product_list": [
		"httpbin"
	],
	"application_name": "httpbin",
	"client_id": "GYDGHy5TRpV8AejXCOlreP7dPVepA8H",
	"developer_email": "user@example.com",
	"scope": ""
}
verifying...
token ok.

หมุนโทเค็น JWT

หลังจากสร้าง JWT ครั้งแรกแล้ว คุณอาจต้องเปลี่ยนคีย์สาธารณะ/ส่วนตัว จับคู่ซึ่งจัดเก็บโดย Apigee Edge ในแมปคีย์-ค่าที่เข้ารหัส (KVM) ขั้นตอนในการสร้าง คู่คีย์ใหม่เรียกว่าการหมุนเวียนคีย์ เมื่อคุณหมุนเวียนคีย์ คู่คีย์ส่วนตัว/สาธารณะชุดใหม่ สร้างและจัดเก็บไว้ใน "istio" KVM ในองค์กร/สภาพแวดล้อม Apigee Edge ของคุณ นอกจากนี้ คีย์สาธารณะเดิมจะยังคงอยู่พร้อมกับค่ารหัสคีย์เดิม

การใช้งาน

หากคุณใช้ Edge Public Cloud ให้ทำดังนี้
apigee-remote-service-cli token rotate-cert -c [config_file] -o [organization] -e [environment] -k [provision_key] -s [provision_secret] --kid [new_key_id]
หากคุณใช้ Edge Private Cloud ให้ทําดังนี้
apigee-remote-service-cli token rotate-cert -o [organization] -e [environment] -u [username] -p [password] -k [provision_key] -s [provision_secret] --kid [new_key_id]

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
-c, --config สตริง (ต้องระบุ) เส้นทางไปยังไฟล์การกำหนดค่า Apigee Remote Service
เคล็ดลับ: แฟล็กนี้ทำให้คุณสามารถข้ามพารามิเตอร์คำสั่งอื่นๆ ส่วนใหญ่ได้ เนื่องจาก CLI จะดึง URL จากไฟล์การกำหนดค่าได้โดยตรง โปรดดู กำลังใช้ตัวเลือก --config
-e, --env สตริง (ต้องระบุ) สภาพแวดล้อมในองค์กร
-h, --help แสดงความช่วยเหลือสำหรับพารามิเตอร์คำสั่ง
--insecure อนุญาตการเชื่อมต่อเซิร์ฟเวอร์ที่ไม่ปลอดภัยเมื่อใช้ SSL
--truncate int จำนวนใบรับรองที่จะเก็บไว้ใน jwks (ค่าเริ่มต้น 2)
-o, --org สตริง (จำเป็น) องค์กร Apigee คุณต้องเป็นผู้ดูแลระบบขององค์กร
-r, --runtime สตริง (Private Cloud เท่านั้น) ระบุ URL รันไทม์สำหรับอินสแตนซ์ Private Cloud
-v, --verbose (ไม่บังคับ) สร้างเอาต์พุตแบบละเอียด

ตัวอย่าง

apigee-remote-service-cli token rotate-cert -c config.yaml -o myorg -e test -k 2e238ffa15dc5ab6a1e97868e7581f6c60ddb8575478582c256d8b7e5b2677a8 -s 51058077223fa7b683c3bea845c5cca138340d1d5583922b6d465f9f918a4b08

เอาต์พุต

certificate successfully rotated

การใช้ .netrc สำหรับข้อมูลเข้าสู่ระบบ

apigee-remote-service-cli จะรับ username โดยอัตโนมัติและ password (สำหรับการตรวจสอบสิทธิ์พื้นฐานเมื่อจำเป็น) จาก .netrc ในไดเรกทอรีหลัก ถ้าคุณใช้ Edge Public Cloud และมีรายการสำหรับ เครื่อง api.enterprise.apigee.com หากคุณใช้ Apigee Private Cloud ค่าเครื่องเหมือนกับ URL ของ management (ตัวอย่างเช่น http://192.162.55.100) ตัวอย่างใน Edge Public Cloud
machine api.enterprise.apigee.com
login jdoe@google.com
password abc123
ตัวอย่างเช่น ใน Edge Private Cloud
machine http://192.162.55.100
login jdoe@google.com
password abc123

คำสั่งของเวอร์ชัน

พิมพ์เวอร์ชัน CLI

apigee-remote-service-cli version

การใช้ตัวเลือกคำสั่ง --config

ตัวเลือก --config จะระบุสถานที่ ของไฟล์การกำหนดค่าที่สร้างโดยคำสั่ง provision ประโยชน์ที่เป็นประโยชน์ของตัวเลือกนี้คือ ทำให้ข้ามพารามิเตอร์คำสั่งอื่นๆ ส่วนใหญ่ได้ ซึ่ง CLI ดึงมาจากไฟล์การกำหนดค่า ตัวเลือกเหล่านี้รวมถึง:
  • องค์กร
  • สภาพแวดล้อม
  • รันไทม์
  • การจัดการ
  • ไม่ปลอดภัย
  • เนมสเปซ
  • เดิม
  • opdk

เช่น เรียกใช้คำสั่ง provision ดังนี้

apigee-remote-service-cli provision --config='old-config.yaml' > new-config.yaml

ไฟล์การกำหนดค่า

ส่วนนี้จะแสดงตัวอย่างไฟล์การกำหนดค่าพร้อมตัวเลือกทั้งหมดที่ใช้ได้

global:
  temp_dir: /tmp/apigee-istio
  keep_alive_max_connection_age: 10m
  api_address: :5000
  metrics_address: :5001
  tls:
    cert_file: tls.crt
    key_file: tls.key
tenant:
  internal_api: https://istioservices.apigee.net/edgemicro
  remote_service_api: https://org-test.apigee.net/remote-service
  org_name: org
  env_name: env
  key: mykey
  secret: mysecret
  client_timeout: 30s
  allow_unverified_ssl_cert: false
products:
  refresh_rate: 2m
analytics:
  legacy_endpoint: false
  file_limit: 1024
  send_channel_size: 10
  collection_interval: 10s
  fluentd_endpoint: apigee-udca-myorg-test.apigee.svc.cluster.local:20001
  tls:
    ca_file: /opt/apigee/tls/ca.crt
    cert_file: /opt/apigee/tls/tls.crt
    key_file: /opt/apigee/tls/tls.key
    allow_unverified_ssl_cert: false
auth:
  api_key_claim: claim
  api_key_cache_duration: 30m
  api_key_header: x-api-key
  api_target_header: :authority
  reject_unauthorized: true
  jwks_poll_interval: 0s