Instalación de la API de BaaS

Edge for Private Cloud v. 4.17.01

Descripción general de instalación

Después de instalar la utilidad apigee-setup en un nodo, usa ese para instalar uno o más componentes de BaaS en el nodo.

La utilidad apigee-setup el formulario:

> sudo /opt/apigee/apigee-setup/bin/setup.sh -p component -f configFile

Pasar un archivo de configuración a la utilidad apigee-setup que contiene los información adicional sobre la instalación. Si al archivo de configuración le falta alguna información, el comando apigee-setup te pedirá que lo ingreses en la línea de comandos.

El único requisito es que el archivo de configuración debe ser accesible o legible “Apigee” usuario.

Por ejemplo, usa el siguiente comando para instalar la pila de BaaS de la API:

> sudo /opt/apigee/apigee-setup/bin/setup.sh -p b -f myConfig

Cómo especificar los componentes que se instalarán

La utilidad setup.sh de Apigee admite varias opciones para instalar componentes de la BaaS de la API. En las instrucciones que aparecen a continuación, se usa el opciones independientes (c, e, b, y p), pero puedes usar diferentes opciones según tu nodo actual:

Opción

Descripción

e

Solo instala ElasticSearch.

b

Solo instala la pila BaaS de API, que también instala Tomcat.

p

Solo instala el portal de API BaaS, que también instala el router Nginx que se usará como sitio web. servidor.

c

Solo instala Cassandra.

eb

Instalar ElasticSearch, API BaaS Stack y Tomcat en el nodo

ebp

Instala ElasticSearch, API BaaS Portal, API BaaS Stack y Tomcat, pero no Cassandra. El portal es tan ligero que no se necesitan recursos adicionales para esto.

Asa

Instalar todos los componentes de BaaS de APIs en un solo nodo (Cassandra, Elasticsearch, BaaS de APIs Stack, API BaaS Portal, Tomcat). Usa esta opción solo para el desarrollo y las pruebas, no para la producción.

Crea un archivo de configuración

El archivo de configuración contiene toda la información necesaria para instalar la BaaS de la API. Puedes suelen usar el mismo archivo de configuración para instalar todos los componentes en una instalación de BaaS.

En cada topología de instalación que se describe a continuación, se muestra un archivo de configuración de ejemplo para esa topología. Para Para obtener una referencia completa del archivo de configuración, consulta la Referencia del archivo de configuración de BaaS.

Instala la BaaS de la API en un solo nodo

A continuación, se muestra el archivo de configuración para instalar la BaaS de la API en un solo nodo. Editar este archivo como necesario para tu configuración. Para obtener una referencia completa sobre el archivo de configuración, consulta Referencia del archivo de configuración de BaaS. 

IP1=192.168.56.101   # IP address of single node

# Must resolve to IP address or DNS name of host - not to 127.0.0.1 or localhost.
HOSTIP=$(hostname -i)

# Define the API BaaS administrator account.  
AS_ADMIN="superuser"    # User name - default is "superuser".
AS_ADMIN_EMAIL=stackAdmin@email.com
AS_PASSWD=stackAdminPWord

# Because you are installing Cassandra,
# specify Cassandra data center and rack suffix.
# Must use IP addresses for CASS_HOSTS, not DNS names.
CASS_HOSTS="$IP1:1,1"

# Specify the Cassandra region.
REGION=dc-1

# Cassandra uname/pword.
# Even if Cassandra authentication is disabled,
# you must still pass values for these properties.
CASS_USERNAME=cassandra    # Default value
CASS_PASSWORD=cassandra    # Default value

# Specify Cassandra data center name.
BAAS_CASS_LOCALDC=dc-1

# For a single data center, specify the same value as BAAS_CASS_LOCALDC.
BAAS_CASS_DC_LIST=dc-1

# Replication is in the form "dataCenterName:#CassandraNodes". 
# For dc-1 with one Cassandra node, it is dc-1:1.
BAAS_CASS_REPLICATION=dc-1:1

# Defines the initial contact points for members of the BaaS cluster. 
# For a single node install, specify the IP address of the node. 
BAAS_CLUSTER_SEEDS="dc-1:$IP1"

# Single ElasticSearch IP.
ES_HOSTS="$IP1"

# API BaaS Stack information.
# Default cluster name is "apigee_baas"
BAAS_USERGRID_CLUSTERNAME="apigee_baas" 

# IP/DNS and port 8080 of a single Stack node.
BAAS_USERGRID_URL="http://$IP1:8080"

# URL and port of the BaaS Portal node.  
BAAS_PORTAL_URL="http://$IP1:9000"

# Portal port. Default value is 9000.
BAAS_PORTAL_LISTEN_PORT=9000

# SMTP information. BaaS requires an SMTP server.
SMTPHOST=smtp.gmail.com
SMTPPORT=465
SMTPUSER=your@email.com
SMTPPASSWORD=yourEmailPassword
SMTPSSL=y

Para instalar la API BaaS en su propio nodo:

  1. Instala la utilidad apigee-setup de Edge en el nodo a través del por Internet o sin Internet. Consulta Instala la utilidad de Apigee-setup de Edge para obtener más.
  2. En el símbolo del sistema, ejecuta la secuencia de comandos de configuración:
    > /opt/apigee/apigee-setup/bin/setup.sh -p asa -f configFile

    La opción “-p asa” especifica la instalación de todos los componentes de BaaS de la API en un solo nodo (Cassandra, Elasticsearch, API BaaS Stack, API BaaS Portal, Tomcat).
    El archivo de configuración debe ser accesible y legible por el “Apigee” usuario.
  3. Debido a que instalaste ElasticSearch en un nodo independiente, ajusta la memoria predeterminada para aumentar la memoria asignada a ElasticSearch de 4 GB a 6 GB:
    1. Abra /opt/apigee/customer/application/elasticsearch.properties en un editor. Si este archivo no existe, créalo.
    2. Configura la propiedad setenv_elasticsearch_max_mem_size a 6g (el valor predeterminado es 4g):
      setenv_elasticsearch_max_mem_size=6g
    3. Guarda el archivo.
    4. Ejecuta el siguiente comando:
      > /opt/apigee/apigee-service/bin/apigee-service apigee-elasticsearch a reiniciar
  4. Integra una organización como se describe a continuación en Cómo integrar una nueva organización.

La configuración completa correctamente la configuración en el nodo.

Instala la BaaS de la API en 7 o 10 nodos

El procedimiento para instalar una versión de 7 o 10 nodos de la BaaS de la API es muy similar. El único la diferencia es que para

  • Instalación de 10 nodos, instala los tres componentes de ElasticSearch y las tres APIs Componentes de la pila de BaaS en nodos independientes, para un total de seis nodos. Esta es la configuración recomendada para obtener porque ElasticSearch requiere una gran cantidad de E/S de disco y memoria.
  • Instala 7 nodos, instalas los tres componentes de ElasticSearch y tres BaaS de APIs Apila los componentes en los mismos nodos, para un total de tres nodos.

Para las versiones de 7 y 10 nodos de la BaaS de la API, debes conectarte a un clúster de Cassandra. Si si ya instalaste Edge, puedes conectarte al clúster de Cassandra, lo que significa que instalar Cassandra como parte de la instalación de las APIs BaaS.

A continuación, se muestra un ejemplo de un archivo de configuración silencioso para una instalación del BaaS de la API de 10 nodos. Si debe instalar los componentes ElasticSearch y API BaaS Stack en los mismos tres nodos. editar el archivo para que:

  • IP1 y IP4 están configurados en la misma dirección IP
  • IP2 y IP5 están configurados en la misma dirección IP
  • IP3 y IP6 están configurados en la misma dirección IP

Edita este archivo según sea necesario para tu configuración. Para obtener una referencia completa el archivo de configuración; consulta BaaS Referencia del archivo de configuración. 

# Specify IP address or DNS name of node.
IP1=192.168.1.1   # ElasticSearch
IP2=192.168.1.2   # ElasticSearch
IP3=192.168.1.3   # ElasticSearch
IP4=192.168.1.4   # API BaaS Stack
IP5=192.168.1.5   # API BaaS Stack
IP6=192.168.1.6   # API BaaS Stack
IP7=192.168.1.7   # API BaaS Portal
IP8=192.168.1.8   # Cassandra (shared with Edge or standalone)
IP9=192.168.1.9   # Cassandra (shared with Edge or standalone)
IP10=192.168.1.10  # Cassandra (shared with Edge or standalone)

# Must resolve to IP address or DNS name of host - not to 127.0.0.1 or localhost.
HOSTIP=$(hostname -i)

# Define the API BaaS administrator account.  
AS_ADMIN="superuser"    # User name - default is "superuser".
AS_ADMIN_EMAIL=stackAdmin@email.com
AS_PASSWD=stackAdminPWord

# Only if you are installing Cassandra.
# Specify Cassandra data center and rack suffix.
# Must use IP addresses for CASS_HOSTS, not DNS names.
# CASS_HOSTS="$IP8:1,1 $IP9:1,1 $IP10:1,1"

