<Nombre Proyecto>

Manual de Instalación

Versión: 0100

[Versión del Producto]

Queda prohibido cualquier tipo de explotación y, en particular, la reproducción, distribución, comunicación
pública y/o transformación, total o parcial, por cualquier medio, de este documento sin el previo
consentimiento expreso y por escrito de la Junta de Andalucía.
 <Nombre Proyecto>
<Unidad Organizativa>
Manual de Instalación

HOJA DE CONTROL
Organismo <Nombre Consejería u Organismo Autónomo>
Proyecto <Nombre Proyecto>
Entregable Manual de Instalación
Autor <Nombre de la Empresa>
Aprobado por Fecha Aprobación DD/MM/AAAA
Nº Total de Páginas 21

REGISTRO DE CAMBIOS

Versión Causa del Cambio Responsable del Cambio Fecha del Cambio
0100 Versión inicial <Nombre Apellido1 Apellido2> DD/MM/AAAA

CONTROL DE DISTRIBUCIÓN

Nombre y Apellidos
<Nombre Apellido1 Apellido2>

Página 2 de 21
 <Nombre Proyecto>
<Unidad Organizativa>
Manual de Instalación

ÍNDICE
1 INTRODUCCIÓN .............................................................................................................................................. 5
1.1 Objeto .......................................................................................................................................................... 5
1.2 Alcance ........................................................................................................................................................ 5
2 DESCRIPCIÓN DEL SISTEMA ........................................................................................................................ 6
2.1 Antecedentes y descripción funcional del sistema ....................................................................................... 6
2.2 Componentes fundamentales ....................................................................................................................... 6
2.3 Relación con otros sistemas ......................................................................................................................... 6
3 RECURSOS HARDWARE ................................................................................................................................. 7
3.1 Servidores .................................................................................................................................................... 7
3.2 Estaciones cliente ......................................................................................................................................... 7
3.3 Conectividad ................................................................................................................................................ 8
3.4 Restricciones ................................................................................................................................................ 8
4 RECURSOS SOFTWARE .................................................................................................................................. 9
4.1 Matriz de certificación ................................................................................................................................. 9
4.2 Restricciones técnicas del sistema ............................................................................................................... 9
4.3 Requisitos de otros sistemas ........................................................................................................................ 9
5 INSTALACIÓN Y CONFIGURACIÓN DEL SOFTWARE BASE ................................................................. 11
6 CONFIGURACIÓN DEL SISTEMA ............................................................................................................... 12
6.1 Configuración del sistema.......................................................................................................................... 12
6.2 Configuración de otros sistemas ................................................................................................................ 13
7 COMPILACIÓN DEL SISTEMA ..................................................................................................................... 14
8 INSTALACIÓN DEL SISTEMA ...................................................................................................................... 15
8.1 Requisitos previos ...................................................................................................................................... 15
8.2 Procedimiento de instalación ..................................................................................................................... 15
9 VERIFICACIÓN DEL PROCESO DE INSTALACIÓN .................................................................................. 17
10 MARCHA ATRÁS DE LA INSTALACIÓN Y CONFIGURACIÓN ............................................................. 18
10.1 Requisitos previos .................................................................................................................................... 18
10.2 Marcha atrás del sistema .......................................................................................................................... 18
10.3 Marcha atrás del software base ................................................................................................................ 19
11 ANEXOS ......................................................................................................................................................... 20
11.1 Resumen de tareas de configuración ........................................................................................................ 20
12 GLOSARIO..................................................................................................................................................... 21
13 BIBLIOGRAFÍA Y REFERENCIAS .............................................................................................................. 22

Página 3 de 21
 <Nombre Proyecto>
<Unidad Organizativa>
Manual de Instalación

1 INTRODUCCIÓN
1.1 Objeto
<Introduzca Contenido y borre cuadro>

Descripción del propósito del documento.

1.2 Alcance
<Introduzca Contenido y borre cuadro>

Unidades organizativas y responsabilidades a las que va dirigida el documento y que participan en

su generación, validación y registro según el modelo de MADEJA.

Página 4 de 21
 <Nombre Proyecto>
<Unidad Organizativa>
Manual de Instalación

2 DESCRIPCIÓN DEL SISTEMA

2.1 Antecedentes y descripción funcional del sistema
<Introduzca contenido y borre cuadro>

