Справочник по CLI для Edge Microgateway

Вы просматриваете документацию Apigee Edge .
Перейдите к документации Apigee X.
информация

Edge Microgateway v. 2.3.x

Обзор

Интерфейс командной строки Edge Microgateway позволяет вам контролировать и управлять всеми аспектами экземпляра Edge Microgateway.

Управление сертификатами

Команды cert позволяют устанавливать и управлять парой открытого/закрытого ключей, которая используется для подписи токенов-носителей, используемых клиентами для совершения безопасных вызовов через Edge Microgateway. Ключи хранятся на Apigee Edge в безопасном хранилище. Edge Microgateway использует открытый ключ для проверки подписанных токенов на предъявителя. Эти ключи генерируются при запуске команды Edgemicro configure, как описано в разделе Установка и настройка Edge Microgateway . Вы можете использовать команды сертификатов , описанные здесь, для регенерации этих ключей и управления ими, если это необходимо.

Установить сертификат

Устанавливает ключи в хранилище с помощью службы безопасного хранилища Apigee Edge и возвращает открытый ключ в качестве выходных данных. Пары ключей привязаны к определенной организации.

Использование

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 (Необязательно) Если ключ уже хранится в хранилище, принудительно замените его.
-h, --help Вывод информации об использовании.

Пример

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

Выход

current nodejs version is v6.1.0
current edgemicro version is 2.2.4-beta
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 (Необязательно) Указывает псевдоним виртуального хоста для вашей организации: среда. Дополнительную информацию о виртуальных хостах см. в документации Edge. По умолчанию: org-env.apigee.net
-v, --virtualHosts (Необязательно) Переопределяет виртуальные хосты по умолчанию, которые являются « default,secure ». Используйте этот параметр, если для вашей организации Edge указаны виртуальные хосты: среда, отличная от этих значений по умолчанию. Дополнительную информацию о виртуальных хостах см. в документации Edge.
-d, --debug (Необязательно) Предоставляет отладочную информацию.
-h, --help Вывод информации об использовании.

Примечания по использованию

Эта команда сохраняет информацию о конфигурации в ~ /.edgemicro/org-env-config.yaml 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 Вывод информации об использовании.

Примечания по использованию

В случае успеха команда возвращает три элемента. Первый — это URL-адрес, который необходимо поместить в файл конфигурации. Два других — это пара ключей, которая требуется при запуске экземпляра Edge Microgateway.

  • URL-адрес начальной загрузки : этот URL-адрес указывает на службу Apigee Edge, которая позволяет экземпляру Edge Microgateway отправлять аналитические данные в Apigee Edge. Вам необходимо скопировать этот URL-адрес в файл конфигурации Edge Microgateway: ~ /.edgemicro/org-env-config.yaml .
  • ключ : Ключ. Этот ключ и секрет необходимы в качестве входных данных для команды CLI, используемой для запуска экземпляра Edge Microgateway.
  • секрет : Секрет.

Пример

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

Настраивает Edge Microgateway для работы с установкой частного облака Apigee Edge.

Использование

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 ».
-d, --debug (Необязательно) Предоставляет отладочную информацию.
-h, --help Вывод информации об использовании.

Примечания по использованию

Эта команда сохраняет информацию о конфигурации в ~ /.edgemicro/org-env-config.yaml 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 (публичное облако) или частную настройку Edgemicro (частное облако). Команда 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 config.yaml. По умолчанию: 8000
-c, --cluster

(Необязательно) Запускает Edge Microgateway в режиме кластера.

Примечание. Начиная с версии 2.3.1 эта опция была удалена. В версии 2.3.1 и более поздних версиях Edge Micro всегда запускается в режиме кластера.

-c --config (Необязательно) Указывает расположение файла default config.yaml . По умолчанию этот файл находится в ./config/config.yaml .
-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

Пример вывода:

...

PROCESS PID : 54709
installed plugin from analytics
installed plugin from analytics
installed plugin from oauth
installed plugin from oauth
installed plugin from analytics
installed plugin from oauth
5a86b570-a142-11e6-aa1f-6730e9065d6c edge micro listening on port 8000
5a86dc80-a142-11e6-962c-43d9cc723190 edge micro listening on port 8000
5a8751b0-a142-11e6-8241-cf1c517c91eb edge micro listening on port 8000
installed plugin from analytics
installed plugin from oauth
5a924e30-a142-11e6-8740-2944162ce275 edge micro listening on port 8000

