Эта страница переведена с помощью Cloud Translation API.

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

Edge для частного облака v4.19.01

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

Видео: посмотрите короткое видео с обзором настройки и конфигурации организации Apigee.

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

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

ПРИМЕЧАНИЕ. При создании виртуального хоста вы указываете порт маршрутизатора, используемый виртуальным хостом.

Например, порт 9001. По умолчанию маршрутизатор работает от имени пользователя «apigee», который не имеет доступа к привилегированным портам, которыми обычно являются порты 1024 и ниже. Чтобы создать виртуальный хост, который привязывает маршрутизатор к защищенному порту, необходимо настроить маршрутизатор для работы от имени пользователя с доступом к этим портам.

Дополнительную информацию см. в разделе Настройка виртуального хоста .

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

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

Где configFile — это путь к файлу конфигурации, который выглядит примерно так:

# Set Edge sys admin credentials.
ADMIN_EMAIL=your@email.com
APIGEE_ADMINPW=admin_password  # If omitted, you are prompted for it.
NEW_USER="y"
USER_NAME=orgAdmin@myCo.com
FIRST_NAME=foo
LAST_NAME=bar
USER_PWD="userPword"
ORG_NAME=example  # lowercase only, no spaces, underscores, or periods.
ENV_NAME=prod  # lowercase only
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

При настройке организации сценарий setup-org выполняет следующие действия:

Создает организацию.
ПРИМЕЧАНИЕ. Вы не можете переименовать организацию после ее создания.
Связывает организацию с модулем «шлюз». Вы не можете это изменить.
Добавляет указанного пользователя в качестве администратора организации. Если пользователь не существует, вы можете его создать.
Создает одну или несколько сред.
Создает один или несколько виртуальных хостов для каждой среды.
Связывает среду со всеми процессорами сообщений.
Включает аналитику.

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

ПРИМЕЧАНИЕ. Вместо использования утилиты apigee-provision вы можете использовать набор дополнительных скриптов или сам Edge API для создания и настройки организации. Например, используйте эти сценарии, чтобы добавить организацию и связать ее с несколькими модулями. В следующих разделах эти сценарии и API описаны более подробно.

Создать организацию

Используйте команду create-org для создания организации, как показано в следующем примере:

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

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

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

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

Скрипт create-org :

Создает организацию.
Связывает организацию с модулем «шлюз».
Добавляет указанного пользователя в качестве администратора организации. Пользователь должен уже существовать; в противном случае скрипт выдает ошибку.

ПРИМЕЧАНИЕ. Вы не можете создать две организации с одинаковым названием. В этом случае второе создание завершится неудачей, например:

<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://management_server_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://management_server_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>'

ПРИМЕЧАНИЕ. В настоящее время Apigee Edge для частного облака поддерживает роли — orgadmin, opsadmin, пользователь и бизнес-пользователь, все из которых по умолчанию имеют разрешение на полный доступ к объектам (API, продуктам API, приложениям, разработчикам и отчетам) в организации Apigee. В зависимости от потребностей клиента вы можете настроить заранее определенные или настроить более сложные роли и разрешения с помощью RBAC API. См. http://apigee.com/docs/api/user-roles .

Обратите внимание, что роль readonlyadmin доступна только в облаке.

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

Создайте среду

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

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

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

APIGEE_ADMINPW=admin_password  # If omitted, you are prompted for it.
ORG_NAME=example  # lowercase only, no spaces, underscores, or periods.
ENV_NAME=prod  # lowercase only
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

Команда add-env :

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

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

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

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

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

curl -H "Content-Type:application/x-www-form-urlencoded" \
  -u sysAdminEmail:adminPasswd -X POST \
  http://management_server_IP:8080/v1/organizations/org_name/environments/env_name/servers \
  -d "action=add&uuid=uuid"

Где uuid — это UUID процессора сообщений. Вы можете получить UUID с помощью команды:

curl http://Message_Processor_IP:8082/v1/servers/self

Где Message_Processor_IP — это IP-адрес процессора сообщений.

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

ПРИМЕЧАНИЕ. Вместо использования следующего вызова API используйте следующую команду для включения Analytics:

/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  # lowercase only

ПРИМЕЧАНИЕ. Если вы включаете аналитику для одной среды в организации, вам необходимо включить аналитику для всех сред в организации:

curl -H "Content-Type:application/json" -u sysAdminEmail:adminPasswd \
  -X POST http://management_server_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:password http://management_server_IP/v1/servers?pod=central

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

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

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

curl -u sysAdminEmail:admin_password http://management_server_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://management_server_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>'

ПРИМЕЧАНИЕ. Символы, которые вы можете использовать в атрибуте имени, ограничены a-zA-Z0-9._\-$% .

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