คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X ข้อมูล
apigee-remote-service-cli
Command Line Interface (CLI) ช่วยให้คุณจัดสรรและจัดการอะแดปเตอร์ Apigee สำหรับ Envoy ได้
คำสั่งการเชื่อมโยง
การเชื่อมโยงจะเชื่อมโยงบริการที่ทำให้ใช้งานได้กับ Istio Mesh กับผลิตภัณฑ์ 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 เคล็ดลับ: แฟล็กนี้ทำให้คุณยกเว้นพารามิเตอร์คำสั่งอื่นๆ ส่วนใหญ่ได้ เนื่องจาก CLI ดึงพารามิเตอร์เหล่านั้นจากไฟล์การกำหนดค่าได้โดยตรง โปรดดูหัวข้อ การใช้ตัวเลือก --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 เคล็ดลับ: แฟล็กนี้ทำให้คุณยกเว้นพารามิเตอร์คำสั่งอื่นๆ ส่วนใหญ่ได้ เนื่องจาก CLI ดึงพารามิเตอร์เหล่านั้นจากไฟล์การกำหนดค่าได้โดยตรง โปรดดูหัวข้อ การใช้ตัวเลือก --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:
นำการเชื่อมโยงออก
นำการเชื่อมโยงบริการระยะไกลสำหรับ 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 เคล็ดลับ: แฟล็กนี้ทำให้คุณยกเว้นพารามิเตอร์คำสั่งอื่นๆ ส่วนใหญ่ได้ เนื่องจาก CLI ดึงพารามิเตอร์เหล่านั้นจากไฟล์การกำหนดค่าได้โดยตรง โปรดดูหัวข้อ การใช้ตัวเลือก --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 เคล็ดลับ: แฟล็กนี้ทำให้คุณยกเว้นพารามิเตอร์คำสั่งอื่นๆ ส่วนใหญ่ได้ เนื่องจาก CLI ดึงพารามิเตอร์เหล่านั้นจากไฟล์การกำหนดค่าได้โดยตรง โปรดดูหัวข้อ การใช้ตัวเลือก --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
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
--analytics-sa
|
สตริง | แฟล็กนี้ใช้ได้เฉพาะกับ Apigee แบบผสมและ Apigee ในการติดตั้ง Google Cloud เท่านั้น
ใช้แฟล็กนี้เพื่อระบุเส้นทางไปยังไฟล์คีย์บัญชีบริการ Google Cloud ซึ่งบัญชีบริการมีบทบาท |
-c, --config
|
สตริง | เส้นทางไปยังไฟล์การกำหนดค่าบริการระยะไกลของ Apigee โปรดดูหัวข้อ
การใช้ตัวเลือก --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
|
สตริง | (ไฮบริดเท่านั้น) โทเค็น OAuth หรือ SAML ของ Apigee |
-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 เคล็ดลับ: แฟล็กนี้ทำให้คุณยกเว้นพารามิเตอร์คำสั่งอื่นๆ ส่วนใหญ่ได้ เนื่องจาก CLI ดึงพารามิเตอร์เหล่านั้นจากไฟล์การกำหนดค่าได้โดยตรง โปรดดูหัวข้อ การใช้ตัวเลือก --config
|
-f, --force
|
บังคับเขียนทับไดเรกทอรีที่มีอยู่ | |
-h, --help
|
แสดงความช่วยเหลือสำหรับพารามิเตอร์คำสั่ง | |
--host
|
โฮสต์บริการเป้าหมาย (ค่าเริ่มต้น "httpbin.org") | |
-n, --name
|
ชื่อบริการเป้าหมาย (ค่าเริ่มต้น "httpbin") | |
--out
|
ไดเรกทอรีที่ใช้สร้างไฟล์การกำหนดค่าตัวอย่าง ค่าเริ่มต้น: ./samples
|
|
-t, --template
|
ชื่อเทมเพลต หากกำลังติดตั้งใช้งาน Istio (ไฮบริดเท่านั้น) ให้เลือกตัวเลือก Istio ที่ใช้ได้ ใช้ตัวเลือกเนทีฟสำหรับการทำให้ Envoy ใช้งานได้แบบเนทีฟ ตัวเลือกที่ใช้ได้มีดังนี้
|
|
--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 เคล็ดลับ: แฟล็กนี้ทำให้คุณยกเว้นพารามิเตอร์คำสั่งอื่นๆ ส่วนใหญ่ได้ เนื่องจาก CLI ดึงพารามิเตอร์เหล่านั้นจากไฟล์การกำหนดค่าได้โดยตรง โปรดดูหัวข้อ การใช้ตัวเลือก --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 เคล็ดลับ: แฟล็กนี้ทำให้คุณยกเว้นพารามิเตอร์คำสั่งอื่นๆ ส่วนใหญ่ได้ เนื่องจาก CLI ดึงพารามิเตอร์เหล่านั้นจากไฟล์การกำหนดค่าได้โดยตรง โปรดดูหัวข้อ การใช้ตัวเลือก --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) กระบวนการสร้างคู่คีย์ใหม่เรียกว่าการหมุนเวียนคีย์ เมื่อคุณหมุนเวียนคีย์ ระบบจะสร้างคู่คีย์ส่วนตัว/สาธารณะใหม่และจัดเก็บใน KVM "istio" ในองค์กร/สภาพแวดล้อม Apigee Edge ของคุณ นอกจากนี้ ระบบจะเก็บคีย์สาธารณะเดิมพร้อมกับค่ารหัสคีย์เดิมการใช้งาน
หากคุณใช้ Edge Public Cloudapigee-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 เคล็ดลับ: แฟล็กนี้ทำให้คุณยกเว้นพารามิเตอร์คำสั่งอื่นๆ ส่วนใหญ่ได้ เนื่องจาก CLI ดึงพารามิเตอร์เหล่านั้นจากไฟล์การกำหนดค่าได้โดยตรง โปรดดูหัวข้อ การใช้ตัวเลือก --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