Как создать организацию, среду и виртуальный хост

Edge for Private Cloud v4.18.01

Одновременное создание организации, среды и виртуального хоста

Видео. Посмотрите короткое видео о настройке организации Apigee.

Прежде чем создавать прокси-сервер API в Apigee Edge, необходимо создать хотя бы одну организацию, а в ней – одну или несколько сред и виртуальных хостов.

Обычно организации и среды создаются вместе. Чтобы упростить процесс, используйте утилиту apigee-provision. Вызовите его из командной строки на сервере управления Edge:

/opt/apigee/apigee-service/bin/apigee-service apigee-provision setup-org -f configFile

Файл конфигурации содержит:

# Set Edge sys admin credentials.
ADMIN_EMAIL=your@email.com
APIGEE_ADMINPW=adminPword     # If omitted, you are prompted for it.
NEW_USER="y"
USER_NAME=orgAdmin@myCo.com
FIRST_NAME=foo
LAST_NAME=bar
USER_PWD="userPwrod"
ORG_NAME=example  # lowercase only, no spaces, underscores, or periods.
ENV_NAME=prod
VHOST_PORT=9001
VHOST_NAME=default
VHOST_ALIAS="$IP1:9001"
# Optionally configure TLS/SSL for virtual host.
# VHOST_SSL=y     # Set to "y" to enable TLS/SSL on the virtual host.
# KEYSTORE_JAR=   # JAR file containing the cert and private key.
# KEYSTORE_NAME=  # Name of the keystore. 
# KEYSTORE_ALIAS= # The key alias.
# KEY_PASSWORD=   # The key password, if it has one. 
# Optionally set the base URL displayed by the Edge UI for an
# API proxy deployed to the virtual host.
# VHOST_BASEURL="http://myCo.com"
# AXGROUP=axgroup-001 # Default value is axgroup-001

Затем команда:

  • Создайте организацию.
    Примечание. После создания организации ее нельзя переименовать.
  • Свяжите организацию с подом. По умолчанию она связывается с подом gateway.
  • Добавьте указанного пользователя в качестве администратора организации. Если пользователя нет, вы можете его создать.
  • Создайте одну или несколько сред
  • Создайте один или несколько виртуальных хостов для каждой среды.
  • Свяжите среду со всеми процессорами сообщений.
  • Включить аналитику

Полный файл конфигурации для автоматической установки приведен в разделе Регистрация организации.

По умолчанию при использовании утилиты apigee-provision максимальная длина названия организации и названия среды составляет 20 символов. Это ограничение не применяется, если вы используете Edge API напрямую для создания организации или среды.

Как создать организацию

Чтобы создать организацию, используйте команду create-org:

/opt/apigee/apigee-service/bin/apigee-service apigee-provision create-org -f configFile

Этот скрипт создает организацию, но не добавляет и не настраивает среды и виртуальные хосты, необходимые организации для обработки вызовов API.

Файл конфигурации содержит название организации и адрес электронной почты администратора организации. В атрибуте name можно использовать только следующие символы: a-z0-9\-$%. Не используйте пробелы, точки и заглавные буквы.

APIGEE_ADMINPW=adminPword    # If omitted, you are prompted for it.
ORG_NAME=example  # lowercase only, no spaces, underscores, or periods.
ORG_ADMIN=orgAdmin@myCo.com

Затем команда:

  • Создает организацию.
  • Связывает организацию с подом. По умолчанию это под gateway.
  • Добавляет указанного пользователя в качестве администратора организации. Пользователь должен существовать, иначе скрипт выдаст ошибку. 
<Error>
  <Code>organizations.OrganizationAlreadyExists</Code>
  <Message>Organization : test already exists</Message>
  <Contexts/>
</Error>

Как создать организацию с помощью вызовов API

Вы также можете использовать следующие вызовы API, чтобы создать организацию. Первый вызов создает организацию:

curl -H "Content-Type:application/xml" -u sysAdminEmail:adminPasswd \
  -X POST http://ms-ip:8080/v1/organizations \
  -d '<Organization name="org-name" type="paid"/>'

Следующий вызов связывает организацию с подом:

curl -H "Content-Type:application/x-www-form-urlencoded" \
  -u sysAdminEmail:adminPasswd -X POST \
  http://ms-ip:8080/v1/organizations/org-name/pods \
  -d "region=default&pod=gateway"

Вы можете выполнить этот вызов несколько раз, чтобы связать организацию с несколькими модулями.

Последний вызов добавляет существующего пользователя в качестве администратора организации:

curl -H "Content-Type:application/xml" -u sysAdminEmail:adminPasswd \
  -X POST http://ms-ip:8080/v1/organizations/org-name/users/user-email/userroles/ \
  -d '<Roles><Role name="orgadmin"/></Roles>'

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

Создание среды

Чтобы создать среду в существующей организации, используйте команду add-env:

/opt/apigee/apigee-service/bin/apigee-service apigee-provision add-env -f configFile

Этот файл конфигурации содержит информацию, необходимую для создания среды и виртуального хоста:

APIGEE_ADMINPW=adminPword    # If omitted, you are prompted for it.
ORG_NAME=example  # lowercase only, no spaces, underscores, or periods.
ENV_NAME=prod
VHOST_PORT=9001
VHOST_NAME=default
VHOST_ALIAS="$IP1:9001"
# Optionally configure TLS/SSL for virtual host.
# VHOST_SSL=y     # Set to "y" to enable TLS/SSL on the virtual host.
# KEYSTORE_JAR=   # JAR file containing the cert and private key.
# KEYSTORE_NAME=  # Name of the keystore. 
# KEYSTORE_ALIAS= # The key alias.
# KEY_PASSWORD=   # The key password, if it has one. 
# Optionally set the base URL displayed by the Edge UI for an
# API proxy deployed to the virtual host.
# VHOST_BASEURL="http://myCo.com"
# AXGROUP=axgroup-001 # Default value is axgroup-001

Команда:

  • Создает среду
  • Создает один виртуальный хост для среды.
  • Связывает среду со всеми процессорами сообщений в пакете, связанном с организацией, содержащей среду.
  • Включает аналитику.
    Примечание. Если вы включите аналитику для одной среды в организации, вам нужно будет включить ее для всех сред в организации.

Как создать среду с помощью вызовов API

Вы также можете использовать следующие вызовы API для создания среды. Первый вызов создает среду:

curl -H "Content-Type:application/xml" -u sysAdminEmail:adminPasswd \
  -X POST http://ms-ip:8080/v1/organizations/org-name/environments \
  -d '<Environment name="env-name"/>'

Следующий вызов связывает среду с Message Processor. Выполните этот вызов для каждого процессора сообщений, который вы хотите связать со средой:

curl -H "Content-Type:application/x-www-form-urlencoded" \
  -u sysAdminEmail:adminPasswd -X POST \
  http://ms-ip:8080/v1/organizations/org-name/environments/env-name/servers \
  -d "action=add&uuid=uuid"

где uuid – это UUID процессора сообщений. Чтобы получить UUID, используйте следующую команду:

curl http://mp-ip:8082/v1/servers/self

где mp-ip – IP-адрес Message Processor.

Следующий вызов API активирует Аналитику для заданной среды. Он проверяет наличие серверов Qpid и Postgres в POD всех центров обработки данных. Затем он запускает регистрацию в Аналитике для указанной организации и среды.

/opt/apigee/apigee-service/bin/apigee-service apigee-provision enable-ax -f configFile

Этот файл конфигурации содержит:

ORG_NAME=orgName  # lowercase only, no spaces, underscores, or periods.
ENV_NAME=envName
 
curl -H "Content-Type:application/json" -u sysAdminEmail:adminPasswd
  -X POST http://ms-ip:8080/v1/organizations/org-name/environments/env-name/analytics/admin -d "@sample.json"

где sample.json содержит следующее:

{
  "properties" : {
    "samplingAlgo" : "reservoir_sampler",
    "samplingTables" : "10=ten;1=one;",
    "aggregationinterval" : "300000",
    "samplingInterval" : "300000",
    "useSampling" : "100",
    "samplingThreshold" : "100000"
  },
  "servers" : {
    "postgres-server" : [ "1acff3a5-8a6a-4097-8d26-d0886853239c", "f93367f7-edc8-4d55-92c1-2fba61ccc4ab" ],  
    "qpid-server" : [ "d3c5acf0-f88a-478e-948d-6f3094f12e3b", "74f67bf2-86b2-44b7-a3d9-41ff117475dd"] 
  }
}

Свойство postgres-servers содержит список UUID Postgres, разделенных запятыми, а свойство qpid-server – UUID Qpid. Если вам нужно получить эти UUID, используйте следующие команды.

Для Qpid выполните следующую команду:

curl -u sysAdminEmail:passwd http://ms-ip/v1/servers?pod=central

Результатом выполнения этой команды является объект JSON. Для каждого сервера Qpid вы увидите выходные данные в следующем формате:

"type" : [ "qpid-server" ],
"uUID" : "d3c5acf0-f88a-478e-948d-6f3094f12e3b"

Для Postgres выполните следующую команду:

curl -u sysAdminEmail:passwd http://ms-ip/v1/servers?pod=analytics

Для каждого сервера Postgres вы увидите выходные данные в следующем формате:

"type" : [ "postgres-server" ],
"uUID" : "d3c5acf0-f88a-478e-948d-6f3094f12e3b"

Как создать виртуальный хост

Вы можете создать виртуальный хост в существующей среде организации. Часто среда поддерживает несколько виртуальных хостов. Например, один виртуальный хост может поддерживать протокол HTTP, а другой в той же среде – зашифрованный протокол HTTPS.

Чтобы создать дополнительные виртуальные хосты или виртуальный хост для среды, в которой его нет, используйте следующий вызов API:

curl -H "Content-Type:application/xml" -u sysAdminEmail:adminPasswd \
  -X POST http://ms-ip:8080/v1/organizations/org-name/environments/env-name/virtualhosts \
  -d '<VirtualHost name="default"> \
    <HostAliases> \
      <HostAlias>myorg-test.apigee.net</HostAlias> \ 
    </HostAliases> \
    <Interfaces/> \
    <Port>443</Port> \
  </VirtualHost>'

Полное описание процесса создания виртуального хоста, в том числе защищенного виртуального хоста, использующего TLS/SSL по протоколу HTTPS, приведено в статье Настройка доступа TLS к API для Private Cloud.