Управление токенами

Команды 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. Для этого требуются входные значения Consumer Key (идентификатор клиента) и Consumer Secret (секрет клиента) из зарегистрированного приложения разработчика в 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' }

Выполнение HTTP-запроса для получения токена

Вы также можете сделать необработанный HTTP-запрос для получения токена. Вот пример скручивания. Просто подставьте имена своей организации и среды в URL-адрес, а также замените значения Consumer Id и Consumer Secret для параметров client_id и client_secret:

curl -i -X POST "http://<org>-<test>.apigee.net/edgemicro-auth/token" -d '{"grant_type": "client_credentials", "client_id": "4t8X137pOUUtMR7wag3M1yZTcRxeK", "client_secret": "RAcOFVOvO0jns"}' -H "Content-Type: application/json"

Подтвердить токен

Сверяет подписанный токен на предъявителя с открытым ключом, хранящимся в 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) }

Получение токенов на предъявителя напрямую

Вы можете предпочесть получить токены на предъявителя напрямую, отправив HTTP-запрос к конечной точке токена в Apigee Edge. Фактическая конечная точка токена реализуется в прокси-сервере, который развертывается с помощью команды CLI развертывания-edge-service.

Вот пример скручивания. Просто замените имена своей организации и среды в URL-адресе, а также замените значения Consumer Id и Consumer Secret, полученные из приложения разработчика в Apigee Edge, на параметры client_id и client_secret :

curl -i -X POST "http://<org>-<test>.apigee.net/edgemicro-auth/token" -d '{"grant_type": "client_credentials", "client_id": "4t8X137pOUUtMR7wag3M1yZTcRxeK", "client_secret": "RAcOFVOvO0jns"}' -H "Content-Type: application/json"

Пример вывода:

HTTP/1.1 200 OK

X-Powered-By: Express

Cache-Control: no-store

Pragma: no-cache

Content-Type: application/json; charset=utf-8

Content-Length: 640

ETag: W/"280-ze/g/k+c9taqp110vjYQ"

Date: Fri, 17 07 2015 15:49:24 GMT

Connection: keep-alive

"<long string of numbers and letters>"

Инициализация новой конфигурации Edge Microgateway

Запустите эту команду один раз после первой установки Edge Microgateway. Создает новый файл конфигурации по умолчанию: ~ /.edgemicro/default.yaml .

Использование

edgemicro init 

Параметры

Параметры Описание
-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]

Параметры

Параметры Описание
-o, --org Организация Apigee, для которой вы настроили Edge Microgateway.
-e, --env Среда, для которой вы настроили Edge Microgateway.
-k, --key Возвращаемое значение ключа, которое возвращается при запуске команды « edgemicro configure ».
-s, --secret Возвращаемое секретное значение, которое возвращается при запуске команды « edgemicro configure ».
-h, --help Вывод информации об использовании.

Пример

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

Проверьте состояние кластера микрошлюза

Добавлено: v2.2.4-бета.

По умолчанию Edge Microgateway запускается в режиме кластера. Эту команду можно использовать для проверки состояния кластера.

Использование

edgemicro status

Параметры

Параметры Описание
-h, --help Вывод информации об использовании.

Пример

edgemicro status

Результат (Успех)

current nodejs version is v6.1.0
current edgemicro version is 2.2.4-beta
edgemicro is running with 4 workers

Остановка кластера микрошлюзов

Добавлено: v2.2.4-бета.

Останавливает кластер Edge Microgateway.

Использование

edgemicro stop

Параметры

Параметры Описание
-h, --help Вывод информации об использовании.

Пример

edgemicro stop

Результат (Успех)

current nodejs version is v6.1.0
current edgemicro version is 2.2.4-beta
Stop Completed Successfully

Перезагрузка кластера микрошлюзов

Добавлено: v2.2.4-бета.

Обеспечивает перезагрузку без простоев после изменения конфигурации. Перезагружает 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