Instrucciones de creación de documentación
En las siguientes secciones todo el texto marcado con el siguiente color y en cursiva corresponde a información que debe cumplimentarse.
Resumen y patrón de diseño
Requerido
Se aceptan referencias a otras páginas siempre que sea públicas a todos los usuarios de Confluence utilizando la macro ‘Inclusión de extracto’.
Se resume en esta sección los patrones y arquetipos de diseño del software a implantar, ofreciendo una visión preliminar de la solución incluyendo si aplicase las diferentes secciones en las cuales se particiona la solución. (monolítico, modular, MVC, rutas, apificaciones, PaaS ready, microservicios..)
Diagrama de componentes y procesos
Requerido
Se aceptan referencias a otras páginas siempre que sea públicas a todos los usuarios de Confluence utilizando la macro ‘Inclusión de extracto’.
- Se recomienda el uso del programa Modelio (Open Source y compatible con Windows, Linux y MacOS) para generar los diagramas de modelado de la solución
- Se recomienda incluir el fichero original para futuras ediciones más allá del formato de imagen incrustado en este documento
Diagrama de componentes a alto nivel en notación UML:
Enlace al fichero original: UML Component Diagram.pptx
En la tabla siguiente se describen los componentes del sistema:
Componente | Propósito | Interacciones / Interfaces | Elemento Software y versión (si aplica) |
|---|---|---|---|
| Facilities | Gestión de salas y otros materiales (recursos) necesarios para las formaciones. | Se utiliza desde la gestión de Seminarios. Obtiene los permisos de cada usuario a cada recurso a través del módulo de seguridad. | n/a |
| Schedule | Gestión de calendarios. | Se utiliza tanto desde la gestión de estudiantes como de seminarios. | Basado en webcalendar (http://webcalendar.sourceforge.net/demo/month.php) versión 1.2.7. |
Condiciones de disparo de procesos
Requerido
Se aceptan referencias a otras páginas siempre que sean públicas a todos los usuarios de Confluence utilizando la macro ‘Inclusión de extracto’.
Esta sección define las condiciones de disparo de los diferentes procesos que implementa la solución. Estas condiciones no están sujetas a un origen concreto.
| Condición | Proceso | Interface | Comentarios |
|---|---|---|---|
| Invocación por parte del usuario a través del proceso Frontend | Facilities | Listener Web HTTP | Se prevé concurrencia alta de peticiones debido a los métodos de notificación que implementa Frontend |
| Invocación por parte del usuario a través del navegador | Frontend | Listener Web HTTP | Se prevé concurrencia baja debido al metadatado de caché. |
| Invocación programada todos los días a las 4h UTC | Statistics | Listener Web HTTP Webhook | Evento de generación de estadísticas sobre el uso de la plataforma. |
Framework, sistemas de construcción y empaquetado
Requerido
Se aceptan referencias a otras páginas siempre que sea públicas a todos los usuarios de Confluence utilizando la macro ‘Inclusión de extracto’.
- Se detallará en esta sección si aplicase el framework el utilizar o supeditado al producto que se implante en los diferentes componentes del diseño de la solución.
- Al mismo tiempo, se extenderá esta información con referencias al orquestador de construcción y empaquetado (maven, ant, gradle, rake, etc). Detallando especialmente el formato del artefacto resultante.
Requisitos específicos de implementación
Opcional
Se aceptan referencias a otras páginas siempre que sean públicas a todos los usuarios de Confluence utilizando la macro ‘Inclusión de extracto’.
Se utilizan los servicios de XXXX de PROVEEDOR en la/s cuenta/s de XXXX.
| Nombre del servicio | Región | Tipo | Función |
|---|---|---|---|
| Santillana-Global | NA | Member | Para servicios globales |
| Santillana-ProyectoA | Ireland | Member | Entorno Producción |
| Santillana-ProyectoA-NonProd | Ireland | Member | Resto de entornos del Proyecto (excepto producción) |
PROVEEDOR realizará la implementación y la posterior operación del servicio.
El proyecto incluye los entornos XXX, YYY, ZZZ.
El ciclo de vida de despliegue sigue el patrón WWW.
Requisitos de seguridad e identidad
Requerido
Se aceptan referencias a otras páginas siempre que sea públicas a todos los usuarios de Confluence utilizando la macro ‘Inclusión de extracto’.
| Tipo de requisito | Consideraciones |
|---|---|
Acceso como usuario (front & back) | El acceso como usuario a la aplicación se realizará por usuarios autenticados en el dominio [o dentro de la aplicación]. |
Gestión de datos | La aplicación [no] gestiona datos sensibles de carácter personal. El nivel de confidencialidad asignado es XXX.[MG1] |
| Acceso desde otros servicios o sistemas | La aplicación necesita protección mediante un WAF que limitará el acceso a los puertos y máquinas mínimos necesarios para prestar el servicio. La aplicación podrá acceder a ciertos servicios dentro de la red interna, para lo que se definirán las IPs y subredes permitidas y se definirán los grupos de seguridad dentro de la subred. No existirán accesos IP externos para las máquinas de producción, exceptuando el tráfico que atraviese el WAF. |
Acceso a la infraestructura | El acceso a la infraestructura se realizará a través de bastión. |
DDoS | Etc. |
Monitorización y gestión de trazas | Etc. |
Escaneo y pruebas de seguridad | Etc. |
Hardening | Etc. |
Encriptación | Etc. |
Requisitos de volumetría
Requerido
Se aceptan referencias a otras páginas siempre que sea públicas a todos los usuarios de Confluence utilizando la macro ‘Inclusión de extracto’.
- Anotar requerimientos de volumetría a nivel de persistencia de datos y archivos (BBDD, NoSQL, Disco)
- Anotar de forma independiente los requerimientos de almacenamiento efímero (temporales)
- Si se cuenta con gestión de datos en memoria o cachés identificadas, se recomienda anotarlo.
| Proceso | Requerimiento | Justificación |
|---|---|---|
| Statistics |
| El proceso de estadísticas genera información estimada que ocupará un espacio menor a 100Gb que pondrán ser consultados desde el interface de usuario. Así mismo, se generarán archivos recuperables de estas estadísticas por 400Gb. |
Requisitos de conectividad
Opcional
Se aceptan referencias a otras páginas siempre que sea públicas a todos los usuarios de Confluence utilizando la macro ‘Inclusión de extracto’.
Más allá de los requisitos de conectividad entre los diferentes procesos/componentes de la solución, los siguientes elementos, requieren de conectividad con orígenes remotos implantados fuera del alcance de este proyecto.
| Proceso/Componente | Tipo de conexión | Datos de conexión | Justificación |
|---|---|---|---|
| Statistics | Webservice REST remoto | Envío de información estadística para integrar. | |
| User | Webservice REST remoto | Envío de actualizaciones de perfil de usuario. | |
Dependencias de ejecución
Requerido
Se aceptan referencias a otras páginas siempre que sea públicas a todos los usuarios de Confluence utilizando la macro ‘Inclusión de extracto’.
Esta sección describe las dependencias con otros sistemas o servicios:
| Sistema Origen | Sistema Destino | Disparador | Tipo de Interfaz | Alcance de la interfaz |
|---|---|---|---|---|
| Google Maps | Vendor | Browsers + app | JSON | There’s no interface here, just a Google Maps for Work contract with Google whereby we include a Carlson client-id for all our Google maps API requests. Carlson to provide all the relevant source code surrounding the current mapping implementation to Vendor. Carlson continues to fund and maintain the Google maps contract. |
| Google Analytics 360 | Vendor | Browsers + app | JavaScript | Part of tagging implementation. |
Licenciamiento de componentes de terceros
Opcional
Se aceptan referencias a otras páginas siempre que sea públicas a todos los usuarios de Confluence utilizando la macro ‘Inclusión de extracto’.
| Componente | Fabricante | Licencia / Modalidad | Cantidad / Entornos | Periodicidad / Límite de uso | Contacto de referencia en Santillana |
|---|---|---|---|---|---|
| Windows Server 2008R2 | Microsoft | Standard Edition + Sotware Assurance + 2 Windows Server CAL | PROD: 2 PRE: 2 DEV: 1 | Software Assurance | |
| Oracle Standard Edition 2 | Oracle | Processor License | PROD: 1 PRE : 1 | Perpetual + Yearly software update | |
Modelo de datos
Opcional
Se aceptan referencias a otras páginas siempre que sea públicas a todos los usuarios de Confluence utilizando la macro ‘Inclusión de extracto’.
- En caso de utilizarse un modelo de persistencia de datos, será necesario detallar resumidamente las entidades y relaciones entre datos, así como las necesidades de indexación. En caso de incluirse gráficos, es obligatoro incluir también el fichero fuente para facilitar futuras actualizaciones.
- Si se prevé que el modelo de datos incluya también lógica de negocio a través de funciones y/o procedimientos almacenados, es necesario indicar cuales de los procesos se ejecutaran por el motor de base de datos.
Resumen del modelo de datos que se utilizará contabilizando las tablas e índices.
Diagrama de la BD o del modelo de persistencia si aplicara.
Mantenimientos de datos
Opcional
Se aceptan referencias a otras páginas siempre que sea públicas a todos los usuarios de Confluence utilizando la macro ‘Inclusión de extracto’.
- En caso de contar con operaciones de mantenimiento a nivel de la persistencia de datos marcadas por la solución, será necesario realizar un resumen de las operaciones a realizar y las condiciones en las cuales deben ser ejecutadas como archivado, particionado o purgado de información.
Resumen de procedimientos operativos para el mantenimiento de los volúmenes de datos persistido por la aplicación.
Trazabilidad y acceso
Requerido
Se aceptan referencias a otras páginas siempre que sea públicas a todos los usuarios de Confluence utilizando la macro ‘Inclusión de extracto’.
- Se recomienda que las soluciones contemplen flujos de información que envíen el registro de operaciones internas a destinos desacoplados de la persistencia de los datos de negocio.
- En el caso de tener diferentes niveles de auditoría y/o diferentes orígenes de esta auditoría, se trataran de almacenar de forma conjunta con el resto de información de registros de explotación.
Orígenes de datos que envían los componentes para trazar la actividad de cualquier tipo.
| Proceso | Nombre de traza | Mecanismo de envío de traza | Formato | Descripción |
|---|---|---|---|---|
| Statistics | statistics-processing-log-debug | syslog | Cadena sin timestamp | Traza de registro de las ejecuciones del proceso de recolección de estadísticas |
Grupos de alarmado
Requerido
Se aceptan referencias a otras páginas siempre que sea públicas a todos los usuarios de Confluence utilizando la macro ‘Inclusión de extracto’.
Información adicional
Los siguientes grupos de alarmado son adicionales a los grupos de alarmado establecidos por el servicio de explotación.
La siguiente tabla describe los diferentes grupos que reciben información proveniente de eventos de que ocurren en explotación:
| Grupo | Contactos | Rol del grupo de alarmado | Nombre de traza | Umbrales o substring de detección de alarma |
|---|---|---|---|---|
| Statistics-ERROR | @Fulanito | Gestiona errores de ejecución y consolida información en caso de ser necesario | statistics-processing-log-debug | Substring: ERROR |
Instrucciones operativas de la solución
Requerido
Se aceptan referencias a otras páginas siempre que sea públicas a todos los usuarios de Confluence utilizando la macro ‘Inclusión de extracto’.
- Indicar instrucciones operativas para el funcionamiento de la solución tales como orden de arranque o parada de servicios o componentes, parámetros de configuración necesarios en explotación o la configuración de red necesaria para el correcto funcionamiento.
- Las operativas relativos a los datos ya se han descrito en apartados anteriores.
Las siguientes instrucciones operativas son necesarias para la gestión de la solución en un entorno de explotación:
Estado del documento
PLANTILLA
| Version | Date | Comment |
|---|---|---|
| Current Version (v. 1) | May 21, 2019 06:32 | Xavier Kiran López Rubi |
| v. 1 | May 21, 2019 06:32 | Xavier Kiran López Rubi |