การอ้างอิง CLI สำหรับ Edge Microgateway

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

Edge Microgateway เวอร์ชัน 2.5.x

ภาพรวม

Edge Microgateway CLI ช่วยให้คุณควบคุมและจัดการอินสแตนซ์ทั้งหมดของ Edge Microgateway ได้

การจัดการใบรับรอง

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

ติดตั้งใบรับรอง

ติดตั้งคีย์ในแมปค่าคีย์ (KVM) ที่เข้ารหัสและส่งคืนคีย์สาธารณะเป็นเอาต์พุต คู่คีย์มีขอบเขตอยู่ในองค์กรที่ระบุ

การใช้งาน

edgemicro cert install -o [organization] -e [environment] -u [username] -p [password] --force

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
-o, --org องค์กร Apigee ที่คุณกำหนดค่า Edge Microgateway ไว้
-e, --env สภาพแวดล้อมที่คุณกำหนดค่า Edge Microgateway
-u, --username ชื่อผู้ใช้ Apigee คุณต้องเป็นผู้ดูแลระบบองค์กรขององค์กรที่ระบุ
-p, --password (ไม่บังคับ) รหัสผ่าน คุณจะได้รับแจ้งหากไม่ได้ระบุพารามิเตอร์นี้ในบรรทัดคำสั่ง
-f, --force (ไม่บังคับ) หากมีการจัดเก็บคีย์ไว้ใน KVM ที่เข้ารหัสอยู่แล้ว ให้บังคับใส่คีย์ใหม่แทน
-h, --help ข้อมูลการใช้งานเอาต์พุต

ตัวอย่าง

edgemicro cert install -o docs -e test -u jdoe@example.com -f

เอาต์พุต

current nodejs version is v6.9.1
current edgemicro version is 2.5.4
password:
deleting vault
creating vault
adding private_key
adding public_key
installed cert

ลบใบรับรอง

ลบคู่คีย์สำหรับองค์กร

การใช้งาน

edgemicro cert delete -o [organization] -e [environment] -u [username] -p [password]

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
-o, --org องค์กร Apigee ที่คุณกำหนดค่า Edge Microgateway ไว้
-e, --env สภาพแวดล้อมที่คุณกำหนดค่า Edge Microgateway
-u, --username ชื่อผู้ใช้ Apigee คุณต้องเป็นผู้ดูแลระบบองค์กรขององค์กรที่ระบุ
-p, --password (ไม่บังคับ) รหัสผ่าน คุณจะได้รับแจ้งหากไม่ได้ระบุพารามิเตอร์นี้ในบรรทัดคำสั่ง
-h, --help ข้อมูลการใช้งานเอาต์พุต

ตัวอย่าง

edgemicro cert delete -o docs -e test -u jdoe@example.com

เอาต์พุต

deleting vault
Vault deleted!

ตรวจสอบใบรับรอง

ตรวจสอบว่าองค์กรติดตั้งใบรับรองแล้ว

การใช้งาน

edgemicro cert check -o [organization] -e [environment] -u [username] -p [password]

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
-o, --org องค์กร Apigee ที่คุณกำหนดค่า Edge Microgateway ไว้
-e, --env สภาพแวดล้อมที่คุณกำหนดค่า Edge Microgateway
-u, --username ชื่อผู้ใช้ Apigee คุณต้องเป็นผู้ดูแลระบบองค์กรขององค์กรที่ระบุ
-p, --password (ไม่บังคับ) รหัสผ่าน คุณจะได้รับแจ้งหากไม่ได้ระบุพารามิเตอร์นี้ในบรรทัดคำสั่ง
-h, --help ข้อมูลการใช้งานเอาต์พุต

ตัวอย่าง

edgemicro cert check -o docs -e test -u jdoe@example.com

เอาต์พุต (สำเร็จ)

checked cert successfully

เอาต์พุต (ล้มเหลว)

หากไม่มีใบรับรอง ระบบจะแสดงข้อผิดพลาด

รับคีย์สาธารณะ

แสดงผลคีย์สาธารณะสำหรับองค์กรที่ระบุ ไม่ต้องมีการตรวจสอบสิทธิ์

การใช้งาน

edgemicro cert public-key -o [organization] -e [environment]

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
-o, --org องค์กร Apigee ที่คุณกำหนดค่า Edge Microgateway ไว้
-e, --env สภาพแวดล้อมที่คุณกำหนดค่า Edge Microgateway
-h, --help ข้อมูลการใช้งานเอาต์พุต

ตัวอย่าง

edgemicro cert public-key -o docs -e test

เอาต์พุต (ตัวอย่าง)

-----BEGIN CERTIFICATE-----

MIICpDCCAYwCCQCKpXWGum9uTjANBgkq9w0BAQsFADAUMRIwEAYDVQQDEwls
b2NhbGhvc3cNMTYxMTAyMjAxNTA2WhcNMTYxMTAzMjAxNTA2WjAUMRIwEAYD
VQQDEwlsb2Nvc3QwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDD
ETr/ne/gP47+9LgjLvBJjpbFVdaeUabZZ3wbA7sSIVnnNXWt3yPklrWSfIh+
L2+dq4k+YunsQE2+dwPdXA2x8DPGvqGcCdWPxnpZ7ix5Akbs8i/J+Ue0pXT4
jkpWbaDDftGL2tcxwP45yI+slpDYvmWRps07TFXkAPjGEHYPvCT9/v/35GkL
0h4v0S+XfpcjS5c47o7CIWlkgEM5GBosQUb17kuVR48392vGFPsnCP34iNe7
zguhiCXYg2zkOcj/N3AE4xKIhCz0QcewULy08GltWMmyjJ/30zs8P41JqoA4
RwfeEZ8RenN3rJQim1ppAAEwDQYJKoZIhvcNAQELBQADggEBAHcORIfc+ySe
2FMmqicNe6Wt5V/5zOaBMLsGQdqGOHB5cQc79sMBrk680KVhrwHXZ2nBIkVe
UEL+2qLY1VLfswBNAvcNwV9U4TwHq4eIANiD751oJK1tHmM/ujThQkwNf96o
6I7Ws+wfpGO3ppJCttRbtnATIxrwsCHN4i5lbW/tJSL7t/Zf6T1B+YSJU9AF
xuvLq22cCqyYJQdmKq2vVS55WRZdllm+mRtJrv7MLM9gfDPRxVlwrBz/eQHy
Fv+dwzxcvQjkz03RNhZUodzuD34DPJoYeK++rItsddwQ26KTahH80yYTAFzY
x9gfPf1/+qo=?

