<Nombre Proyecto>

Manual de Instalacin

Versin: 0100

[Versin del Producto]

Queda prohibido cualquier tipo de explotacin y, en particular, la reproduccin,
distribucin, comunicacin pblica y/o transformacin, total o parcial, por cualquier
medio, de este documento sin el previo consentimiento expreso y por escrito de la
Junta de Andaluca.

<Nombre Proyecto>

<Unidad Organizativa>

Manual de Instalacin

HOJA DE CONTROL
Organismo

<Nombre Consejera u Organismo Autnomo>

Proyecto

<Nombre Proyecto>

Entregable

Manual de Instalacin

Autor

<Nombre de la Empresa>

Aprobado por

Fecha Aprobacin
N
Total
Pginas

de

DD/MM/AAAA
22

REGISTRO DE CAMBIOS
Versi
n

Causa del Cambio

Responsable del Cambio

Fecha del
Cambio

0100

Versin inicial

<Nombre Apellido1 Apellido2>

DD/MM/AAAA

CONTROL DE DISTRIBUCIN
Nombre y Apellidos
<Nombre Apellido1 Apellido2>

Pgina 2 de 22

<Nombre Proyecto>
Manual de Instalacin

<Unidad Organizativa>

NDICE
1 INTRODUCCIN............................................................................................................... 5
1.1 Objeto....................................................................................................................... 5
1.2 Alcance..................................................................................................................... 5
2 DESCRIPCIN DEL SISTEMA............................................................................................ 6
2.1 Antecedentes y descripcin funcional del sistema................................................... 6
2.2 Componentes fundamentales................................................................................... 6
2.3 Relacin 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 certificacin.............................................................................................. 9
4.2 Restricciones tcnicas del sistema........................................................................... 9
4.3 Requisitos de otros sistemas.................................................................................... 9
5 INSTALACIN Y CONFIGURACIN DEL SOFTWARE BASE................................................ 11
6 CONFIGURACIN DEL SISTEMA..................................................................................... 12
6.1 Configuracin del sistema...................................................................................... 12
6.2 Configuracin de otros sistemas............................................................................. 13
7 COMPILACIN DEL SISTEMA.......................................................................................... 14
8 INSTALACIN DEL SISTEMA........................................................................................... 15
8.1 Requisitos previos.................................................................................................. 15
8.2 Procedimiento de instalacin.................................................................................. 15
9 VERIFICACIN DEL PROCESO DE INSTALACIN............................................................. 17
10 MARCHA ATRS DE LA INSTALACIN Y CONFIGURACIN............................................ 18
10.1 Requisitos previos................................................................................................ 18
10.2 Marcha atrs del sistema...................................................................................... 18
10.3 Marcha atrs del software base............................................................................ 19
Pgina 3 de 22

<Nombre Proyecto>
Manual de Instalacin

<Unidad Organizativa>

11 ANEXOS....................................................................................................................... 20
11.1 Resumen de tareas de configuracin.................................................................... 20
12 GLOSARIO................................................................................................................... 21
13 BIBLIOGRAFA Y REFERENCIAS.................................................................................... 22

Pgina 4 de 22

<Nombre Proyecto>
Manual de Instalacin

<Unidad Organizativa>

1 INTRODUCCIN
1.1

Objeto

<Introduzca Contenido y borre cuadro>

Descripcin del propsito 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 generacin, validacin y registro segn el modelo de
MADEJA.

Pgina 5 de 22

<Nombre Proyecto>
Manual de Instalacin

<Unidad Organizativa>

2 DESCRIPCIN DEL SISTEMA

2.1

Antecedentes y descripcin funcional del

sistema

<Introduzca contenido y borre cuadro>

En este apartado se describir la situacin previa de la organizacin antes de
la construccin del sistema, as como los motivos que llevaron a la
construccin del sistema de informacin. Adems, se describir a alto nivel la
funcionalidad que el nuevo sistema aporta o sustituye dentro de la
organizacin.

