Справочные материалы

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

Интерфейс командной строки (CLI) apigee-remote-service-cli помогает инициализировать адаптер Apigee для Envoy и управлять им.

Команды привязки

Привязка связывает сервис, развернутый в сети Istio, с продуктом API Apigee. С помощью интерфейса командной строки можно создавать, удалять, перечислять и проверять привязки.

Как добавить привязку

Добавляет привязку целевого объекта удаленного сервиса к продукту API.

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

Для Edge Public Cloud:

apigee-remote-service-cli bindings add [service_name] [product_name]  -o [organization] -e [environment] -u [username] -p [password] -c [config]

Для Edge Private Cloud:

apigee-remote-service-cli bindings add [service_name] [product_name]  -o [organization] -e [environment] -u [username] -p [password] -r [runtime] -c [config]

Где:

  • target_name – название целевого объекта удаленного сервиса, который нужно привязать к продукту.
  • product_name – название продукта, с которым нужно связать сервис.

Флаги

Параметры Тип Описание
-c, --config Строка Обязательный параметр. Путь к файлу конфигурации удаленного сервиса Apigee.
Примечание. Этот флаг позволяет опустить большинство других параметров команды, поскольку CLI может получить их непосредственно из файла конфигурации. Подробнее о том, как использовать вариант --config…
-e, --env Строка (Обязательно) Среда в вашей организации.
-h, --help Показывает справку по параметрам команды.
--insecure Разрешить небезопасные подключения к серверу при использовании SSL
--legacy Установите этот флаг, если вы используете облачную версию Apigee Edge. Он задает URL управления и URL среды выполнения для Edge Cloud.
--mfa Токен многофакторной авторизации Apigee (используется только с --legacy)
--opdk Установите этот флаг, если вы используете Apigee Edge для частного облака.
-o, --org Строка Организация Apigee (обязательно). У вас должна быть роль администратора организации.
-p, --password Строка (Требуется только для базовой аутентификации.) Пароль Apigee. При необходимости можно указать пароль в файле .netrc. В этом случае вам не нужно будет указывать пароль в командной строке. Также ознакомьтесь со статьей Как использовать файл .netrc для хранения учетных данных.
-r, --runtime Строка (Только для частного облака) Указывает URL среды выполнения для экземпляра частного облака.
-t, --token Строка (Требуется только для аутентификации с помощью токена OAuth.) Токен OAuth или SAML, который вы создаете на основе информации аккаунта Apigee. Информацию о том, как создавать токены, можно найти в статьях Как использовать get_token и Как получить доступ к Management API с помощью SAML.
-u, --username Строка (Требуется только для базовой аутентификации.) Имя пользователя Apigee (обычно адрес электронной почты). При необходимости вы можете указать имя пользователя в файле .netrc. В таком случае вам не нужно будет указывать имя пользователя в командной строке. Также ознакомьтесь с информацией о том, как использовать файл .netrc для учетных данных.
-v, --verbose (Необязательно) Выводит подробные данные.

Пример

./apigee-remote-service-cli bindings add httpbin.org envoy-test -o myorg -e test -u user@example.com -c config.yaml -p xxxxxx
product envoy-test is now bound to: httpbin.org

Получение списка привязок

Перечислите все продукты API, связанные с удаленным сервисом.

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

Для Edge Public Cloud:

apigee-remote-service-cli bindings list -o [organization] -e [environment] -u [username] -p [password]

Для Edge Private Cloud:

apigee-remote-service-cli bindings list -o [organization] -e [environment] -u [username] -p [password] -r [runtime] 

Параметры

