Manual de operación Paquetería

Manual de operación Paquetería
GM-Transport

• Documento original
• Video presentación
• Modelo de datos

Fecha: 23 de agosto de 2024
Versión: Ver. 1.0
Proyecto: GM-Transport

Elaborado por:

Certuit Software S. de R.L de C.V.
Cerro de las Campanas No. 384, Insurgentes Oeste, CP. 21280

Mexicali, BC. México

Historial de Cambios

Fecha	Secciones	Razón de Cambios	Autor(es)	Revisor(es)
30 de mayo de 2022	TODAS	Creación del documento	Adrian Renteria
5 de julio del 2024	TODAS	Actualización del formato	Jocelyn Martinez

Tabla de Contenido

Manual de Operación

1. Especificación técnica del sistema

La siguiente documentación técnica describe los requisitos técnicos para desplegar el sistema.

1.1 Especificaciones de hardware

Los requerimientos del servidor se expresan en la siguiente tabla:

Ambiente	Servidor APP	Procesadores	Memoria RAM	Disco duro
Calidad	Maquina virtual	4 CPU	4 GB	50 GB
Preproducción/Producción	Servidor	2 CPU	2 GB	30 GB

Ambiente	Servidor WEBDEV	Procesadores	Memoria RAM	Disco duro
Calidad	Maquina virtual	8 CPU	16 GB	111 GB
Preproducción/Producción	Servidor	32 CPU	8 GB	126 GB

Los accesos para acceder se enlistan en las siguientes tablas:

Ambiente	URL	IP Servidor APP	Usuario	Contraseña
Calidad	http://paqueteria.desarrollo.gmtransport.co:8081	192.168.2.150	administrador	dockerDeploytreegras
Preproducción	https://paqueteria-calidad.gmtransport.co	172.202.200.153	GMTUser	Degcj83WeFCRU
Producción	https://paqueteria.gmtransport.co/	20.64.112.26	GMTUser	Degcj83WeFCRU

Ambiente	IP Servidor WEBDEV	Usuario	Contraseña
Calidad	192.168.2.211	certuitserver	DespE003
Preproducción	gmterpv8pq-calidad.gmtransport.co	GMTAdmin	9Y/Ehx+T]e”{PQ
Producción	paqueteria-backend.gmtransport.co	GMTAdmin	9Y/Ehx+T]e”{PQ

1.2 Especificaciones de software

El software configurado en el servidor APP se lista en la siguiente tabla:

Software	Descripción
Ubuntu 18.04.6 LTS	Sistema operativo
Apache Tomcat 8	Servidor de aplicaciones Java
Java 11	Máquina virtual de Java

2. Operación del sistema

2.1 Entorno de desarrollo del sistema

Los entornos consisten en lo siguiente:

1. Servicios web

   1. Lenguaje: Java
   2. IDE: IntelliJ IDEA 2021.3.2 (Ultimate Edition)
   3. Framework: Spring boot (2.1.6)
   4. Herramientas: Maven (3.8.1), SDK(11)
   5. Configuración del ambiente
      1. Abrir en IDE proyecto principal
      2. Esperar a la descarga de dependencias

2. Aplicación web

   1. Lenguaje: JavaScript
   2. IDE: WebStorm 2021.3 (Ultimate Edition)
   3. Framework: ReactJs (17.0.1)
   4. Herramienta: Node (14.17.3), npm (6.14.13)
   5. Configuración del ambiente
      1. Abrir terminal desde IDE
      2. Ejecutar el comando: npm install

2.2 Generación de empaquetados para despliegue

Para desplegar y facilitar la creación de empaquetados es necesario configurar el ambiente de desarrollo descrito en la sección 1.3.

2.2.1 Servicios web

1. Seleccionar la opción Build > Build Artifacts > All Artifacts

En caso de usar visual seguir la documentación oficial para la creación del empaquetado.

2. Renombrar el war, ubicado en /target, a reportes

2.2.2 Aplicación web

1. Abrir terminal desde IDE
2. Ejecutar el comando: npm run build
3. Renombrar la carpeta generada (build) a ROOT

2.3 Operación de servicios

Ejecutar y/o detener aplicación Web:

1. Acceder por SSH al servidor con Bitvise SSH Client
2. Ingresar
   1. IP: IP del servidor
   2. Puerto: 22
   3. Usuario
   4. Contraseña
3. Abrir la consola e ingresar como root con los comandos (este paso solo aplica para el ambiente de Calidad):
   1. su
   2. Ingresar contraseña de root.
4. Ejecutar el comando correspondiente a la acción y ambiente.

Iniciar
TOMCAT_HOME/bin/startup.sh
Detener
TOMCAT_HOME/bin/shutdown.sh

Ambiente	Ruta TOMCAT_HOME
Calidad	/opt/apache-tomcat-8.5.40/
Preproducción	/opt/tomcat/
Producción	/opt/tomcat/

2.3.1 Desplegar servicios Web

1. Acceder por SFTP al servidor con Bitvise SSH Client
2. Ingresar
   1. IP: IP del servidor
   2. Modo de acceso: Normal
   3. Usuario
   4. Contraseña
3. Arrastrar el archivo war(previamente renombrada) reportes.war a la ruta

Ambiente	Ruta
Calidad	/home/administrador
Preproducción	/home/GMTUser
Producción	/home/GMTUser

4. Acceder por SSH al servidor con Bitvise SSH Client
5. Ingresar
   1. IP: IP del servidor
   2. Puerto: 22
   3. Usuario
   4. Contraseña
6. Abrir la consola e ingresar como root con los comandos (este paso solo aplica para el ambiente de Calidad:
   1. su
   2. Ingresar contraseña de root:
7. Ir a TOMCAT_HOME
8. Eliminar el archivo reportes.war anterior.
9. Mover el archivo reportes.war a TOMCAT_HOME/webapps

Ambiente	Ruta TOMCAT_HOME
Calidad	/opt/apache-tomcat-8.5.40/
Preproducción	/opt/tomcat/
Producción	/opt/tomcat/

2.3.2 Desplegar aplicación Web

1. Acceder por SFTP al servidor con Bitvise SSH Client
2. Ingresar
   1. IP: IP del servidor
   2. Usuario
   3. Contraseña
3. Arrastrar carpeta (previamente renombrada) ROOT a la ruta:

Ambiente	Ruta
Calidad	/home/administrador
Preproducción	/home/GMTUser
Producción	/home/GMTUser

4. Acceder por SSH al servidor con Bitvise SSH Client
5. Ingresar
   1. IP: IP del servidor
   2. Puerto: 22
   3. Usuario
   4. Contraseña
6. Abrir la consola e ingresar como root con los comandos (este paso solo aplica para el ambiente de Calidad:
   1. su
   2. Ingresar contraseña de root:
7. Ir a TOMCAT_HOME/webapps
8. Eliminar la carpeta ROOT
9. Mover la carpeta ROOT a /TOMCAT_HOME/webapps

Ambiente	Ruta TOMCAT_HOME
Calidad	/opt/apache-tomcat-8.5.40/
Preproducción	/opt/tomcat/
Producción	/opt/tomcat/

2.3.3 Registros de errores

El sistema genera un archivo de errores que podrían ayudar a solucionar problemas, tal como lo es el log que proporciona Tomcat. Puede acceder a él ejecutando los siguientes comandos:

1. Acceder por SSH al servidor con Bitvise SSH Client.
2. Ingresar
   1. IP: IP del servidor
   2. Puerto: 22
   3. Usuario
   4. Contraseña
3. Abrir la consola e ingresar como root con los comandos (este paso solo aplica para el ambiente de Calidad):
   1. su
   2. Ingresar contraseña de root:
4. Ejecutar el comando según el ambiente.

tail -f TOMCAT_HOME/logs/catalina.out

Ambiente	Ruta TOMCAT_HOME
Calidad	/opt/apache-tomcat-8.5.40/
Preproducción	/opt/tomcat/
Producción	/opt/tomcat/

2.4 Versionamiento

Para el versionamiento de la aplicación se gestionan cuatro ramas como se indican a continuación:

Develop
Esta rama es la que se toma de base para los nuevos desarrollos o correcciones de bugs. Debe contener solo los cambios aprobados por calidad.

Calidad
Esta rama es la utilizada para realizar despliegues al ambiente de calidad sobre los cambios realizados en las ramas de los desarrolladores.

Release
Esta rama es la utilizada para la liberación al ambiente de preproducción con los cambios integrados de la rama develop.

Master
Esta rama es la utilizada para la liberación al ambiente de producción.

2.5 Creación de base de datos nueva

Para la generación de nuevas bases de datos se utiliza de referencia la base de datos GMTERP_WEB_DEFINICION_UNI la cual ya cuenta con los catálogos y la información inicial cargada, de igual manera se comparte el enlace al query que se usa actualmente para la carga de catálogos. Es importante mantener actualizada esta base de datos, de igual manera es importante que el equipo encargado del ERP actualice la base de datos.

Esta base de datos se encuentra dentro del servidor de calidad.