2.2

Componentes fundamentales

<Cumplimente tabla y borre cuadro>

En este apartado se recogern los principales mdulos del sistema,
incluyendo una pequea descripcin de cada uno de ellos.

Mdulo

2.3

Descripcin

Relacin con otros sistemas

<Cumplimente tabla y borre cuadro>

En este apartado se debern describir los otros sistemas con los que se
relaciona el sistema y describir dichas relaciones. Estos sistemas pueden ser
utilizados para obtener informacin (registros, sistemas de informacin
geogrfica....), para realizar acciones necesarias para nuestro sistema
(programas de clculo, sistemas de cifrado...), para realizar tareas de soporte
Sistema

Relacin

Pgina 6 de 22

<Nombre Proyecto>
Manual de Instalacin

<Unidad Organizativa>

3 RECURSOS HARDWARE
3.1

Servidores

<Cumplimente tabla y borre cuadro>

Para cada uno de los servidores necesarios para la implantacin del sistema
(servidor de aplicaciones, servidor de base de datos, servidor de archivos,
etc.), se detallarn sus requisitos hardware, diferenciando entre requisitos
mnimos 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 creacin de la mquina
virtual mediante la plantilla correspondiente.
Servidor 1
Dato

Valor mnimo

Valor recomendado

Procesador
Memoria RAM
Tamao
Almacenamiento
Otros

3.2

Estaciones cliente

<Cumplimente tabla y borre cuadro>

Se detallarn los requisitos hardware de las estaciones cliente necesarios
para la ejecucin del sistema, diferenciando entre requisitos mnimos y
recomendados.

Pgina 7 de 22

<Nombre Proyecto>
Manual de Instalacin

Dato

Valor mnimo

<Unidad Organizativa>

Valor recomendado

Procesador
Memoria RAM
Tamao Almacenamiento
Otros

3.3

Conectividad

<Cumplimente tabla y borre cuadro>

Se detallarn todos los requisitos mnimos y recomendados de recursos
hardware de conectividad entre servidores y estaciones cliente necesarios
para la implantacin. Para facilitar la comprensin, se recomienda incluir el
diagrama de despliegue correspondiente.
Dato

Valor mnimo

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
caractersticas, funcionamiento, acceso a otros productos, etc.

Restriccin

Detalle

Pgina 8 de 22

<Nombre Proyecto>
Manual de Instalacin

<Unidad Organizativa>

4 RECURSOS SOFTWARE
4.1

Matriz de certificacin

<Introduzca contenido y borre cuadro>

Este apartado recoger la compatibilidad de la versin del sistema objeto de
la instalacin, con las distintas versiones de software base y componentes
externos utilizados (mquina virtual Java, servidor de aplicaciones, servidor de
base de datos, LDAP, etc.).

4.2

Restricciones tcnicas del sistema

<Cumplimente tabla y borre cuadro>

En este apartado se ofrecer un listado completo de todos los recursos
software necesarios para la compilacin, instalacin y configuracin del
sistema. Como recursos ms importantes podemos destacar sistema
operativo, servicios de red, servidor de aplicaciones, servidor de base de
datos, compilador, mquina virtual de java...
En los casos que se considere necesario, se deber indicar la ubicacin de los
servidores a utilizar y el modo de acceso a los mismos.
Elemento

Descripcin

Sistema operativo
Servidor de aplicaciones
Servidor
datos

de

base

de

Compilador
JVM
Otros

4.3

Requisitos de otros sistemas

<Cumplimente tabla y borre cuadro>

Pgina 9 de 22

<Nombre Proyecto>
Manual de Instalacin

<Unidad Organizativa>

En este apartado se describirn los requisitos existentes para la utilizacin de

