Edge for Private Cloud v4.19.01
Antes de instalar el portal de Servicios para desarrolladores de Apigee (o simplemente el portal), asegúrate de que se cumpla lo siguiente:
- Instala Postgres antes de instalar el portal. Puedes instalar Postgres como parte de la instalación de Edge o instalar Postgres independiente para que lo use el portal.
- Si instalas Postgres 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 maestro o en espera, especifica la dirección IP del servidor maestro de Postgres.
- Estás realizando la instalación en la versión de 64 bits de una versión compatible de Red Hat Enterprise Linux, CentOS o Oracle. Consulta la lista de versiones compatibles en Software y versiones compatibles.
- Se instaló Yum.
El instalador solo incluye los módulos que Drupal contribuyó y que requiere el portal de servicios para desarrolladores de Apigee (o simplemente, el portal). Para obtener información sobre la instalación de otros módulos contribuidos, consulta Cómo extender Drupal 7.
Descripción general de instalación
Para instalar el portal, sigue los pasos que se indican a continuación. Cada uno de estos pasos se describe con más detalle en las siguientes secciones.
- Prueba tu conexión
- Quita las versiones de PHP anteriores a la 7.0.
- Instala Postgres
- Instala el portal
- Asegúrate de que el Administrador de actualizaciones esté habilitado
- Cómo configurar Apache Solr(opcional)
- Instala SmartDocs(opcional)
- Configura jQuery(opcional)
Baja de la propiedad SMTPSSL
En versiones anteriores, usaste la propiedad SMTPSSL
para configurar el protocolo que usa el servidor SMTP conectado al portal. Esa propiedad dejó de estar disponible.
Ahora, usa la propiedad SMTP_PROTOCOL
, en lugar de la propiedad 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 archivo de configuración silenciosa para una instalación de portal. Edítalo según sea necesario para la configuración. Usa la opción -f en setup.sh
para 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=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 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:
curl -u EMAIL:PASSWORD https://ms_IP_or_DNS:TLSPort/v1/organizations/ORGNAME
En el que 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 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 la 7.0 de PHP
La secuencia de comandos de instalación busca versiones anteriores a la 7.0 de PHP en el sistema antes de comenzar la instalación. Si existen versiones anteriores a la 7.0 de PHP, 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 sabes si PHP está instalado en tu servidor, usa el siguiente comando:
rpm -qa | grep -i php
Ten en cuenta que el portal usa la versión 4.18.01-0.0.49 de PHP. No está diseñado para coincidir con el número de versión de Apigee Edge para la nube privada.
3. Instala Postgres
El portal requiere que Postgres esté instalado 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 el modo maestro/en espera, especifica la dirección IP del servidor maestro de Postgres.
- Si instalas Postgres 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 independiente, sigue estos pasos:
- Instala la utilidad
apigee-setup
de Edge en el nodo con un procedimiento de Internet o que no sea de Internet. Consulta Instala la utilidad de Apigee-setup de Edge para obtener más información. - 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
- 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 “apigee” debe poder acceder al archivo de configuración o leerlo.
4. Instala el portal
Antes de instalar el portal, asegúrate de haber hecho lo siguiente, como se describe en 3. Instala Postgres:
- Instala la utilidad
apigee-setup
de Edge en el nodo del portal - Instala Postgres, ya sea de forma independiente o como parte de la instalación de Edge
Para instalar el portal, sigue estos pasos:
- 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
le indica a la secuencia de comandossetup
que instale el portal.
Para verificar que la instalación del portal se haya realizado correctamente, haz lo siguiente:
- Navega a la página principal del portal en
http://localhost:8079
o al nombre de DNS de tu portal. - Accede al portal con las credenciales de administrador que estableciste en el archivo de configuración del portal.
- Selecciona Informes > Informe de estado en el menú de Drupal para asegurarte de poder ver el estado actual del portal.
- Asegúrate de que la conexión con el servidor de administración se haya establecido correctamente. Si no fue así, haz lo siguiente:
- Navega a la página Configuración de conexión del portal (por ejemplo,
http://portal_IP:8079/admin/config/devconnect
). - Haz clic en el botón Test Connection. Si la conexión se realiza correctamente, habrá terminado. Si la conexión falla, continúa.
- Verifica la configuración del extremo y la autenticación:
- URL del extremo de la API de Management: Verifica 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 del extremo: Es el nombre de usuario del administrador de la organización.
- Contraseña del usuario autenticado: Es la contraseña del administrador de la organización.
Los valores predeterminados reflejan la configuración del archivo de configuración del portal que creaste durante el proceso de instalación.
Estos valores deben coincidir con los valores de 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
yUSER_PWD
en el archivo de configuración de integración o las credenciales de cualquier usuario cuyo rol sea administrador de la organización. - URL del extremo de la API de Management: Verifica que el protocolo (HTTP o
HTTPS), el nombre de IP o DNS y el número de puerto sean correctos. Por ejemplo:
- Después de conectarte correctamente 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.
- Navega a la página Configuración de conexión del portal (por ejemplo,
5. Asegúrate de que el módulo Administrador de actualizaciones esté habilitado.
Para recibir notificaciones de actualizaciones de Drupal, asegúrate de que el módulo del administrador de actualizaciones de Drupal esté habilitado. En el menú de Drupal, selecciona Módulos y desplázate hacia abajo hasta el módulo Administrador de actualizaciones. 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 de Drush:
drush pm-info update
Debes 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 al directorio de instalación.
Utiliza el elemento de menú Informes > Actualizaciones disponibles > Configuración para configurar el módulo de modo que te envíe correos electrónicos cuando haya actualizaciones disponibles y definir la frecuencia de comprobación de actualizaciones.
6. Configura el motor de búsqueda Apache Solr (opcional)
De forma predeterminada, los módulos de Drupal que se conectan al motor de búsqueda 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 Solr de Drupal en el portal.
Para habilitar los módulos de Drupal Solr, sigue estos pasos:
- Accede a tu portal como un usuario con privilegios de administrador o creación de contenido.
- Selecciona Módulos en el menú de Drupal.
- Habilita el módulo Apache Solr Framework y el módulo Apache Solr Search.
- Guarda los cambios.
- Configura Solr como se describe en https://drupal.org/node/1999280.
7. Instalar SmartDocs (opcional)
SmartDocs te permite documentar tus APIs en el portal 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 instalarlos en Edge.
- Si conectas el portal a una instalación de Edge Cloud, SmartDocs ya está instalado y no es necesario realizar más configuraciones.
- 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 la instalación de Edge y SmartDocs, consulta Cómo instalar SmartDocs.
También debes habilitar SmartDocs en el portal. Para obtener más información sobre SmartDocs, consulta Cómo usar SmartDocs para documentar APIs.
8. Configura el módulo jQuery Update para instalaciones sin conexión a Internet (opcional)
Si instalas y usas el módulo JQuery Update en una instalación sin conexión a Internet, debes configurar el módulo para usar la versión local de JQuery. Si configuras el módulo para usar una CDN para una instalación que no es de Internet, intentará acceder a la CDN y provocará 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 JQuery Update para que use la versión local de JQuery, haz lo siguiente:
- Accede a tu portal como un usuario con privilegios de administrador o de creación de contenido.
- Selecciona Configuration > Development > JQuery Update en el menú de Drupal.
- Haz clic en Rendimiento en el panel de navegación izquierdo.
- En el menú desplegable de CDN de JQuery y JQuery UI, selecciona None.
- 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 |
---|---|
El tema define la apariencia del portal, incluidos los colores, el estilo y otros aspectos visuales. |
|
La página principal incluye el menú principal, el mensaje de bienvenida, el encabezado, el pie de página y el título. |
|
El proceso de registro controla la forma en que los desarrolladores nuevos registran una cuenta en el portal. Por ejemplo, ¿los desarrolladores nuevos obtienen acceso inmediato al portal o un administrador debe verificarlos? Este proceso también controla cómo se notifica a un administrador del portal cuando se crea una cuenta nueva. |
|
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 un desarrollador pierde su contraseña. |
|
Agrega una página de Términos y Condiciones que los desarrolladores deban aceptar para poder acceder al portal. |
|
En el portal, se implementa un modelo de autorización basado en roles. Antes de permitir que los desarrolladores se registren, define los permisos y roles que usa el portal. |
|
El portal tiene compatibilidad integrada con blogs y foros de conversación. Define los permisos necesarios para ver, agregar, editar y borrar entradas de blog y de foros. |
|
Asegúrate de crear copias de seguridad de la base de datos |
Asegúrate de crear una copia de seguridad de la base de datos de Drupal. Ten en cuenta que, como cada instalación es diferente, depende de ti determinar la mejor manera de crear una copia de seguridad de la base de datos. Consulte 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 quieres usar un nombre de host, puedes configurar el DNS para el 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 URLs incorrectas en tu sitio por algún otro motivo, puedes configurar
Ten en cuenta que puedes agregar cualquier otro parámetro de configuración de Para obtener más información sobre la propiedad |
Desarrollo personalizado | También puedes 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 colócalo en el directorio /sites/all/modules . |