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

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

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

Команда list bindings

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

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

apigee-remote-service-cli bindings list [flags]

Параметры

Параметры Тип поля Используется с товарами Описание
-c,
‑‑config
Обязательно Все (Строка) Путь к файлу конфигурации удаленного сервиса Apigee.
Примечание. Этот флаг позволяет опустить большинство других параметров команды, поскольку CLI может получить их непосредственно из файла конфигурации. Подробнее о том, как использовать вариант ‑‑config…
-e,
‑‑environment
Обязательно Все (Строка) Среда в вашей организации.
-h,
‑‑help
Необязательно Все Показывает справку по параметрам команды.
‑‑insecure Необязательно Все Разрешить небезопасные подключения к серверу при использовании SSL.
‑‑legacy Обязательно Только Edge Public Cloud Этот флаг необходимо задать, если вы используете Apigee Edge для общедоступного облака. Задает URL управления и среды выполнения для Apigee Edge Public Cloud.
-m,
‑‑management
Обязательно Только Edge Private Cloud (Строка) Базовый URL управления для установки Apigee Edge Private Cloud. По умолчанию: https://api.enterprise.apigee.com
‑‑mfa Обязательно Только Edge Public Cloud (Строка) Токен многофакторной авторизации для Apigee Edge для общедоступного облака. Требуется, только если в аккаунте Apigee Edge настроена многофакторная аутентификация.
‑‑opdk Обязательно Только Edge Private Cloud Этот флаг необходимо задать, если вы используете Apigee Edge для частного облака.
-o,
‑‑organization
Обязательно Все (Строка) Организация Apigee. У вас должна быть роль администратора организации.
-p,
‑‑password
Обязательный атрибут
(только для базовой аутентификации)
Только для Edge Public и Private Cloud (Строка) Пароль Apigee. При необходимости можно указать пароль в файле .netrc. Также ознакомьтесь со статьей Как использовать файл .netrc для хранения учетных данных.
-r,
‑‑runtime
Обязательно Только для Edge Private Cloud и Apigee Hybrid (Строка) Указывает URL среды выполнения для частного облака или гибридного экземпляра Apigee. URL должен начинаться с https://. Пример: https://apitest.apigee-hybrid-docs.net
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca
Необязательно Только Edge Private Cloud (Строка) Указывает клиентский сертификат TLS, закрытый ключ и корневой центр сертификации для подключения mTLS.
-t,
‑‑token
Обязательно
(только для авторизации с помощью токена OAuth)
Все (Строка) Токен OAuth или SAML, сгенерированный на основе информации вашего аккаунта Apigee. Переопределяет любые другие предоставленные учетные данные.
-u,
‑‑username
Обязательный атрибут
(только для базовой аутентификации)
Только для Edge Public и Private Cloud (Строка) Имя пользователя 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:

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

Для всех команд 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 устанавливает два прокси API в организации Apigee Edge, настраивает сертификат и создает учетные данные, которые понадобятся для настройки адаптера Apigee для Envoy.

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

apigee-remote-service-cli provision [flags]

Параметры

Параметры Тип поля Используется с товарами Описание
‑‑analytics-sa Необязательно Только Apigee Hybrid и Apigee X

(Строка) Используйте этот флаг, чтобы указать путь к файлу ключа сервисного аккаунта Google Cloud, которому назначена роль Apigee Analytics Agent. С помощью этого сервисного аккаунта адаптер напрямую загружает данные аналитики в Apigee. Если вы используете Apigee Hybrid, этот вариант позволяет установить среду выполнения Hybrid в одном кластере, а адаптер – в другом.

-c,
‑‑config
Обязательно Все (Строка) Путь к файлу конфигурации удаленного сервиса Apigee.
Примечание. Этот флаг позволяет опустить большинство других параметров команды, поскольку CLI может получить их непосредственно из файла конфигурации. Подробнее о том, как использовать вариант ‑‑config…
-e,
‑‑environment
Обязательно Все (Строка) Среда в вашей организации.
-f, ‑‑force-proxy-install Необязательно Все (Необязательно.) Принудительно переустанавливает прокси-сервер remote-service, если он уже установлен в организации.
-h,
‑‑help
Необязательно Все Показывает справку по параметрам команды.
‑‑insecure Необязательно Все Разрешить небезопасные подключения к серверу при использовании SSL.
‑‑legacy Обязательно Только Edge Public Cloud Этот флаг необходимо задать, если вы используете Apigee Edge для общедоступного облака. Задает URL управления и среды выполнения для Apigee Edge Public Cloud.
-m,
‑‑management
Обязательно Только Edge Private Cloud (Строка) Базовый URL управления для установки Apigee Edge Private Cloud. По умолчанию: https://api.enterprise.apigee.com
‑‑mfa Обязательно Только Edge Public Cloud Токен многофакторной авторизации для Apigee Edge для общедоступного облака. Требуется, только если в аккаунте Apigee Edge настроена многофакторная аутентификация.
-n, ‑‑namespace Необязательно Все (Строка) Создает конфигурацию в виде Envoy ConfigMap в указанном пространстве имен. По умолчанию: apigee
‑‑opdk Обязательно Только Edge Private Cloud Этот флаг необходимо задать, если вы используете Apigee Edge для частного облака.
-o,
‑‑organization
Обязательно Все (Строка) Организация Apigee. Для этого вам нужны права администратора организации.
-p,
‑‑password
Обязательный атрибут
(только для базовой аутентификации)
Только для Edge Public и Private Cloud (Строка) Пароль Apigee. При необходимости можно указать пароль в файле
.netrc. В этом случае вам не нужно будет указывать пароль в командной строке. Также ознакомьтесь со статьей Как использовать файл .netrc для хранения учетных данных.
‑‑rotate-int Необязательно Только Apigee Hybrid (Целое число) Если n > 0, создайте новый закрытый ключ и сохраните n открытых ключей (только для гибридного режима).
-r,
‑‑runtime
Обязательно Только для Edge Private Cloud и Apigee Hybrid (Строка) Указывает URL среды выполнения для частного облака или гибридного экземпляра Apigee. URL должен начинаться с https://. Пример: https://apitest.apigee-hybrid-docs.net
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca
Необязательно Только Edge Private Cloud (Строка) Указывает клиентский сертификат TLS, закрытый ключ и корневой центр сертификации для подключения mTLS.
-t,
‑‑token
Обязательно
(только для авторизации с помощью токена OAuth)
Все (Строка) Токен OAuth или SAML, сгенерированный на основе информации вашего аккаунта Apigee. Переопределяет любые другие предоставленные учетные данные.
-u,
‑‑username
Обязательный атрибут
(только для базовой аутентификации)
Только для Edge Public и Private Cloud (Строка) Имя пользователя Apigee (обычно адрес электронной почты). При необходимости вы можете указать имя пользователя в файле .netrc. Также ознакомьтесь с информацией о том, как использовать файл .netrc для учетных данных.
-v,
‑‑verbose
Необязательно Все (Необязательно) Выводит подробные данные.
‑‑virtual-hosts Необязательно Только Edge Private Cloud Тип: строка. Переопределяет виртуальных хостов по умолчанию, которые являются default,secure. Используйте этот вариант, если для среды организации Edge заданы виртуальные хосты, отличные от этих значений по умолчанию.

Пример

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

Пример:

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. В противном случае вы несете ответственность за подготовку файлов конфигурации, связанных с развертыванием целевых сервисов.

Параметры

Параметры Тип поля Используется с товарами Описание
‑‑adapter‑host Требуется только для шаблонов Envoy Все (Строка) Имя хоста адаптера (по умолчанию: localhost).
-c, ‑‑config Обязательно Все (Строка) Путь к файлу конфигурации удаленного сервиса Apigee.
Примечание. Этот флаг позволяет опустить большинство других параметров команды, поскольку CLI может получить их непосредственно из файла конфигурации. Подробнее о том, как использовать вариант ‑‑config…
-f, ‑‑force Необязательно Все Принудительно перезаписать существующий каталог.
-h, ‑‑help Необязательно Все Показывает справку по параметрам команды.
‑‑host Требуется только для шаблонов Envoy Все (Строка) Целевой хост сервиса (по умолчанию httpbin.org).
-n, ‑‑name Обязательно Все (Строка) Название целевого сервиса (по умолчанию httpbin.org).
‑‑out Необязательно Все (Строка) Каталог, в котором будут созданы примеры файлов конфигурации.
По умолчанию: ./samples
‑‑tag Требуется только для шаблонов Istio Все (Строка) Тег версии образа адаптера Envoy. По умолчанию: v2.0.0
-t, ‑‑template Обязательно Все (Строка) Название шаблона Envoy или Istio. Чтобы посмотреть список доступных шаблонов, выполните команду apigee-remote-service samples templates.
‑‑tls Необязательный параметр, только для шаблонов Envoy Все (Строка) Каталог, содержащий файлы tls.key и tls.crt, используемые для сервиса адаптера.

Пример

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

Как посмотреть доступные варианты шаблонов