los distintos sistemas con los que existen relaciones. Estos requisitos podrn
administrativos (necesidad de alta en un sistema, solicitud de permisos...),
restricciones tcnicas del sistema (restricciones de comunicaciones,
seguridad, transferencia de informacin...), etc.
Estos sistemas con los que existe relacin pueden ser otros sistemas de la
organizacin (gestin de personal, inventarios, agenda...), sistemas
horizontales de la Junta de Andaluca (@firma, @ries, Trew@...) o sistemas
externos (sistemas de informacin geogrfica, servidores de noticias...).
Se cumplimentar una tabla para cada sistema con los que existan relaciones.
Como ejemplo, este sera un ejemplo de alta en @ries:

@ries
Descripcin
Funcionalidad utilizada
Requisito administrativo
1

Sistema de registro telemtico de la Junta de

Andaluca
Se utilizarn los servicios de registro de documentos
y ficheros.
Solicitud de alta de aplicacin en @ries,
cumplimentando el documento de registro que se
puede obtener en la url...

Requisito administrativo
2
Si se anexan ficheros, es necesario tener acceso va
FTP al servidor proporcionado por @ries.

Restriccin tcnica 1

<Sistema 1>
Descripcin
Funcionalidad utilizada
Requisito formal 1
...
Requisito tcnico 1
...
Requisito
comunicacin 1

de

...
Otros

Pgina 10 de 22

<Nombre Proyecto>

<Unidad Organizativa>

Manual de Instalacin

5 INSTALACIN Y CONFIGURACIN DEL SOFTWARE BASE

<Inserta comentario y eliminar cuadro>
Entendemos por software base, aquel del que depende directamente el
sistema para su correcta compilacin, instalacin y funcionamiento. Dentro de
lo que se identifica tpicamente como software base tenemos el entorno de
compilacin, el servidor de aplicaciones, el servidor de base de datos y la
mquina virtual de java. Adicionalmente pueden existir otros en funcin de las
caractersticas de nuestro sistema.
En este apartado se describir el procedimiento de instalacin del software
base. Para cada uno de los componentes software utilizados se indicar una
pequea descripcin del software, la localizacin en la que se puede obtener,
la descripcin detallada de todos los pasos que componen su instalacin, el
procedimiento de configuracin y los parmetros a configurar. Toda esta
informacin se cumplimentar en la tabla adjunta (se incluir una tabla para
cada componente software).
<Software Base 1>
Descripci
n
Localizaci
n
Procedimiento de instalacin
Paso 1
Paso 2
...
Procedimiento de configuracin
Paso 1
Paso 2
...
Parmetros a configurar
Parmetro
1
Parmetro
2

[Ubicacin
(BBDD,
properties...)]
[Ubicacin
(BBDD,
properties...)]

...

...

fichero

xml,

fichero

xml,

[Valor]
[Valor]
...

Pgina 11 de 22

<Nombre Proyecto>
Manual de Instalacin

<Unidad Organizativa>

6 CONFIGURACIN DEL SISTEMA

6.1

Configuracin del sistema

< Cumplimentar tabla y eliminar cuadro>

En este apartado se detallar la configuracin que se llevar a cabo durante
la implantacin del sistema. Diferenciaremos entre la configuracin que es
necesario realizar inicialmente, durante la compilacin, durante la instalacin
y despliegue y al final del proceso. Las configuraciones correspondientes a las
fases de compilacin e instalacin y despliegue sern referenciadas desde los
apartados correspondientes.
Para cada configuracin a realizar se indicar el elemento a configurar, el
efecto de la configuracin, la ubicacin en la que realiza la configuracin y
una descripcin detallada de las acciones a llevar a cabo y los valores a
establecer. Esta informacin se estructurar en forma de tabla.
Como ejemplo, se muestra la configuracin de los parmetros de conexin a
base de datos:
Configuracin: Datasource
Efecto

Se establecen los parmetros de conexin a base de datos.

Fase

Configuracin final despus del despliegue.

Ubicacin

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

Paso
1