-----END CERTIFICATE-----

การกำหนดค่า Edge Microgateway สำหรับ Apigee Edge Cloud

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

การใช้งาน

edgemicro configure -o [organization] -e [environment] -u [username] -p [password]

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
-o, --org องค์กร Apigee ที่คุณกำหนดค่า Edge Microgateway ไว้
-e, --env สภาพแวดล้อมที่คุณกำหนดค่า Edge Microgateway
-u, --username ชื่อผู้ใช้ Apigee คุณต้องเป็นผู้ดูแลระบบองค์กรขององค์กรที่ระบุ
-p, --password (ไม่บังคับ) รหัสผ่าน คุณจะได้รับแจ้งหากไม่ได้ระบุพารามิเตอร์นี้ในบรรทัดคำสั่ง
-r, --url (ไม่บังคับ) ระบุชื่อโฮสต์เสมือนสำหรับองค์กรของคุณ:environment โปรดดูเอกสาร Edge เพื่อดูข้อมูลเกี่ยวกับโฮสต์เสมือน ค่าเริ่มต้น: org-env.apigee.net
-c, --configDir (ไม่บังคับ) ระบุเส้นทางไปยังไฟล์การกำหนดค่า Edge Microgateway โดยค่าเริ่มต้น ไฟล์การกำหนดค่าจะอยู่ใน ./config/config.yaml (เพิ่ม v2.4.x แล้ว)
-x, --proxyName (ไม่บังคับ) ตั้งค่าเส้นทางฐานสำหรับพร็อกซี edgemicro-auth หากมีการทำให้พร็อกซี edgemicro-auth ใช้งานได้ภายใต้เส้นทางที่แตกต่างจากค่าเริ่มต้น /edgemicro-auth ฟีเจอร์นี้จะช่วยให้คุณกำหนดเส้นทางใหม่ใน Edge Microgateway ได้ โดยค่าเริ่มต้น เส้นทางฐานคือ /edgemicro-auth (เพิ่ม v2.4.x แล้ว)
-t, --token (ไม่บังคับ) ให้คุณใช้โทเค็น OAuth สำหรับการตรวจสอบสิทธิ์แทนชื่อผู้ใช้/รหัสผ่าน โปรดดูเพิ่มเติมที่หัวข้อการเรียก API ที่ปลอดภัยด้วยโทเค็นเพื่อการเข้าถึง OAuth2 ดังตัวอย่างต่อไปนี้

edgemicro configure -o docs -e test -t <your token>
-v, --virtualHosts (ไม่บังคับ) ลบล้างโฮสต์เสมือนเริ่มต้น ซึ่งก็คือ "default,secure" ใช้ตัวเลือกนี้หากคุณมีโฮสต์เสมือนที่ระบุสำหรับ Edge enterprise:สภาพแวดล้อมอื่นที่ไม่ใช่ค่าเริ่มต้นเหล่านี้ โปรดดูข้อมูลเกี่ยวกับโฮสต์เสมือนในเอกสารประกอบของ Edge
-d, --debug (ไม่บังคับ) ระบุข้อมูลการแก้ไขข้อบกพร่อง
-h, --help ข้อมูลการใช้งานเอาต์พุต

หมายเหตุการใช้งาน

คำสั่งนี้เก็บข้อมูลการกำหนดค่าไว้ใน ~/.edgemicro/org-env-config.yaml

ตัวอย่าง

edgemicro configure -o docs -e test -u jdoe@example.com

เอาต์พุต

เมื่อทำสำเร็จ คำสั่งจะแสดงชุดคีย์ที่คุณต้องใช้เมื่อเริ่มใช้งาน Edge Microgateway

...

The following credentials are required to start edge micro
  key: d2f0a246ad52b5d2a8b04ba65b43c76348aba586691cf6185cd7bb9fb78fe9f
  secret: 59813bc1db4a7ada182705ae40893c28a6fae680c3deb42aefbf1a4db42e372

edgemicro configuration complete!

กำลังสร้างคีย์

คำสั่ง genkeys จะสร้างคู่คีย์และข้อมูลลับที่ Edge Microgateway เพื่อตรวจสอบสิทธิ์ตัวเองเมื่อโพสต์ข้อมูลการวิเคราะห์ไปยัง Apigee Edge แบบไม่พร้อมกัน

การใช้งาน

edgemicro genkeys -o [organization] -e [environment] -u [username] -p [password]

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
-o, --org องค์กร Apigee ที่คุณกำหนดค่า Edge Microgateway ไว้
-e, --env สภาพแวดล้อมที่คุณกำหนดค่า Edge Microgateway
-u, --username ชื่อผู้ใช้ Apigee คุณต้องเป็นผู้ดูแลระบบองค์กรขององค์กรที่ระบุ
-p, --password (ไม่บังคับ) รหัสผ่าน คุณจะได้รับแจ้งหากไม่ได้ระบุพารามิเตอร์นี้ในบรรทัดคำสั่ง
-h, --help ข้อมูลการใช้งานเอาต์พุต

หมายเหตุการใช้งาน

เมื่อทำสำเร็จ คำสั่งจะแสดงผลลัพธ์ 3 รายการ อย่างแรกคือ URL ที่คุณต้องวางในไฟล์การกำหนดค่า อีก 2 รายการเป็นคู่คีย์ที่จำเป็นเมื่อคุณเริ่มต้นอินสแตนซ์ Edge Microgateway

  • Bootstrapp URL: URL นี้ชี้ไปยังบริการ Apigee Edge ที่ช่วยให้อินสแตนซ์ Edge Microgateway ส่งข้อมูลวิเคราะห์ไปยัง Apigee Edge ได้ คุณจะต้องคัดลอก URL ดังกล่าวลงในไฟล์การกำหนดค่า Edge Microgateway: ~/.edgemicro/org-env-config.yaml
  • key: คีย์ ต้องระบุคีย์นี้และข้อมูลลับเป็นอินพุตของคำสั่ง CLI ที่ใช้เพื่อเริ่มอินสแตนซ์ของ Edge Microgateway
  • secret: ความลับ

ตัวอย่าง

edgemicro genkeys -o docs -e test -u jdoe@example.com

เอาต์พุต (ตัวอย่าง)

เมื่อทำสำเร็จ คำสั่งจะแสดงชุดคีย์ที่คุณต้องใช้เมื่อเริ่มใช้งาน Edge Microgateway

configuring host edgemicroservices-us-east-1.apigee.net for region us-east-1
Please copy the following property to the edge micro agent config
  bootstrap: https://edgemicroservices-us-east-1.apigee.net/edgemicro/bootstrap/organization/jdoe/environment/test

The following credentials are required to start edge micro
  key: db39324077989c75eac34c13d285772ea8e3b982b957b3f52916f3048511443f
  secret: 5bf8da39de0056f88fdd5f25a8602d22f312c1c8c870580a5fef55ac6637b7ae

finished

การกำหนดค่า Edge Microgateway สำหรับ Apigee Edge Private Cloud

กําหนดค่า Edge Microgateway ให้ทํางานร่วมกับการติดตั้ง Apigee Edge Private Cloud

การใช้งาน

edgemicro private configure -o [organization] -e [environment] -u [username] -p [password]

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
-o, --org องค์กร Apigee ที่คุณกำหนดค่า Edge Microgateway ไว้
-e, --env สภาพแวดล้อมที่คุณกำหนดค่า Edge Microgateway
-u, --username ชื่อผู้ใช้ Apigee คุณต้องเป็นผู้ดูแลระบบองค์กรขององค์กรที่ระบุ
-p, --password (ไม่บังคับ) รหัสผ่าน คุณจะได้รับแจ้งหากไม่ได้ระบุพารามิเตอร์นี้ในบรรทัดคำสั่ง
-r, --runtime-url ระบุ URL รันไทม์สำหรับอินสแตนซ์ระบบคลาวด์ส่วนตัว
-m, --mgmt-url URL ของเซิร์ฟเวอร์การจัดการสำหรับอินสแตนซ์ระบบคลาวด์ส่วนตัว
-v, --virtualHosts รายการโฮสต์เสมือนที่คั่นด้วยจุลภาคสำหรับองค์กรของคุณ:สภาพแวดล้อม ค่าเริ่มต้น "default,secure"
-c, --configDir (ไม่บังคับ) ระบุเส้นทางไปยังไฟล์การกำหนดค่า Edge Microgateway โดยค่าเริ่มต้น ไฟล์การกำหนดค่าจะอยู่ใน ./config/config.yaml (เพิ่ม v2.4.x แล้ว)
-t, --token (ไม่บังคับ) ให้คุณใช้โทเค็น OAuth สำหรับการตรวจสอบสิทธิ์แทนชื่อผู้ใช้/รหัสผ่าน โปรดดูเพิ่มเติมที่หัวข้อการเรียก API ที่ปลอดภัยด้วยโทเค็นเพื่อการเข้าถึง OAuth2 ดังตัวอย่างต่อไปนี้

edgemicro configure -o docs -e test -t <your token>
-d, --debug (ไม่บังคับ) ระบุข้อมูลการแก้ไขข้อบกพร่อง
-h, --help ข้อมูลการใช้งานเอาต์พุต

หมายเหตุการใช้งาน

คำสั่งนี้เก็บข้อมูลการกำหนดค่าไว้ใน ~/.edgemicro/org-env-config.yaml

ตัวอย่าง

edgemicro private configure -o docs -e test -u jdoe@example.com -r http://192.162.55.100:9002 -m http://192.162.55.100:8080

เอาต์พุต

เมื่อทำสำเร็จ คำสั่งจะแสดงชุดคีย์ที่คุณต้องใช้เมื่อเริ่มใช้งาน Edge Microgateway

...

The following credentials are required to start edge micro
  key: d2f0a246ad52b5d2a8b04ba65b43c76348aba586691cf6185cd7bb9fb78fe9f
  secret: 59813bc1db4a7ada182705ae40893c28a6fae680c3deb42aefbf1a4db42e372

edgemicro configuration complete!

Microgateway ของ Edge เริ่มต้น

ก่อนที่จะเริ่ม Edge Microgateway คุณต้องเรียกใช้กำหนดค่า edgemicro (ระบบคลาวด์สาธารณะ) หรือการกำหนดค่า edgemicro ส่วนตัว (Private Cloud) ก่อน คำสั่งกำหนดค่าจะแสดงค่าคีย์และข้อมูลลับที่จำเป็นต่อการเริ่มต้น Edge Microgateway

การใช้งาน

edgemicro start -o [organization] -e [environment] -k [public-key] -s [secret-key]

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
-o, --org องค์กร Apigee ที่คุณกำหนดค่า Edge Microgateway ไว้
-e, --env สภาพแวดล้อมที่คุณกำหนดค่า Edge Microgateway
-k, --key ค่าคีย์ที่แสดงผลซึ่งแสดงผลเมื่อคุณเรียกใช้คำสั่ง "edgemicro configure"
-s, --secret ค่าข้อมูลลับที่แสดงผลซึ่งแสดงผลเมื่อคุณเรียกใช้คำสั่ง "edgemicro configure"
-p, --processes (ไม่บังคับ) จำนวนกระบวนการที่จะเริ่มต้น ค่าเริ่มต้น: จำนวนแกนในระบบของคุณ
-d, --pluginDir (ไม่บังคับ) เส้นทางสัมบูรณ์ไปยังไดเรกทอรีปลั๊กอิน
-r, --port (ไม่บังคับ) ลบล้างหมายเลขพอร์ตที่ระบุไว้ในไฟล์ ~/.edgemicro/org-env-config.yaml ค่าเริ่มต้น: 8000
-c, --cluster

(ไม่บังคับ) เริ่มต้น Edge Microgateway ในโหมดคลัสเตอร์

หมายเหตุ: ตัวเลือกนี้ถูกนำออกแล้วตั้งแต่เวอร์ชัน 2.3.1 ในเวอร์ชัน v2.3.1 และเวอร์ชันที่ใหม่กว่า Edge Micro จะเริ่มต้นในโหมดคลัสเตอร์เสมอ
-c, --configDir (ไม่บังคับ) ระบุเส้นทางไปยังไฟล์การกำหนดค่า Edge Microgateway โดยค่าเริ่มต้น ไฟล์การกำหนดค่าจะอยู่ใน ./config/config.yaml (เพิ่ม v2.4.x แล้ว)
-u, --configUrl (ไม่บังคับ) ระบุปลายทางที่ Edge Microgateway จะดาวน์โหลดไฟล์การกำหนดค่า (เพิ่ม v2.5.x)
-d, --debug (ไม่บังคับ) ระบุข้อมูลการแก้ไขข้อบกพร่อง
-h, --help ข้อมูลการใช้งานเอาต์พุต

การตั้งค่าพอร์ต

คำสั่ง start ช่วยให้คุณระบุหมายเลขพอร์ตเพื่อลบล้างพอร์ตที่ระบุในไฟล์การกำหนดค่าได้ คุณยังระบุหมายเลขพอร์ตโดยใช้ตัวแปรสภาพแวดล้อม PORT ได้ด้วย เช่น

edgemicro start -o docs -e test -k abc123 -s xyz456 -p 2 --port 8002

หรือ

export PORT=8002
edgemicro start -o org -e test -k key -s secret -p 2

Edge Microgateway จะแสดงข้อผิดพลาดหากพอร์ตที่ใช้งานอยู่

เกี่ยวกับการจัดกลุ่ม

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

ตัวอย่าง

edgemicro start -o docs -e test -k abc123 -s xyz456

ตัวอย่างเอาต์พุต:

...

current nodejs version is v6.9.1
current edgemicro version is 2.5.4
info: jwk_public_keys download from null returned 200 undefined
info: jwt_public_key download from https://docs-test.apigee.net/edgemicro-auth/publicKey returned 200 OK
info: products download from https://docs-test.apigee.net/edgemicro-auth/products returned 200 OK
info: config download from https://edgemicroservices-us-east-1.apigee.net/edgemicro/bootstrap/organization/docs/environment/test returned 200 OK
PROCESS PID : 17991

การจัดการโทเค็น

คำสั่ง token จะช่วยให้คุณรับ ถอดรหัส และยืนยันโทเค็นเพื่อการเข้าถึง OAuth2 ที่ลงชื่อแล้วได้ โปรดดูเพิ่มเติมที่หัวข้อ การเรียก API ที่ปลอดภัยด้วยโทเค็นเพื่อการเข้าถึง OAuth2

ถอดรหัสโทเค็น

ถอดรหัสโทเค็นสำหรับผู้ถือที่เข้ารหัสและมีการรับรองลงในการแทน JSON JWT (Java Web Token) แบบข้อความธรรมดา โทเค็นจะบ่งบอกถึงข้อมูลเกี่ยวกับแอปของนักพัฒนาซอฟต์แวร์ Apigee Edge ที่มอบคีย์ที่ใช้สร้างโทเค็น รวมถึงชื่อแอปพลิเคชัน, client_id, รายการผลิตภัณฑ์ และอีกมากมาย

การใช้งาน

edgemicro token decode -f [filename]

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
-f, --file ชื่อไฟล์ที่มีโทเค็น JWT ที่จะถอดรหัส
-h, --help ข้อมูลการใช้งานเอาต์พุต

ตัวอย่าง

edgemicro token decode -f token.jwt

เอาต์พุต (ตัวอย่าง)

{ header: { typ: 'JWT', alg: 'RS256' },

  payload:
   { application_name: 'b43342ef-86f6-4666-a121-b9ac2025d217',
     client_id: 'O9ZQRZKnn1rdgcKQgsABSMdOsKS',
     scopes: [],
     api_product_list: [ 'MicroTest' ],
     iat: 1436280566,
     exp: 1436282365 },
  signature: '' }

สร้างโทเค็น

สร้างโทเค็นสำหรับผู้ถือที่ลงนาม โทเค็นนี้ช่วยให้แอปไคลเอ็นต์เรียก API ที่ตรวจสอบสิทธิ์แล้วไปยัง Edge Microgateway ได้ โทเค็นคือ JSON Web Token (JWT) ที่เป็นไปตามข้อกำหนดของ OAuth 2.0 ซึ่งต้องป้อนค่าคีย์ผู้บริโภค (รหัสไคลเอ็นต์) และข้อมูลลับของผู้บริโภค (รหัสลับไคลเอ็นต์) จากแอปของนักพัฒนาซอฟต์แวร์ที่ลงทะเบียนใน Apigee Edge โปรดดูเพิ่มเติมที่หัวข้อ การเรียก API ที่ปลอดภัยด้วยโทเค็นเพื่อการเข้าถึง OAuth2

การใช้งาน

edgemicro token get -o [org] -e [env] -i [client_id] -s [client_secret]

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
-o, --org องค์กร Apigee ที่คุณกำหนดค่า Edge Microgateway ไว้
-e, --env สภาพแวดล้อมที่คุณกำหนดค่า Edge Microgateway
-1, --key Client-ID จากแอปนักพัฒนาซอฟต์แวร์ที่เชื่อมโยงกับพร็อกซี Microgateway-Aware ของคุณ
-s, --secret รหัสลับไคลเอ็นต์จากแอปนักพัฒนาซอฟต์แวร์ที่เชื่อมโยงกับพร็อกซี Microgateway-aware
-h, --help ข้อมูลการใช้งานเอาต์พุต

ตัวอย่าง

edgemicro token get -o docs -e test -i 5UzOwAXGoOeo60aew94PPG5MAZE3aJp -s 6vahKFGS9a3qMLwz

เอาต์พุต (ตัวอย่าง)

