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

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

Edge Microgateway v. 3.0.x

ภาพรวม

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

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

คำสั่ง cert ช่วยให้คุณติดตั้งและจัดการคู่คีย์สาธารณะ/ส่วนตัว ที่ใช้ในการลงนามโทเค็นผู้ถือที่ไคลเอ็นต์ใช้เพื่อทำการเรียกที่ปลอดภัยผ่าน Edge Microgateway ระบบจะจัดเก็บคีย์ไว้ใน Apigee Edge ในแมปค่าคีย์ (KVM) ที่เข้ารหัส Edge Microgateway ใช้คีย์สาธารณะเพื่อตรวจสอบโทเค็นผู้ถือที่ลงนามแล้ว คีย์เหล่านี้จะสร้างขึ้นเมื่อคุณเรียกใช้คำสั่ง edgemicro configure ตามที่อธิบายไว้ในการตั้งค่าและ การกำหนดค่า 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 v12.5.0
current edgemicro version is 3.0.2
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 Cloud ได้ โดยจะห่อหุ้มและดำเนินการ ลำดับคำสั่งเพื่อติดตั้งใช้งานพร็อกซีการตรวจสอบสิทธิ์ที่จำเป็นใน 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 (ไม่บังคับ) ตั้งค่า basepath สำหรับพร็อกซี edgemicro-auth หากพร็อกซี edgemicro-auth ได้รับการติดตั้งใช้งานภายใต้เส้นทางอื่นที่ไม่ใช่เส้นทางเริ่มต้น /edgemicro-auth ฟีเจอร์นี้จะช่วยให้คุณตั้งค่าเส้นทางใหม่ใน Edge Microgateway ได้ โดยค่าเริ่มต้น basepath คือ /edgemicro-auth (เพิ่มใน v2.4.x)
-t, --token (ไม่บังคับ) ให้คุณใช้โทเค็น OAuth สำหรับการตรวจสอบสิทธิ์แทนชื่อผู้ใช้/รหัสผ่าน ดูการเรียก API ที่ปลอดภัยด้วยโทเค็นเพื่อการเข้าถึง OAuth2 ด้วย ตัวอย่างเช่น

edgemicro configure -o docs -e test -t <your token>
-v, --virtualHosts (ไม่บังคับ) ลบล้างโฮสต์เสมือนเริ่มต้น ซึ่งคือ "default,secure" ใช้ตัวเลือกนี้หากคุณมีโฮสต์เสมือนที่ระบุไว้สำหรับ องค์กร Edge:สภาพแวดล้อมอื่นนอกเหนือจากค่าเริ่มต้นเหล่านี้ ดูข้อมูลเกี่ยวกับโฮสต์เสมือนได้ในเอกสารประกอบของ 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 (ไม่บังคับ) รหัสผ่าน ระบบจะแจ้งให้คุณระบุพารามิเตอร์นี้หากคุณไม่ได้ระบุในบรรทัดคำสั่ง
-t, --token (ไม่บังคับ) ให้คุณใช้โทเค็น OAuth สำหรับการตรวจสอบสิทธิ์แทนชื่อผู้ใช้/รหัสผ่าน ดูการเรียก API ที่ปลอดภัยด้วยโทเค็นเพื่อการเข้าถึง OAuth2 ด้วย ตัวอย่างเช่น

edgemicro genkeys -o docs -e test -t <your token>
-h, --help ข้อมูลการใช้งานเอาต์พุต

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

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

  • 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 รันไทม์สำหรับอินสแตนซ์ Private Cloud
-m, --mgmt-url URL ของเซิร์ฟเวอร์การจัดการสำหรับอินสแตนซ์ Private Cloud
-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!

การเริ่มต้น Edge Microgateway

ก่อนที่จะเริ่ม Edge Microgateway คุณต้องเรียกใช้ edgemicro configure (ระบบคลาวด์สาธารณะ) หรือ edgemicro private configure (ระบบคลาวด์ส่วนตัว) ก่อน คำสั่ง configure จะแสดงค่าคีย์และค่าลับที่จำเป็นต่อการเริ่มต้น 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 ในโหมดคลัสเตอร์

หมายเหตุ: ตั้งแต่ v2.3.1 เป็นต้นไป เราได้นำตัวเลือกนี้ออกแล้ว ในเวอร์ชัน 2.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 v12.5.0
current edgemicro version is 3.0.2
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 (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 รหัสไคลเอ็นต์จากแอปนักพัฒนาซอฟต์แวร์ที่เชื่อมโยงกับพร็อกซีที่รับรู้ Microgateway
-s, --secret รหัสลับไคลเอ็นต์จากแอปนักพัฒนาซอฟต์แวร์ที่เชื่อมโยงกับพร็อกซีที่รองรับ Microgateway ของคุณ
-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' }

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

ยืนยันโทเค็นผู้ถือที่ลงนามกับคีย์สาธารณะที่จัดเก็บไว้ใน 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

ตรวจสอบสถานะคลัสเตอร์ Microgateway

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

การใช้งาน

edgemicro status

พารามิเตอร์

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

ตัวอย่าง

edgemicro status

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

current nodejs version is v12.5.0
current edgemicro version is 3.0.2
edgemicro is running with 8 workers

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

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

การใช้งาน

edgemicro stop

พารามิเตอร์

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

ตัวอย่าง

edgemicro stop

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

current nodejs version is v12.5.0
current edgemicro version is 3.0.2
Stop Completed Successfully

โหลดคลัสเตอร์ Microgateway อีกครั้ง

ให้การรีสตาร์ทโดยไม่มีการหยุดทำงานหลังจากเปลี่ยนการกำหนดค่า โหลด 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 v12.5.0
current edgemicro version is 3.0.2
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, --username (ต้องระบุ) ชื่อผู้ใช้ 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 v12.5.0
current edgemicro version is 3.0.2
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!

หลังจากหมุนเวียนแล้ว คุณจะเห็นใน UI ของ Edge ว่ามีการเพิ่มคีย์ใหม่ลงใน KVM ของ Microgateway

การตรวจสอบตลอดเวลา

ใช้คำสั่ง 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 ค่าเริ่มต้นคือ "เริ่ม"

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

วิธีเริ่มใช้ Forever

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

วิธีหยุด Forever

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