Estás consultando la documentación de Apigee Edge.
Consulta la
documentación de Apigee X. Información
Apigee usa Pantheon, un servicio de administración de sitios web, para alojar versiones basadas en la nube del portal de servicios para desarrolladores. Pantheon está diseñado para funcionar con Drupal y te permite desarrollar, probar y publicar tu portal en un entorno seguro. El servicio de administración de sitios web de Pantheon está disponible para clientes con necesidades de operaciones de hosting y desarrollo en todo el mundo.
En las siguientes secciones, se describe cómo usar Pantheon para desarrollar y administrar tu portal.
Accede al panel de Pantheon
Cuando Apigee te envíe la URL de tu portal, también recibirás la URL del panel de Pantheon: https://dashboard.getpantheon.com/.
Cuando accedes por primera vez al panel de Pantheon, llegas a la página Sites, que se muestra a continuación:
Desde el panel, puedes acceder a tu sitio, configurar tu cuenta y realizar otras operaciones.
Selecciona la imagen de tu sitio (por ejemplo, apigeedocs) para abrir el panel de ese sitio:
Administra tus entornos
En el panel de Pantheon, hay tres entornos en la parte superior de la página: Dev, Test y Live. Cada una se describe en la siguiente tabla.
|
Entorno |
Descripción |
|---|---|
|
Desarrollo |
El entorno Dev está conectado a tu repositorio de Git. Cualquier cambio que envíes a Git se mostrará de inmediato en el entorno Dev. La URL de este sitio tiene el siguiente formato, en el que org_name es el nombre de la organización: http://dev-{org_name}.devportal.apigee.io/ |
|
Prueba |
El entorno Test sirve para probar el código más reciente con una copia de los datos del entorno activo. En este entorno, se prueban los cambios de código antes de enviarlos al entorno activo. La URL de este sitio tiene el siguiente formato, en el que org_name es el nombre de la organización: http://test-{org_name}.devportal.apigee.io/ |
|
En vivo |
El entorno en vivo es el entorno de producción al que puedes acceder tus clientes. La URL de este sitio tiene el siguiente formato, en el que org_name es el nombre de la organización: http://live-{org_name}.devportal.apigee.io/ |
Desarrollo del contenido del portal
En las siguientes secciones, se describe cómo desarrollar el contenido del portal.
- Descripción general del repositorio de Git
- Accede a tu código
- Implementa código en los entornos del portal
- Cómo agregar módulos y temas personalizados
- Cómo anular módulos y temas de perfiles de Drupal
Además, consulta las siguientes secciones a fin de obtener más detalles para personalizar tu portal.
|
Si deseas... |
Puedes |
Más información |
|---|---|---|
|
Cambiar la apariencia del sitio |
Básica: Usa la entrada de menú Apariencia en el sitio del portal para hacer cambios, como modificar el logotipo y los colores del sitio. |
Consulta Cómo personalizar la apariencia: |
|
Avanzado: Para realizar modificaciones en el aspecto completo del sitio, extiende el tema responsivo de Apigee. |
Consulta Cómo personalizar el tema |
|
|
Cómo cambiar el comportamiento de las funciones del sitio |
Básica: Usa la configuración del administrador en el portal para cambiar o configurar el comportamiento del sitio. |
Consulta la documentación de Apigee desde aquí |
|
Advanced: Crea un módulo personalizado para cambiar cualquier comportamiento del sitio. |
Consulta Crea módulos personalizados en la documentación de Drupal |
Descripción general del repositorio de Git
El repositorio de Git para tu código de Drupal contiene todo el código del portal y se organiza con la siguiente estructura.
Nota: Solo modifica el contenido del directorio /sites/all. Si modificas contenido que está fuera del directorio /sites/all, tendrás problemas para actualizar a versiones nuevas y es posible que se produzcan conflictos de combinación cuando se verifiquen los cambios en Git.
|
Carpeta en el repositorio de Git |
Descripción |
|---|---|
/profiles/apigee |
Módulos y temas que mantiene Apigee, incluidos los siguientes:
Nota: No modifiques el contenido del directorio /profiles/apigee o tendrás problemas cuando actualices a versiones nuevas y es posible que experimentes conflictos de combinación cuando se verifiquen los cambios en Git. Para conocer las prácticas recomendadas de Drupal, consulta Nunca hackear core. |
/sites/all |
Tus módulos y temas personalizados de Drupal Para obtener información sobre cómo administrar el contenido de esta carpeta, consulta Cómo agregar módulos y temas personalizados y Cómo anular módulos y temas de perfiles de Drupal. Nota: Solo modifica el contenido del directorio /sites/all. |
Accede a tu código
Para acceder a tu repositorio de código en Git, debes realizar las tareas que se describen en las siguientes secciones:
Consulta también ¿Cómo puedo acceder al código fuente del portal para desarrolladores de Drupal 7?
Habilita el acceso SSH a tu servidor
Antes de poder usar Git para administrar tu código de Drupal, debes habilitar SSH para acceder a tu servidor subiendo una clave SSH a Pantheon.
Para habilitar el acceso SSH a tu servidor:
- Accede a Pantheon en https://dashboard.getpantheon.com/.
- En el panel, selecciona Cuenta.
- Selecciona Llaves SSH en el menú de la izquierda.
- Agrega tu llave y selecciona Agregar clave.
Si necesitas ayuda, selecciona el vínculo Aprende a generar una clave SSH.
Accede a tu repositorio de código en Git
Nota: Consulta Descripción general del repositorio de Git para obtener una descripción general de la estructura del repositorio de Git.
Para acceder a tu repositorio de código en Git, haz lo siguiente:
- Accede al panel de Pantheon.
- En la página principal de Sites, selecciona el ícono de tu portal.
- La URL del repositorio de Git aparece en la página a la derecha del Modo de conexión, como se muestra en la figura anterior.
- Copia la URL de tu repositorio de Git y clónala en tu entorno de desarrollo local con el comando:
> git clone gitURL sitename
Por ejemplo:
> git clone ssh://codeserver.dev.12@codeserver.dev.12.drush.in:2222/~/repository.git devportal
Cualquier cambio de código que envíes al repositorio de Git aparecerá de inmediato en el entorno Dev de tu portal.
Implementa código en tus entornos del portal
Para programar en los entornos del portal, haz lo siguiente:
- Envía las actualizaciones de tu código a Git, que actualiza de inmediato el entorno Dev.
- Accede a Pantheon y selecciona tu sitio.
- Selecciona el entorno Dev.
- Selecciona </>Code en el menú de la izquierda para ver un mensaje acerca del cambio de código en el registro de confirmación:
- Selecciona el entorno de pruebas en la parte superior de la página.
- Si aún no subiste Dev a Test, se te solicitará que lo hagas ahora.
- Si ya tienes un entorno de pruebas, aparecerá un mensaje que indicará que hay una confirmación de Dev lista para implementar:
- Si ya enviaste un sitio al entorno Live, puedes seleccionar de manera opcional la tercera casilla de verificación para copiar la base de datos en vivo y los archivos que subieron los desarrolladores a Test desde Live. Esto es útil si quieres probar los cambios de tu código con los datos más recientes disponibles en publicaciones.
- Selecciona el botón Deploy Code from Development.
- Probar el portal en el entorno de pruebas
- Realiza las correcciones de código necesarias en el entorno de Dev y vuelve a enviar los archivos a Test para su prueba.
- Cuando se completen las pruebas, selecciona el entorno En vivo en la parte superior de la página.
- Si aún no has subido Test a Live, se te solicitará que lo hagas ahora.
- Si ya tienes un entorno activo, aparecerá un mensaje que indicará que hay una confirmación de Prueba lista para implementar. Implementa esos cambios de la misma manera en que los implementaste en Test desde Dev. Cuando termines de probar, envía el código al entorno Live.
Obtenga más información:
- Pantheon proporciona un conjunto de Going Live Articles sobre este proceso que puedes consultar. Uno de los más importantes es el artículo Cómo usar el flujo de trabajo de Pantheon, que proporciona una descripción general de cómo desarrollar, probar y enviar un sitio.
Cómo agregar módulos y temas personalizados
Puedes expandir la funcionalidad del portal si agregas tus propios módulos y temas personalizados a las carpetas que se enumeran en la siguiente tabla.
Nota: Solo modifica el contenido del directorio /sites/all. Si modificas contenido que está fuera del directorio /sites/all, es posible que se generen conflictos de combinación cuando verifiques los cambios en Git.
| Módulo/Tema | Carpeta en el repositorio de Git | Más información (documentación de Drupal) |
| Módulos personalizados | sites/all/modules/custom |
Cómo crear módulos personalizados |
| Temas personalizados | sites/all/themes |
Cómo personalizar el tema Temas de Drupal 7 |
Después de agregar el módulo o tema personalizado en el entorno de Dev, puedes implementarlo en Test para realizar pruebas y, luego, en el entorno Live para la producción, como se describe en Implementa código en los entornos del portal.
Anula módulos y temas de perfiles de Drupal
Los módulos y temas de los siguientes directorios anulan los temas y módulos de perfiles de Drupal que Apigee mantiene y distribuye en /profiles/apigee.
Consulta Descripción general de tu repositorio de Git.
Por ejemplo, se recomienda anular un módulo en la distribución de Drupal de Apigee en las siguientes situaciones:
- Deseas usar una versión diferente de un módulo en particular.
- Quieres implementar una actualización de seguridad antes del próximo lanzamiento programado de Apigee.
| Módulo/Tema | Carpeta en el repositorio de Git | Más información (documentación de Drupal) |
| Módulos contribuidos de Drupal |
Nota: Los módulos almacenados en cualquier lugar de |
Módulos contribuidos
Nota: Los módulos contribuidos de Drupal en este directorio anulan los módulos equivalentes que Apigee mantiene y distribuye en |
| Temas contribuidos de Drupal | sites/all/themes |
Temas contribuidos
Nota: Los temas aportados por Drupal en este directorio anulan los módulos equivalentes que Apigee mantiene y distribuye en |
Información acerca del archivo settings.php
El settings.php de Drupal se confirma en el repositorio de Git ascendente del portal para desarrolladores de Drupal de Apigee. Si quieres realizar cambios en el archivo sites/default/settings.php, no lo edites directamente.
En su lugar, crea un archivo llamado sites/default/settings.local.php y coloca tu código personalizado allí. sites/default/settings.local.php se incluye en el archivo settings.php.
Por ejemplo, cuando configures un dominio personalizado para un sitio publicado siguiendo las instrucciones que proporciona Pantheon, en lugar de modificar directamente el archivo settings.php, agrega las actualizaciones necesarias en sites/default/settings.local.php.
Protege tu portal
Los sitios del portal asociados con los entornos Dev, Test y Live son accesibles públicamente de forma predeterminada. Eso significa que cualquier persona que tenga la URL del sitio puede acceder a él, aunque no pueda registrar una cuenta ni acceder al sitio. Para obtener más información sobre cómo controlar el registro de usuarios, consulta Cómo agregar y administrar cuentas de usuario.
Es probable que quieras ocultar tu sitio de Dev y Test del público y que quieras ocultar el sitio Publicado hasta que completes el desarrollo. Pantheon te permite agregar control de nombre de usuario y contraseña para bloquear un sitio de modo que solo las personas con las credenciales adecuadas puedan acceder a él.
Para agregar el bloqueo a cualquiera de los tres entornos, selecciona Seguridad en el menú de la izquierda del entorno. Para obtener más información, consulta Cómo bloquear tu sitio.
Si quieres habilitar TLS/SSL para tu sitio, consulta Usar TLS en el portal.
Aplica una actualización de Apigee a tu portal
Cuando Apigee publica una versión nueva del portal, aparece un mensaje en el panel de Pantheon.
Por lo general, debes aplicar la actualización al entorno Dev y, luego, probar esos cambios de la misma manera que pruebas tus propios cambios de código. Por ejemplo, envía el entorno Dev a Test, envía los datos en vivo de Live a Test y, luego, prueba la actualización.
Sigue estos pasos para aplicar una actualización:
- Accede a Pantheon en https://dashboard.getpantheon.com/ y selecciona tu sitio.
- Selecciona el entorno Dev.
- Selecciona la entrada del menú </>Code a la izquierda. Si hay actualizaciones de Apigee disponibles, aparecerán en una lista.
- Aplica la actualización:
-
Selecciona la casilla de verificación Ejecutar update.php después de extraer el código.
-
Si está disponible, selecciona la casilla de verificación Borrar cachés después de extraer el código.
-
Selecciona el botón Implementar código.
-
- Una vez que se complete la actualización, selecciona el elemento de menú Estado en el lado izquierdo del panel.
- En el área Estado de un entorno, es posible que veas un error durante una actualización de la base de datos, como se muestra a continuación:
Si ves este error en cualquier entorno, actualiza la base de datos de forma manual:
- Accede a tu portal como un usuario con privilegios de administrador o de creación de contenido.
- Selecciona el ícono de inicio > Ejecutar actualizaciones en la esquina superior izquierda del portal.
- Sigue las instrucciones para actualizar tu base de datos.
- Envía los cambios de código al entorno de pruebas y, luego, envíalos a En vivo, como se describió anteriormente.
Migra tus funciones personalizadas
Si agregas código personalizado o funciones al portal, debes decidir cómo mantenerlos y cómo moverlos del entorno de desarrollo a pruebas y actividades.
Para el código en el repositorio de Git, puedes usar el proceso descrito en Implementa código en los entornos de tu portal a fin de migrar el código de Dev a Test a Live.
Si creaste configuraciones personalizadas, usa uno de los siguientes métodos para migrarlas:
| Método | Descripción |
| Exporta tu configuración al código | Muchas configuraciones comunes son "exportables" al código mediante el módulo de funciones. Por ejemplo, vistas, paneles, caché de imágenes, etcétera. |
Implementa la función hook_update_N() |
Drupal administra los cambios de configuración y la base de datos mediante la función hook_update_N().
Si tienes un módulo personalizado, puedes hacer lo siguiente:
|
Consulta también Cómo usar el flujo de trabajo de Pantheon, que proporciona una descripción general de cómo desarrollar, probar y enviar tu sitio. En ese artículo, se incluye la sección Administración de configuraciones.
Configura un dominio personalizado
El valor predeterminado de los nombres de dominio que proporciona Apigee para un portal es apigee.io, como se describe en Administra tus entornos, que puede no ser lo que quieres exponer a tus clientes.
Con los planes de portal pagados, se puede configurar un nombre de dominio personalizado para el portal (las cuentas de desarrollador o gratuitas no pueden crear un dominio personalizado). Para usar un dominio personalizado, crea un CNAME en tu DNS y apunta el dominio a edge.apigee.getpantheon.com.
Por ejemplo, para configurar el dominio personalizado de una empresa llamada Mytech, sigue estos pasos:
- Establece la siguiente configuración de DNS:
developer.mytech.com. 3600 IN CNAME root.apigee.getpantheon.com
Este cambio de DNS puede tardar hasta 48 horas en aplicarse en todos los dispositivos cliente. - Usa la entrada de menú Domains / SSL en el lado izquierdo del panel para agregar este dominio a tu panel de Pantheon solo para el entorno Live.
En la mayoría de los casos, solo configuras DNS para el entorno en vivo, no para Dev y Test. No debes usar los entornos de Dev (Desarrollo) o Test para la producción.
Para obtener más información, consulta la documentación de Pantheon aquí.
Agrega administradores del portal
Cuando recibas el correo electrónico de Apigee que indique que tu portal está listo, Apigee ya habrá configurado la lista de administradores del portal. Para ver esa lista, selecciona el vínculo Equipo en la esquina superior derecha del panel del sitio.
Para agregar más administradores, consulta Cómo crear usuarios administradores.
Creando una copia de seguridad de tu portal
Para crear una copia de seguridad de tu portal, usa la pestaña Copias de seguridad del panel de Pantheon. Puedes crear una copia de seguridad automática o a pedido. En Pantheon, una copia de seguridad consta de tres archivos separados: base de datos, archivos y código.
Para obtener más información, consulta Herramienta de copias de seguridad en la documentación de Pantheon.
Suscribirse a las actualizaciones de estado
Puedes suscribirte a las actualizaciones de estado y de lanzamiento de Apigee en status.apigee.com. Haz clic en Suscribirse a las actualizaciones, ingresa tu información de contacto, como la dirección de correo electrónico, cuando se te solicite y haz clic en Suscribirse. En la página de administración de notificaciones por correo electrónico, asegúrate de que esté seleccionada la opción Portal para desarrolladores, activa otras opciones de configuración de notificaciones según sea necesario y haz clic en Actualizar preferencias.
Puedes suscribirte a las actualizaciones de estado y a los informes de incidentes de Pantheon, como cuando se produce una interrupción, en http://status.getpantheon.com. Haz clic en Subscribe to Updates para registrarte.