# If connecting to existing Cassandra nodes, 
# specify Cassandra IPs.
# Must use IP addresses for CASS_HOSTS, not DNS names.
CASS_HOSTS="$IP8 $IP9 $IP10"

# Specify the Cassandra region.
REGION=dc-1

# Cassandra uname/pword.
# Even if Cassandra authentication is disabled,
# you must still pass values for these properties.
CASS_USERNAME=cassandra    # Default value
CASS_PASSWORD=cassandra    # Default value

# Specify BaaS Cassandra connection information.
# Specify the data center name.
BAAS_CASS_LOCALDC=dc-1    # Default is dc-1.

# For a single data center, specify the same value as BAAS_CASS_LOCALDC.
BAAS_CASS_DC_LIST=dc-1

# Replication is in the form "dataCenterName:#CassandraNodes". 
# For example, for dc-1 with three Cassandra nodes, it is dc-1:3.
BAAS_CASS_REPLICATION=dc-1:3

# Defines the initial contact points for members of the BaaS cluster. 
# Specify the IP address of no more than two Stack nodes. 
BAAS_CLUSTER_SEEDS="dc-1:$IP4,dc-1:$IP5"

# ElasticSearch IPs or DNS names, separated by spaces.
ES_HOSTS="$IP1 $IP2 $IP3"

# API BaaS Stack information.
# Default cluster name is "apigee_baas"
BAAS_USERGRID_CLUSTERNAME="apigee_baas" 

# URL and port of the load balancer for the API BaaS Stack nodes, 
# or IP/DNS and port 8080 of a single Stack node with no load balancer.
BAAS_USERGRID_URL=http://myloadbalancer:8443

# API BaaS Portal information.
# URL and port number of load balancer, if there is one in front of the Portal,
# or the URL and port of the Portal node.  
BAAS_PORTAL_URL="http://$IP7:9000"

# Portal port. Default value is 9000.
BAAS_PORTAL_LISTEN_PORT=9000 

# SMTP information. BaaS requires an SMTP server.
SMTPHOST=smtp.gmail.com
SMTPPORT=465
SMTPUSER=your@email.com
SMTPPASSWORD=yourEmailPassword
SMTPSSL=y

Instalación (opcional) Cassandra: Machine 8, 9 and 10

Puedes conectar las BaaS de API al mismo clúster de Cassandra que usa Edge. Si aún no has instalado Edge, puedes instalar Cassandra de forma opcional para que lo use las BaaS de API.

El clúster de Cassandra puede usar la autenticación o se puede inhabilitar la autenticación de Cassandra. Consulta Habilitar la autenticación de Cassandra para más.

  1. Instala la utilidad apigee-setup de Edge en el nodo a través del por Internet o por otro. Consulta Instala la utilidad de Apigee-setup de Edge para obtener más.
  2. En el símbolo del sistema, ejecuta la secuencia de comandos de configuración:
    > /opt/apigee/apigee-setup/bin/setup.sh -p c -f configFile

    La opción “-p c” especifica la instalación de Cassandra.
    El archivo de configuración debe ser accesible y legible por el “Apigee” usuario.

La configuración completa correctamente la configuración del almacén de datos en el nodo.

Ten en cuenta que JMX está habilitado de forma predeterminada para Cassandra. El acceso remoto JMX a Cassandra no requieren una contraseña. Puedes configurar Cassandra para que use la autenticación para JMX. Para obtener más información, consulta Cómo supervisar.

Configura un trabajo cron de Cassandra

Si tienes que instalar Cassandra, configura un trabajo cron que use nodetool para vaciar los bloqueos cada hora en cada nodo de Cassandra.

Si tienes varios nodos Cassandra, compensa el trabajo cron en cada servidor cinco minutos para para que no todos los nodos se vacíen al mismo tiempo.

El trabajo cron debe ejecutar el siguiente comando:

/opt/apigee/apigee-cassandra/bin/nodetool -h IP_address flush Apigee_Baas_Locks

en la que IP_address es la dirección IP del nodo de Cassandra.

Instala ElasticSearch: Máquinas 1, 2 y 3

Para instalar ElasticSearch en su propio nodo, sigue estos pasos:

  1. Instala la utilidad de Apigee-setup de Edge en el nodo a través de Internet o sin Internet procedimiento. Consulta Instala el entorno de Apigee-setup de Edge utilitario para obtener más información.
  2. En el símbolo del sistema, ejecuta la secuencia de comandos de configuración:
    > /opt/apigee/apigee-setup/bin/setup.sh -p e -f configFile

    La opción “-p e” especifica la instalación de ElasticSearch.
    El archivo de configuración debe ser accesible y legible por el “Apigee” usuario.
  3. (Opcional) Si instalas ElasticSearch en un nodo independiente, lo que significa que no está instalado con una pila BaaS de APIs y, luego, ajustas la opción de memoria predeterminada para aumentar la memoria asignada a ElasticSearch de 4 GB a 6 GB:
    1. Abra /opt/apigee/customer/application/elasticsearch.properties. en un editor. Si este archivo no existe, créalo.
    2. Establece el valor setenv_elasticsearch_max_mem_size propiedad en 6g (el valor predeterminado es 4g):
      setenv_elasticsearch_max_mem_size=6g
    3. Guarda el archivo.
    4. Ejecuta el siguiente comando:
      > /opt/apigee/apigee-service/bin/apigee-service apigee-elasticsearch a reiniciar

La configuración completa correctamente la configuración en el nodo.

Instala la pila de BaaS de la API: Máquinas 4, 5 y 6

Para instalar la pila de BaaS de la API en su propio nodo, haz lo siguiente:

  1. Instala la utilidad de Apigee-setup de Edge en el nodo a través de Internet o sin Internet procedimiento. Consulta Instala el entorno de Apigee-setup de Edge utilitario para obtener más información.
  2. En el símbolo del sistema, ejecuta la secuencia de comandos de configuración:
    > /opt/apigee/apigee-setup/bin/setup.sh -p b -f configFile

    La opción “-p b” especifica la instalación de la pila BaaS de la API.
    El archivo de configuración debe ser accesible y legible por el “Apigee” usuario.

Una vez que el instalador recupera las credenciales de administrador correctas, instala Tomcat, crea una API Espacios de claves BaaS y, luego, configura la pila de BaaS de la API en el servidor. SMTP también está configurado para permitir la IU para enviar correos electrónicos de confirmación de contraseña.

Instala el portal de BaaS de APIs: máquina (7)

Para instalar el Portal de BaaS de APIs, haz lo siguiente:

  1. Instala la utilidad de Apigee-setup de Edge en el nodo a través de Internet o sin Internet procedimiento. Consulta Instala el entorno de Apigee-setup de Edge utilitario para obtener más información.
  2. En el símbolo del sistema, ejecuta la secuencia de comandos de configuración:
    > /opt/apigee/apigee-setup/bin/setup.sh -p p -f configFile

    La opción “-p p” especifica la instalación del portal de BaaS de APIs.
    El archivo de configuración debe ser accesible y legible por el “Apigee” usuario.

    El instalador inicia el servidor web Nginx y, luego, finaliza el portal de API BaaS. configuración.
  3. El próximo paso depende de la instalación.
    1. Si tienes un balanceador de cargas frente a los nodos de la pila del portalor, la siguiente sección se describe cómo configurar las BaaS de las APIs para los balanceadores de cargas.
    2. Si no tienes un balanceador de cargas frente a los nodos de Portalor Stack, intégrate una organización, como se describe a continuación en Integración una organización nueva.

Toma nota de la URL del portal de BaaS de la API. Esta es la URL que se ingresa en el navegador para acceder a la Interfaz de usuario del portal de BaaS de la API.

Configurar Nodos de BaaS de API para un balanceador de cargas de pila o portal

Si incluyes un balanceador de cargas frente a los nodos de la pila o del portal, debes configurar los nodos con la URL correcta del balanceador de cargas. Por ejemplo, los nodos de pila requieren esta cuando sucede lo siguiente:

  • Incluir una URL en las respuestas de las solicitudes a la API de BaaS.
  • Agregar vínculos en las plantillas de correo electrónico cuando restablezcas una contraseña o envíes otro notificaciones.
  • Redireccionar a los usuarios a páginas específicas del Portal

Si usas un balanceador de cargas frente a los nodos de pila, configura la siguiente propiedad en /opt/apigee/customer/application/usergrid.properties: 

usergrid-deployment_usergrid.api.url.base=http://localhost:8080

Reemplaza http://localhost:8080 por la URL de la carga. del balanceador de cargas. Si el balanceador de cargas está configurado para usar TLS, usa el protocolo HTTPS. Solo debes deberás incluir el puerto si usas un puerto no estándar, es decir, 80 para HTTP y el puerto 443 para HTTPS.

También debe configurar la siguiente propiedad en /opt/apigee/customer/application/portal.properties si se usa un balanceador de cargas frente a los nodos de pila:

baas.portal.config.overrideUrl=http://localhost:8080

Reemplaza http://localhost:8080 por la URL de de cargas HTTP(S) para la pila.

Si usas un balanceador de cargas frente al nodo del portal, configura las siguientes propiedades en usergrid.properties: 

usergrid-deployment_portal.url=http://localhost:9000

Reemplaza http://localhost:9000 por la URL de balanceador de cargas HTTP(S) global externo. Si el balanceador de cargas está configurado para usar TLS, usa el protocolo HTTPS. Tú solo necesitarás incluir el puerto si estás usando un puerto no estándar, es decir, el puerto 80 para HTTP y el puerto 443 para HTTPS.

Después de editar usergrid.properties y portal.properties, haz lo siguiente:

  1. Configura el nodo de pila:
    > /opt/apigee/apigee-service/bin/apigee-service baas-usergrid configure
  2. Reinicia la pila de BaaS:
    > /opt/apigee/apigee-service/bin/apigee-service baas-usergrid restart

    Nota: Cuando reinicies los nodos de la pila de BaaS, hazlo en el mismo orden. que aparezcan en BAAS_CLUSTER_SEEDS. BAAS_CLUSTER_SEEDS enumera como máximo dos de los nodos de la pila. Después de reiniciar esos dos nodos en orden, puedes reiniciar los restantes nodos en cualquier orden.

  3. Si modificaste portal.properties, configura el nodo del portal:
    > /opt/apigee/apigee-service/bin/apigee-service configuración de baas-portal
  4. Reinicia el portal de BaaS:
    > /opt/apigee/apigee-service/bin/apigee-service reinicio de baas-portal

Incorporación de una organización nueva

La integración es el proceso de crear una organización y un administrador de la organización. Después del creando la organización y el administrador de la organización, puedes acceder al Portal de BaaS de APIs IU y solicitudes a la API de REST de BaaS de la API.

Cuando creas una organización, la dirección de correo electrónico del administrador de la organización hace lo siguiente:

  • Debe ser diferente de la dirección de correo electrónico del administrador del sistema.
  • Debe ser único entre todas las demás organizaciones. Es decir, no puedes crear dos organizaciones con la misma dirección de correo electrónico del administrador de la organización. Sin embargo, después de crear el puedes agregar administradores adicionales que se puedan duplicar en varios organizaciones.

Para realizar la integración, usa la secuencia de comandos de Python create_org_and_user.py. Si invocas esta secuencia de comandos sin argumentos de línea de comandos, se te solicitará información:

> python create_org_and_user.py

De manera alternativa, puedes pasar una o todas las opciones como argumento de la línea de comandos. Se te indicará cualquier información que se omita en la línea de comandos:

> python create_org_and_user.py -o '<org name>'
> python create_org_and_user.py -o '<org name>' -a '<new admin email>' -p '<new admin password>'

Para crear una organización, sigue estos pasos:

  1. Cambia el directorio a /opt/apigee/baas-usergrid/bin.
  2. Invoca la secuencia de comandos create_org_and_user.py de Python.
    Se te solicita el nombre de usuario y la contraseña del administrador del sistema BaaS para que solo un usuario administrador puede ejecutarla.
  3. Accede al portal de BaaS de la API en un navegador web con la URL que anotaste al final de la Instalación de la URL del portal de BaaS de la API Para acceder al portal, ingresa la URL del portal de BaaS de la API en el formulario:
    http://{portalExternalIP}:9000/

    Nota: La IP es la dirección IP externa o el nombre de host de la máquina del portal. Asegúrate de que de que ese puerto esté abierto.
  4. Cuando aparece la pantalla de acceso del portal, puedes hacer lo siguiente:
    • Accede con el nombre de usuario y la contraseña del administrador de la organización.
    • Accede con el nombre de usuario y la contraseña del administrador del sistema.

Accede a la API de REST de BaaS de la API

Para acceder a la API de REST de BaaS de la API, usa una URL en el formato siguiente:

https://{loadBalancerIP}:8080/{your-org}/{your-app}

En un entorno de desarrollo, puedes instalar todos los componentes de la API BaaS en un solo nodo, lo que significa que tienes una sola pila BaaS de la API. O puedes tener un entorno pequeño con una sola Nodo de pila de la API de BaaS y sin balanceador de cargas. En este tipo de entornos, puedes realizar llamadas a la API directamente al nodo de la pila de BaaS de la API:

curl -v "http://portalExternalIP:8080/status"

Si deseas obtener más información para comenzar a usar el portal de BaaS de APIs, consulta la documentación de Apigee en: http://apigee.com/docs/content/build-apps-home.