En este apartado se describirá la situación previa de la organización antes de la construcción del

sistema, así como los motivos que llevaron a la construcción del sistema de información. Además,
se describirá a alto nivel la funcionalidad que el nuevo sistema aporta o sustituye dentro de la
organización.
Se recomienda la utilización de diagramas en estilo libre para ilustrar la funcionalidad del nuevo
sistema.
2.2 Componentes fundamentales
<Cumplimente tabla y borre cuadro>

En este apartado se recogerán los principales módulos del sistema, incluyendo una pequeña
descripción de cada uno de ellos.

Módulo Descripción

2.3 Relación con otros sistemas

<Cumplimente tabla y borre cuadro>

En este apartado se deberán describir los otros sistemas con los que se relaciona el sistema y describir
dichas relaciones. Estos sistemas pueden ser utilizados para obtener información (registros, sistemas
de información geográfica....), para realizar acciones necesarias para nuestro sistema (programas de
cálculo, sistemas de cifrado...), para realizar tareas de soporte (gestión de agendas, generación de
informes...), etc.

Sistema Relación

Página 5 de 21
 <Nombre Proyecto>
<Unidad Organizativa>
Manual de Instalación

3 RECURSOS HARDWARE
3.1 Servidores
<Cumplimente tabla y borre cuadro>

Para cada uno de los servidores necesarios para la implantación del sistema (servidor de
aplicaciones, servidor de base de datos, servidor de archivos, etc.), se detallarán sus requisitos
hardware, diferenciando entre requisitos mínimos y recomendados.
Incluir una tabla para cada Servidor.
En caso de no tratarse de servidores virtuales, deberá justificarse en este apartado. Previamente de
deberá haber solicitado la creación de la máquina virtual mediante la plantilla correspondiente.

Servidor 1

Dato Valor mínimo Valor recomendado

Procesador

Memoria RAM

Tamaño Almacenamiento

Otros

3.2 Estaciones cliente

<Cumplimente tabla y borre cuadro>

Se detallarán los requisitos hardware de las estaciones cliente necesarios para la ejecución del
sistema, diferenciando entre requisitos mínimos y recomendados.

Dato Valor mínimo Valor recomendado

Procesador

Memoria RAM

Tamaño Almacenamiento

Otros

Página 6 de 21
 <Nombre Proyecto>
<Unidad Organizativa>
Manual de Instalación

3.3 Conectividad
<Cumplimente tabla y borre cuadro>

Se detallarán todos los requisitos mínimos y recomendados de recursos hardware de conectividad

entre servidores y estaciones cliente necesarios para la implantación. Para facilitar la comprensión,
se recomienda incluir el diagrama de despliegue correspondiente.

Dato Valor mínimo Valor recomendado

Tarjeta de Red

Tipo de Red

Otros

3.4 Restricciones
<Cumplimente tabla y borre cuadro>

En este apartado deben mostrarse todos aquellos aspectos, circunstancias, etc. que especifiquen las
limitaciones del elemento en cuanto a características, funcionamiento, acceso a otros productos, etc.

Restricción Detalle

Página 7 de 21
 <Nombre Proyecto>
<Unidad Organizativa>
Manual de Instalación

4 RECURSOS SOFTWARE
4.1 Matriz de certificación
<Introduzca contenido y borre cuadro>

Este apartado recogerá la compatibilidad de la versión del sistema objeto de la instalación, con las
distintas versiones de software base y componentes externos utilizados (máquina virtual Java,
servidor de aplicaciones, servidor de base de datos, LDAP, etc.).

4.2 Restricciones técnicas del sistema

<Cumplimente tabla y borre cuadro>

En este apartado se ofrecerá un listado completo de todos los recursos software necesarios para la
compilación, instalación y configuración del sistema. Como recursos más importantes podemos
destacar sistema operativo, servicios de red, servidor de aplicaciones, servidor de base de datos,
compilador, máquina virtual de java...
En los casos que se considere necesario, se deberá indicar la ubicación de los servidores a utilizar y
el modo de acceso a los mismos.

Elemento Descripción

Sistema operativo

Servidor de aplicaciones

Servidor de base de datos

Compilador

JVM

Otros

4.3 Requisitos de otros sistemas

<Cumplimente tabla y borre cuadro>

