Instalación del portal de servicios para desarrolladores

Edge para nube privada v. 4.17.09

Antes de instalar la etiqueta, asegúrate de lo siguiente:

  • Debes instalar Postgres antes de instalar el portal. Puedes instalar Postgres como parte de la instalación de Edge o instalar Postgres de forma independiente para que lo use el portal.
    • Si instalas Postgres de forma independiente, puedes estar en el mismo nodo que el portal.
    • Si te conectas a Postgres instalado como parte de Edge, y Postgres está configurado en modo principal/en espera, especifica la dirección IP del servidor de Postgres principal.
  • Estás realizando la instalación en la versión de 64 bits de una versión compatible de Red Hat Enterprise Linux, Oracle o CentOS. Consulta la lista de versiones admitidas en Software y versiones compatibles.
  • Yum está instalado.

El instalador solo incluye módulos aportados por Drupal que son necesarios para el portal de servicios para desarrolladores de Apigee (o simplemente, el portal). Para obtener información sobre cómo instalar otros módulos contribuidos, consulta Cómo extender Drupal 7.

Descripción general de instalación

Después de instalar la utilidad apigee-setup de Edge en un nodo, úsala para instalar el portal en el nodo. La utilidad apigee-setup tiene el siguiente formato:

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

Pasa un archivo de configuración a la utilidad apigee-setup que contiene la información sobre la instalación. Si al archivo de configuración le falta alguna información necesaria, la utilidad apigee-setup te solicita que la ingreses en la línea de comandos.

El único requisito es que el usuario de “Apigee” debe poder acceder o leer el archivo de configuración.

Por ejemplo, usa el siguiente comando para instalar el portal:

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

Consulta Instala la utilidad apigee-setup de Edge para obtener más información.

Crea un archivo de configuración

A continuación, se muestra un ejemplo de archivo de configuración silencioso para la instalación de un portal. Edita este archivo según sea necesario para tu configuración. Usa la opción -f para setup.sh a fin de incluir este archivo.

IP1=IPorDNSnameOfNode

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

# Specify the name of the portal database in Postgres. 
PG_NAME=devportal 

# Specify the Postgres admin credentials. 
# The portal connects to Postgres by using the 'apigee' user. 
# If you changed the Postgres password from the default of 'postgres' 
# then set PG_PWD accordingly. 
# If connecting to a Postgres node installed with Edge, 
# contact the Edge sys admin to get these credentials. 
PG_USER=apigee 
PG_PWD=postgres 

# The IP address of the Postgres server. 
# If it is installed on the same node as the portal, specify that IP. 
# If connecting to a remote Postgres server,specify its IP address. 
PG_HOST=$IP1 

# The Postgres user credentials used by the portal 
# to access the Postgres database, 
# This account is created if it does not already exist. 
DRUPAL_PG_USER=drupaladmin 
DRUPAL_PG_PASS=portalSecret 

# Specify 'postgres' as the database. 
DEFAULT_DB=postgres 

# Specify the Drupal admin account details. 
# DO NOT set DEVPORTAL_ADMIN_USERNAME=admin. 
# The installer creates this user on the portal. 
DEVPORTAL_ADMIN_FIRSTNAME=firstName 
DEVPORTAL_ADMIN_LASTNAME=lastName 
DEVPORTAL_ADMIN_USERNAME=userName 
DEVPORTAL_ADMIN_PWD=pWord 
DEVPORTAL_ADMIN_EMAIL=foo@bar.com 

# Edge connection details. 
# If omitted, you can set them in the portal UI. 
# Specify the Edge organization associated with the portal. 
EDGE_ORG=edgeOrgName 

# Specify the URL of the Edge management API. 
# For a Cloud based installation of Edge, the URL is: 
# https://api.enterprise.apigee.com/v1 
# For a Private Cloud installation, it is in the form: 
# http://<ms_ip_or_DNS>:8080/v1 or 
# https://<ms_ip_or_DNS>:TLSport/v1 
MGMT_URL=https://api.enterprise.apigee.com/v1 

# The org admin credentials for the Edge organization in the form
# of Edge emailAddress:pword. 
# The portal uses this information to connect to Edge. 
DEVADMIN_USER=orgAdmin@myCorp.com 
DEVADMIN_PWD=pWord 

