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 Developer Channel Services.

Antes de continuar con la instalación, crea una copia de seguridad de todo el 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 Login to your Support Portal para solicitar el archivo .tar de los servicios del canal para desarrolladores de una de las siguientes 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, CentOS u Oracle. 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 en un servidor con conexión a Internet como un solo archivo .tar.gz. 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. Cambia el directorio al nuevo y descarga el archivo DeveloperServices_x.y.z.tar de los servicios del 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 Developer Channel Services con el comando:
      > tar -xvf <tar file>
   5. Cambia el directorio a DeveloperServices-4.x.y.z.
   6. Crea el archivo .tar.gz del portal con el siguiente comando:
      > ./non-networked-install.sh
      
      Ese comando descarga todos los archivos necesarios y los coloca en un solo archivo .tar.gz. Luego, copias ese archivo .tar.gz en tu servidor que no tiene conexión a Internet para completar la instalación.
4. Ejecuta el siguiente comando de cURL desde un símbolo del sistema en el servidor del portal para probar la conexión con el servidor de administración de Edge:
   > curl -u {EMAIL}:{PASSWORD} https://{hostname}:8080/v1/organizations/{ORGNAME}
   
   En el ejemplo anterior, 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 puerto predeterminado que usa Edge. Si te conectas a una organización en la nube, la URL de la solicitud es la siguiente:
   https://api.enterprise.apigee.com/v1/organizations/{ORGNAME}
   
   Si se ejecuta de forma correcta, este comando 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"
   }

3. Instala los servicios del canal para desarrolladores con la secuencia de comandos de instalación automatizada

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

1. Accede al servidor como usuario raíz o superusuario.
2. Crea un directorio para los archivos de instalación, como portal.
3. En un servidor con conexión a Internet, haz lo siguiente:
   1. Cambia el directorio al nuevo directorio portal y descarga el archivo DeveloperServices_x.y.z.tar de Developer Channel Services, 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 de cURL:
      > curl -kOL <paste link here>
   2. Extrae el contenido del archivo .tar de Developer Channel Services con el comando:
      > tar -xvf <tar file>
   3. Cambia el directorio 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, haz lo siguiente:
   1. Copia el archivo .tar.gz que creaste anteriormente 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. Cambia al directorio que creó el comando tar.
   4. Establece 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 preguntas.
6. Una vez que se complete la instalación, navega a la URL del servidor en un navegador, como
   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 habrás registrado en tu servidor DNS para no tener que usar http://localhost.
7. Configura la conexión a MySQL. Si MySQL está 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. Configura la conexión al extremo de Apigee ingresando la siguiente información y, luego, selecciona Guardar:
   Para obtener más información sobre estos valores, consulta "Información requerida antes de iniciar 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 de extremo
   4. Contraseña de los usuarios autenticados
9. Cuando se te solicite, selecciona el botón Instalar WADL de SmartDocs de muestra para instalar el WADL de SmartDocs de muestra. 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 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 usarlo. 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, consulta 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, puedes usar Drush para crear un administrador, como se describe en el paso 4 que aparece a continuación. Crear un usuario administrador
    1. Nombre y apellido del desarrollador
    2. Nombre de usuario del portal para desarrolladores
    3. Contraseña
    4. Dirección de correo electrónico
12. Una vez que se complete la instalación, establece 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. Crea un usuario administrador

Usa Drush para crear un usuario administrador para tu instalación de Developer Channel Services. Drupal crea automáticamente un usuario administrador llamado "admin" de forma predeterminada, por lo que no debes usar "admin" como nombre de usuario.

1. Cambia el directorio a 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 devuelve 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 entre “< >” 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 que se especificaron 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 establecer 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 Update manager 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 que habilites la función, 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

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

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

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

1. Ejecuta la siguiente secuencia de comandos para proteger tu instalación de MySQL:
   > /usr/bin/mysql_secure_installation
   
   Esta secuencia de comandos establece la contraseña raíz y te da la opción de restringir el acceso raíz solo al host local y de quitar las bases de datos de prueba y el usuario anónimo creado de forma predeterminada. Se recomienda ejecutar esta secuencia de comandos en los servidores de producción.
2. Si las políticas de tu empresa 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 Drupal Solr.

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 Drupal Solr en el portal.

Para habilitar los módulos de Drupal Solr, 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 Apache Solr Framework y el módulo Apache Solr Search.
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 de Apache usa el módulo mod_ssl para publicar páginas web a través de HTTPS. Si quieres usar HTTPS, usa el siguiente comando para instalar mod_ssl:

> yum install mod_ssl

Para 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: Instala SmartDocs

SmartDocs te permite documentar tus APIs en el portal de servicios para desarrolladores de una manera 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 nube privada, debes asegurarte de que SmartDocs esté instalado en Edge. Para obtener más información sobre la instalación de Edge y SmartDocs, consulta Instala SmartDocs.

Para obtener más información sobre SmartDocs, consulta Usa SmartDocs para documentar APIs.

11. Próximos pasos

Los próximos pasos después de instalar el portal de servicios para desarrolladores son configurarlo y personalizarlo según tus requisitos específicos. La documentación en el sitio web de Apigee contiene toda la información sobre cómo configurar, diseñar y administrar un portal. Accede 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 se incluyen vínculos a la documentación de Apigee, en la que puedes encontrar más información: