Edge для частного облака v. 4.17.01
Используйте утилиту apigee-adminapi.sh для выполнения тех же задач по настройке Edge, которые вы выполняете, вызывая API управления Edge. Преимущество утилиты apigee-adminapi.sh заключается в том, что она:
- Используйте простой интерфейс командной строки
- Реализует завершение команд на основе табуляции.
- Предоставляет справку и информацию об использовании.
- Может отображать соответствующий вызов API, если вы решите попробовать API.
Утилита apigee-adminapi.sh не заменяет утилиту apigee-provision . Утилита apigee-provision фактически использует утилиту apigee-adminapi.sh для выполнения своих задач.
Основные различия между ними заключаются в следующем:
- Утилита apigee-adminapi.sh выполняет атомарные функции, которые заменяют отдельные вызовы Edge API. Например, для создания организации, среды и виртуального хоста требуются три отдельные команды apigee-adminapi.sh , соответствующие трем вызовам API.
- Утилита apigee-provision предназначена для выполнения полной операции высокого уровня с помощью одной команды. Например, вы можете создать организацию, среду и виртуальный хост с помощью одной команды apigee-provision , передав файл конфигурации со всей необходимой информацией.
В документации Edge используются обе утилиты, где это необходимо.
Установка apigee-adminapi.sh
Утилита apigee-adminapi.sh автоматически устанавливается при установке утилиты apigee-provision или apigee-validate .
Утилита устанавливается в следующую папку:
/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh
Синтаксис apigee-adminapi.sh
Утилита apigee-adminapi.sh использует простой синтаксис командной строки. В любой момент используйте клавишу табуляции, чтобы отобразить подсказку со списком доступных параметров команды.
Чтобы просмотреть все возможные команды, вызовите утилиту без параметров:
> apigee-adminapi.sh
Если вы нажмете клавишу Tab после ввода apigee-adminapi.sh, вы увидите список возможных опций:
analytics classification logsessions regions securityprofile userroles buildinfo GET orgs runtime servers users
Клавиша табуляции отображает параметры в зависимости от контекста команды. Если вы введете клавишу табуляции после ввода:
> apigee-adminapi.sh orgs
Вы увидите возможные варианты выполнения команды orgs :
add apis apps delete envs list pods userroles
Используйте опцию -h для отображения справки по любой команде. Например, если вы используете опцию -h , как показано ниже:
> apigee-adminapi.sh orgs -h
Утилита отображает полную справочную информацию для всех возможных параметров команды orgs . Первый элемент вывода показывает справку по команде «orgs add» :
+++++++++++++++++++++++++++++++++++++++++++
orgs add
Required:
-o ORG Organization name
Optional:
-H HEADER add http header in request
--admin ADMIN_EMAIL admin email address
--pwd ADMIN_PASSWORD admin password
--host EDGE_SERVER edge server to make request to
--port EDGE_PORT port to use for the http request
--ssl set EDGE_PROTO to https, defaults to http
--debug ( set in debug mode, turns on verbose in curl )
-h Displays Help
Установка параметров с помощью ключей командной строки и переменных среды
Вы должны ввести все параметры команды, используя либо переключатели командной строки, либо переменные среды. При необходимости перед переключателями командной строки ставится одинарное (-) или двойное тире (--).
Например, в приведенной выше справке для команды «orgs add» вы можете указать имя организации одним из следующих способов:
- Используя ключ командной строки -o :
> apigee-adminapi.sh orgs -o testOrg - Установка переменной среды с именем ORG :
> экспортировать ORG=testOrg
> apigee-adminapi.sh организации
Если вы опустите в команде какие-либо обязательные параметры, утилита выведет сообщение об ошибке с описанием отсутствующих параметров. Например, если при создании организации вы опустите переменную среды --host или EDGE_SERVER , определяющую Edge Management Server, вы увидите следующее сообщение об ошибке:
Error with required variable or parameter ADMIN_PASSWORD....OK ADMIN_EMAIL....OK EDGE_SERVER....null
Два общих параметра, которые вы часто задаете в качестве переменных среды, — это адрес электронной почты системного администратора и IP-адрес сервера управления:
> export ADMIN_EMAIL=foo@bar.com > export EDGE_SERVER=192.168.56.101
Передача файла утилите apigee-adminapi.sh
Некоторые команды утилиты apigee-adminapi.sh соответствуют вызовам API PUT и POST, которые принимают тело запроса. Например, создание виртуального хоста соответствует вызову POST API, для которого требуется информация о виртуальном хосте в теле запроса.
При использовании утилиты apigee-adminapi.sh для создания виртуального хоста или любой команды, принимающей тело запроса, вы можете передать всю необходимую информацию в командной строке, как показано ниже:
> apigee-adminapi.sh orgs envs virtual_hosts add -e prod -o testOrg --host localhost --admin foo@bar.com -v myVHostUtil -p 9005 -a 192.168.56.101:9005
Или вы можете передать файл, содержащий ту же информацию, которая содержится в теле запроса POST. Например, следующая команда принимает файл, определяющий виртуальный хост:
> apigee-adminapi.sh orgs envs virtual_hosts add -e prod -o testOrg --host localhost --admin foo@bar.com -f vhostcreate
где файл vhostcreate содержит тело вызова POST. В этом примере это тело запроса в формате XML:
<VirtualHost name="myVHostUtil">
<HostAliases>
<HostAlias>192.168.56.101:9005</HostAlias>
</HostAliases>
<Interfaces/>
<Port>9005</Port>
</VirtualHost>
Отображение информации об отладке и API
Используйте параметр --debug утилиты apigee-adminapi.sh для отображения подробной информации о команде. Эта информация включает команду cURL, созданную утилитой apigee-adminapi.sh для выполнения операции.
Например, эта команда использует опцию --debug :
> apigee-adminapi.sh orgs add -o testOrg2 --admin foo@bar.com --host localhost --debug
И отображает следующий вывод, включая сгенерированную команду cURL:
curl -H Content-Type: application/xml -v -X POST -s -k -w \n==> %{http_code}
-u ***oo@bar.com:***** http://localhost:8080/v1/o -d <Organization name="testOrg2"
type="paid"/>
* About to connect() to localhost port 8080 (#0)
* Trying ::1... connected
* Connected to localhost (::1) port 8080 (#0)
* Server auth using Basic with user 'foo@bar.com'
> POST /v1/o HTTP/1.1
> Authorization: Basic c2dp234234NvbkBhcGlnZ2342342342342341Q5
> User-Agent: curl/7.19.7 (x86_64-redhat-linux-gnu) libcurl/7.19.7 NSS/3.19.1
Basic ECC zlib/1.2.3 libidn/1.18 libssh2/1.4.2
> Host: localhost:8080
> Accept: */*
> Content-Type: application/xml
> Content-Length: 43
>
} [data not shown]
< HTTP/1.1 201 Created
< Content-Type: application/json
< Date: Tue, 03 May 2016 02:08:32 GMT
< Content-Length: 291
<
{ [data not shown]
* Connection #0 to host localhost left intact
* Closing connection #0