Содержит список шаблонов, которые можно использовать с параметром --templates для команды samples.

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

apigee-remote-service-cli samples templates

Параметры

Нет.

Пример

apigee-remote-service-cli samples templates
Supported templates (native is deprecated):
  envoy-1.15
  envoy-1.16
  envoy-1.17
  istio-1.7
  istio-1.8
  istio-1.9

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

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

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

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

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

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

Параметры

Параметры Тип поля Используется с товарами Описание
-c,
‑‑config
Обязательно Все (Строка) Путь к файлу конфигурации удаленного сервиса Apigee.
Примечание. Этот флаг позволяет опустить большинство других параметров команды, поскольку CLI может получить их непосредственно из файла конфигурации. Подробнее о том, как использовать вариант ‑‑config…
-e,
‑‑environment
Обязательно Все (Строка) Среда в вашей организации.
-h,
‑‑help
Необязательно Все Показывает справку по параметрам команды.
--i, --id Обязательно Все (Строка) Учетные данные Ключ, найденные в приложении разработчика Apigee, как описано в разделе Как получить ключ API.
‑‑insecure Необязательно Все Разрешить небезопасные подключения к серверу при использовании SSL.
‑‑legacy Обязательно Только Edge Public Cloud Этот флаг необходимо задать, если вы используете Apigee Edge для общедоступного облака. Задает URL управления и среды выполнения для Apigee Edge Public Cloud.
‑‑opdk Обязательно Только Edge Private Cloud Этот флаг необходимо задать, если вы используете Apigee Edge для частного облака.
-o,
‑‑organization
Обязательно Все (Строка) Организация Apigee. У вас должна быть роль администратора организации.
-r,
‑‑runtime
Обязательно Только для Edge Private Cloud и Apigee Hybrid (Строка) Указывает URL среды выполнения для частного облака или гибридного экземпляра Apigee. URL должен начинаться с https://. Пример: https://apitest.apigee-hybrid-docs.net
--s, ‑‑secret Обязательно Все (Строка) Секретный ключ, найденный в приложении разработчика Apigee, как описано в разделе Как получить ключ API.
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca
Необязательно Только Edge Private Cloud (Строка) Указывает клиентский сертификат TLS, закрытый ключ и корневой центр сертификации для подключения mTLS.
-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. Также ознакомьтесь с разделом Как проверить токен.

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

apigee-remote-service-cli token inspect [flags]

Параметры

Параметры

Параметры Тип поля Используется с товарами Описание
-c,
‑‑config
Обязательно Все (Строка) Путь к файлу конфигурации удаленного сервиса Apigee.
Примечание. Этот флаг позволяет опустить большинство других параметров команды, поскольку CLI может получить их непосредственно из файла конфигурации. Подробнее о том, как использовать вариант ‑‑config…
-e,
‑‑environment
Обязательно Все (Строка) Среда в вашей организации.
-f,
‑‑file
Обязательно Все Строка. Файл токена (по умолчанию используется stdin).
-h,
‑‑help
Необязательно Все Показывает справку по параметрам команды.
‑‑insecure Необязательно Все Разрешить небезопасные подключения к серверу при использовании SSL.
‑‑legacy Обязательно Только Edge Public Cloud Этот флаг необходимо задать, если вы используете Apigee Edge для общедоступного облака. Задает URL управления и среды выполнения для Apigee Edge Public Cloud.
‑‑opdk Обязательно Только Edge Private Cloud Этот флаг необходимо задать, если вы используете Apigee Edge для частного облака.
-o,
‑‑organization
Обязательно Все (Строка) Организация Apigee. У вас должна быть роль администратора организации.
-r,
‑‑runtime
Обязательно Только для Edge Private Cloud и Apigee Hybrid (Строка) Указывает URL среды выполнения для частного облака или гибридного экземпляра Apigee. URL должен начинаться с https://. Пример: https://apitest.apigee-hybrid-docs.net
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca
Необязательно Только Edge Private Cloud (Строка) Указывает клиентский сертификат TLS, закрытый ключ и корневой центр сертификации для подключения mTLS.
-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 вам может понадобиться изменить пару открытого и закрытого ключей, хранящуюся в зашифрованной карте "ключ-значение" Apigee. Процесс создания новой пары ключей называется ротацией ключей. При ротации ключей создается новая пара закрытого и открытого ключей, которая сохраняется в KVM istio в организации или среде Apigee. Кроме того, старый открытый ключ сохраняется вместе с исходным значением идентификатора ключа.

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

apigee-remote-service-cli token rotate-cert [flags]

Параметры

