Edge para la nube privada v. 4.17.01
Antes de instalar, asegúrate de 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/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 admitidas en Software y versiones compatibles.
- Se instaló Yum.
Descripción general de instalación
Después de instalar la utilidad apigee-setup de Edge en un nodo, usa esa utilidad para instalar el portal en el nodo. La utilidad apigee-setup tiene la siguiente forma:
> sudo /opt/apigee/apigee-setup/bin/setup.sh -p component -f configFile
Pasa un archivo de configuración a la utilidad apigee-setup que contenga la información sobre la instalación. Si falta información obligatoria en el archivo de configuración, la utilidad apigee-setup solicita que lo 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 de 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 silenciosa para una instalación de portal. Edita este archivo según sea necesario para tu 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=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
Prueba tu conexión con el servidor de administración perimetral; para ello, 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:
> 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, 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"
}
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
En CentOS y Red Hat Enterprise Linux (RHEL), quita los paquetes de PHP con el siguiente comando:
yum remove <package-name>
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 modo maestro o 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 Instala componentes de Edge en un nodo.
Para instalar Postgres independiente, haz lo siguiente:
- Instala la utilidad apigee-setup de Edge en el nodo mediante 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 para Postgres, como se muestra a continuación:
# El pod y la región de Postgres. Usa los valores predeterminados que se muestran a continuación.
MP_POD=gateway
REGION=dc-1
# Set the Postgres password. El valor predeterminado es "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 configFile
La opción “-p pdb” especifica que se debe instalar Postgres.
El usuario "apigee" debe poder acceder al archivo de configuración o leerlo.
4. Instala el portal
Para instalar el portal, sigue estos pasos:
- Instala la utilidad apigee-setup de Edge en el nodo mediante un procedimiento de Internet o que no sea de Internet. Consulta Instala la utilidad apigee-setup de Edge para obtener más información.
- Asegúrate de haber instalado Postgres, ya sea independiente o como parte de la instalación de Edge.
- 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 que se debe instalar el portal.
El usuario de “apigee” debe poder acceder o leer el archivo de configuración. - 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.
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 para desarrolladores se instala en /opt/apigee/apigee-drupal. Por lo tanto, primero debes cambiar el directorio a /opt/apigee/apigee-drupal 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 para que te envíe un correo electrónico cuando haya actualizaciones disponibles y establecer la frecuencia para verificar si hay 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 de 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. Instala SmartDocs (opcional)
SmartDocs te permite documentar tus APIs 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 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. Si deseas obtener más información sobre SmartDocs, consulta Usa SmartDocs para documentar las API.
8. ¿Qué debo hacer?
Después de instalar el portal de servicios para desarrolladores, debes configurarlo y personalizarlo según tus requisitos específicos. La documentación del sitio web de Apigee contiene toda la información para configurar, aplicar diseño y administrar 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 |
|
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 cómo los desarrolladores nuevos registran una cuenta en el portal. Por ejemplo, ¿los desarrolladores nuevos obtienen acceso inmediato al portal o deben verificarlos un administrador? 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. |
|
|
El portal 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 publicaciones de blogs y 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. Nota: El módulo de copia de seguridad y migración no es compatible con las bases de datos de Postgres. Consulta también Cómo realizar una copia de seguridad. |
|
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 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 configuras un balanceador de cargas o obtienes URLs incorrectas en tu sitio por algún otro motivo, puedes establecer $base_url en el archivo settings.php del portal para desarrolladores, que se encuentra, de forma predeterminada, en el directorio /opt/apigee/apigee-drupal/sites/default. |
| Desarrollo personalizado | También te recomendamos que amplíes 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. |