{ token: 'eyJ0eXAiOiJKV1JhbGciOiJSUzI1NiJ9Glvbl9uYW1lIjoiNWNiMGY0NTV6TV3
EtOWMzOC00YmJjLWIzNzEtZGMxZTQzOGMxIiwiY2xpZW50X2lkIjoiNVV6T3dBWEdvSU9lbz
YwYWV3OTRQN0c1TUFaRTNhSnAiLCJzY2MiOltdLCJhcGlfcHJvZHVjdF9saXN0IjpbIkVkZ2
VNaWNyb1Rlc3RQcm9kdWN0Il0sImlhdCI3ODEyMzQ2MSwiZXhwIjoxNDc4MTI1MjYwfQ.Dx5
f5U7PXm8koNGmFX4N6VrxKMJnpndKgoJ5zWSJvBZ6Ccvhlpd85ipIIA5S2A5nx4obYWp_rpY
RJpIGYwyxP6Oq2j0rxnVjdCC4qyYMgthZjhKgEBVBe3s1ndP72GP2vV6PsSA9RQ2-yzsy9r0
TzhAZ3NJTxT1tS0XKqKngE-OhR3fJHVLAzdMDT0AmS9H0Z2NAJtQOuK6RTpCjG9B6Bc48AEM
sj7QSM-1LWiQ8LdY8k_BoC06qsTI7bCQGWwTuqL-ismbcx2bxovUxSemZIaoROfuF-dCZHG3
2aTP75WxBvvNgBBvPvQtPzbeSOtEaww' }

การส่งคำขอ HTTP เพื่อรับโทเค็น

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

ยืนยันโทเค็น

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

การใช้งาน

edgemicro token verify -o [org] -e [env] -f [filename]

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
-o, --org องค์กร Apigee ที่คุณกำหนดค่า Edge Microgateway ไว้
-e, --env สภาพแวดล้อมที่คุณกำหนดค่า Edge Microgateway
-f, --file ชื่อไฟล์ที่มี JWT ที่จะยืนยัน
-h, --help ข้อมูลการใช้งานเอาต์พุต

ตัวอย่าง

edgemicro token get -o docs -e test -f token.jwt

เอาต์พุตตัวอย่างสำหรับโทเค็นที่ถูกต้อง

{ application_name: 'b43342ef-86f6-4666-a121-b9ac2025d217',

  client_id: 'O9ZQRZKnn1rdgcKQsAZUBkQSMdOsKS',

  scopes: [],

  api_product_list: [ 'MicroTest' ],

  iat: 1436396155,

  exp: 1436397954 }

เอาต์พุตตัวอย่างสำหรับโทเค็นที่ไม่ถูกต้อง

{ [JsonWebTokenError: invalid token] name: 'JsonWebTokenError', message: 'invalid token' }

ตัวอย่างเอาต์พุตสำหรับโทเค็นที่หมดอายุ

{ [TokenExpiredError: jwt expired]

  name: 'TokenExpiredError',

  message: 'jwt expired',

  expiredAt: Tue Jul 07 2015 09:19:25 GMT-0600 (MDT) }

กำลังเริ่มการกำหนดค่า Edge Microgateway ใหม่

เรียกใช้คำสั่งนี้ 1 ครั้งหลังจากที่คุณติดตั้ง Edge Microgateway ครั้งแรก สร้างไฟล์การกำหนดค่าเริ่มต้นใหม่: ~/.edgemicro/default.yaml

การใช้งาน

edgemicro init

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
-c, --configDir (ไม่บังคับ) ระบุเส้นทางไปยังไฟล์การกำหนดค่า Edge Microgateway โดยค่าเริ่มต้น ไฟล์การกำหนดค่าจะอยู่ใน ./config/config.yaml (เพิ่ม v2.4.x แล้ว)
-h, --help ข้อมูลการใช้งานเอาต์พุต

ตัวอย่าง

edgemicro init

เอาต์พุต (สำเร็จ)

config initialized to /MyHome/.edgemicro/default.yaml

กำลังยืนยันการกำหนดค่า Edge Microgateway

ยืนยันว่า Edge Microgateway ได้รับการกําหนดค่าอย่างถูกต้อง

การใช้งาน

edgemicro verify -o [organization] -e [environment] -k [public-key] -s [secret-key]

พารามิเตอร์

ตัวอย่าง

edgemicro verify -o docs -e test -k abc123 -s xyz456

เอาต์พุต (สำเร็จ)

logging to /var/tmp/edgemicro-My-Machine.local-a0c48610-a148-11e6-8466-93f081b05988
installed plugin from analytics
installed plugin from oauth
a0c48610-a148-11e6-8466-93f081b05988 edge micro listening on port 8000
verifying analytics negative case: OK
verifying bootstrap url availability:OK
verifying jwt_public_key availability: OK
verifying products availability: OK
verifying quota with configured products: OK
verifying analytics with payload: OK
verification complete

ตรวจสอบสถานะคลัสเตอร์ไมโครเกตเวย์

โดยค่าเริ่มต้น Edge Microgateway จะเริ่มต้นในโหมดคลัสเตอร์ คุณใช้คำสั่งนี้เพื่อตรวจสอบสถานะของคลัสเตอร์ได้

การใช้งาน

edgemicro status

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
-h, --help ข้อมูลการใช้งานเอาต์พุต

ตัวอย่าง

edgemicro status

เอาต์พุต (สำเร็จ)

current nodejs version is v6.9.1
current edgemicro version is 2.5.4
edgemicro is running with 8 workers

กำลังหยุดคลัสเตอร์ไมโครเกตเวย์

หยุดคลัสเตอร์ Edge Microgateway

การใช้งาน

edgemicro stop

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
-h, --help ข้อมูลการใช้งานเอาต์พุต

ตัวอย่าง

edgemicro stop

เอาต์พุต (สำเร็จ)

current nodejs version is v6.9.1
current edgemicro version is 2.5.4
Stop Completed Successfully

กำลังโหลดคลัสเตอร์ไมโครเกตเวย์อีกครั้ง

ให้การรีสตาร์ทแบบไม่มีช่วงพักหลังจากการเปลี่ยนแปลงการกำหนดค่า โหลด Edge Microgateway ซ้ำโดยดึงการกำหนดค่าใหม่

การใช้งาน

edgemicro reload -o [organization] -e [environment] -k [public-key] -s [secret-key]

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
-o, --org องค์กร Apigee ที่คุณกำหนดค่า Edge Microgateway ไว้
-e, --env สภาพแวดล้อมที่คุณกำหนดค่า Edge Microgateway
-k, --key ค่าคีย์ที่แสดงผลซึ่งแสดงผลเมื่อคุณเรียกใช้คำสั่ง "edgemicro configure"
-s, --secret ค่าข้อมูลลับที่แสดงผลซึ่งแสดงผลเมื่อคุณเรียกใช้คำสั่ง "edgemicro configure"
-h, --help ข้อมูลการใช้งานเอาต์พุต

ตัวอย่าง

edgemicro reload -o docs -e test -k abc123 -s xyz456

เอาต์พุต (สำเร็จ)

...

Reload Completed Successfully

การอัปเกรด KVM

หากต้องการใช้การหมุนเวียนคีย์ คุณต้องติดตั้งแมปค่าคีย์ที่อัปเกรดแล้วในองค์กร Apigee Edge (เพิ่ม v2.5.x)

หมายเหตุ: หากกำหนดค่าอินสแตนซ์ Edge Micro ปัจจุบันก่อนเวอร์ชัน 2.5.2 คุณต้องอัปเกรด KVM เพื่อใช้การหมุนเวียนคีย์ คุณจะอัปเกรดนี้เพียงครั้งเดียวเท่านั้น

การใช้งาน

edgemicro upgradekvm -o [organization] -e [environment] -u [username]

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
-o, --org องค์กร Apigee ที่คุณกำหนดค่า Edge Microgateway ไว้
-e, --env สภาพแวดล้อมที่คุณกำหนดค่า Edge Microgateway
-u, --username ชื่อผู้ใช้ Apigee คุณต้องเป็นผู้ดูแลระบบองค์กรขององค์กรที่ระบุ
-p, --password (ไม่บังคับ) รหัสผ่าน คุณจะได้รับแจ้งหากไม่ได้ระบุพารามิเตอร์นี้ในบรรทัดคำสั่ง
-v, --virtualhost (ไม่บังคับ) โฮสต์เสมือนของพร็อกซี
-t, --token (ไม่บังคับ) ช่วยให้คุณใช้โทเค็น OAuth สำหรับการตรวจสอบสิทธิ์แทนชื่อผู้ใช้/รหัสผ่านได้ โปรดดูเพิ่มเติมที่หัวข้อการเรียก API ที่ปลอดภัยด้วยโทเค็นเพื่อการเข้าถึง OAuth2 ดังตัวอย่างต่อไปนี้

edgemicro upgradekvm -o docs -e test -t <your token>
-b, --baseuri (ไม่บังคับ) URI พื้นฐานสำหรับองค์กรของคุณใน Apigee Edge ค่าเริ่มต้นคือ URI ฐานสำหรับการทำให้ใช้งานได้บนระบบคลาวด์ของ Apigee คือ api.enterprise.apigee.com สำหรับการทำให้ใช้งานได้ภายในองค์กร URL ฐานอาจแตกต่างออกไป

ตัวอย่าง

edgemicro upgradekvm -o docs -e test -u jdoe@example.com

เอาต์พุต (สำเร็จ)

เมื่อทำสำเร็จ คำสั่งจะแสดงเอาต์พุตที่คล้ายกับตัวอย่างต่อไปนี้

current nodejs version is v6.9.1
current edgemicro version is 2.5.4
password:
Checking for certificate...
Certificate found!
-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsT6yVoT/h6pvkPlkUUtv
Hgs7MbDPcWxto7dZqJBwQ4oOQ0IJ2P4XGigc3kYUyPp5lFHg1ssP9+0onRpqn6Lq
z7N5iaTSv5YXb26bU2kSOl4hbwcljIzauAnBzQ13VaQ5SoflRxMGSZmTqZeu5jkQ
3JZ7F6k2bCar5sk1k84vd4WXcCVyngFlrMtlux5z0vOU56QYZFvvKYl/wOHNPLLB
Js54531CV1ZfhV3nDDq9Lh5D1C/oQVlm1Lc7BJoEUmKeFATmSsi50c14ScsmdtJ1
HqC/brSXCd185P6ifu2RH7IHKzNfcD4NlfAVmDScng4w5RxBan2avbmAJrokQ4b5
WQIDAQAB
-----END PUBLIC KEY-----
KVM update complete

การอัปเกรดพร็อกซี edgemicro-auth

หากต้องการใช้การหมุนเวียนคีย์ คุณต้องมีพร็อกซี edgemicro-auth ที่อัปเกรดในองค์กร Apigee Edge ของคุณ (เพิ่ม v2.5.x)

หมายเหตุ: หากกำหนดค่าอินสแตนซ์ Edge Micro ปัจจุบันก่อนเวอร์ชัน 2.5.2 คุณต้องอัปเกรดพร็อกซีนี้หากต้องการใช้การหมุนเวียนคีย์ คุณจะอัปเกรดนี้เพียงครั้งเดียวเท่านั้น

การใช้งาน

edgemicro upgradeauth -o [organization] -e [environment] -u [username]

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
-o, --org องค์กร Apigee ที่คุณกำหนดค่า Edge Microgateway ไว้
-e, --env สภาพแวดล้อมที่คุณกำหนดค่า Edge Microgateway
-u, --username ชื่อผู้ใช้ Apigee คุณต้องเป็นผู้ดูแลระบบองค์กรขององค์กรที่ระบุ
-p, --password (ไม่บังคับ) รหัสผ่าน คุณจะได้รับแจ้งหากไม่ได้ระบุพารามิเตอร์นี้ในบรรทัดคำสั่ง
-v, --virtualhost (ไม่บังคับ) โฮสต์เสมือนของพร็อกซี
-b, --baseuri (ไม่บังคับ) URI พื้นฐานสำหรับองค์กรของคุณใน Apigee Edge ค่าเริ่มต้นคือ URI ฐานสำหรับการทำให้ใช้งานได้บนระบบคลาวด์ของ Apigee คือ api.enterprise.apigee.com สำหรับการทำให้ใช้งานได้ภายในองค์กร URL ฐานอาจแตกต่างออกไป

ตัวอย่าง

edgemicro upgradeauth -o docs -e test -u jdoe@example.com

เอาต์พุต (สำเร็จ)

เมื่อทำสำเร็จ คำสั่งจะแสดงเอาต์พุตที่คล้ายกับตัวอย่างต่อไปนี้

Going to create revision 2 of API edgemicro-auth
Using /Users/jdoe/npm/lib/node_modules/edgemicro/node_modules/microgateway-edgeauth/apiproxy/edgemicro-auth.xml as the root file
Creating revision 2 of API edgemicro-auth
Uploading java resource micro-gateway-products-javacallout-2.0.0.jar
Uploading jsc resource generate-verify-jwt.js
Uploading jsc resource send-public-key.js
Uploading jsc resource set-jwt-variables.js
Uploading jsc resource set-response.js
Uploading node resource index.js
Uploading node resource node_modules_apigee-access.zip
Uploading node resource node_modules_base64url.zip
Uploading node resource node_modules_buffer-equal-constant-time.zip
Uploading node resource node_modules_ecdsa-sig-formatter.zip
Uploading node resource node_modules_jsrsasign.zip
Uploading node resource node_modules_jwa.zip
Uploading node resource node_modules_jws.zip
Uploading node resource node_modules_safe-buffer.zip
Uploading node resource package.json
Uploading policy Access-App-Info-2.xml
Uploading policy Access-App-Info.xml
Uploading policy AccessTokenRequest.xml
Uploading policy Add-Custom-Claims.xml
Uploading policy Create-OAuth-Request.xml
Uploading policy Create-Refresh-Request.xml
Uploading policy Extract-API-Key.xml
Uploading policy Extract-OAuth-Params.xml
Uploading policy Extract-Refresh-Params.xml
Uploading policy Get-Private-Key.xml
Uploading policy Get-Public-Key.xml
Uploading policy Get-Public-Keys.xml
Uploading policy JavaCallout.xml
Uploading policy Products-to-JSON-2.xml
Uploading policy Products-to-JSON.xml
Uploading policy Raise-Fault-Unknown-Request.xml
Uploading policy RefreshAccessToken.xml
Uploading policy Send-Public-Key.xml
Uploading policy Set-JWT-Variables.xml
Uploading policy Set-Response.xml
Uploading policy Verify-API-Key.xml
Uploading target TargetEndpoint-1
Uploading proxy default
Deploying revision 2 of edgemicro-auth to test
Deployment on test successful
edgemicro-auth proxy upgraded

การหมุนคีย์

ใช้คำสั่ง edgemicro rotatekey เพื่อหมุนเวียนคู่คีย์สาธารณะ/ส่วนตัวที่ใช้สร้างโทเค็น JWT ที่ใช้สำหรับการรักษาความปลอดภัย OAuth บน Edge Microgateway

ดูข้อมูลเพิ่มเติมได้ที่ การหมุนคีย์ JWT

การใช้งาน

edgemicro rotatekey -o [organization] -e [environment] -u [username] -k [kid]

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
-o, --org (ต้องระบุ) องค์กร Apigee ที่คุณกำหนดค่า Edge Microgateway ให้
-e, --env (ต้องระบุ) สภาพแวดล้อมที่คุณกำหนดค่า Edge Microgateway
-u, --ชื่อผู้ใช้ (ต้องระบุ) ชื่อผู้ใช้ Apigee คุณต้องเป็นผู้ดูแลระบบองค์กรขององค์กรที่ระบุ
-p, --password (ไม่บังคับ) รหัสผ่าน คุณจะได้รับแจ้งหากไม่ได้ระบุพารามิเตอร์นี้ในบรรทัดคำสั่ง
-k, --kid (ต้องระบุ) รหัสที่ใช้จับคู่กับคีย์เฉพาะ Edge Microgateway จะใช้ค่านี้เพื่อเลือกชุดคีย์ระหว่างการหมุนเวียนคีย์ ดูข้อมูลเพิ่มเติมได้ที่ส่วนที่ 4.5 ของข้อกําหนดของคีย์เว็บ JSON
-b, --baseuri (ไม่บังคับ) URI พื้นฐานสำหรับองค์กรของคุณใน Apigee Edge ค่าเริ่มต้นคือ URI ฐานสำหรับการทำให้ใช้งานได้บนระบบคลาวด์ของ Apigee คือ api.enterprise.apigee.com สำหรับการทำให้ใช้งานได้ภายในองค์กร URL ฐานอาจแตกต่างออกไป

ตัวอย่าง

edgemicro rotatekey -o jdoe -e test -u jdoe@google.com -k 2

เอาต์พุต (สำเร็จ)

เมื่อทำสำเร็จ คำสั่งจะแสดงเอาต์พุตที่คล้ายกับตัวอย่างต่อไปนี้

current nodejs version is v6.9.1
current edgemicro version is 2.5.7
password:
Checking if private key exists in the KVM...
Checking for certificate...
Found Certificate
Generating New key/cert pair...
Extract new public key
Key Rotation successfully completed!

หลังจากการหมุนเวียน คุณจะเห็นใน Edge UI ว่ามีการเพิ่มคีย์ใหม่ไปยัง KVM ไมโครเกตเวย์

การตรวจสอบตลอดไป

ใช้คำสั่ง edgemicro forever เพื่อจัดการกระบวนการ Forever ซึ่งเป็นเครื่องมือ Node.js ที่รีสตาร์ทแอป Node.js โดยอัตโนมัติในกรณีที่แอปหยุดทำงานหรือมีข้อผิดพลาด ดูเพิ่มเติมที่ การตรวจสอบตลอดไป

การใช้งาน

คุณต้องตั้งค่าตัวแปรสภาพแวดล้อมต่อไปนี้ก่อนเรียกใช้คำสั่ง edgemicro forever

  • EDGEMICRO_ORG - องค์กร Apigee ที่คุณกำหนดค่า Edge Microgateway ให้
  • EDGEMICRO_ENV - สภาพแวดล้อมที่คุณกำหนดค่า Edge Microgateway
  • EDGEMICRO_KEY - คีย์-ค่าที่แสดงผลเมื่อเรียกใช้คำสั่ง "edgemicro Configure"
  • EDGEMICRO_SECRET - ค่าข้อมูลลับที่แสดงผลเมื่อเรียกใช้คำสั่ง "edgemicro Configure"
edgemicro forever -f [forever_file] -a [start|stop]

พารามิเตอร์

พารามิเตอร์คำอธิบาย
-f, --fileระบุตำแหน่งของไฟล์ forever.json
-a, --actionstart หรือ stop ก็ได้ ค่าเริ่มต้นคือเริ่มต้น

ตัวอย่างเช่น

วิธีเริ่มต้นตลอดไป

edgemicro forever -f ~/mydir/forever.json -a start

หากต้องการหยุด "ตลอดไป" ให้ทำดังนี้

edgemicro forever -a stop

เพิกถอนคีย์

ใช้คำสั่ง edgemicro revokekeys เพื่อเพิกถอนข้อมูลเข้าสู่ระบบของคีย์และข้อมูลลับสำหรับการกำหนดค่า Edge Microgateway

การใช้งาน

edgemicro revokekeys -o [organization] -e [environment] -u [username]
-k [key] -s [secret]

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
-o, --org (ต้องระบุ) องค์กร Apigee ที่คุณกำหนดค่า Edge Microgateway ให้
-e, --env (ต้องระบุ) สภาพแวดล้อมที่คุณกำหนดค่า Edge Microgateway
-u, --username (ต้องระบุ) ชื่อผู้ใช้ Apigee คุณต้องเป็นผู้ดูแลระบบองค์กรขององค์กรที่ระบุ
-p, --password (ไม่บังคับ) รหัสผ่าน คุณจะได้รับแจ้งหากไม่ได้ระบุพารามิเตอร์นี้ในบรรทัดคำสั่ง
-k, --key (ต้องระบุ) คีย์ที่จะเพิกถอน
-s, --secret (ต้องระบุ) ข้อมูลลับที่จะเพิกถอน

ตัวอย่าง

edgemicro revokekeys -o myorg -e test -u jdoe@apigee.com
-k 2c0064f5bd85f5573dcaffe21566fa7a2d49885cdbf8899370c8a4479285f -s 4b5d6355b874f7c46838893823e8d929dcb2e42fb9aebcb535089c9b98513

เมื่อเสร็จสมบูรณ์ คุณจะเห็นข้อความต่อไปนี้:

key 2c0064f5bd85f5573dcaffe21566fa7a2d49885cdbf8899370c8a4479285f revoked successfully