通过命令行在单个命令行中创建组织、环境和虚拟主机 也可以单独创建一个此外,您还可以使用 management API 执行其中很多操作
视频 :观看短视频,简要了解 Apigee 组织的设置和配置。
创建组织 同时运行虚拟机
在 Apigee Edge 上创建 API 代理之前,您必须创建至少一个组织,并且 一个或多个环境和虚拟主机中。
通常,组织和环境是一起创建的。为了简化此流程,请使用
apigee-provision
实用程序在 Edge Management 上从命令行调用它
服务器:
/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
脚本会执行以下操作:
- 创建组织。
- 将组织与“网关”相关联Pod。您无法更改此设置。
- 将指定用户添加为组织管理员。如果用户不存在,您可以 可以创建一个
- 创建一个或多个环境。
- 为每个环境创建一个或多个虚拟主机。
- 将环境与所有消息处理器相关联。
- 启用分析功能。
默认情况下,组织名称和环境名称的最大长度为 20 个字符
。apigee-provision
如果您使用
直接使用 Edge 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
脚本:
- 创建组织。
- 将组织与“网关”相关联Pod。
- 将指定用户添加为组织管理员。该用户必须已存在; 否则脚本会发出错误。
使用 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"/>'
下一次调用会将组织与 Pod 相关联:
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>'
如果用户不存在,您可以使用以下调用来创建用户,如 添加用户。
创建环境
使用 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
命令:
- 创建环境。
- 为环境创建单个虚拟主机。
- 将环境与 Pod 中所有与 包含环境的组织。
- 启用分析功能
使用 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。您可以使用 命令:
curl http://Message_Processor_IP:8082/v1/servers/self
其中,Message_Processor_IP 是消息处理器的 IP 地址。
下一次 API 调用将为指定环境启用 Google Analytics。它可验证是否存在 所有数据中心的 Pod 中的 Qpid 和 Postgres 服务器。然后,会启动 Google Analytics 新手入门流程 特定组织和环境
此配置文件包含:
ORG_NAME=orgName # lowercase only, no spaces, underscores, or periods. ENV_NAME=envName # lowercase only
其中,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
属性
包含以英文逗号分隔的 Postgres UUID 列表,而 qpid-server
属性包含 Qpid UUID。
如果您需要获取这些 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"
创建虚拟主机
您可以在组织的现有环境中创建虚拟主机。通常, 环境支持多个虚拟主机。例如,一个虚拟主机可能支持 协议,而同一环境中的另一个虚拟主机支持加密的 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>'
有关创建虚拟主机(包括创建安全 使用 TLS/SSL 的主机,请参阅配置对 API 的 TLS 访问 适用于私有云。