Instala el portal

Edge para la nube privada v4.18.05

Antes de instalar el portal de servicios para desarrolladores de Apigee (o simplemente el portal), asegúrese de lo siguiente:

  1. Instala 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 el portal lo use.
    • Si instalas Postgres de forma independiente, puede 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 Postgres principal.
  2. 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 compatibles en Software y versiones compatibles.
  3. Se instaló Yum.

El instalador solo incluye módulos aportados por Drupal que requiere 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

Para instalar el portal, deberás realizar los siguientes pasos. Cada uno de estos pasos se describe con más detalle en las siguientes secciones.

  1. Prueba tu conexión
  2. Quita las versiones anteriores a PHP 7.0 de PHP
  3. Instala Postgres
  4. Instala el portal
  5. Cómo asegurarse de que el Administrador de actualizaciones esté habilitado
  6. (Opcional) Configura Apache Solr
  7. (Opcional) Instala SmartDocs
  8. (Opcional) Configura JQuery

Baja de la propiedad SMTPSSL

En las versiones anteriores, usaste la propiedad SMTPSSL para establecer el protocolo que usa el servidor SMTP conectado al portal. Esa propiedad dejó de estar disponible.

Ahora usas la propiedad SMTP_PROTOCOL, en lugar de SMTPSSL, para establecer el protocolo que usa el servidor SMTP conectado al portal. Los valores válidos son “standard”, “ssl” o “tls”.

Crea un archivo de configuración del portal

A continuación, se muestra un ejemplo de un archivo de configuración silenciosa para una instalación del portal. Edita este archivo según sea necesario para tu configuración. Usa la opción -f para incluir setup.sh en 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=PORTAL_ADMIN_PASSWORD
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=ORG_ADMIN_PASSWORD

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

# Optionally configure the SMTP server used by the portal.
# If you do, 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

# Set the SMTP protocol as "standard", "ssl", or "tls",
# where "standard" corresponds to HTTP.
# Note that in previous releases, this setting was controlled by the
# SMTPSSL property. That property has been deprecated.
SMTP_PROTOCOL="standard"

# 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=YOUR_EMAIL_PASSWORD

1. Prueba tu conexión a Apigee Edge

Ejecuta el siguiente comando de curl en el servidor del portal para probar la conexión entre el servidor en el que instalarás el portal y el servidor de administración de Edge:

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 EMAIL y PASSWORD 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 tu 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 solicitud es https://api.enterprise.apigee.com/v1/organizations/ORGNAME.

Si se ejecuta de forma correcta, curl muestra 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 anteriores a 7.0 de PHP

La secuencia de comandos de instalación busca versiones anteriores a PHP 7.0 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

Si no estás seguro de que PHP esté instalado en tu servidor, usa el siguiente comando:

rpm -qa | grep -i php

3. Instala Postgres

Es necesario instalar Postgres para poder instalar el portal. Puedes instalar Postgres como parte de la instalación de Edge o instalar Postgres de forma independiente para que el portal lo use.

  • 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 Postgres principal.
  • Si instalas Postgres de forma independiente, puede estar en el mismo nodo que el portal.

Para obtener información sobre cómo instalar Postgres como parte de la instalación de Edge, consulta Cómo instalar 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 mediante el procedimiento de Internet o sin Internet. Consulta Instala la utilidad de configuración de Apigee Edge para obtener más información.
  2. Crea un archivo de configuración de Postgres, como se muestra en el siguiente ejemplo:
    # Must resolve to IP address or DNS name of host - not to 127.0.0.1 or localhost
    HOSTIP=$(hostname -i)
    
    # The pod and region of Postgres. Use the default values shown below.
    MP_POD=gateway
    REGION=dc-1
    
    # Set the Postgres password. The default value is '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 postgres_config_file

    La opción -p pdb especifica que se debe instalar Postgre. El usuario de Apigee debe poder acceder a la información o leerla.

4. Instala el portal

Antes de instalar el portal, asegúrate de haber hecho lo siguiente, como se describe en 3. Instala Postgres:

  1. Instala la utilidad apigee-setup de Edge en el nodo del portal
  2. Instala Postgres, ya sea de forma independiente o como parte de la instalación de Edge

Para instalar el portal, haz lo siguiente:

  1. En el símbolo del sistema, ejecuta la secuencia de comandos setup:
    /opt/apigee/apigee-setup/bin/setup.sh -p dp -f configFile

    Aquí:

    • configFile es el archivo de configuración del portal, como se describe en Crea un archivo de configuración del portal.
    • -p dp indica a la secuencia de comandos setup que instale el portal.