Página 8 de 21
 <Nombre Proyecto>
<Unidad Organizativa>
Manual de Instalación

En este apartado se describirán los requisitos existentes para la utilización de los distintos sistemas
con los que existen relaciones. Estos requisitos podrán administrativos (necesidad de alta en un
sistema, solicitud de permisos...), restricciones técnicas del sistema (restricciones de
comunicaciones, seguridad, transferencia de información...), etc.
Estos sistemas con los que existe relación pueden ser otros sistemas de la organización (gestión de
personal, inventarios, agenda...), sistemas horizontales de la Junta de Andalucía (@firma, @ries,
Trew@...) o sistemas externos (sistemas de información geográfica, servidores de noticias...).
Se cumplimentará una tabla para cada sistema con los que existan relaciones.
Como ejemplo, este sería un ejemplo de alta en @ries:

@ries

Descripción Sistema de registro telemático de la Junta de Andalucía

Funcionalidad utilizada Se utilizarán los servicios de registro de documentos y ficheros.

Solicitud de alta de aplicación en @ries, cumplimentando el
Requisito administrativo 1
documento de registro que se puede obtener en la url...
Requisito administrativo 2
Si se anexan ficheros, es necesario tener acceso vía FTP al servidor
Restricción técnica 1
proporcionado por @ries.
Sólo se tendrá comunicación con @ries desde las IPs indicadas en
Restricción técnica 2
la solicitud.

<Sistema 1>

Descripción

Funcionalidad utilizada

Requisito formal 1

...

Requisito técnico 1

...

Requisito de comunicación 1

...

Otros

Página 9 de 21
 <Nombre Proyecto>
<Unidad Organizativa>
Manual de Instalación

5 INSTALACIÓN Y CONFIGURACIÓN DEL SOFTWARE BASE

<Inserta comentario y eliminar cuadro>

Entendemos por software base, aquel del que depende directamente el sistema para su correcta
compilación, instalación y funcionamiento. Dentro de lo que se identifica típicamente como
software base tenemos el entorno de compilación, el servidor de aplicaciones, el servidor de base de
datos y la máquina virtual de java. Adicionalmente pueden existir otros en función de las
características de nuestro sistema.
En este apartado se describirá el procedimiento de instalación del software base. Para cada uno de
los componentes software utilizados se indicará una pequeña descripción del software, la
localización en la que se puede obtener, la descripción detallada de todos los pasos que componen
su instalación, el procedimiento de configuración y los parámetros a configurar. Toda esta
información se cumplimentará en la tabla adjunta (se incluirá una tabla para cada componente
software).
En caso de que sea necesario realizar alguna configuración adicional en otro software (Sistema
Operativo, sistema de almacenamiento...), se realizará igualmente en este apartado.

<Software Base 1>

Descripción

Localización

Procedimiento de instalación

Paso 1

Paso 2

...

Procedimiento de configuración

Paso 1

Paso 2

...

Parámetros a configurar

Parámetro 1 [Ubicación (BBDD, fichero xml, properties...)] [Valor]

Parámetro 2 [Ubicación (BBDD, fichero xml, properties...)] [Valor]

... ... ...

Página 10 de 21
 <Nombre Proyecto>
<Unidad Organizativa>
Manual de Instalación

6 CONFIGURACIÓN DEL SISTEMA

6.1 Configuración del sistema
< Cumplimentar tabla y eliminar cuadro>

En este apartado se detallará la configuración que se llevará a cabo durante la implantación del
sistema. Diferenciaremos entre la configuración que es necesario realizar inicialmente, durante la
compilación, durante la instalación y despliegue y al final del proceso. Las configuraciones
correspondientes a las fases de compilación e instalación y despliegue serán referenciadas desde los
apartados correspondientes.
Para cada configuración a realizar se indicará el elemento a configurar, el efecto de la configuración,
la ubicación en la que realiza la configuración y una descripción detallada de las acciones a llevar a
cabo y los valores a establecer. Esta información se estructurará en forma de tabla.
Como ejemplo, se muestra la configuración de los parámetros de conexión a base de datos:

Configuración: Datasource

Efecto Se establecen los parámetros de conexión a base de datos.

Fase Configuración final después del despliegue.

Ubicación Fichero [directorio de despliegue]/WEB-INF/bd.properties