Параметры Тип Описание
-c, --config Строка Обязательный параметр. Путь к файлу конфигурации удаленного сервиса Apigee.
Примечание. Этот флаг позволяет опустить большинство других параметров команды, поскольку CLI может получить их непосредственно из файла конфигурации. Подробнее об использовании варианта --config…
-e, --env Строка (Обязательно) Среда в вашей организации.
-h, --help Показывает справку по параметрам команды.
--insecure Разрешить небезопасные подключения к серверу при использовании SSL
--legacy Установите этот флаг, если вы используете облачную версию Apigee Edge. Он задает URL управления и URL среды выполнения для Edge Cloud.
--mfa Токен многофакторной авторизации Apigee (используется только с --legacy)
--opdk Установите этот флаг, если вы используете Apigee Edge для частного облака.
-o, --org Строка Организация Apigee (обязательно). У вас должна быть роль администратора организации.
-p, --password Строка (Требуется только для базовой аутентификации.) Пароль Apigee. При необходимости можно указать пароль в файле .netrc. В этом случае вам не нужно будет указывать пароль в командной строке. Также ознакомьтесь со статьей Как использовать файл .netrc для хранения учетных данных.
-r, --runtime Строка (Только для частного облака) Указывает URL среды выполнения для экземпляра частного облака.
-t, --token Строка (Требуется только для аутентификации с помощью токена OAuth.) Токен OAuth или SAML, который вы создаете на основе информации аккаунта Apigee. Информацию о том, как создавать токены, можно найти в статьях Как использовать get_token и Как получить доступ к Management API с помощью SAML.
-u, --username Строка (Требуется только для базовой аутентификации.) Имя пользователя Apigee (обычно адрес электронной почты). При необходимости вы можете указать имя пользователя в файле .netrc. В таком случае вам не нужно будет указывать имя пользователя в командной строке. Также ознакомьтесь с информацией о том, как использовать файл .netrc для учетных данных.
-v, --verbose (Необязательно) Выводит подробные данные.

Пример

apigee-remote-service-cli bindings list -o myorg -e test -u user@example.com -c config.yaml -p abc123
PI Products
============
Bound
-----
envoy-test:
  Quota: 5 requests every 1 minute
  Target bindings:
    httpbin.org
  Paths:
httpbin:
  Quota: 5 requests every 1 minute
  Target bindings:
    httpbin.org
  Paths:
    /httpbin
    /

Unbound
-------
product-1:
  Quota: 100 requests every 1 hour
product-2:
  Quota: 1000 requests every 1 month
product-3:
product-4:

Как удалить привязку

Удалите привязку удаленного сервиса Envoy к продукту API.

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

Для Edge Public Cloud:

apigee-remote-service-cli bindings remove [service_name] [product_name]  -o [organization] -e [environment] -u [username] -p [password] -c [config]

Для Edge Private Cloud:

apigee-remote-service-cli bindings remove [service_name] [product_name]  -o [organization] -e [environment] -u [username] -p [password] -r [runtime] -c [config]

Где:

  • target_name – название целевого объекта удаленного сервиса, который нужно отменить для продукта.
  • product_name – название продукта, от которого нужно отвязать целевой объект.

Параметры

Параметры Тип Описание
-c, --config Строка Обязательный параметр. Путь к файлу конфигурации удаленного сервиса Apigee.
Примечание. Этот флаг позволяет опустить большинство других параметров команды, поскольку CLI может получить их непосредственно из файла конфигурации. Подробнее о том, как использовать вариант --config…
-e, --env Строка (Обязательно) Среда в вашей организации.
-h, --help Показывает справку по параметрам команды.
--insecure Разрешить небезопасные подключения к серверу при использовании SSL
--legacy Установите этот флаг, если вы используете облачную версию Apigee Edge. Он задает URL управления и URL среды выполнения для Edge Cloud.
--mfa Токен многофакторной авторизации Apigee (используется только с --legacy)
--opdk Установите этот флаг, если вы используете Apigee Edge для частного облака.
-o, --org Строка Организация Apigee (обязательно). У вас должна быть роль администратора организации.
-p, --password Строка (Требуется только для базовой аутентификации.) Пароль Apigee. При необходимости можно указать пароль в файле .netrc. В этом случае вам не нужно будет указывать пароль в командной строке. Также ознакомьтесь со статьей Как использовать файл .netrc для хранения учетных данных.
-r, --runtime Строка (Только для частного облака) Указывает URL среды выполнения для экземпляра частного облака.
-t, --token Строка (Требуется только для аутентификации с помощью токена OAuth.) Токен OAuth или SAML, который вы создаете на основе информации аккаунта Apigee. Информацию о том, как создавать токены, можно найти в статьях Как использовать get_token и Как получить доступ к Management API с помощью SAML.
-u, --username Строка (Требуется только для базовой аутентификации.) Имя пользователя Apigee (обычно адрес электронной почты). При необходимости вы можете указать имя пользователя в файле .netrc. В таком случае вам не нужно будет указывать имя пользователя в командной строке. Также ознакомьтесь с информацией о том, как использовать файл .netrc для учетных данных.
-v, --verbose (Необязательно) Выводит подробные данные.