Параметры Тип поля Используется с товарами Описание
-c,
‑‑config
Обязательно Все (Строка) Путь к файлу конфигурации удаленного сервиса Apigee.
Примечание. Этот флаг позволяет опустить большинство других параметров команды, поскольку CLI может получить их непосредственно из файла конфигурации. Подробнее о том, как использовать вариант ‑‑config…
-e,
‑‑environment
Обязательно Все (Строка) Среда в вашей организации.
-h,
‑‑help
Необязательно Только для Edge Public и Private Cloud Показывает справку по параметрам команды.
--k, --key Обязательно Только для Edge Public и Private Cloud Строка, содержащая ключ инициализации.
‑‑insecure Необязательно Только для Edge Public и Private Cloud Разрешить небезопасные подключения к серверу при использовании SSL.
‑‑legacy Обязательно Только Edge Public Cloud Этот флаг необходимо задать, если вы используете Apigee Edge для общедоступного облака. Задает URL управления и среды выполнения для Apigee Edge Public Cloud.
‑‑opdk Обязательно Только Edge Private Cloud Этот флаг необходимо задать, если вы используете Apigee Edge для частного облака.
-o,
‑‑organization
Обязательно Только для Edge Public и Private Cloud (Строка) Организация Apigee. У вас должна быть роль администратора организации.
-r,
‑‑runtime
Обязательно Только Edge Private Cloud (Строка) Указывает URL среды выполнения для частного облака или гибридного экземпляра Apigee. URL должен начинаться с https://. Пример: https://apitest.apigee-hybrid-docs.net
--s, ‑‑secret Обязательно Все (Строка) Секрет инициализации.
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca
Необязательно Только Edge Private Cloud (Строка) Указывает клиентский сертификат TLS, закрытый ключ и корневой центр сертификации для подключения mTLS.
--t, ‑‑truncate Обязательно Все Тип: целое число. Количество сертификатов, которые нужно хранить в JWKS (по умолчанию 2).
-v,
‑‑verbose
Необязательно Все (Необязательно) Выводит подробные данные.

Пример

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

Результат

certificate successfully rotated

Как создать внутренний токен

Создайте токен JWT для авторизации вызовов API удаленного сервиса.

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

apigee-remote-service-cli token internal [flags]

Параметры

Параметры

Параметры Тип поля Используется с товарами Описание
-c,
‑‑config
Обязательно Только Apigee Hybrid (Строка) Путь к файлу конфигурации удаленного сервиса Apigee.
Примечание. Этот флаг позволяет опустить большинство других параметров команды, поскольку CLI может получить их непосредственно из файла конфигурации. Подробнее о том, как использовать вариант ‑‑config…
-d,
‑‑duration
Обязательно Только Apigee Hybrid (Строка) Срок действия внутреннего JWT с момента создания (по умолчанию: 10m0s (10 минут)).
-e,
‑‑environment
Обязательно Только Apigee Hybrid (Строка) Среда в вашей организации.
-h,
‑‑help
Необязательно Только Apigee Hybrid Показывает справку по параметрам команды.
‑‑insecure Необязательно Только Apigee Hybrid Разрешить небезопасные подключения к серверу при использовании SSL.
-o,
‑‑organization
Обязательно Только Apigee Hybrid (Строка) Организация Apigee. У вас должна быть роль администратора организации.
-r,
‑‑runtime
Обязательно Только Apigee Hybrid Тип: строка. Указывает URL среды выполнения для экземпляра Apigee Hybrid. URL должен начинаться с https://. Пример: https://apitest.apigee-hybrid-docs.net
-v,
‑‑verbose
Необязательно Только Apigee Hybrid (Необязательно) Выводит подробные данные.

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

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

apigee-remote-service-cli version

Использование файла .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

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

Параметр ‑‑config указывает расположение файла конфигурации, созданного с помощью команды provision. Преимущество этого варианта в том, что вам не нужно указывать большинство других параметров команды, поскольку интерфейс командной строки получает их из файла конфигурации. Вот несколько примеров:
  • организация
  • окружающая среда
  • время выполнения
  • управления
  • небезопасное
  • пространство имен
  • Устаревшая версия
  • 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
  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
products:
  refresh_rate: 2m
analytics:
  legacy_endpoint: false
  file_limit: 1024
  send_channel_size: 10
  collection_interval: 10s
auth:
  api_key_claim: claim
  api_key_cache_duration: 30m
  api_key_header: x-api-key
  api_header: :authority
  allow_unauthorized: false
  jwt_provider_key: https://org-test.apigee.net/remote-token/token
  append_metadata_headers: true