Instalación del portal de servicios para desarrolladores

Edge for Private Cloud v4.18.01

Antes de instalar el paquete, asegúrate de lo siguiente:

• Instala Postgres antes de instalar el portal. Puedes instalar Postgres como parte de instalar 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 principal/en espera, especifica la dirección IP del servidor de Postgres principal.
• 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.
• Está instalado Yum.

El instalador solo incluye módulos aportados por Drupal que requieren el Portal de Apigee para desarrolladores (o simplemente el portal). Para obtener información sobre cómo instalar otros módulos aportados, consulta Cómo extender Drupal 7.

Descripción general de instalación

Después de instalar la utilidad apigee-setup de Edge en un nodo, usa esa 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 el información adicional sobre la instalación. Si al archivo de configuración le falta alguna la apigee-setup. te pedirá que lo ingreses en la línea de comandos.

El único requisito es que el archivo de configuración debe ser accesible o legible “Apigee” usuario.

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.

Baja de la propiedad SMTPSSL

En versiones anteriores, usaste la propiedad SMTPSSL para establece el protocolo que usa el servidor SMTP conectado al portal. Esa propiedad se obsoleto.

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

Crea un archivo de configuración

A continuación, se muestra un ejemplo de un archivo de configuración silenciosa para la instalación de un portal. Editar este archivo según sea necesario para tu configuración. Usa la opción -f en setup.sh para incluir esto. .

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 

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

1. Prueba tu conexión a Apigee Edge

Para probar tu conexión con el servidor de administración perimetral, 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 ejemplo anterior, EMAIL y PASSWORD corresponden al correo electrónico. dirección y 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. Puerto El puerto predeterminado que usa Edge es 8080. Si te conectas a una organización en la nube, entonces 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 de PHP anteriores a la 7.0

La secuencia de comandos de instalación comprueba si hay versiones de PHP anteriores a la 7.0 en el sistema antes de iniciar instalación. Si existen versiones de PHP anteriores a la 7.0, se muestra 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

3. Instala Postgres

El portal requiere que se instale Postgres antes de que puedas instalarlo. Tienes las siguientes opciones: instalar Postgres como parte de la instalación de Edge o instalar Postgres independiente para que lo use el portal.

• Si te conectas a Postgres instalado como parte de Edge, y Postgres se configura en en modo principal o en espera, especifica la dirección IP del servidor de Postgres de la instancia principal.
• Si instalas Postgres independiente, puede estar en el mismo nodo que el portal.

Para obtener información sobre la instalación de Postgres como parte de la instalación de Edge, consulta Instala componentes de Edge en un nodo.

Para instalar Postgres independiente, haz lo siguiente:

1. Instala la utilidad apigee-setup de Edge en el nodo a través del por Internet o por otro. Consulta Instala la utilidad de Apigee-setup de Edge para obtener más.
2. Crea un archivo de configuración para Postgres, como se muestra a continuación:

   # 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 configFile

   La opción -p pdb especifica que se debe instalar Postgre. El archivo de configuración debe sean accesibles o legibles por el software de “Apigee” usuario.

4. Instala el portal

Para instalar el portal, haz lo siguiente:

1. Instala la utilidad apigee-setup de Edge al nodo con un procedimiento de Internet o que no sea de Internet. Consulta Instala la utilidad de Apigee-setup de Edge para más.
2. Asegúrate de haber instalado Postgres, ya sea de forma independiente o como parte de instalar Edge.
3. 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 archivo de configuración debe ser accesible y legible por el “Apigee” usuario.

4. Navega a la página principal del portal en http://localhost:8079 o al nombre de DNS de tu portal.
5. Accede al portal con las credenciales de administrador que estableciste en el archivo de configuración para garantizar que el portal funcione correctamente.
6. Selecciona Informes > de estado del usuario en el menú de Drupal para garantizar que puedas ver el estado actual del portal.

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

Para recibir notificaciones sobre 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 Administrador de actualizaciones. Si no está habilitada, habilítala.

Una vez habilitadas, puedes ver las actualizaciones disponibles en Informes > Disponibles actualizaciones. También puedes usar el siguiente comando "Drush":

drush pm-info update

Debes ejecutar este comando desde el directorio raíz del sitio. De forma predeterminada, el Programador El portal está instalado en /opt/apigee/apigee-drupal/wwwroot. Por lo tanto, primero debes cambiar el directorio a /opt/apigee/apigee-drupal/wwwroot antes ejecutando el comando. Si no instalaste el portal en el directorio predeterminado, cambia a tu directorio de instalación.

Utiliza la pestaña Informes > Actualizaciones disponibles > Elemento de menú de configuración el módulo para enviarte un correo electrónico cuando haya actualizaciones disponibles y para establecer la frecuencia de la búsqueda 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 Apache Solr se inhabilitan cuando instalas el portal. La mayoría de los portales usan el motor de búsqueda interno 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, habilitaremos y configuraremos los módulos de Drupal Solr en el portal.

Sigue estos pasos para habilitar los módulos de Drupal Solr:

1. Accede a tu portal como un usuario con privilegios de administrador o de creación de contenido.
2. Selecciona Módulos en el menú de Drupal.
3. Habilitar el módulo del framework de Apache Solr y Apache Solr Search.
4. Guarda los cambios.
5. 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 servicios para desarrolladores de una manera que hace que documentación de API 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á y no es necesario configurarlo.
• Si conectas el portal a un perímetro para instalar una nube privada, debes asegurarte que SmartDocs está instalado en Edge. Para obtener más información sobre la instalación de Edge y SmartDocs, consulta Instala SmartDocs.

También debes habilitar SmartDocs en el portal. Para obtener más información sobre SmartDocs, consulta Usa SmartDocs para documentar APIs.

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 sin Internet, debes hacer lo siguiente: configurar el módulo para usar la versión local de JQuery. Si configuras el módulo para usar una CDN en el caso de una instalación que no sea a través de Internet, intentará acceder a la CDN y causará demoras en cargando. Para obtener más información sobre el módulo de actualización de jQuery, consulta https://www.drupal.org/project/jquery_update.

A fin de configurar el módulo de actualización de JQuery para que use la versión local de JQuery:

1. Accede a tu portal como un usuario con privilegios de administrador o de creación de contenido.
2. Selecciona Configuración > Desarrollo > JQuery Update en el menú de Drupal.
3. Haz clic en Rendimiento en el panel de navegación izquierdo.
4. En el menú desplegable de CDN de la IU de JQuery y JQuery, selecciona Ninguna.
5. Haga clic en Guardar configuración.

9. ¿Qué debo hacer?

Después de instalar el portal de servicios para desarrolladores, sigue los pasos que se indican a continuación: configurar y personalizar según tus requisitos específicos. La documentación del sitio web de Apigee contiene más información sobre la configuración, el estilo y la administración de 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 donde puedes encontrar más información: