Tham chiếu CLI cho Edge Microgateway

Bạn đang xem tài liệu về Apigee Edge.
Truy cập vào tài liệu Apigee X. thông tin

Edge Microgateway phiên bản 3.0.x

Tổng quan

CLI Edge Microgateway cho phép bạn kiểm soát và quản lý mọi khía cạnh của một phiên bản Edge Microgateway.

Quản lý chứng chỉ

Các lệnh cert cho phép bạn cài đặt và quản lý cặp khoá công khai/riêng tư được dùng để ký mã thông báo của người mang mà các ứng dụng sử dụng để thực hiện các lệnh gọi bảo mật thông qua Edge Microgateway. Các khoá được lưu trữ trên Apigee Edge trong Key Value Map (KVM) được mã hoá. Edge Microgateway sử dụng khoá công khai để xác thực mã thông báo người mang đã ký. Các khoá này được tạo khi bạn chạy lệnh định cấu hình edgemicro, như giải thích trong phần Thiết lập và định cấu hình Edge Microgateway. Bạn có thể dùng các lệnh cert được mô tả tại đây để tạo lại và quản lý các khoá này nếu cần.

Cài đặt chứng chỉ

Cài đặt các khoá trong Key Value Map (KVM) được mã hoá và trả về khoá công khai dưới dạng đầu ra. Cặp khoá được giới hạn trong một tổ chức cụ thể.

Tác dụng

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

Tham số

Thông số Mô tả
-o, --org Tổ chức Apigee mà bạn đã định cấu hình Edge Microgateway.
-e, --env Một môi trường mà bạn đã định cấu hình Edge Microgateway.
-u, --username Tên người dùng Apigee của bạn. Bạn phải là quản trị viên tổ chức của tổ chức được chỉ định.
-p, --password (Không bắt buộc) Mật khẩu của bạn. Bạn sẽ được nhắc nếu không cung cấp tham số này trên dòng lệnh.
-f, --force (Không bắt buộc) Nếu một khoá đã được lưu trữ trong KVM được mã hoá, hãy buộc thay thế khoá đó.
-h, --help Xuất thông tin về mức sử dụng.

Ví dụ

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

Đầu ra

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

Xoá chứng chỉ

Xoá cặp khoá của một tổ chức.

Tác dụng

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

Tham số

Thông số Mô tả
-o, --org Tổ chức Apigee mà bạn đã định cấu hình Edge Microgateway.
-e, --env Một môi trường mà bạn đã định cấu hình Edge Microgateway.
-u, --username Tên người dùng Apigee của bạn. Bạn phải là quản trị viên tổ chức của tổ chức được chỉ định.
-p, --password (Không bắt buộc) Mật khẩu của bạn. Bạn sẽ được nhắc nếu không cung cấp tham số này trên dòng lệnh.
-h, --help Xuất thông tin về mức sử dụng.

Ví dụ

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

Đầu ra

deleting vault
Vault deleted!

Kiểm tra chứng chỉ

Kiểm tra để đảm bảo tổ chức của bạn đã cài đặt một chứng chỉ.

Tác dụng

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

Tham số

Thông số Mô tả
-o, --org Tổ chức Apigee mà bạn đã định cấu hình Edge Microgateway.
-e, --env Một môi trường mà bạn đã định cấu hình Edge Microgateway.
-u, --username Tên người dùng Apigee của bạn. Bạn phải là quản trị viên tổ chức của tổ chức được chỉ định.
-p, --password (Không bắt buộc) Mật khẩu của bạn. Bạn sẽ được nhắc nếu không cung cấp tham số này trên dòng lệnh.
-h, --help Xuất thông tin về mức sử dụng.

Ví dụ

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

Đầu ra (Thành công)

checked cert successfully

Đầu ra (Lỗi)

Nếu chứng chỉ không tồn tại, hệ thống sẽ trả về lỗi.

Lấy khoá công khai

Trả về khoá công khai cho tổ chức được chỉ định. Không yêu cầu xác thực.

Tác dụng

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

Tham số

Thông số Mô tả
-o, --org Tổ chức Apigee mà bạn đã định cấu hình Edge Microgateway.
-e, --env Một môi trường mà bạn đã định cấu hình Edge Microgateway.
-h, --help Xuất thông tin về mức sử dụng.

Ví dụ

edgemicro cert public-key -o docs -e test

Đầu ra (Mẫu)

-----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-----

Định cấu hình Edge Microgateway cho Apigee Edge Cloud

Cho phép Edge Microgateway hoạt động với một phiên bản Apigee Edge Cloud. Thao tác này sẽ bao bọc và thực hiện một chuỗi lệnh để triển khai một proxy xác thực bắt buộc cho Edge, tạo mã thông báo xác thực và cập nhật tệp cấu hình. Để xem ví dụ đầy đủ về cách thức hoạt động, hãy xem phần Thiết lập và định cấu hình Edge Microgateway.

Tác dụng

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

Tham số

Thông số Mô tả
-o, --org Tổ chức Apigee mà bạn đã định cấu hình Edge Microgateway.
-e, --env Một môi trường mà bạn đã định cấu hình Edge Microgateway.
-u, --username Tên người dùng Apigee của bạn. Bạn phải là quản trị viên tổ chức của tổ chức được chỉ định.
-p, --password (Không bắt buộc) Mật khẩu của bạn. Bạn sẽ được nhắc nếu không cung cấp tham số này trên dòng lệnh.
-r, --url (Không bắt buộc) Chỉ định bí danh máy chủ ảo cho tổ chức:môi trường. Hãy xem tài liệu về Edge để tìm hiểu về máy chủ ảo. Mặc định: org-env.apigee.net
-c, --configDir (Không bắt buộc) Chỉ định đường dẫn đến tệp cấu hình Edge Microgateway. Theo mặc định, tệp cấu hình nằm trong ./config/config.yaml. (Đã thêm phiên bản 2.4.x)
-x, --proxyName (Không bắt buộc) Đặt basepath cho proxy edgemicro-auth. Nếu proxy edgemicro-auth được triển khai theo một đường dẫn khác với đường dẫn mặc định /edgemicro-auth, thì tính năng này cho phép bạn đặt đường dẫn mới trong Edge Microgateway. Theo mặc định, basepath là /edgemicro-auth. (Đã thêm v2.4.x)
-t, --token (Không bắt buộc) Cho phép bạn sử dụng mã thông báo OAuth để xác thực thay vì tên người dùng/mật khẩu. Xem thêm phần Bảo mật các lệnh gọi API bằng mã truy cập OAuth2. Ví dụ:

edgemicro configure -o docs -e test -t <your token>
-v, --virtualHosts (Không bắt buộc) Ghi đè các máy chủ ảo mặc định là "default,secure". Hãy sử dụng lựa chọn này nếu bạn có các máy chủ ảo được chỉ định cho tổ chức:môi trường Edge khác với các giá trị mặc định này. Hãy xem tài liệu về Edge để tìm hiểu về máy chủ ảo.
-d, --debug (Không bắt buộc) Cung cấp thông tin gỡ lỗi.
-h, --help Xuất thông tin về mức sử dụng.

Lưu ý về cách sử dụng

Lệnh này lưu trữ thông tin cấu hình trong ~/.edgemicro/org-env-config.yaml.

Ví dụ

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

Đầu ra

Khi thành công, lệnh này sẽ trả về một tập hợp các khoá mà bạn cần dùng khi khởi động Edge Microgateway.

...

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

edgemicro configuration complete!

Đang tạo khoá

Lệnh genkeys sẽ tạo một cặp khoá và khoá bí mật mà Edge Microgateway dùng để tự xác thực khi đăng số liệu phân tích không đồng bộ lên Apigee Edge.

Tác dụng

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

Tham số

Thông số Mô tả
-o, --org Tổ chức Apigee mà bạn đã định cấu hình Edge Microgateway.
-e, --env Một môi trường mà bạn đã định cấu hình Edge Microgateway.
-u, --username Tên người dùng Apigee của bạn. Bạn phải là quản trị viên tổ chức của tổ chức được chỉ định.
-p, --password (Không bắt buộc) Mật khẩu của bạn. Bạn sẽ được nhắc nếu không cung cấp tham số này trên dòng lệnh.
-t, --token (Không bắt buộc) Cho phép bạn sử dụng mã thông báo OAuth để xác thực thay vì tên người dùng/mật khẩu. Xem thêm phần Bảo mật các lệnh gọi API bằng mã truy cập OAuth2. Ví dụ:

edgemicro genkeys -o docs -e test -t <your token>
-h, --help Xuất thông tin về mức sử dụng.

Lưu ý về cách sử dụng

Khi thành công, lệnh này sẽ trả về 3 mục. Đầu tiên là một URL mà bạn cần đặt trong tệp cấu hình. Hai khoá còn lại là một cặp khoá bắt buộc khi bạn khởi động một phiên bản Edge Microgateway.

  • URL khởi động: URL này trỏ đến một dịch vụ Apigee Edge cho phép một thực thể Edge Microgateway gửi dữ liệu phân tích đến Apigee Edge. Bạn cần sao chép URL đó vào tệp cấu hình Edge Microgateway: ~/.edgemicro/org-env-config.yaml.
  • key: Khoá. Khoá này và khoá bí mật là thông tin đầu vào bắt buộc đối với lệnh CLI dùng để khởi động một phiên bản Edge Microgateway.
  • bí mật: Bí mật.

Ví dụ

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

Đầu ra (Mẫu)

Khi thành công, lệnh này sẽ trả về một tập hợp các khoá mà bạn cần dùng khi khởi động 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

Định cấu hình Edge Microgateway cho Apigee Edge Private Cloud

Định cấu hình Edge Microgateway để hoạt động với một bản cài đặt Apigee Edge Private Cloud.

Tác dụng

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

Tham số

Thông số Mô tả
-o, --org Tổ chức Apigee mà bạn đã định cấu hình Edge Microgateway.
-e, --env Một môi trường mà bạn đã định cấu hình Edge Microgateway.
-u, --username Tên người dùng Apigee của bạn. Bạn phải là quản trị viên tổ chức của tổ chức được chỉ định.
-p, --password (Không bắt buộc) Mật khẩu của bạn. Bạn sẽ được nhắc nếu không cung cấp tham số này trên dòng lệnh.
-r, --runtime-url Chỉ định URL thời gian chạy cho phiên bản đám mây riêng tư của bạn.
-m, --mgmt-url URL của máy chủ quản lý cho phiên bản đám mây riêng tư của bạn.
-v, --virtualHosts Danh sách được phân tách bằng dấu phẩy gồm các máy chủ ảo cho tổ chức của bạn:môi trường. Mặc định "default,secure".
-c, --configDir (Không bắt buộc) Chỉ định đường dẫn đến tệp cấu hình Edge Microgateway. Theo mặc định, tệp cấu hình nằm trong ./config/config.yaml. (Đã thêm phiên bản 2.4.x)
-t, --token (Không bắt buộc) Cho phép bạn sử dụng mã thông báo OAuth để xác thực thay vì tên người dùng/mật khẩu. Xem thêm phần Bảo mật các lệnh gọi API bằng mã truy cập OAuth2. Ví dụ:

edgemicro configure -o docs -e test -t <your token>
-d, --debug (Không bắt buộc) Cung cấp thông tin gỡ lỗi.
-h, --help Xuất thông tin về mức sử dụng.

Lưu ý về cách sử dụng

Lệnh này lưu trữ thông tin cấu hình trong ~/.edgemicro/org-env-config.yaml.

Ví dụ

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

Đầu ra

Khi thành công, lệnh này sẽ trả về một tập hợp các khoá mà bạn cần dùng khi khởi động Edge Microgateway.

...

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

edgemicro configuration complete!

Bắt đầu Edge Microgateway

Trước khi bắt đầu Edge Microgateway, trước tiên, bạn phải chạy edgemicro configure (Đám mây công khai) hoặc edgemicro private configure (Đám mây riêng tư). Lệnh configure sẽ trả về các giá trị khoá và bí mật cần thiết để khởi động Edge Microgateway.

Tác dụng

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

Tham số

Thông số Mô tả
-o, --org Tổ chức Apigee mà bạn đã định cấu hình Edge Microgateway.
-e, --env Một môi trường mà bạn đã định cấu hình Edge Microgateway.
-k, --key Giá trị khoá được trả về khi bạn chạy lệnh "edgemicro configure".
-s, --secret Giá trị bí mật được trả về khi bạn chạy lệnh "edgemicro configure".
-p, --processes (Không bắt buộc) Số lượng quy trình cần bắt đầu. Mặc định: Số lõi trên hệ thống của bạn.
-d, --pluginDir (Không bắt buộc) Đường dẫn tuyệt đối đến thư mục trình bổ trợ.
-r, --port (Không bắt buộc) Ghi đè số cổng được chỉ định trong tệp ~/.edgemicro/org-env-config.yaml. Mặc định: 8000
-c, --cluster

(Không bắt buộc) Khởi động Edge Microgateway ở chế độ cụm.

Lưu ý: Kể từ phiên bản 2.3.1, lựa chọn này đã bị xoá. Trong phiên bản 2.3.1 trở lên, Edge Micro luôn khởi động ở chế độ cụm.
-c, --configDir (Không bắt buộc) Chỉ định đường dẫn đến tệp cấu hình Edge Microgateway. Theo mặc định, tệp cấu hình nằm trong ./config/config.yaml. (Đã thêm phiên bản 2.4.x)
-u, --configUrl (Không bắt buộc) Chỉ định một điểm cuối mà Edge Microgateway sẽ tải tệp cấu hình xuống. (Đã thêm phiên bản 2.5.x)
-d, --debug (Không bắt buộc) Cung cấp thông tin gỡ lỗi.
-h, --help Xuất thông tin về mức sử dụng.

Thiết lập cổng

Lệnh start cho phép bạn chỉ định một số cổng để ghi đè cổng được chỉ định trong tệp cấu hình. Bạn cũng có thể chỉ định số cổng bằng biến môi trường PORT. Ví dụ:

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

hoặc

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

Nếu cổng đang được sử dụng, Edge Microgateway sẽ trả về lỗi.

Giới thiệu về việc phân cụm

Edge Microgateway sử dụng mô-đun cụm Node.js để bật tính năng phân cụm. Cụm cho phép Edge Microgateway tận dụng các hệ thống đa lõi. Để biết thông tin chi tiết, hãy xem tài liệu về Node.js này.

Ví dụ

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

Kết quả mẫu:

...

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

Quản lý mã thông báo

Các lệnh token cho phép bạn lấy, giải mã và xác minh mã truy cập OAuth2 đã ký. Xem thêm phần Bảo mật các lệnh gọi API bằng mã truy cập OAuth2.

Giải mã mã thông báo

Giải mã mã thông báo người mang đã ký và được mã hoá thành bản trình bày JWT (Mã thông báo web Java) JSON văn bản thuần tuý. Mã thông báo truyền tải thông tin về ứng dụng nhà phát triển Apigee Edge đã cung cấp các khoá dùng để tạo mã thông báo, bao gồm tên ứng dụng, client_id, danh sách sản phẩm và nhiều thông tin khác.

Tác dụng

edgemicro token decode -f [filename]

Tham số

Thông số Mô tả
-f, --file Tên của một tệp chứa mã thông báo JWT cần giải mã.
-h, --help Xuất thông tin về mức sử dụng.

Ví dụ

edgemicro token decode -f token.jwt

Đầu ra (Mẫu)

{ 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: '' }

Tạo mã thông báo

Tạo mã thông báo người mang đã ký. Mã thông báo này cho phép các ứng dụng khách thực hiện các lệnh gọi API đã xác thực đến Edge Microgateway. Mã thông báo này là một Mã thông báo web JSON (JWT) tuân thủ OAuth 2.0. Bạn phải nhập các giá trị Consumer Key (mã ứng dụng khách) và Consumer Secret (mật khẩu ứng dụng khách) từ một ứng dụng nhà phát triển đã đăng ký trên Apigee Edge. Xem thêm phần Bảo mật các lệnh gọi API bằng mã truy cập OAuth2.