Descripcin
Asegurarse de que la aplicacin est correctamente desplegada y de
que el servidor de aplicaciones est parado.
Editar el archivo de configuracin indicado y establecer los siguientes
valores:
cad_conexion: jdbc:oracle:thin:@127.0.0.1:1521:MIBD
driver: oracle.jdbc.driver.OracleDriver
nombre: jdbc/conexion
usuario: user

Configuracin: <Elemento a configurar>

Efecto
Fase
Ubicacin
Paso

Descripcin

Pgina 12 de 22

<Nombre Proyecto>

<Unidad Organizativa>

Manual de Instalacin

2
3
4

6.2

Configuracin de otros sistemas

<Cumplimente tabla y borre cuadro>

En este apartado se describir el procedimiento y los requisitos de
configuracin e instalacin (en los casos que sea necesario) de aquellos
sistemas que, sin ser software base, son utilizados por nuestro sistema.
La instalacin y configuracin de estos sistemas se especificar mediante una
tabla similar a la utilizada en el apartado de instalacin y configuracin del
<Otro sistema 1>
Descripci
n
Localizaci
n
Procedimiento de instalacin
Paso 1
Paso 2
...
Procedimiento de configuracin
Paso 1
Paso 2
...
Parmetros a configurar
Parmetro
1
Parmetro
2

[Ubicacin
(BBDD,
properties...)]
[Ubicacin
(BBDD,
properties...)]

...

...

fichero

xml,

fichero

xml,

[Valor]
[Valor]
...

Pgina 13 de 22

<Nombre Proyecto>

<Unidad Organizativa>

Manual de Instalacin

7 COMPILACIN DEL SISTEMA

< Cumplimentar tabla y eliminar cuadro>
En este apartado de describirn todos los requisitos existentes y las tareas a
realizar para la correcta compilacin del sistema. Como requisitos generales,
deben cumplirse todas las indicaciones referentes a construccin y
compilacin del software que estn recogidas en la normativa tcnica. Es
particularmente importante el cumplimiento de todo lo referente a normativa
Maven.
La informacin mnima necesaria para la compilacin incluye la ubicacin de
los fuentes, la configuracin del proyecto Maven (profiles, plugins...), los
repositorios a partir de los cuales se obtendrn los recursos necesarios, las
dependencias del proyecto y el producto final generado (war, jar...).
Finalmente se describirn detalladamente todas las acciones a realizar en el
proceso de compilacin, desde la obtencin de los ficheros fuente hasta la
obtencin del producto final, pasando pro la ejecucin de comandos de
configuracin y compilacin.
En caso de que sea necesario realizar alguna configuracin, se har referencia
Requisitos de compilacin
Requisito

Descripcin

Ubicacin Fuentes
Configuracin 1
...
Repositorio 1
...
Dependencia 1
...
Producto final
Procedimiento de compilacin
Paso

Descripcin

1
2
3

Pgina 14 de 22

<Nombre Proyecto>
Manual de Instalacin

<Unidad Organizativa>

8 INSTALACIN DEL SISTEMA

< Cumplimentar tabla y eliminar cuadro>
En este apartado se recoger la informacin necesaria para realizar la
instalacin del sistema, prestando especial inters 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 informacin de todo los requerimientos previos
al inicio del proceso de instalacin. En aquellos casos en los que la
informacin se recoja en otro apartado de este documento, ser suficiente
incluir una referencia.
Como requisitos previos de la instalacin destacan:

8.2

Los ficheros y recursos que se van a utilizar.

La ubicacin de los servidores que hay que utilizar y el modo de acceso

a los mismos.

Software previamente instalado.

Requisitos de comunicacin con otras plataformas previos para la

aplicacin.

Altas necesarias en otra aplicaciones (siempre si son previas a la

instalacin del producto).

Procedimiento de instalacin

< Cumplimentar tabla y eliminar cuadro>

