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

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

Edge Microgateway версии 3.3.x

Обзор

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

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

Команды cert позволяют установить и настроить пару открытого и закрытого ключей, которые используются для подписи токенов доступа, применяемых клиентами для безопасных вызовов через Edge Microgateway. Ключи хранятся в Apigee Edge в зашифрованной таблице "Ключ-значение" (KVM). Edge Microgateway использует открытый ключ для проверки подписанных токенов носителя. Эти ключи создаются при выполнении команды edgemicro configure, как описано в разделе Настройка Edge Microgateway. При необходимости вы можете сгенерировать и настроить эти ключи с помощью команд cert, описанных ниже.

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

Устанавливает ключи в зашифрованную карту "ключ-значение" и возвращает открытый ключ в качестве выходных данных. Пары ключей относятся к определенной организации.

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

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. Он выполняет последовательность команд для развертывания необходимого прокси-сервера аутентификации в 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
-c, --configDir (Необязательно) Указывает путь к файлу конфигурации Edge Microgateway. По умолчанию файл конфигурации находится в папке ./config/config.yaml. (Добавлено в версии 2.4.x)
-x, --proxyName Необязательный тег. Задает базовый путь для прокси-сервера edgemicro-auth. Если прокси-сервер edgemicro-auth развернут по пути, отличному от пути по умолчанию /edgemicro-auth, эта функция позволяет задать новый путь в Edge Microgateway. По умолчанию базовый путь – /edgemicro-auth. (Добавлено в версии 2.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 Вывод информации об использовании.

Примечания

При успешном выполнении команда возвращает три объекта. Первый – это URL, который нужно добавить в файл конфигурации. Остальные два файла – это пара ключей, которые необходимы при запуске экземпляра Edge Microgateway.

  • 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. (Добавлено в версии 2.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 в режиме кластера (необязательный параметр).

Примечание. В версии 2.3.1 этот параметр был удален. В версии 2.3.1 и более поздних версиях Edge Micro всегда запускается в режиме кластера.
-c, --configDir (Необязательно) Указывает путь к файлу конфигурации Edge Microgateway. По умолчанию файл конфигурации находится в папке ./config/config.yaml. (Добавлено в версии 2.4.x)
-u, --configUrl (Необязательно) Указывает конечную точку, из которой Edge Microgateway будет скачивать файл конфигурации. (Добавлено в версии 2.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. Токен соответствует стандарту OAuth 2.0 и представляет собой веб-токен JSON (JWT). Для этого требуется ввести ключ потребителя (идентификатор клиента) и секретный код потребителя (секретный код клиента) из зарегистрированного приложения для разработчиков в 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 Идентификатор клиента из приложения для разработчиков, связанного с прокси-сервером, поддерживающим микрошлюз.
-s, --secret Секретный код клиента из приложения для разработчиков, связанного с прокси-сервером, поддерживающим микрошлюз.
-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' }

Вы также можете сгенерировать токен JWT с помощью Management API:

curl -i -X POST "http://$ORG-$ENV.apigee.net/edgemicro-auth/token" \
  -H "Content-Type: application/json" \
  -d '{
    "$CLIENT_ID": "your consumer key",
    "$CLIENT_SECRET": "your consumer secret",
    "grant_type": "client_credentials"
  }'

Где:

  • $ORG – название организации Edge (требуются права администратора организации).
  • $ENV – это среда в вашей организации (например, "тестовая" или "производственная").
  • $CLIENT_ID – это идентификатор потребителя в созданном вами ранее приложении разработчика.
  • $CLIENT_SECRET – это секретный код потребителя в созданном вами ранее приложении для разработчиков.

Как проверить токен

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

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

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

edgemicro init

Параметры

Параметры Описание
-c, --configDir (Необязательно) Указывает путь к файлу конфигурации Edge Microgateway. По умолчанию файл конфигурации находится в папке ./config/config.yaml. (Добавлено в версии 2.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 v12.5.0
current edgemicro version is 3.0.2
edgemicro is running with 8 workers

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

Останавливает кластер 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

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

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

Как обновить прокси-сервер edgemicro-auth

Чтобы использовать ротацию ключей, необходимо развернуть обновленный прокси-сервер edgemicro-auth в организации Apigee Edge. (Добавлено в версии 2.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

Обновление карты пар "ключ-значение" (KVM)

Используйте команду edgemicro upgradekvm, чтобы обновить хранилище пар "ключ-значение" в организации Apigee. Если вы хотите использовать ротацию ключей, необходимо обновить KVM.

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

Edge для общедоступного облака: 

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

Edge для частного облака: 

edgemicro private upgradekvm -o [organization] -e [environment] -k [key] -s [secret] -p 'https://[hostname]/edgemicro-auth'

Параметры

Параметры Описание
-o, --org Организация Apigee, для которой вы настроили Edge Microgateway.
-e, --env Среда, для которой вы настроили Edge Microgateway.
-k, --key Значение ключа, возвращаемое при выполнении команды "edgemicro configure".
-s, --secret Значение секрета, возвращаемое при выполнении команды "edgemicro configure".
-p, --proxyuri URI для прокси-сервера edgemicro_auth

Общедоступное облако Edge: необязательно.
Edge Private Cloud: обязательно.

Пример для Edge Public Cloud: 

 -p 'https://[org]-[env].apigee.net/edgemicro-auth'

Пример для Edge Private Cloud: 

-p 'https://[hostname]/edgemicro-auth'

Пример

edgemicro upgradekvm -o docs -e test \
-k 27ee39567c75e4567a66236cbd4e86d1cc93df6481454301bd5fac4d3497fcbb \
-s 4618b0008a6185d7327ebf53bee3c50282ccf45a3cceb1ed9828bfbcf1148b47

Выходные данные (успешно)

При успешном выполнении команды вы увидите строку примерно следующего содержания:

current nodejs version is v12.5.0
current edgemicro version is 3.1.5
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 rotatekey, чтобы сменить пары открытого и закрытого ключей, которые использовались для создания токенов JWT, применяемых для защиты OAuth в Edge Microgateway.

Подробнее о том, как проводить ротацию токена JWT…

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

Edge для общедоступного облака: 

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

Edge для частного облака: 

edgemicro private rotatekey -o [organization] -e [environment] -k [key] -s [secret] -r '[hostname]/edgemicro-auth/rotateKey'

Параметры

Параметры Описание
-o, --org (Обязательно) Организация Apigee, для которой вы настроили Edge Microgateway.
-e, --env (Обязательно) Среда, для которой вы настроили Edge Microgateway.
-k, --key Значение ключа, возвращаемое при выполнении команды "edgemicro configure".
-s, --secret Значение секрета, возвращаемое при выполнении команды "edgemicro configure".
-p Путь к пользовательскому закрытому ключу, который будет использоваться Apigee Edge. (Добавлено в версии 3.1.6)
-c Путь к специальному сертификату, который будет использоваться Apigee Edge. (Добавлено в версии 3.1.6)
-n, --nbf

Настройте задержку в минутах, после которой новый закрытый ключ начнет действовать. Эта задержка нужна для того, чтобы экземпляры микрошлюза обновились с новым открытым ключом. Рекомендуем задать задержку, превышающую значение параметра конфигурации config_change_poll_internal (по умолчанию 10 минут). Подробнее о том, как настроить задержку "не ранее"… (Добавлено в версии 3.1.6)

Примечание. Если вы используете этот параметр с версиями edgemicro-auth, более ранними, чем версия, распространяемая с Edge Microgateway 3.1.6, флаг игнорируется.

-i, --kid (Необязательно.) Идентификатор, используемый для сопоставления с определенным ключом. Edge Microgateway использует это значение, чтобы выбрать один из наборов ключей во время ротации ключей. Если этот параметр не указан (рекомендуется), Edge Microgateway генерирует ключ на основе временной метки. Дополнительную информацию можно найти в разделе 4.5 спецификации веб-ключей JSON.
-r, --rotatekeyuri Проведите ротацию URI ключа.

Edge Public Cloud: необязательно.
Edge Private Cloud: обязательно.

Пример для общедоступного облака: 

-r 'https://[org]-[env].apigee.net/edgemicro-auth/rotateKey'

Пример для Edge Private Cloud: 

-r '[hostname]/edgemicro-auth/rotateKey'

Пример

edgemicro rotatekey -o docs -e test \
-k 27ee39567c75e4567a66236cbd4e86d1cc93df6481454301bd5fac4d3497fcbb \
-s 4618b0008a6185d7327ebf53bee3c50282ccf45a3cceb1ed9828bfbcf1148b47

Выходные данные (успешно)

При успешном выполнении команды вы увидите строку примерно следующего содержания:

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!

После ротации в интерфейсе Edge можно увидеть, что в хранилище пар "ключ-значение" микрошлюза добавлены новые ключи.

Пример

В этом примере используются флаги -p и -c, чтобы указать путь к паре закрытого ключа и сертификата. Эти варианты позволяют передать собственную пару закрытого ключа и сертификата. 

edgemicro rotatekey -o docs -e test \
-k 27ee39567c75e4567a66236cbd4e86d1cc93df6481454301bd5fac4d3497fcbb \
-s 4618b0008a6185d7327ebf53bee3c50282ccf45a3cceb1ed9828bfbcf1148b47 \
-p /users/home/keys.pem -c /users/home/cert.cert

Постоянный мониторинг

Как отозвать ключи

Используйте команду 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 (Обязательно укажите -u или -t.) Имя пользователя Apigee. Вы должны быть администратором организации, указанной в запросе. Этот параметр не обязателен, если вы укажете параметр -t.
-p, --password Пароль (необязательно). Если вы не укажете этот параметр в командной строке, вам будет предложено сделать это.
-k, --key Обязательный параметр. Ключ, который нужно отозвать.
-s, --secret Обязательный параметр. Секрет, который нужно отозвать.
-t, --token (Требуется -u или -t.) Позволяет использовать для аутентификации токен OAuth вместо имени пользователя и пароля. Если указано значение -t, параметр -u не требуется. Также ознакомьтесь с информацией о том, как защитить вызовы API с помощью токена доступа OAuth2. Пример: 
edgemicro revokekeys -o ORG-NAME -e ENV-NAME -k KEY-TO-REVOKE \
    -s KEY-SECRET -t TOKEN

Примеры

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

Если все пройдет успешно, вы увидите следующее сообщение:

key 2c0064f5bd85f5573dcaffe21566fa7a2d49885cdbf8899370c8a4479285f revoked successfully