Пример

./apigee-remote-service-cli bindings remove httpbin.org envoy-test -o myorg -e test -u user@example.com -c config.yaml -p xxxxxx
product envoy-test is no longer bound to: httpbin.org

Как проверить привязку

Убедитесь, что указанный связанный продукт API и связанные с ним приложения разработчика также связаны с продуктом удаленного сервиса. Если вы не укажете название продукта API, команда проверит все связанные продукты.

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

Для Edge Public Cloud:

apigee-remote-service-cli bindings verify [product_name]  -o [organization] -e [environment] -u [username] -p [password] -c [config]

Для Edge Private Cloud:

apigee-remote-service-cli bindings verify [product_name]  -o [organization] -e [environment] -u [username] -p [password] -r [runtime] -c [config]

Атрибут "название товара" необязательный. Если вы не укажете название товара, будут проверены все связанные товары.

Параметры

Параметры Тип Описание
-c, --config Строка Обязательный параметр. Путь к файлу конфигурации удаленного сервиса Apigee.
Примечание. Этот флаг позволяет опустить большинство других параметров команды, поскольку CLI может получить их непосредственно из файла конфигурации. Подробнее о том, как использовать вариант --config…
-e, --env Строка (Обязательно) Среда в вашей организации.
-h, --help Показывает справку по параметрам команды.
--insecure Разрешить небезопасные подключения к серверу при использовании SSL
--legacy Установите этот флаг, если вы используете облачную версию Apigee Edge. Он задает URL управления и URL среды выполнения для Edge Cloud.
--mfa Токен многофакторной авторизации Apigee (используется только с --legacy)
--opdk Установите этот флаг, если вы используете Apigee Edge для частного облака.
-o, --org Строка Организация Apigee (обязательно). У вас должна быть роль администратора организации.
-r, --runtime Строка (Только для частного облака) Указывает URL среды выполнения для экземпляра частного облака.
-t, --token Строка (Требуется только для аутентификации с помощью токена OAuth.) Токен OAuth или SAML, который вы создаете на основе информации аккаунта Apigee. Информацию о том, как создавать токены, можно найти в статьях Как использовать get_token и Как получить доступ к Management API с помощью SAML.
-v, --verbose (Необязательно) Выводит подробные данные.

Пример

./apigee-remote-service-cli bindings verify my-product -o myorg -e test -u user@example.com -c config.yaml -p xxxxxx
  app my-app associated with product my-product is verified

Команда "Справка"

Для всех команд apigee-remote-service-cli доступна онлайн-справка. Просто введите:

apigee-remote-service-cli help

Чтобы получить справку по любой команде, введите:

apigee-remote-service-cli [command] help

Пример:

apigee-remote-service-cli provision help

Команда инициализации

Команда apigee-remote-service-cli provision устанавливает прокси в организации Apigee Edge, настраивает сертификат и создает учетные данные, которые понадобятся для настройки адаптера Apigee для Envoy.

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

Если вы используете Edge Public Cloud:

apigee-remote-service-cli provision -o $ORG -e $ENV -u $USERNAME -p $PASSWORD

Если вы используете Edge Private Cloud:

apigee-remote-service-cli provision --opdk -o $ORG -e $ENV -u $USERNAME --management $MGMT_SERVER_URL --runtime $RUNTIME_URL -p $PASSWORD

Параметры

Параметры Тип Описание
-c, --config Строка Путь к файлу конфигурации удаленного сервиса Apigee. Также ознакомьтесь с информацией о том, как использовать параметр --config.
-e, --environment Строка (Обязательно) Среда в вашей организации.
-f, --force-proxy-install (Необязательно.) Принудительно переустанавливает прокси-сервер remote-service, если он уже установлен в организации.
-h, --help Показывает справку по параметрам команды.
-k, --key Строка Указывает ключ, возвращенный командой apigee-remote-service-cli provision.
--legacy Установите этот флаг, если вы используете облачную версию Apigee Edge. Он задает URL управления и URL среды выполнения для Edge Cloud.
--mfa Токен многофакторной авторизации Apigee (используется только с --legacy)
-m, --management Строка (Обязательно, если вы используете частное облако Apigee.) Базовый URL управления Apigee. По умолчанию: https://api.enterprise.apigee.com
-n, --namespace Строка Создать конфигурацию в виде файла ConfigMap Envoy в указанном пространстве имен. Значение по умолчанию: apigee.
--opdk Строка Apigee OPDK.
-o, --organization Строка (Обязательно) Организация Apigee. У вас должна быть роль администратора организации.
-p, --password Строка (Требуется только для базовой аутентификации.) Пароль Apigee. При необходимости можно указать пароль в файле .netrc. В этом случае вам не нужно будет указывать пароль в командной строке. Также ознакомьтесь со статьей Как использовать файл .netrc для хранения учетных данных.
--rotate-int int Если n > 0, создайте новый закрытый ключ и сохраните n открытых ключей (только для гибридного режима).
-r, --runtime Строка (Только для частного облака) Указывает URL среды выполнения для экземпляра частного облака.
-s, --secret Строка Указывает секрет, возвращенный командой apigee-remote-service-cli provision.
--strength int (Необязательно.) Указывает уровень шифрования для SSL-сертификатов, используемых при инициализации адаптера. По умолчанию: 2048.
-t, --token Строка (Только для гибридной версии) Токен OAuth или SAML Apigee.
-u, --username Строка (Требуется только для базовой аутентификации.) Имя пользователя Apigee (обычно адрес электронной почты). При необходимости вы можете указать имя пользователя в файле .netrc. Также ознакомьтесь с информацией о том, как использовать файл .netrc для хранения учетных данных.
-v, --verbose (Необязательно) Выводит подробные данные.
--virtual-hosts Строка Переопределяет виртуальных хостов по умолчанию, которые являются default,secure. Используйте этот вариант, если для среды организации Edge заданы виртуальные хосты, отличные от этих значений по умолчанию. Подробнее о виртуальных хостах…
--years int (Необязательно.) Количество лет до истечения срока действия сертификата SSL, используемого при подготовке. Значение по умолчанию: 1.

Пример

Обязательно сохраните выходные данные команды provision в файл, который будет использоваться в качестве входных данных для других операций адаптера Apigee для Envoy.

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

apigee-remote-service-cli provision --legacy --mfa $MFA --username $USER --password $PASSWORD --organization $ORG --environment $ENV > config.yaml

Команда Samples

Создает примеры файлов конфигурации для развертываний нативных Envoy или Istio.

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

apigee-remote-service-cli samples create [flags]

Описание

Для выполнения команды требуется действительный файл config.yaml, созданный при инициализации. По умолчанию файлы с примерами сохраняются в каталог ./samples. Эта команда создаст каталог для вас.