# The PHP port. 
# If omitted, it defaults to 8888. 
PHP_FPM_PORT=8888 

# You must configure the SMTP server used by the portal. 
# The properties SMTPHOST and SMTPPORT are required. 
# The others are optional with a default value as notated below. 
# SMTP hostname. For example, for the Gmail server, use smtp.gmail.com. 
SMTPHOST=smtp.gmail.com 

# Use SSL for SMTP: 'y' or 'n' (default). 
SMTPSSL="n" 

# SMTP port (usually 25). 
# The value can be different based on the selected encryption protocol. 
# For example, for Gmail, the port is 465 when using SSL and 587 for TLS. 
SMTPPORT=25 

# Username used for SMTP authentication, defaults is blank. 
SMTPUSER=your@email.com 

# Password used for SMTP authentication, default is blank. 
SMTPPASSWORD=yourEmailPassword

1. Prueba tu conexión a Apigee Edge

Para probar la conexión con el servidor de administración Edge, ejecuta el siguiente comando cURL desde un símbolo del sistema en el servidor del portal:

> curl -u {EMAIL}:{PASSWORD} http://<ms_ip_or_DNS>:8080/v1/organizations/{ORGNAME}

o bien

> curl -u {EMAIL}:{PASSWORD} https://<ms_ip_or_DNS>:TLSPort/v1/organizations/{ORGNAME}

Donde CORREO ELECTRÓNICO y CONTRASEÑA son la dirección de correo electrónico y la contraseña del administrador de ORGNAME.

Asegúrate de especificar el nombre de host y el número de puerto específicos de la instalación de Edge. El puerto 8080 es el predeterminado que usa Edge. Si te conectas a una organización en la nube, la URL de la solicitud es https://api.enterprise.apigee.com/v1/organizations/{ORGNAME}.

Si se ejecuta de forma correcta, este comando mostrará una respuesta similar a la siguiente:

{
  "createdAt" : 1348689232699,
  "createdBy" : "USERNAME",
  "displayName" : "cg",
  "environments" : [ "test", "prod" ],
  "lastModifiedAt" : 1348689232699,
  "lastModifiedBy" : "foo@bar.com",
  "name" : "cg",
  "properties" : {
    "property" : [ ]
  },
  "type" : "trial"
}

2. Quita las versiones de PHP anteriores a la 7.0

La secuencia de comandos de instalación comprueba si hay versiones anteriores a 7.0 de PHP en el sistema antes de comenzar la instalación. Si existen versiones de PHP anteriores a la 7.0, se mostrará el siguiente mensaje de advertencia:

The following packages present on your system conflict with software we are
about to install. You will need to manually remove each one, then re-run this install script.

php
php-cli
php-common
php-gd
php-mbstring
php-mysql
php-pdo
php-pear
php-pecl-apc
php-process
php-xml

Quita los paquetes de PHP con el siguiente comando:

yum remove <package-name>

3. Instala Postgres

El portal requiere la instalación de Postgres antes de que puedas instalarlo. Puedes instalar Postgres como parte de la instalación de Edge o instalar Postgres de forma independiente para que lo use el portal.

  • Si te conectas a Postgres instalado como parte de Edge, y Postgres está configurado en modo principal o en espera, especifica la dirección IP del servidor de Postgres principal.
  • Si instalas Postgres de forma independiente, puedes estar en el mismo nodo que el portal.

Si deseas obtener información para instalar Postgres como parte de la instalación de Edge, consulta Instala componentes de Edge en un nodo.

Para instalar Postgres de forma independiente, sigue estos pasos:

  1. Instala la utilidad apigee-setup de Edge en el nodo con el procedimiento de Internet o que no sea de Internet. Consulta Instala la utilidad apigee-setup de Edge para obtener más información.
  2. Crea un archivo de configuración para Postgres, como se muestra a continuación:

    # Debe resolverse en la dirección IP o el nombre de DNS del host, no en 127.0.0.1 o localhost.
    HOSTIP=$(nombre de host -i)

    # El Pod y la región de Postgres. Usa los valores predeterminados que se muestran a continuación.
    MP_POD=gateway
    REGION=dc-1

    # Configura la contraseña de Postgres. El valor predeterminado es “postgres”.
    PG_PWD=postgres
  3. En el símbolo del sistema, ejecuta la secuencia de comandos de configuración para instalar Postgres:
    >/opt/apigee/apigee-setup/bin/setup.sh -p pdb -f configFile

    La opción “-p pdb” especifica para instalar Postgre.

    El usuario de “apigee” debe poder acceder o leer el archivo de configuración.

4. Instalar el portal

Para instalar el portal, haz lo siguiente:

  1. Instala la utilidad apigee-setup de Edge en el nodo con el procedimiento de Internet o que no sea de Internet. Consulta Instala la utilidad apigee-setup de Edge para obtener más información.
  2. Asegúrate de haber instalado Postgres, ya sea de forma independiente o como parte de la instalación de Edge.
  3. En el símbolo del sistema, ejecuta la secuencia de comandos de configuración:
    > /opt/apigee/apigee-setup/bin/setup.sh -p dp -f configFile

    La opción “-p dp” especifica para instalar el portal.

    El usuario de “apigee” debe poder acceder o leer el archivo de configuración.
  4. Navega a la página principal del portal en http://localhost:8079 o al nombre de DNS de tu portal.
  5. Accede al portal con las credenciales de administrador que estableciste en el archivo de configuración para asegurarte de que el portal se ejecuta de forma correcta.
  6. Selecciona Reports > Status Report en el menú de Drupal para asegurarte de que puedes ver el estado actual del portal.

5. Asegúrate de que el módulo del Administrador de actualizaciones esté habilitado.

Para recibir notificaciones de las actualizaciones de Drupal, asegúrate de que el módulo del administrador de actualizaciones de Drupal esté habilitado. En el menú de Drupal, selecciona Modules y desplázate hacia abajo hasta el módulo Update Manager. Si no está habilitada, habilítala.

Una vez habilitada, puedes ver las actualizaciones disponibles en el elemento de menú Informes > Actualizaciones disponibles. También puedes usar el siguiente comando Drush:

> drush pm-info update

Debes ejecutar este comando desde el directorio raíz del sitio. De forma predeterminada, el Portal para desarrolladores se instala en /opt/apigee/apigee-drupal/wwwroot. Por lo tanto, primero debes cambiar el directorio a /opt/apigee/apigee-drupal/wwwroot antes de ejecutar el comando. Si no instalaste el portal en el directorio predeterminado, cambia al directorio de instalación.

Usa el elemento de menú Informes > Actualizaciones disponibles > Configuración para configurar el módulo a fin de que te envíe un correo electrónico cuando haya actualizaciones disponibles y para establecer la frecuencia de búsqueda de actualizaciones.

6. Configura el motor de búsqueda de Apache Solr (opcional)

De forma predeterminada, los módulos de Drupal que se conectan al motor de búsqueda de Apache Solr se inhabilitan cuando instalas el portal. La mayoría de los portales usan el motor de búsqueda interno de Drupal y, por lo tanto, no requieren los módulos de Solr de Drupal.

Si decides usar Solr como motor de búsqueda, debes instalarlo de forma local en tu servidor y, luego, habilitar y configurar los módulos de Solr de Drupal en el portal.

Para habilitar los módulos de Solr de Drupal, haz lo siguiente:

  1. Accede a tu portal como un usuario con privilegios de administrador o de creación de contenido.
  2. Selecciona Modules en el menú de Drupal.
  3. Habilita el módulo del framework de Apache Solr y el módulo de búsqueda de Apache Solr.
  4. Guarda los cambios.
  5. Configura Solr como se describe en https://drupal.org/node/1999280.

7. Instalar SmartDocs (opcional)

SmartDocs te permite documentar tus API en el portal de servicios para desarrolladores de manera que la documentación de la API sea completamente interactiva. Sin embargo, para usar SmartDocs con el portal, primero debes instalar SmartDocs en Edge.

  • Si quieres conectar el portal a una instalación de Edge Cloud, SmartDocs ya está instalado y no es necesario configurar nada más.
  • Si quieres conectar el portal a una instalación de Edge para la nube privada, debes asegurarte de que SmartDocs esté instalado en Edge. Si quieres obtener más información para instalar Edge y SmartDocs, consulta Cómo instalar SmartDocs.

También debes habilitar SmartDocs en el portal. Si deseas obtener más información sobre SmartDocs, consulta Cómo usar SmartDocs para documentar las API.

8. Configura el módulo de actualización de JQuery para instalaciones que no sean de Internet (opcional)

Si instalas y usas el módulo de actualización de JQuery en una instalación que no es de Internet, debes configurar el módulo para usar la versión local de JQuery. Si configuras el módulo a fin de usar una CDN para una instalación que no sea de Internet, se intentará acceder a la CDN y causará demoras en la carga de la página. Para obtener más información sobre el módulo de actualización de JQuery, consulta https://www.drupal.org/project/jquery_update.

Para configurar el módulo de actualización de JQuery a fin de usar la versión local de JQuery:

  1. Accede a tu portal como un usuario con privilegios de administrador o de creación de contenido.
  2. Selecciona Configuration > Development > JQuery Update en el menú de Drupal.
  3. Haz clic en Rendimiento en el panel de navegación izquierdo.
  4. En el menú desplegable de la CDN de IU de JQuery y JQuery, selecciona None.
  5. Haga clic en Guardar configuración.

9. ¿Qué debes hacer a continuación?

Los siguientes pasos después de instalar el portal de Developer Services son configurarlo y personalizarlo según tus requisitos específicos. La documentación del sitio web de Apigee contiene toda la información sobre la configuración, el diseño y la administración de un portal. Acceda a la documentación en http://apigee.com/docs/developer-services/content/what-developer-portal.

En la siguiente tabla, se enumeran algunas de las tareas más comunes que realizas después de la instalación y, además, se incluyen vínculos a la documentación de Apigee en la que puedes encontrar más información:

Tarea Descripción

Personaliza el tema

El tema define la apariencia del portal, incluidos los colores, el estilo y otros aspectos visuales.

Cómo personalizar el aspecto

La página principal incluye el menú principal, el mensaje de bienvenida, el encabezado, el pie de página y el título.

Cómo agregar y administrar cuentas de usuario

El proceso de registro controla cómo los desarrolladores nuevos registran una cuenta en el portal. Por ejemplo, ¿los desarrolladores nuevos obtienen acceso inmediato al portal o deben contar con la verificación de un administrador? Este proceso también controla cómo se notifica a un administrador del portal cuando se crea una cuenta nueva.

Configura el correo electrónico

El portal envía correos electrónicos en respuesta a ciertos eventos. Por ejemplo, cuando un desarrollador nuevo se registra en el portal y cuando pierde su contraseña.

Cómo agregar y administrar cuentas de usuario

Agrega una página de Términos y Condiciones que los desarrolladores deban aceptar para poder acceder al portal.

Cómo agregar y administrar cuentas de usuario

El portal implementa un modelo de autorización basado en funciones. Antes de permitir que los desarrolladores se registren, define los permisos y roles que usa el portal.

Cómo agregar entradas de blog y foros

El portal tiene soporte integrado para blogs y foros de múltiples conversaciones. Define los permisos necesarios para ver, agregar, editar y borrar entradas de blog y foros.

Asegúrate de realizar copias de seguridad de bases de datos

Asegúrate de crear una copia de seguridad de la base de datos de Drupal. Ten en cuenta que, debido a que cada instalación es diferente, depende de ti determinar la mejor manera de crear una copia de seguridad de la base de datos.

Nota: El módulo Copia de seguridad y migración no es compatible con las bases de datos de Postgres.

Consulta también Cómo crear una copia de seguridad del portal.

Configura un nombre de host

Si no configuras un nombre de host en tu servidor DNS, siempre podrás acceder al sitio a través de la dirección IP del servidor. Si deseas usar un nombre de host, puedes configurar el DNS del servidor, que debería funcionar correctamente sin ninguna otra configuración en una configuración básica.

Si configuraste un balanceador de cargas o recibes URL incorrectas en tu sitio por algún otro motivo, puedes configurar $base_url en el siguiente archivo:

/opt/apigee/apigee-drupal-devportal-opdk_version/source/conf/settings.php

Este valor se reemplazará si actualizas el portal.

Desarrollo personalizado También te recomendamos que amplíes las capacidades de tu portal con código personalizado fuera del tema. Para ello, crea tu propio módulo de Drupal como se describe en los temas de desarrollo de módulos de Drupal y colócalo en el directorio /sites/all/modules.