Guía de Uso de Consola de Operación

ES | EN

Disponible a partir de versión 2.2.0-hyperblast

Introducción

La Consola de Operación es una nueva herramienta construida con el objetivo de ayudar a los equipos que construyen su solución sobre Onesait Platform a gestionar de una forma sencilla y sin necesidad de un conocimiento previo sobre estas tecnologías.

  • El despliegue de Plataforma y de los servicios construidos sobre esta

  • La Monitorizacion de la Plataforma y de los servicios

  • Los costes asociados tanto a nivel de Infraestructura como de Plataforma.

Esta herramienta está desarrollada sobre la Onesait Platform y en la primera versión nos permite:

  • Que los Product Owners puedan gestionar sus proyectos

  • Que los PO y Arquitectos puedan desplegar una versión de Plataforma y sus microservicios (así como actualizarlos, arrancarlos, pararlos) sobre OpenShift.

  • Monitorizar el estado de una instalación.

Resumiendo esta herramienta centraliza en un único punto todo lo relacionado con un proyecto o producto sus despliegues, actualizaciones, monitorización, gestión de la suscripción, facturación…

¿Cómo trabajar con la herramienta?

A continuación se van a detallar las funcionalidades que abarca la primera versión de la Consola. Se puede acceder a la herramienta a través de este enlace

Acceso a la herramienta

Desde el login de la herramienta se puede acceder al formulario de creación de usuarios, a través del botón Sign Up!

Una vez creado el usuario, será necesario enviar una petición al equipo de soporte para la creación de nuestro proyecto, a través del email support@onesaitplatform.com. En esta petición habrá que incluir la siguiente información:

  • Nombre del proyecto

  • Breve descripción

  • Correo electrónico de contacto

  • Código de proyecto

  • Fecha aproximada de inicio y fin del proyecto

  • Listado de los entornos necesarios (dev, demo, pre…)

  • Listado de usuarios que tendrán acceso al proyecto (nombre de usuario, correo electrónico y rol)

Una vez creado el proyecto por parte del equipo de soporte, el usuario podrá acceder a él a través de la página principal de la herramienta, logándonos con cualquiera de los usuarios asociados a dicho proyecto:

Despliegue de Onesait Platform

Un usuario registrado en la Consola podrá hacer un despliegue de plataforma (siempre que sea el responsable de un PO y pueda solicitar un namespace en OpenShift).

A continuación vamos a mostrar cómo se puede desplegar una versión de la Onesait Platform a través de esta herramienta. Para ello seleccionamos Show Project del proyecto que queremos gestionar y accederemos a la ficha del proyecto:

Dentro de la ficha del proyecto tenemos un listado con los entornos disponibles:

El primer paso para desplegar la Plataforma o cualquier microservicio en un entorno es la creación del namespace en el caso de que no exista. Para ello es necesario lanzar una petición al equipo de soporte a través del formulario que aparecerá al seleccionar el botón NUEVO NAMESPACE:

Una vez el equipo de soporte nos notifique que el namespace se ha creado con éxito, podemos desplegar la Onesait Platform en dicho entorno. Para ello seleccionaremos el botón Desplegar:

Y seleccionaremos Onesait Platform:

Accederemos al asistente que nos permitirá realizar el despliegue de la Platforma en el entorno demo, después de aceptar que dicha operación conllevará costes asociados al código del proyecto.

Selección del entorno

El primer paso es seleccionar el entorno del proyecto en el cual queremos desplegar la Plataforma, para ello tendremos que seleccionar:

  • Entorno

  • Nombre del proyecto: por defecto <proyecto>.<entorno>

  • Versión a desplegar: versión de la Plataforma que se quiere desplegar

Una vez configurado la selección del entorno y la versión, se pulsa sobre el botón Siguiente.

Bases de Datos

El siguiente paso es configurar las bases de datos que necesita la Plataforma para funcionar, tenemos dos modalidades:

  • Contenerizadas: las bases de datos se despliegan como contenedores Docker dentro del cluster Kubernetes.

  • Sin contenerizar: las bases de datos se encuentran en una VM externa y por ello es necesario indicar los parámetros de configuración.

    • Para la ConfigDB es necesario indicar las URLs de la MasterDB, ConfigDb y SchedulerDB, así como el usuario y la contraseña.

    • Para la RealTimeDB sobre MongoDB, es necesario indicar las URLs de la replica set de MongoDB, siendo obligatoria al menos una, el usuario y la contraseña.

Una vez configuradas las bases de datos, se selecciona Siguiente

Módulos Onesait Platform

A continuación se seleccionarán los módulos de la Plataforma que se quieren desplegar. Por defecto aparecerán seleccionados los módulos mínimos para el funcionamiento de la Plataforma.