Если вы используете нативный Envoy, в команде нужно указать хост целевого сервиса и желаемое название его кластера. Он также устанавливает пользовательское SSL-подключение от прокси-сервера Envoy к удаленному кластеру сервисов, если папка, содержащая tls.key и tls.crt, указана с помощью --tls.

Если вы используете Istio, где прокси-сервер Envoy выступает в качестве дополнительного контейнера, и целевой объект не указан, будет сгенерирован пример httpbin. В противном случае вы несете ответственность за подготовку файлов конфигурации, связанных с развертыванием целевых сервисов.

Параметры

Параметры Тип Описание
-c, --config Строка Обязательный параметр. Путь к файлу конфигурации удаленного сервиса Apigee.
Примечание. Этот флаг позволяет опустить большинство других параметров команды, поскольку CLI может получить их непосредственно из файла конфигурации. Подробнее о том, как использовать вариант --config…
-f, --force Принудительно перезаписать существующий каталог.
-h, --help Показывает справку по параметрам команды.
--host Хост целевого сервиса (по умолчанию – httpbin.org)
-n, --name Название целевого сервиса (по умолчанию "httpbin").
--out Каталог, в котором будут созданы примеры файлов конфигурации. По умолчанию: ./samples
-t, --template

Название шаблона. Если вы развертываете Istio (только гибридный вариант), выберите один из доступных вариантов Istio. Используйте встроенный вариант для развертываний Envoy. Доступны следующие варианты:

  • istio-1.6 (по умолчанию)
  • istio-1.7
  • native
--tls Каталог, в котором будут храниться файлы ключа и сертификата TLS.

Пример

apigee-remote-service-cli samples create -c ./config.yaml

Команды токенов

Вы можете использовать токен JWT для выполнения аутентифицированных вызовов прокси-сервера API вместо ключа API. Команды для работы с токенами позволяют создавать, проверять и обновлять токены JWT для этой цели.

Как создать токен JWT

Вы можете использовать токен JWT для выполнения аутентифицированных вызовов прокси-сервера API к целевому удаленному сервису. Также ознакомьтесь с информацией о том, как использовать аутентификацию на основе JWT.

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

Для Edge Public Cloud:
apigee-remote-service-cli token create -c [config_file] --id [consumer_key] --secret [consumer_secret] -o [org] -e [env]
Для Edge Private Cloud:
apigee-remote-service-cli token create -c [config_file] --id [consumer_key] --secret [consumer_secret] -r [runtime] -o [org] -e [env]

Параметры

Параметры Тип Описание
-c, --config Строка Обязательный параметр. Путь к файлу конфигурации удаленного сервиса Apigee.
Примечание. Этот флаг позволяет опустить большинство других параметров команды, поскольку CLI может получить их непосредственно из файла конфигурации. Подробнее о том, как использовать вариант --config…
-e, --env Строка (Обязательно) Среда в вашей организации.
-h, --help Показывает справку по параметрам команды.
--insecure Разрешить небезопасные подключения к серверу при использовании SSL.
-o, --org Строка Организация Apigee (обязательно). У вас должна быть роль администратора организации.
-r, --runtime Строка (Только для частного облака) Указывает URL среды выполнения для экземпляра частного облака.
-v, --verbose (Необязательно) Выводит подробные данные.

Пример

apigee-remote-service-cli token create -o myorg -e test -i YUmlZAcBKNsTAelJqPZFl3sh58ObATX9 -s icTARgaKHqvUH1dq -c config.yaml

Результат

Если все пройдет успешно, вы увидите токен JST, похожий на следующий:
eyJraWQiOiIxIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJhY2Nlc3NfdG9rZW4iOiJ0a2tlVzVKQTY2a0pZYTB4bFV1cVBsUW1BMU43IiwiYXVkIjoiaXN0aW8iLCJuYmYiOjE1MzAxMzg1OTEsImFwaV9wcm9kdWN0X2xpc3QiOlsiaXN0aW8tcHJvZHVjdCJdLCJhcHBsaWNhdGlvbl9uYW1lIjoiaXN0aW8tYXBwIiwiZGV2ZWxvcGVyX2VtYWlsIjoicFluZ2Zsb3lkQGdvb2dsZS5jb20iLCJpc3MiOiJodHRwczovL2FwaWdlZXNlYXJjaC10ZXN0LmFwaWdlZS5uZXQvaXN0aW8tYXV0aC90b2tlbiIsImV4cCI6MTUzMDEzOTQ5MSwiaWF0IjoxNTMwMTM4NTkxLCJqdGkiOiIxODgzMzViZi0wMmE4LTRjZGUsOGFkOS0yMWJmNDZjNmRjZDkiLCJjbGllbnRfaWQiOiJZVW1sWkFjQktOc1RBZWxKcVBZRmwzc2g1OE9iQVRYOSJ9.AL7pKSTmond-NSPRNNHVbIzTdAnZjOXcjQ-BbOJ_8lsQvF7PuiOUrGIhY5XTcJusisKgbCdtIxBl8Wq1EiQ_fKnUc3JYYOqzpTB5bGoFy0Yqbfu96dneuWyzgZnoQBkqwZkbQTIg7WNTGx1TJX-UTePvBPxAefiAbaEUcigX9tTsXPoRJZOTrm7IOeKpxpB_gQYkxQtV1_NbERxjTPyMbHdMWal9_xRVzSt7mpTGudMN9OR-VtQ1uXA67GOqhZWcOzq57qImOiCMbaoKnKUADevyWjX_VscN5ZZUtzQUQhTrmv8aR69-uVhMIPKp9juMyYKaYn2IsYZEeCWfhfV45Q

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

С помощью этой команды можно проверить токен JWT. Также ознакомьтесь с разделом Как проверить токен.

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

Для Edge Public Cloud:
apigee-remote-service-cli token inspect -o [organization] -e [environment] -f [token_file]
Для Edge Private Cloud:
apigee-remote-service-cli token inspect -o [organization] -e [environment] -f [token_file] --runtime [host_alias]

Параметры

Параметры Тип Описание
-c, --config Строка Обязательный параметр. Путь к файлу конфигурации удаленного сервиса Apigee.
Примечание. Этот флаг позволяет опустить большинство других параметров команды, поскольку CLI может получить их непосредственно из файла конфигурации. Подробнее о том, как использовать вариант --config…
-e, --env Строка (Обязательно) Среда в вашей организации.
-h, --help Показывает справку по параметрам команды.
--insecure Разрешить небезопасные подключения к серверу при использовании SSL.
-o, --org Строка Организация Apigee (обязательно). У вас должна быть роль администратора организации.
-r, --runtime Строка (Только для частного облака) Указывает URL среды выполнения для экземпляра частного облака.
-v, --verbose (Необязательно) Выводит подробные данные.

Пример

apigee-remote-service-cli token inspect -c config.yaml <<< $TOKEN

Результат

Если все пройдет успешно, вы увидите примерно такой результат:
{
	"aud": [
		"remote-service-client"
	],
	"exp": 1591741549,
	"iat": 1591740649,
	"iss": "https://apigee-docs-test.apigee.net/remote-service/token",
	"jti": "99325d2e-6440-4278-9f7f-b252a1a79e53",
	"nbf": 1591740649,
	"access_token": "VfzpXzBGAQ07po0bPMKY4JgQjus",
	"api_product_list": [
		"httpbin"
	],
	"application_name": "httpbin",
	"client_id": "GYDGHy5TRpV8AejXCOlreP7dPVepA8H",
	"developer_email": "user@example.com",
	"scope": ""
}
verifying...
token ok.

Как проводить ротацию токена JWT

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

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

Если вы используете Edge Public Cloud:
apigee-remote-service-cli token rotate-cert -c [config_file] -o [organization] -e [environment] -k [provision_key] -s [provision_secret] --kid [new_key_id]
Если вы используете Edge Private Cloud:
apigee-remote-service-cli token rotate-cert -o [organization] -e [environment] -u [username] -p [password] -k [provision_key] -s [provision_secret] --kid [new_key_id]