Tác dụng

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

Tham số

Thông số Mô tả
-o, --org Tổ chức Apigee mà bạn đã định cấu hình Edge Microgateway.
-e, --env Một môi trường mà bạn đã định cấu hình Edge Microgateway.
-1, --key Mã ứng dụng khách của Ứng dụng dành cho nhà phát triển được liên kết với proxy có nhận biết Microgateway.
-s, --secret Mật khẩu ứng dụng khách của ứng dụng Nhà phát triển được liên kết với proxy có hỗ trợ Microgateway.
-h, --help Xuất thông tin về mức sử dụng.

Ví dụ

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

Đầu ra (Mẫu)

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

Xác minh mã thông báo

Xác minh mã thông báo người mang đã ký dựa trên khoá công khai được lưu trữ trên Apigee Edge cho tổ chức và môi trường được chỉ định.

Tác dụng

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

Tham số

Thông số Mô tả
-o, --org Tổ chức Apigee mà bạn đã định cấu hình Edge Microgateway.
-e, --env Một môi trường mà bạn đã định cấu hình Edge Microgateway.
-f, --file Tên của một tệp chứa JWT cần xác minh.
-h, --help Xuất thông tin về mức sử dụng.

Ví dụ

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

Đầu ra mẫu cho mã thông báo hợp lệ

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

  client_id: 'O9ZQRZKnn1rdgcKQsAZUBkQSMdOsKS',

  scopes: [],

  api_product_list: [ 'MicroTest' ],

  iat: 1436396155,

  exp: 1436397954 }

Ví dụ về đầu ra cho mã thông báo không hợp lệ

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

Ví dụ về đầu ra cho mã thông báo đã hết hạn

{ [TokenExpiredError: jwt expired]

  name: 'TokenExpiredError',

  message: 'jwt expired',

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

Khởi tạo một cấu hình Edge Microgateway mới

Chạy lệnh này một lần sau khi bạn cài đặt Edge Microgateway lần đầu tiên. Tạo tệp cấu hình mặc định mới: ~/.edgemicro/default.yaml.

Tác dụng

edgemicro init

Tham số

Thông số Mô tả
-c, --configDir (Không bắt buộc) Chỉ định đường dẫn đến tệp cấu hình Edge Microgateway. Theo mặc định, tệp cấu hình nằm trong ./config/config.yaml. (Đã thêm phiên bản 2.4.x)
-h, --help Xuất thông tin về mức sử dụng.

Ví dụ

edgemicro init

Đầu ra (Thành công)

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

Xác minh cấu hình Edge Microgateway

Xác minh rằng Edge Microgateway được định cấu hình đúng cách.

Tác dụng

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

Tham số

Ví dụ

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

Đầu ra (Thành công)

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

Kiểm tra trạng thái của cụm microgateway

Theo mặc định, Edge Microgateway sẽ khởi động ở chế độ cụm. Bạn có thể dùng lệnh này để kiểm tra trạng thái của cụm.

Tác dụng

edgemicro status

Tham số

Thông số Mô tả
-h, --help Xuất thông tin về mức sử dụng.

Ví dụ

edgemicro status

Đầu ra (Thành công)

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

Dừng cụm microgateway

Dừng cụm Edge Microgateway.

Tác dụng

edgemicro stop

Tham số

Thông số Mô tả
-h, --help Xuất thông tin về mức sử dụng.

Ví dụ

edgemicro stop

Đầu ra (Thành công)

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

Đang tải lại cụm microgateway

Cung cấp khả năng khởi động lại mà không bị gián đoạn sau khi thay đổi cấu hình. Tải lại Edge Microgateway bằng cách kéo vào một cấu hình mới.

Tác dụng

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

Tham số

Thông số Mô tả
-o, --org Tổ chức Apigee mà bạn đã định cấu hình Edge Microgateway.
-e, --env Một môi trường mà bạn đã định cấu hình Edge Microgateway.
-k, --key Giá trị khoá được trả về khi bạn chạy lệnh "edgemicro configure".
-s, --secret Giá trị bí mật được trả về khi bạn chạy lệnh "edgemicro configure".
-h, --help Xuất thông tin về mức sử dụng.

Ví dụ

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

Đầu ra (Thành công)

...

Reload Completed Successfully

Nâng cấp KVM

Để sử dụng tính năng xoay khoá, bạn phải cài đặt Bản đồ khoá giá trị đã nâng cấp trong tổ chức Apigee Edge của mình. (Đã thêm phiên bản 2.5.x)

Lưu ý: Nếu đã định cấu hình phiên bản Edge Micro hiện tại trước phiên bản 2.5.2, bạn phải nâng cấp KVM để sử dụng tính năng xoay vòng khoá. Bạn chỉ cần thực hiện nâng cấp một lần.

Tác dụng

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

Tham số

Thông số Mô tả
-o, --org Tổ chức Apigee mà bạn đã định cấu hình Edge Microgateway.
-e, --env Một môi trường mà bạn đã định cấu hình Edge Microgateway.
-u, --username Tên người dùng Apigee của bạn. Bạn phải là quản trị viên tổ chức của tổ chức được chỉ định.
-p, --password (Không bắt buộc) Mật khẩu của bạn. Bạn sẽ được nhắc nếu không cung cấp tham số này trên dòng lệnh.
-v, --virtualhost (Không bắt buộc) Máy chủ ảo của proxy.
-t, --token (Không bắt buộc.) Cho phép bạn sử dụng mã thông báo OAuth để xác thực thay vì tên người dùng/mật khẩu. Xem thêm phần Bảo mật các lệnh gọi API bằng mã truy cập OAuth2. Ví dụ:

edgemicro upgradekvm -o docs -e test -t <your token>
-b, --baseuri (Không bắt buộc) URI cơ sở cho tổ chức của bạn trên Apigee Edge. URI cơ sở mặc định cho các hoạt động triển khai trên đám mây Apigee là api.enterprise.apigee.com. Đối với các hoạt động triển khai tại chỗ, URL cơ sở có thể khác.

Ví dụ

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

Đầu ra (Thành công)

Khi thành công, lệnh sẽ trả về kết quả tương tự như sau:

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

Nâng cấp proxy edgemicro-auth

Để sử dụng tính năng xoay khoá, bạn phải triển khai một proxy edgemicro-auth đã nâng cấp trong tổ chức Apigee Edge của mình. (Đã thêm phiên bản 2.5.x)

Lưu ý: Nếu đã định cấu hình phiên bản Edge Micro hiện tại trước phiên bản 2.5.2, bạn phải nâng cấp proxy này nếu muốn sử dụng tính năng xoay vòng khoá. Bạn chỉ cần thực hiện nâng cấp này một lần.

Tác dụng

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

Tham số

Thông số Mô tả
-o, --org Tổ chức Apigee mà bạn đã định cấu hình Edge Microgateway.
-e, --env Một môi trường mà bạn đã định cấu hình Edge Microgateway.
-u, --username Tên người dùng Apigee của bạn. Bạn phải là quản trị viên tổ chức của tổ chức được chỉ định.
-p, --password (Không bắt buộc) Mật khẩu của bạn. Bạn sẽ được nhắc nếu không cung cấp tham số này trên dòng lệnh.
-v, --virtualhost (Không bắt buộc) Máy chủ ảo của proxy.
-b, --baseuri (Không bắt buộc) URI cơ sở cho tổ chức của bạn trên Apigee Edge. URI cơ sở mặc định cho các hoạt động triển khai trên đám mây Apigee là api.enterprise.apigee.com. Đối với các hoạt động triển khai tại chỗ, URL cơ sở có thể khác.

Ví dụ

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

Đầu ra (Thành công)

Khi thành công, lệnh sẽ trả về kết quả tương tự như sau:

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

Xoay vòng khoá

Sử dụng lệnh edgemicro rotatekey để xoay cặp khoá công khai/riêng tư đã dùng để tạo mã thông báo JWT dùng cho bảo mật OAuth trên Edge Microgateway.

Để tìm hiểu thêm, hãy xem bài viết Xoay khoá JWT.

Tác dụng

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

Tham số

Thông số Mô tả
-o, --org (Bắt buộc) Tổ chức Apigee mà bạn đã định cấu hình Edge Microgateway.
-e, --env (Bắt buộc) Một môi trường mà bạn đã định cấu hình Edge Microgateway.
-u, --username (Bắt buộc) Tên người dùng Apigee của bạn. Bạn phải là quản trị viên tổ chức của tổ chức được chỉ định.
-p, --password (Không bắt buộc) Mật khẩu của bạn. Bạn sẽ được nhắc nếu không cung cấp tham số này trên dòng lệnh.
-k, --kid (Bắt buộc) Mã nhận dạng dùng để so khớp một khoá cụ thể. Edge Microgateway sử dụng giá trị này để chọn trong số một tập hợp khoá trong quá trình xoay vòng khoá. Để biết thêm thông tin, hãy xem phần 4.5 của quy cách Khoá web JSON.
-b, --baseuri (Không bắt buộc) URI cơ sở cho tổ chức của bạn trên Apigee Edge. URI cơ sở mặc định cho các hoạt động triển khai trên đám mây Apigee là api.enterprise.apigee.com. Đối với các hoạt động triển khai tại chỗ, URL cơ sở có thể khác.

Ví dụ

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

Đầu ra (Thành công)

Khi thành công, lệnh sẽ trả về kết quả tương tự như sau:

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!

Sau khi xoay, bạn có thể thấy trong Giao diện người dùng Edge rằng các khoá mới đã được thêm vào KVM của cổng vi mô.

Giám sát vĩnh viễn

Sử dụng lệnh edgemicro forever để quản lý quy trình Forever, một công cụ Node.js tự động khởi động lại ứng dụng Node.js trong trường hợp ứng dụng ngừng hoạt động hoặc gặp lỗi. Xem thêm bài viết Luôn giám sát.

Tác dụng

Bạn phải thiết lập các biến môi trường sau đây trước khi thực thi lệnh edgemicro forever:

  • EDGEMICRO_ORG – Tổ chức Apigee mà bạn đã định cấu hình Edge Microgateway.
  • EDGEMICRO_ENV – Một môi trường mà bạn đã định cấu hình Edge Microgateway.
  • EDGEMICRO_KEY – Giá trị khoá được trả về khi bạn chạy lệnh "edgemicro configure".
  • EDGEMICRO_SECRET – Giá trị bí mật được trả về khi bạn chạy lệnh "edgemicro configure".
edgemicro forever -f [forever_file] -a [start|stop]

Tham số

Tham sốMô tả
-f, --fileChỉ định vị trí của tệp forever.json.
-a, --actionstart hoặc stop. Giá trị mặc định là start.

Ví dụ:

Cách bắt đầu sử dụng Forever:

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

Cách dừng Forever:

edgemicro forever -a stop

Thu hồi khoá

Sử dụng lệnh edgemicro revokekeys để thu hồi khoá và thông tin đăng nhập bí mật cho cấu hình Edge Microgateway.

Tác dụng

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

Tham số

Thông số Mô tả
-o, --org (Bắt buộc) Tổ chức Apigee mà bạn đã định cấu hình Edge Microgateway.
-e, --env (Bắt buộc) Một môi trường mà bạn đã định cấu hình Edge Microgateway.
-u, --username (Bắt buộc) Tên người dùng Apigee của bạn. Bạn phải là quản trị viên tổ chức của tổ chức được chỉ định.
-p, --password (Không bắt buộc) Mật khẩu của bạn. Bạn sẽ được nhắc nếu không cung cấp tham số này trên dòng lệnh.
-k, --key (Bắt buộc) Khoá cần thu hồi.
-s, --secret (Bắt buộc) Khoá bí mật cần thu hồi.

Ví dụ

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

Khi thành công, bạn sẽ thấy thông báo sau:

key 2c0064f5bd85f5573dcaffe21566fa7a2d49885cdbf8899370c8a4479285f revoked successfully