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

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

Edge Microgateway v. 3.3.x

Обзор

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

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

Команды cert позволяют устанавливать и управлять парой открытого/закрытого ключей, используемой для подписи токенов bearer, применяемых клиентами для совершения защищенных вызовов через Edge Microgateway. Ключи хранятся на Apigee Edge в зашифрованной карте ключ-значение (KVM). Edge Microgateway использует открытый ключ для проверки подписанных токенов bearer. Эти ключи генерируются при выполнении команды 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 (Необязательно) Указывает псевдоним виртуального хоста для вашей организации:среды. Подробнее о виртуальных хостах см. в документации 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 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-адрес начальной загрузки : Этот URL-адрес указывает на службу Apigee Edge, которая позволяет экземпляру Edge Microgateway отправлять аналитические данные в Apigee Edge. Вам необходимо скопировать этот URL-адрес в файл конфигурации Edge Microgateway: ~ /.edgemicro/org-env-config.yaml -config.yaml.
  • key : Ключ. Этот ключ, а также секретный ключ, необходимы в качестве входных данных для команды 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 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 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!

Start 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 -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. Токен представляет собой JSON Web Token (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' }

Также можно сгенерировать JWT, используя 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 — это среда в вашей организации (например, "test" или "prod").
  • $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 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. По умолчанию для облачных развертываний Apigee используется базовый URI 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 для обновления KVM в вашей организации 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:

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

Пример использования частного облака на границе сети:

-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 Web Key.
-r, --rotatekeyuri Поверните URI ключа.

Граничное публичное облако: необязательно.
Частное облако на периферии сети: Обязательно.

Пример публичного облака:

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

Пример использования частного облака на границе сети:

-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 можно увидеть, что к KVM-переключателю микрошлюза были добавлены новые клавиши.

Пример

В этом примере используются флаги -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