Параметры

Параметры Тип Описание
-c, --config Строка Обязательный параметр. Путь к файлу конфигурации удаленного сервиса Apigee.
Примечание. Этот флаг позволяет опустить большинство других параметров команды, поскольку CLI может получить их непосредственно из файла конфигурации. Подробнее о том, как использовать вариант --config…
-e, --env Строка (Обязательно) Среда в вашей организации.
-h, --help Показывает справку по параметрам команды.
--insecure Разрешить небезопасные подключения к серверу при использовании SSL
--truncate int Количество сертификатов, которые нужно хранить в JWKS (по умолчанию 2)
-o, --org Строка Организация Apigee (обязательно). У вас должна быть роль администратора организации.
-r, --runtime Строка (Только для частного облака) Указывает URL среды выполнения для экземпляра частного облака.
-v, --verbose (Необязательно) Выводит подробные данные.

Пример

apigee-remote-service-cli token rotate-cert -c config.yaml -o myorg -e test -k 2e238ffa15dc5ab6a1e97868e7581f6c60ddb8575478582c256d8b7e5b2677a8 -s 51058077223fa7b683c3bea845c5cca138340d1d5583922b6d465f9f918a4b08

Результат

certificate successfully rotated

Использование файла .netrc для учетных данных

apigee-remote-service-cli автоматически выбирает username и password (для базовой аутентификации, если она необходима) из файла .netrc в домашнем каталоге, если вы используете Edge Public Cloud и у вас есть запись для машины api.enterprise.apigee.com. Если вы используете частное облако Apigee, значение параметра machine совпадает с URL management (например, http://192.162.55.100). Пример для общедоступного облака Edge:
machine api.enterprise.apigee.com
login jdoe@google.com
password abc123
Например, в Edge Private Cloud:
machine http://192.162.55.100
login jdoe@google.com
password abc123

Команда версии

Распечатать версию CLI.

apigee-remote-service-cli version

Использование команды --config

Параметр --config указывает расположение файла конфигурации, созданного с помощью команды provision. Преимущество этого варианта в том, что он позволяет пропустить большинство других параметров команды, которые CLI извлекает из файла конфигурации. Вот несколько примеров:
  • организация
  • окружающая среда
  • время выполнения
  • управления
  • небезопасное
  • пространство имен
  • Устаревшая версия
  • opdk

Например, команду provision можно выполнить следующим образом:

apigee-remote-service-cli provision --config='old-config.yaml' > new-config.yaml

Файл конфигурации

В этом разделе приведен пример файла конфигурации со всеми доступными параметрами.

global:
  temp_dir: /tmp/apigee-istio
  keep_alive_max_connection_age: 10m
  api_address: :5000
  metrics_address: :5001
  tls:
    cert_file: tls.crt
    key_file: tls.key
tenant:
  internal_api: https://istioservices.apigee.net/edgemicro
  remote_service_api: https://org-test.apigee.net/remote-service
  org_name: org
  env_name: env
  key: mykey
  secret: mysecret
  client_timeout: 30s
  allow_unverified_ssl_cert: false
products:
  refresh_rate: 2m
analytics:
  legacy_endpoint: false
  file_limit: 1024
  send_channel_size: 10
  collection_interval: 10s
  fluentd_endpoint: apigee-udca-myorg-test.apigee.svc.cluster.local:20001
  tls:
    ca_file: /opt/apigee/tls/ca.crt
    cert_file: /opt/apigee/tls/tls.crt
    key_file: /opt/apigee/tls/tls.key
    allow_unverified_ssl_cert: false
auth:
  api_key_claim: claim
  api_key_cache_duration: 30m
  api_key_header: x-api-key
  api_target_header: :authority
  reject_unauthorized: true
  jwks_poll_interval: 0s