Paso Descripción
Asegurarse de que la aplicación está correctamente desplegada y de que el servidor de
1º
aplicaciones está parado.
Editar el archivo de configuración indicado y establecer los siguientes valores:
• cad_conexion: jdbc:oracle:thin:@127.0.0.1:1521:MIBD
• driver: oracle.jdbc.driver.OracleDriver
2º
• nombre: jdbc/conexion
• usuario: user
• password: pass
3º Guardar el archivo.

Configuración: <Elemento a configurar>

Efecto

Fase

Ubicación

Paso Descripción

1º

2º

Página 11 de 21
 <Nombre Proyecto>
<Unidad Organizativa>
Manual de Instalación

3º

4º

6.2 Configuración de otros sistemas

<Cumplimente tabla y borre cuadro>

En este apartado se describirá el procedimiento y los requisitos de configuración e instalación (en

los casos que sea necesario) de aquellos sistemas que, sin ser software base, son utilizados por
nuestro sistema.
La instalación y configuración de estos sistemas se especificará mediante una tabla similar a la
utilizada en el apartado de instalación y configuración del software base.

<Otro sistema 1>

Descripción

Localización

Procedimiento de instalación

Paso 1

Paso 2

...

Procedimiento de configuración

Paso 1

Paso 2

...

Parámetros a configurar

Parámetro 1 [Ubicación (BBDD, fichero xml, properties...)] [Valor]

Parámetro 2 [Ubicación (BBDD, fichero xml, properties...)] [Valor]

... ... ...

Página 12 de 21
 <Nombre Proyecto>
<Unidad Organizativa>
Manual de Instalación

7 COMPILACIÓN DEL SISTEMA

< Cumplimentar tabla y eliminar cuadro>

En este apartado de describirán todos los requisitos existentes y las tareas a realizar para la correcta
compilación del sistema. Como requisitos generales, deben cumplirse todas las indicaciones
referentes a construcción y compilación del software que estén recogidas en la normativa técnica.
Es particularmente importante el cumplimiento de todo lo referente a normativa Maven.
La información mínima necesaria para la compilación incluye la ubicación de los fuentes, la
configuración del proyecto Maven (profiles, plugins...), los repositorios a partir de los cuales se
obtendrán los recursos necesarios, las dependencias del proyecto y el producto final generado (war,
jar...).
Finalmente se describirán detalladamente todas las acciones a realizar en el proceso de compilación,
desde la obtención de los ficheros fuente hasta la obtención del producto final, pasando pro la
ejecución de comandos de configuración y compilación.
En caso de que sea necesario realizar alguna configuración, se hará referencia a la descripción
realizada en el apartado 6 de este documento.

Requisitos de compilación

Requisito Descripción

Ubicación Fuentes

Configuración 1

...

Repositorio 1

...

Dependencia 1

...

Producto final

Procedimiento de compilación

Paso Descripción

Página 13 de 21
 <Nombre Proyecto>
<Unidad Organizativa>
Manual de Instalación

8 INSTALACIÓN DEL SISTEMA

< Cumplimentar tabla y eliminar cuadro>

En este apartado se recogerá la información necesaria para realizar la instalación del sistema,
prestando especial interés a los requisitos previos así como el detalle de las acciones secuenciales
necesarias para llevarla a cabo.

8.1 Requisitos previos

< Cumplimentar tabla y eliminar cuadro>

En este apartado se incluye la información de todo los requerimientos previos al inicio del proceso
de instalación. En aquellos casos en los que la información se recoja en otro apartado de este
documento, será suficiente incluir una referencia.
Como requisitos previos de la instalación destacan:
• Los ficheros y recursos que se van a utilizar.
• La ubicación de los servidores que hay que utilizar y el modo de acceso a los mismos.
• Software previamente instalado.
• Requisitos de comunicación con otras plataformas previos para la aplicación.
• Altas necesarias en otra aplicaciones (siempre si son previas a la instalación del producto).
• Posibles desinstalaciones o paradas de sistemas con los que entraría en conflicto
• etc.

8.2 Procedimiento de instalación

< Cumplimentar tabla y eliminar cuadro>

En este apartado se incluirá una descripción detallada y completa y en orden secuencial de todas las
tareas que hay que realizar. Para cada acción, se deberá indicar claramente tipo de acción
(configuración copia de ficheros, despliegue...), los componentes implicados (fichero war, scripts
de base da datos...) y los permisos necesarios para llevar a cabo la acción (permisos de
administración en el servidor de aplicaciones, propietario del esquema de base de datos...).
En caso de que se realice una instalación desde 0 habrá que incluir una referencia al apartado 5 de
este documento. Si en cambio la instalación se realiza a partir del software base, un requisito previo
será la instalación de dicho software base.
Por otro lado, en caso de que sea necesario realizar alguna configuración, se hará referencia a la
descripción realizada en el apartado 6 de este documento.

Página 14 de 21
 <Nombre Proyecto>
<Unidad Organizativa>
Manual de Instalación

Procedimiento de instalación

Paso 1

Tipo

Componente

Permisos

Descripción

Paso 2

Tipo

Componente

Permisos

Descripción

Página 15 de 21
 <Nombre Proyecto>
<Unidad Organizativa>
Manual de Instalación

9 VERIFICACIÓN DEL PROCESO DE INSTALACIÓN

< Introducir contenido y eliminar cuadro>

En este apartado se recogerán las comprobaciones mínimas que deberán realizarse una vez realizado
el despliegue para asegurar la correcta configuración e instalación del sistema (acceso al sistema,
funcionalidad básica, comunicación con los diferentes sistemas externos, etc.).

Página 16 de 21
 <Nombre Proyecto>
<Unidad Organizativa>
Manual de Instalación

10 MARCHA ATRÁS DE LA INSTALACIÓN Y CONFIGURACIÓN

10.1 Requisitos previos
<Insertar comentario y eliminar cuadro>

Se debe comentar cualquier tipo de requisito previo que deba tenerse en cuenta antes de realizar
la marcha atrás.

10.2 Marcha atrás del sistema

< Cumplimentar tabla y eliminar cuadro>

En este apartado se describirá la secuencia de tareas que hay que realizar en el caso de querer
desinstalar y dar marcha atrás a la instalación y configuración del sistema. Todas las tareas deben
describirse detalladamente indicando para cada una de ellas, el tipo de tarea (modificación de
configuración, ejecución de un comando, ejecución de scripts...), el componente implicado
(aplicación, script de base de datos...) y los permisos necesarios para llevar a cabo la acción
(permisos de administración en el servidor de aplicaciones, propietario del esquema de base de
datos...).

Procedimiento de marcha atrás

Paso 1

Tipo

Componente

Permisos

Descripción

Paso 2

Tipo

Componente

Permisos

Descripción

10.3 Marcha atrás del software base

<Insertar comentario y eliminar cuadro>

Página 17 de 21
 <Nombre Proyecto>
<Unidad Organizativa>
Manual de Instalación

En este apartado se desglosará la secuencia de tareas que hayan de realizarse para desinstalar y dar
marcha atrás a la instalación y configuración del software base. La información será desglosada por
tipo de software base y localización.

Página 18 de 21
 <Nombre Proyecto>
<Unidad Organizativa>
Manual de Instalación

11 ANEXOS
<Introduzca contenido y borre cuadro>

Este punto contendrá toda aquella información de interés para la elaboración y validación del
Manual de Instalación.

11.1 Resumen de tareas de configuración

<Introduzca contenido y borre cuadro>

En este apartado se incluirá, a modo de resumen, un listado con los elementos de configuración que
hay que actualizar para la correcta puesta en marcha del sistema en el entorno deseado. El detalle de
los pasos para configurar cada uno de los componentes, así como la fase en la que deberá realizarse,
vendrá especificado en el apartado 'Configuración del Sistema'.

Página 19 de 21
 <Nombre Proyecto>
<Unidad Organizativa>
Manual de Instalación

12 GLOSARIO
<Insertar comentario y eliminar cuadro>
Este punto contendrá la definición de todos los términos utilizados en el presente documento.

Término Descripción

Página 20 de 21
 <Nombre Proyecto>
<Unidad Organizativa>
Manual de Instalación

13 BIBLIOGRAFÍA Y REFERENCIAS
<Insertar comentario y eliminar cuadro>

En este punto se incluirán las referencias a la documentación utilizada para la elaboración del
presente documento.

Referenci
Título Código
a
Ref. 1

Página 21 de 21