Instalación del portal de servicios para desarrolladores

Portal de Servicios para desarrolladores v. 4.16.05

Sigue estos pasos para instalar el portal de servicios de canal para desarrolladores.

Antes de continuar con la instalación, crea una copia de seguridad de todo tu directorio raíz web de Drupal. La ubicación de instalación predeterminada es /var/www/html, pero es posible que la hayas cambiado en el momento de la instalación. Después de realizar los pasos de instalación que se describen a continuación, puedes restablecer tus personalizaciones desde la copia de seguridad.

1. Obtén el paquete de servicios de canal para desarrolladores

Ve a http://community.apigee.com/content/apigee-customer-support y selecciona Acceder a tu Portal de asistencia para solicitar el archivo .tar de los servicios de canal para desarrolladores de una de estas dos maneras:

  • Solicita acceso al directorio de descarga de Edge para nube privada.
  • Solicita una URL para el archivo .tar de los servicios de canal para desarrolladores.

2. Asegúrate de que tu sistema cumpla con los requisitos del sistema

Antes de instalar el portal, tu servidor debe cumplir con los siguientes requisitos:

  1. Asegúrate de realizar 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 aquí.
  2. Asegúrate de que Yum esté instalado.
  3. (Para una instalación en un servidor sin conexión a Internet) Primero debes descargar todos los archivos necesarios a un servidor con una conexión a Internet como un archivo .tar.gz único. Luego, copia ese archivo .tar.gz en el servidor sin conexión a Internet para realizar la instalación.
    1. Accede a un servidor con conexión a Internet como raíz o como superusuario.
    2. Crea un directorio para los archivos de instalación, como portal_tar.
    3. CD al directorio nuevo y descarga el archivo DeveloperServices_x.y.z.tar de los servicios de canal para desarrolladores, en el que x.y.z corresponde al número de versión del portal.
    4. Extrae el contenido del archivo .tar de los servicios de canal para desarrolladores mediante el comando:
      > tar -xvf <tar file>
    5. de CD a DeveloperServices-4.x.y.z.
    6. Crea el archivo .tar.gz del portal con el comando:
      > ./non-networked-install.sh

      Con ese comando, se descargan todos los archivos necesarios y se descargan en un solo archivo .tar.gz. Luego, copia ese archivo .tar.gz en tu servidor, que no tiene conexión a Internet para completar la instalación.
  4. Prueba la conexión con el servidor de administración de Edge mediante la ejecución del siguiente comando cURL desde un símbolo del sistema en el servidor del portal:
    > curl -u {EMAIL}:{PASSWORD} https://{hostname}:8080/v1/organizations/{ORGNAME}

    donde EMAIL. y EMAILNAME son la dirección de correo electrónico del administrador

    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 la solicitud es:
    https://api.enterprise.apigee.com/v1/organizations/{ORGNAME}

    Si se ejecuta correctamente, este comando muestra una respuesta similar a la siguiente:
    {
    "createdAt" : 134868923269,"
    "createBy" : "
    "nombre:"








3. Instala los servicios de canal para desarrolladores con la secuencia de comandos de instalación automática

Usa el siguiente procedimiento para instalar el portal con la secuencia de comandos de instalación automática. Este procedimiento funciona para servidores con o sin conexión externa a Internet.

  1. Accede al servidor como raíz o como superusuario.
  2. Crea un directorio para los archivos de instalación, como el portal.
  3. En un servidor con conexión a Internet:
    1. CD al nuevo directorio del portal y descarga el archivo DeveloperServices_x.y.z.tar de los servicios de canal de desarrollador, en el que x.y.z corresponde al número de versión del portal.

      Puedes descargar un archivo desde el vínculo que te envió Apigee en un navegador o copiarlo y, luego, agregarlo al siguiente comando cURL:
      > curl -kOL <pegar el vínculo aquí>
    2. Extrae el contenido del archivo .tar de los servicios de canal para desarrolladores mediante el comando:
      > tar -xvf <tar file>
    3. de CD a DeveloperServices-4.x.y.z.
    4. Ejecuta la secuencia de comandos de instalación con el siguiente comando:
      > ./networked-install.sh
  4. En un servidor sin conexión a Internet:
    1. Copia el archivo .tar.gz que creaste en la sección 2. Asegúrate de que tu sistema cumpla con los requisitos del sistema.
    2. Extrae el contenido del archivo .tar.gz con el siguiente comando:
      > tar -xvf <tar file>
    3. CD al directorio que creó el comando "tar".
    4. Configura los permisos en la secuencia de comandos install-from-rpm-bundle.sh:
      > chmod 755 install-from-rpm-bundle.sh
    5. Ejecuta la secuencia de comandos install-from-rpm-bundle.sh con el siguiente comando:
      > ./install-from-rpm-bundle.sh
  5. Responde las indicaciones.
  6. Una vez completada la instalación, navega a la URL del servidor en un navegador, por ejemplo:
    http://localhost. O bien, si tienes una IP o un DNS específicos configurados, ve a http://IP_address o http://DNS_name.

    Se te redireccionará a la página de configuración de la base de datos del perfil de Apigee.

    Nota: Por lo general, ya habrás configurado un nombre de host y lo registraste en tu servidor DNS para que no tengas que usar http://localhost.
  7. Configurar la conexión a MySQL Si MySQL se encuentra en una máquina remota, expande la sección Opciones avanzadas, ingresa la información de conexión a esa máquina y, luego, selecciona Guardar y continuar.
  8. Para configurar la conexión con el extremo de Apigee, ingresa la siguiente información y, luego, selecciona Guardar:
    . Si quieres obtener más información sobre estos valores, consulta “Información necesaria antes de comenzar la instalación” en Requisitos del portal de servicios para desarrolladores.
    1. Organización del Portal para desarrolladores
    2. URL del extremo del portal para desarrolladores
    3. Usuario autenticado del extremo
    4. Contraseña de los usuarios autenticados
  9. Cuando se te solicite, selecciona el botón Instalar muestra de WADL de SmartDocs para instalar la muestra de WADL de SmartDocs. Si omites este paso, la API de SmartDocs de ejemplo no aparecerá en tu portal.
    Nota: Si tu portal se conecta a una instalación de Apigee Edge para la nube privada y esa instalación de Edge no tiene conexión a Internet externa, debes realizar una configuración adicional del módulo de SmartDocs antes de poder usar SmartDocs. Para obtener más información sobre SmartDocs, consulta http://apigee.com/docs/developer-services/content/using-smartdocs-document-apis.
  10. Establece la Configuración del servidor SMTP. Apigee requiere que configures un servidor SMTP para enviar mensajes de correo electrónico desde el portal.
    Para obtener más información, consulte http://apigee.com/docs/developer-services/content/configuring-email.
  11. Para configurar el usuario administrador, ingresa la siguiente información y, luego, selecciona Guardar. Ten en cuenta que Drupal crea un usuario administrador llamado “admin” de forma predeterminada, por lo que no debes usar “admin” como nombre de usuario.
    Si omites este paso, igualmente puedes usar Drush para crear un administrador, como se describe a continuación en 4. Crea un usuario administrador.
    1. Nombre y apellido del desarrollador
    2. Nombre de usuario del portal del desarrollador
    3. Contraseña
    4. Dirección de correo electrónico
  12. Una vez finalizada la instalación, configura los permisos en el archivo settings.php:
    > chmod 640 /var/www/html/sites/default/settings.php
  13. Navega a la página principal del portal en http://localhost/ o al nombre de DNS de tu portal.
  14. Accede al portal con las credenciales de administrador.

4. Crear un usuario administrador

Usa Drush para crear un usuario administrador para la instalación de los servicios de canal para desarrolladores. Drupal crea automáticamente un usuario administrador llamado “admin” de forma predeterminada, por lo que no debes usar “admin” como nombre de usuario.

  1. CD a tu directorio drupal_root/sites/default. La ubicación estándar del directorio raíz de Drupal es /var/www/html:
    > cd <drupal_root>/sites/default
  2. Asegúrate de tener permisos de escritura en los archivos privados de Drupal:
    > drush vget file_private_path

    Este comando muestra la ruta de acceso a los archivos privados de Drupal, por ejemplo:
    file_private_path: 'sites/default/private'

    Corresponde a /var/www/html/sites/default/private/. Usa el siguiente comando para asegurarte de que el propietario y el grupo puedan escribir en este directorio:
    chmod -R g+w dirPathAndName
    chmod -R o+r dirPathAndName
  3. Ingresa los siguientes comandos para crear un usuario administrador y reemplaza los comandos de “< >” por tus valores:
    > drush user-create <username> --mail="<email-address>" --password="<password>"
    > drush user-add-role Administrator <username>
  4. Accede al portal para desarrolladores como administrador con el nombre de usuario y la contraseña especificados anteriormente.

5. Establece la contraseña raíz de MySQL

Si instalaste MySQL como parte de la instalación del portal, la secuencia de comandos de instalación deja la contraseña raíz de MySQL establecida en su valor predeterminado, que está en blanco.

Usa el siguiente comando para configurar la contraseña raíz:

> mysqladmin -u root password NEWPASSWORD

Si ya configuraste la contraseña raíz y deseas cambiarla, usa el siguiente comando:

> mysqladmin -u root -p'OLDPASSWORD' password NEWPASSWORD

También debes actualizar la contraseña en el archivo /var/www/html/sites/default/settings.php.

6. 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

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.

7. Opcional: implementación en un servidor de producción

Si implementas el portal en un servidor de producción, debes realizar los siguientes pasos de seguridad adicionales:

  1. Ejecuta la siguiente secuencia de comandos para proteger la instalación de MySQL:
    > /usr/bin/mysql_secure_installation

    Esta secuencia de comandos establece la contraseña raíz y te brinda la opción de restringir el acceso raíz solo al localhost y quitar las bases de datos de prueba y los usuarios anónimos creados de forma predeterminada. Recomendamos enfáticamente ejecutar esta secuencia de comandos para los servidores de producción.
  2. Si tus políticas corporativas lo requieren, habilita y configura SELinux.

8. Opcional: Configura el motor de búsqueda de Apache Solr

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.

9. Opcional: Instala mod_ssl para admitir HTTPS

El servidor HTTP Apache usa el módulo mod_ssl para entregar páginas web a través de HTTPS. Si quieres usar HTTPS, usa el siguiente comando para instalar mod_ssl:

> yum install mod_ssl

Si deseas obtener más información sobre cómo configurar el portal para usar SSL, consulta http://apigee.com/docs/developer-services/content/using-ssl-portal.

10. Opcional: instalar SmartDocs

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.

Si deseas obtener más información sobre SmartDocs, consulta Cómo usar SmartDocs para documentar las API.

11. ¿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

Cómo personalizar 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.

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 configuras un balanceador de cargas o recibes URL incorrectas en tu sitio por algún otro motivo, puedes configurar $base_url en el archivo settings.php del portal para desarrolladores, que se encuentra de forma predeterminada en el directorio /var/www/html/sites/default.