Pgina 15 de 22

<Nombre Proyecto>
Manual de Instalacin

<Unidad Organizativa>

En este apartado se incluir una descripcin detallada y completa y en orden

secuencial de todas las tareas que hay que realizar. Para cada accin, se
deber indicar claramente tipo de accin (configuracin copia de ficheros,
despliegue...), los componentes implicados (fichero war, scripts de base da
datos...) y los permisos necesarios para llevar a cabo la accin (permisos de
administracin en el servidor de aplicaciones, propietario del esquema de
base de datos...).
En caso de que se realice una instalacin desde 0 habr que incluir una
referencia al apartado 5 de este documento. Si en cambio la instalacin se
realiza a partir del software base, un requisito previo ser la instalacin de
dicho software base.

Procedimiento de instalacin
Paso 1
Tipo
Component
e
Permisos
Descripcin
Paso 2
Tipo
Component
e
Permisos
Descripcin

Pgina 16 de 22

<Nombre Proyecto>
Manual de Instalacin

<Unidad Organizativa>

9 VERIFICACIN DEL PROCESO DE INSTALACIN

< Introducir contenido y eliminar cuadro>
En este apartado se recogern las comprobaciones mnimas que debern
realizarse una vez realizado el despliegue para asegurar la correcta
configuracin e instalacin del sistema (acceso al sistema, funcionalidad
bsica, comunicacin con los diferentes sistemas externos, etc.).

Pgina 17 de 22

<Nombre Proyecto>
Manual de Instalacin

10

<Unidad Organizativa>

MARCHA ATRS DE LA INSTALACIN Y

CONFIGURACIN

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 atrs.

10.2

Marcha atrs 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 atrs a la instalacin y
configuracin del sistema. Todas las tareas deben describirse detalladamente
indicando para cada una de ellas, el tipo de tarea (modificacin de
configuracin, ejecucin de un comando, ejecucin de scripts...), el
componente implicado (aplicacin, script de base de datos...) y los permisos
necesarios para llevar a cabo la accin (permisos de administracin en el
servidor de aplicaciones, propietario del esquema de base de datos...).
Procedimiento de marcha atrs
Paso 1
Tipo
Component
e
Permisos
Descripcin
Paso 2
Tipo
Component
e
Permisos
Descripcin

Pgina 18 de 22

<Nombre Proyecto>
Manual de Instalacin

10.3

<Unidad Organizativa>

Marcha atrs del software base

<Insertar comentario y eliminar cuadro>

En este apartado se desglosar la secuencia de tareas que hayan de
realizarse para desinstalar y dar marcha atrs a la instalacin y configuracin
del software base. La informacin ser desglosada por tipo de software base y
localizacin.

Pgina 19 de 22

<Nombre Proyecto>
Manual de Instalacin

11

<Unidad Organizativa>

ANEXOS

<Introduzca contenido y borre cuadro>

Este punto contendr toda aquella informacin de inters para la elaboracin
y validacin del Manual de Instalacin.

11.1

Resumen de tareas de configuracin

<Introduzca contenido y borre cuadro>

En este apartado se incluir, a modo de resumen, un listado con los
elementos de configuracin 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 'Configuracin del Sistema'.

Pgina 20 de 22

<Nombre Proyecto>
Manual de Instalacin

12

<Unidad Organizativa>

GLOSARIO

<Insertar comentario y eliminar cuadro>

Este punto contendr la definicin de todos los trminos utilizados en el
presente documento.

Trmino

Descripcin

Pgina 21 de 22

<Nombre Proyecto>
Manual de Instalacin

13

<Unidad Organizativa>

BIBLIOGRAFA Y REFERENCIAS

<Insertar comentario y eliminar cuadro>

En este punto se incluirn las referencias a la documentacin utilizada para la
elaboracin del presente documento.
Referen
cia
Ref. 1

Ttulo

Cdigo

Pgina 22 de 22