Para verificar que la instalación del portal se haya realizado correctamente, sigue estos pasos:

  1. Navega a la página principal del portal en http://localhost:8079 o al nombre de DNS del portal.
  2. Accede al portal con las credenciales de administrador que estableciste en el archivo de configuración del portal.
  3. Selecciona Informes > Informe de estado en el menú de Drupal para asegurarte de que puedes ver el estado actual del portal.
  4. Asegúrate de que la conexión con el servidor de administración sea correcta. De lo contrario:
    1. Navega a la página de configuración de conexión del portal (por ejemplo, http://portal_IP:8079/admin/config/devconnect).
    2. Haz clic en el botón Test Connection. Si la conexión se realiza de forma correcta, habrás terminado. Si la conexión falla, continúa.
    3. Verifica la configuración del extremo y la autenticación:
      • URL del extremo de la API de Management: Comprueba que el protocolo (HTTP o HTTPS), el nombre de IP o DNS y el número de puerto sean correctos, por ejemplo:
        http://10.10.10.10:8080/v1
      • Usuario autenticado en extremo: el nombre de usuario del administrador de la organización.
      • Contraseña de usuario autenticado: La contraseña del administrador de la organización.

      Los valores predeterminados reflejan los ajustes del archivo de configuración del portal que creaste durante el proceso de instalación.

      Estos valores deben coincidir con los valores ms_IP_or_DNS, email y password que usaste en el paso 1: Prueba tu conexión a Apigee Edge. El nombre de usuario y la contraseña también deben coincidir con los valores de las propiedades USER_NAME y USER_PWD del archivo de configuración de integración, o con las credenciales de cualquier usuario cuya función sea administrador de la organización.

    4. Después de conectarte con éxito al servidor de administración, haz clic en el botón Guardar configuración en la parte inferior de la página para guardar los cambios.

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

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

Una vez que se habiliten, podrás ver las actualizaciones disponibles en el elemento de menú Informes > Actualizaciones disponibles. También puedes usar el siguiente comando de Drush:

drush pm-info update

Debe ejecutar este comando desde el directorio raíz del sitio. De forma predeterminada, el portal 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 a tu directorio de instalación.

Usa el elemento de menú Informes > Actualizaciones disponibles > Configuración para configurar el módulo que te enviará un correo electrónico cuando haya actualizaciones disponibles y 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 Drupal Solar.

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

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

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

7. Instala SmartDocs (opcional)

SmartDocs te permite documentar tus API en el portal de un modo que hace 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 conectas el portal a una instalación de Edge Cloud, SmartDocs ya está instalado y no se necesita ninguna configuración adicional.
  • Si conectas el portal a una instalación de Edge para la nube privada, debes asegurarte de que SmartDocs esté instalado en Edge. Para obtener más información sobre cómo instalar Edge y SmartDocs, consulta Cómo instalar SmartDocs.

También debe habilitar SmartDocs en el portal. Si quieres 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 sea de Internet, deberás configurar el módulo para usar la versión local de JQuery. Si configuras el módulo para usar una CDN en una instalación ajena a Internet, se intentará acceder a la CDN y causará retrasos en la carga de la página. Para obtener más información sobre el módulo de actualización de JQuery, visita https://www.drupal.org/project/jquery_update.

Si deseas configurar el módulo de actualización de JQuery para usar la versión local de JQuery, haz lo siguiente:

  1. Accede a tu portal como 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 CDN de la IU de JQuery y JQuery, selecciona Ninguno.
  5. Haga clic en Guardar configuración.

9. Próximos pasos

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

Tarea Descripción

Cómo personalizar el tema

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

Cómo personalizar la apariencia

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 un administrador debe verificarlo. 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 se registra un desarrollador nuevo en el portal o cuando un desarrollador pierde su contraseña.

Cómo agregar y administrar cuentas de usuario

Agrega una página de Términos y Condiciones que los desarrolladores deben 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 de foros

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

Asegúrese de crear copias de seguridad para la base 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, tú decides cómo crear la mejor copia de seguridad de la base de datos.

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

Configura un nombre de host

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

Si configuras un balanceador de cargas o recibes URLs incorrectas en tu sitio por algún otro motivo, puedes configurar $base_url para Drupal siguiendo estos pasos:

  1. Crea el directorio /opt/apigee/data/apigee-drupal-devportal/sites/default/includes si no existe.
  2. Crea un archivo llamado settings.php en ese directorio.
  3. Agrega lo siguiente al archivo settings.php:
    /**
    * Base URL (optional).
    *
    * If Drupal is generating incorrect URLs on your site, which could
    * be in HTML headers (links to CSS and JS files) or visible links
    * on pages (such as in menus), uncomment the Base URL statement
    * below (remove the leading hash sign) and fill in the absolute URL
    * to your Drupal installation.
    *
    * You might also want to force users to use a given domain.
    * See the .htaccess file for more information.
    *
    * Examples:
    *   $base_url = 'http://www.example.com';
    *   $base_url = 'http://www.example.com:8888';
    *   $base_url = 'http://www.example.com/drupal';
    *   $base_url = 'https://www.example.com:8888/drupal';
    *
    * It is not allowed to have a trailing slash; Drupal will add it
    * for you.
    */
    # $base_url = 'http://www.example.com/';  // NO trailing slash!
    $base_url = ‘http://www.example.com’;
    
  4. Cambia la última línea $base_url para que sea el nombre de host de tu sitio.
  5. Guarda el archivo.

Ten en cuenta que puedes incluir otros parámetros de configuración de /opt/apigee/data/apigee-drupal-devportal/ sites/default/default.settings.php en este archivo.

Para obtener más información sobre la propiedad $base_url, consulta lo siguiente:

Desarrollo personalizado Es posible que también desees extender las capacidades de tu portal con código personalizado fuera de tu tema. Para ello, crea tu propio módulo de Drupal como se describe en los temas de desarrollo de módulos de Drupal y coloca el módulo en el directorio /sites/all/modules.