Una vez seleccionados los módulos, se pulsa sobre Siguiente y aparecerá un resumen con la configuración de nuestro despliegue:

Seleccionando el botón Desplegar se lanzará el despliegue de la Plartaforma sobre Openshift. Recibirás un email cuando finalice el despliegue.

En el este vídeo puedes ver el proceso de despliegue.

El despliegue puede tardar del orden de 15 - 20 minutos

Despliegue de microservicios

Desde esta herramienta también se puede realizar el despliegue de microservicios externos a Plataforma, para que los proyectos puedan desplegar aquí sus desarrollos. Del mismo modo que la Plataforma, los microservicios se desplegarán a nivel de entorno, por lo que para desplegar cualquier microservicio primero tiene que existir el namespace asociado a dicho entorno.

En este caso al seleccionar la opción Desplegar del listado de entornos, seleccionaremos la opción Custom Deployment:

Accederemos al asistente que nos permitirá realizar el despliegue del microservicio en el entorno demo, después de aceptar que dicha operación conllevará costes asociados al código del proyecto.

Selección del entorno

El primer paso es seleccionar el entorno del proyecto dónde se quiere realizar el despliegue y la configuración necesaria para el mismo:

  • Nombre de la aplicación

  • Puerto en el que se arrancará el microservicio

  • Repositorio docker de dónde se descargará la imágen

  • Usuario y contraseña del repositorio docker de ser necesario

  • Imagen y tag que se va a desplegar

Actualmente el repositorio Docker se establece por defecto, en próximas versiones será posible configurarlo desde este formulario.

Una vez configurado el microservicio se pulsa sobre Siguiente

Variables de entorno

A continuación se configuran las variables de entorno, de ser necesarias, para el despliegue del microservicio. Pudiéndose añadir tantas como sean necesarias a través del botón Add property

Pulsando sobre Siguiente se mostrará un resumen con la configuración del microservicio:

Con el botón Desplegar se lanzará el despliegue del microservicio en el namespace del entorno seleccionado.

Arranque y parada de módulos de Plataforma

El arranque y parada de módulos de una instalación de Plataforma puede tener impacto sobre el precio de la suscripción.

Una vez desplegada y arrancada la Plataforma, la herramienta nos permite arrancar y parar módulos a voluntad. Hay que recordar que al lanzar el despliegue ya se seleccionaron los módulos que se querían desplegar, pero puede surgir la necesidad de arrancar o parar distintos módulos según la necesidad del proyecto.

Desde el listado de entornos de la ficha del proyecto podremos acceder al arranque y parada de módulos a través de la siguiente opción:

Aparecerá un listado con los módulos y el estado, pudiendo ser el estado:

  • Stopped: módulo parado

  • Started: módulo arrancado

  • Pending: módulo arrancando

  • Error: módulo que no ha arrancado bien

Con los botones de la columna de la derecha se pueden arrancar o parar los módulos deseados, pudiéndose refrescar el estado de los módulos a través del botón Recargar.

Utilizaremos el botón Volver para volver al listado de módulos.

El arranque y parada de los módulos puede tardar varios minutos.

Monitorización

A través de la herramienta se puede consultar la monitorización de cada entorno de un proyecto. Para ello basta con seleccionar la opción Monitorización del listado de entornos:

Se abrirá un panel con la monitorización, donde se podrá consultar el estado de cada módulo de Plataforma, así como de los microservicios desplegados en dicho entorno:

Actualización de versión de Onesait Platform

A través de la Consola de Gobierno se puede solicitar al equipo de soporte la actualización de la versión de una instancia de la Plataforma ya desplegada sobre un entorno.

Para ello seleccionaremos el botón Actualizar del listado de entornos del proyecto:

Aparecerá un formulario que lanzará la petición de la actualización, dónde tendremos que indicar la versión de Plataforma a la que queremos actualizar y un breve mensaje si lo deseamos.

Una vez realizada la tarea de la actualización por parte del equipo de soporte, se notificará al usuario en cuestión.

Desinstalación/Eliminación de un despliegue previo.

Por último, también es posible realizar la desinstalación/eliminación tanto de un despliegue de Plataforma como de un microservicio de un entorno. Para ello seleccionamos el boton Eliminar del listado de entornos del proyecto:

Aparecerá un listado con los servicios desplegados en el entorno, seleccionando un servicio aparecerá la opción de Borrar.

Al desinstalar una instancia de Plataforma se perderán todos los desarrollos realizada sobre la misma.

Generación de Tickets

A través de la ficha de cada proyecto, esta herramienta nos permite dar de alta Tickets sobre posibles incidencias o consultas de Plataforma.

Seleccionando el botón Ticket aparecerá un formulario, dónde tendremos que indicar el entorno y un mensaje descriptivo sobre la consulta o problema.