Crea una organización, un entorno y un host virtual

Edge for Private Cloud v4.19.01

Puedes crear una organización, un entorno y un host virtual en la línea de comandos en un solo o puedes crear cada una por separado. Además, puedes usar API de Management muchas de estas acciones.

Video: Mira un video breve para obtener una descripción general de la configuración de la organización de Apigee.

Crear una organización entorno y un host virtual al mismo tiempo

Antes de crear un proxy de API en Apigee Edge, debes crear al menos una organización. en cada organización, uno o más entornos y hosts virtuales.

Por lo general, las organizaciones y los entornos se crean juntos. Para simplificar el proceso, utiliza la utilidad apigee-provision. Invocarlo desde la línea de comandos en la administración perimetral Servidor:

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

Donde configFile es la ruta a un archivo de configuración que es similar al lo siguiente:

# 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

Cuando configuras una organización, la secuencia de comandos setup-org hace lo siguiente:

  • Crea la organización.
  • Asocia la organización con la “puerta de enlace”. del Pod. No se puede cambiar.
  • Agrega al usuario especificado como administrador de la organización. Si el usuario no existe, puedes pueden crear una.
  • Crea uno o más entornos.
  • Crea uno o más hosts virtuales para cada entorno.
  • Asocia el entorno con todos los Message Processor.
  • Habilita las estadísticas.

De forma predeterminada, la longitud máxima del nombre de la organización y el nombre del entorno es de 20 caracteres. cuando uses la utilidad apigee-provision. Este límite no se aplica si utilizas la API de Edge directamente para crear la organización o el entorno. El nombre de la organización y el entorno nombre debe estar en minúscula.

Crea una organización

Usa el comando create-org para crear una organización, como en el siguiente ejemplo. muestra:

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

Esta secuencia de comandos crea la organización, pero no agrega ni configura los entornos ni los hosts virtuales requeridos por la organización para manejar las llamadas a la API.

El archivo de configuración contiene el nombre y la dirección de correo electrónico de la organización administrador. Los caracteres que puedes usar en el atributo name están restringidos a a-z0-9\-$% No uses espacios, puntos ni letras mayúsculas en el nombre:

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

La secuencia de comandos create-org:

  • Crea la organización.
  • Asocia la organización con la “puerta de enlace”. del Pod.
  • Agrega al usuario especificado como administrador de la organización. El usuario ya debe existir. De lo contrario, la secuencia de comandos emitirá un error.

Crea una organización con Llamadas a la API

Puedes usar las siguientes llamadas a la API para crear una organización. La primera llamada crea organización:

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"/>'

La siguiente llamada asocia la organización con un 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"

En la llamada final, se agrega un usuario existente como administrador de la organización:

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>'

Si el usuario no existe, puedes usar la siguiente llamada para crearlo como se describe en Agrega un usuario.

Crear un entorno

Usa la secuencia de comandos add-env para crear un entorno en una organización existente:

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

Este archivo de configuración contiene la información necesaria para crear el entorno host:

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

Con el comando add-env, se realiza lo siguiente:

  • Crea el entorno.
  • Crea un host virtual único para el entorno.
  • Asocia el entorno con todos los Message Processors del Pod asociados con el organización que contiene el entorno.
  • Permite el análisis

Crear un entorno con Llamadas a la API

Como alternativa, puedes usar las siguientes llamadas a la API para crear un entorno. La primera llamada crea el entorno:

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"/>'

La siguiente llamada asocia el entorno con un Message Processor. Realizar esta llamada para cada Message Processor que quieres asociar con el entorno:

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"

Donde uuid es el UUID de Message Processor. Para obtener el UUID, usa el comando :

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

En el ejemplo anterior, Message_Processor_IP es la dirección IP del procesador de mensajes.

La siguiente llamada a la API habilitará Analytics para un entorno determinado. Valida la existencia de Servidores Qpid y Postgres en los POD de todos los centros de datos Luego, comienza la integración de Analytics para la organización y el entorno determinados.

Este archivo de configuración contiene lo siguiente:

ORG_NAME=orgName  # lowercase only, no spaces, underscores, or periods.
ENV_NAME=envName  # lowercase only
.

Donde sample.json contiene lo siguiente:

{
  "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"] 
  }
}

La propiedad postgres-servers contiene una lista separada por comas de los UUID de Postgres y la propiedad qpid-server contiene los UUID de Qpid. Si necesitas obtener estos UUID, usa los siguientes comandos.

Para Qpid, ejecuta el siguiente comando:

curl -u sysAdminEmail:password http://management_server_IP/v1/servers?pod=central

El resultado de este comando es un objeto JSON. Para cada servidor Qpid, verás un resultado en la formulario:

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

Para Postgres, ejecuta el siguiente comando:

curl -u sysAdminEmail:admin_password http://management_server_IP/v1/servers?pod=analytics

Para cada servidor de Postgres, verás un resultado en el formato siguiente:

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

Crea un host virtual

Puedes crear un host virtual en un entorno existente en una organización. A menudo, es admite varios hosts virtuales. Por ejemplo, un host virtual podría admitir la HTTP protocolo, mientras que otro host virtual en el mismo entorno admite el protocolo HTTPS encriptado protocolo.

Usa la siguiente llamada a la API para crear hosts virtuales adicionales, o bien para crear un host virtual para un entorno sin host virtual:

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>'

Para obtener una descripción completa de cómo crear un host virtual, incluida la creación de un entorno que usa TLS/SSL sobre HTTPS, consulta Configura el acceso TLS a una API para la nube privada.