Diferencias

Muestra las diferencias entre dos versiones de la página.

--- ada:howto:sicoferp:factory:integrations:msadadeploymentservice [2022/04/04 15:06]
administraidor
+++ ada:howto:sicoferp:factory:integrations:msadadeploymentservice [2022/04/04 16:49] (actual)
administraidor [Fábrica - Servicios Web - Integraciones - AdaDeploymentService]
@@ Línea 2: / Línea 2: @@
 Este servicio permite realizar el proceso de despliegue de aplicaciones Powerbuilder en la tecnología Appeon el cual define la siguientes fases.
-  * Fase 1 - Copia de configuración Remota: Extrae los archivos de configuración del despliegue del servidor appeon al un directorio local.
+  * **Fase 1 (PHASE_1_COPY_CONFIG_FROM_REMOTE_TO_LOCAL_SERVER)** - Copia de configuración Remota: Extrae los archivos de configuración del despliegue del servidor appeon al un directorio local.
-  * Fase 2 - Full Build PB: Realiza la compilación local del código powerbuilder del proyecto.
+  * **Fase 2 (PHASE_2_FULL_BUILD_PB)** - Full Build PB: Realiza la compilación local del código powerbuilder del proyecto.
-  * Fase 3 - Despliegue Appeon: Realiza la compilación del código powerbuilder y genera el despliegue appeon y lo sube al servidor.
+  * **Fase 3 (PHASE_3_DEPLOY_APPEON_DEVELOPER)** - Despliegue Appeon: Realiza la compilación del código powerbuilder y genera el despliegue appeon y lo sube al servidor.
-  * Fase 4 - Copia de configuración Local: Copia la configuración extraida en la fase 1 al servidor appeon.
+  * **Fase 4 (PHASE_4_COPY_CONFIG_FROM_LOCAL_TO_REMOTE_SERVER)** - Copia de configuración Local: Copia la configuración extraida en la fase 1 al servidor appeon.
-  * Fase 5 - Reiniciar servidor: Reinicia el servidor appeon para que tome los cambios.
+  * **Fase 5 (PHASE_5_RESTART_WEB_SERVER)** - Reiniciar servidor: Reinicia el servidor appeon para que tome los cambios.
-Cada fase puede ser lanzada por separado según necesidad. Sin embargo existe una fase que integra todas las fases.
+Cada fase puede ser lanzada por separado según necesidad. Sin embargo existe una fase (**ALL_PHASES**) que integra todas las fases. Es decir ejecuta todo el proceso de despliegue.
 ===== Descripción del Servicio =====
 ^Nombre^Descripción^Tipo Servicio^Tecnología^Lenguaje^Tipo Desarrollo^Versión Desarrollo^Archivo de Configuración^
-|AdaDeploymentService|Realzia despliegues Appeon/Powerbuilder.|Rest|SpringBoot 2.6.4|Java 11.0.315|Nuevo|11.6.0.1|application.properties|
+|AdaDeploymentService|Realiza despliegues Appeon/Powerbuilder.|Rest|SpringBoot 2.6.4|Java 11.0.315|Nuevo|11.6.0.1|application.properties|
 ^Tipo Empaquetado^Gestor de Dependencias^Servidor de Despliegue^IDE Proyecto^Tipo Repositorio^Url Desarrollo^Url Calidad^Url Producción^
 |war|Maven 3.8.1|WildFly 20|SpringTools 4.6|Subversión|[[http://adacsc.co:1443/svn/repository/ADA/SICOFERP/fuentes/branches/development/core/Microservicios/AdaDeploymentService|SVN branches]]|[[http://adacsc.co:1443/svn/repository/ADA/SICOFERP/fuentes/trunk/development/core/Microservicios/AdaDeploymentService|SVN trunk]]|[[|SVN tags]]|
@@ Línea 34: / Línea 34: @@
 ^Documentación Operaciones^^^^^^^^
 ^Tipo^Documentación^^^^^^Visor^
-|Swagger|[[http://srv-appeon-000-w23.adacsc.co/AdaDeploymentService/api-docs|Ver Documento Json]]||||||https://editor.swagger.io/|
+|Swagger|[[http://localhost:8080/api-docs|Ver Documento Json]]||||||https://editor.swagger.io/|
 |Javadoc|[[http://adacsc.co:1443/svn/repository/ADA/SICOFERP/fuentes/branches/development/core/Microservicios/AdaDeploymentService/doc|Directorio Javadoc]]||||||Navegador Web|
 ^Ambientes de Despliegue^^^^^^^^
 ^Tipo^Url^^Observaciones^^^^^
 |Desarrollo:|http://localhost:8080||Ambiente de desarrollo|||||
-|Calidad:|http://srv-appeon-000-w23.adacsc.co/AdaEmailService||Ambiente de validación|||||
+|Calidad:|http://localhost:8080||Ambiente de validación|||||
 |Producción:| ||Ambiente de producción|||||
@@ Línea 57: / Línea 57: @@
   * Publicar la URL y Puerto del WildFly
-=== Notas ===
+=== Proceso ===
+Siga los siguientes pasos para utilizar la funcionalidad
-  * Se debe generar jar
+  * Antes de iniciar debe asegurarse que el servidor appeon contiene un despliegue previo para que se pueda extraer la configuración. Ya que appeon genera unas claves de control.
-  * Se debe ejecutar en el mismo entorno donde está instalado el appeon developer y powerbuilder
+  * La solución se debe ejecutar en el mismo entorno donde está instalado el appeon developer y powerbuilder.
-  * El puerto por defecto es 8080, se puede modificar en el properties y volver a generar el jar.
+  * El puerto por defecto de la solución es 8080. Se puede modificar en el application.properties y volver a [[ada:howto:sicoferp:factory:integrations:deployspringboot|Generar el jar]] .
-  * Ejemplo de Consumo QA - Index: http://localhost:8080/
+  * [[ada:howto:sicoferp:factory:integrations:deployspringboot|Desplegar como jar]]
-  * Ejemplo de consumo QA - Doc Swagger: http://localhost:8080/api-docs
+  * Validar Ejemplo de Consumo - Index: http://localhost:8080/
+  * Validar Documentación Swagger: http://localhost:8080/api-docs
+  * Realizar despliegue de prueba.
 ===== Ejemplo de generación de despliegue completo =====
@@ Línea 70: / Línea 73: @@
 |POST|localhost:8080/deployment/generate|Body,raw,json|json|
+==== Request ====
 <code yaml>
 {
@@ Línea 98: / Línea 102: @@
 }
 </code>
+^Columna^Descripcion^
+|profileDeploymentName|Nombre de la tarea de despliegue.|
+|temporaryDeploymentProcessingDirectoryPath|Directorio temporal que se utilizará para la generación de archivos del depsliegue. Esta propiedad no es obligatoria y si no se envía se utilizará un directorio temporal.|
+|deploymentPhases|Array de cadenas que contienen las fases del depsliegue las cuales son: PHASE_1_COPY_CONFIG_FROM_REMOTE_TO_LOCAL_SERVER, PHASE_2_FULL_BUILD_PB, PHASE_3_DEPLOY_APPEON_DEVELOPER, PHASE_4_COPY_CONFIG_FROM_LOCAL_TO_REMOTE_SERVER, PHASE_5_RESTART_WEB_SERVER. Si desea ejecutar todas las fases sólo debe enviar la fase ALL_PHASES|
+|deploymentExcludePhases|Array de fases que pueden ser excluidas del despliegue. Es utilizada cuando ejecutamos la fase ALL_PHASES|
+|sshHost|Dirección Ip de la conexión ssh|
+|sshPort|Puerto de la conexión ssh|
+|sshUser|Usuario de la conexión ssh. Debe tener permisos de lectura/escritura.|
+|sshPassword|Contraseña del usuario de la conexión ssh|
+|powerbuilderExecutablePath|Ruta del ejecutable powerbuilder. Si el path tiene espacios deben encapsularse en cadenas "" y separadores \\|
+|powerbuilderWorkspaceProjectPath|Ruta del workspace del proyecto powerbuilder. Si el path tiene espacios debe encapsularse en cadenas "" y separadores \\|
+|powerbuilderTargetProjectPath|Ruta del target(proyecto) powerbuilder. Si el path tiene espacios debe encapsularse en cadenas "" y separadores \\|
+|powerbuilderTargetProjectPath|Ruta del target(proyecto) powerbuilder. Si el path tiene espacios debe encapsularse en cadenas "" y separadores \\|
+|appeonRepositoryConfigDirectory|Ruta del directorio appeon donde se guarda la configuración. Si el path tiene espacios debe encapsularse en cadenas "" y separadores \\|
+|appeonDeveloperExecutablePath|Ruta del ejecutable appeon. Si el path tiene espacios debe encapsularse en cadenas "" y separadores \\|
+|appeonProfileDeployment|Array que contiene los perfiles de despliegue que se van a generar. Solo puede enviar despliegues de un mismo proyecto. Cada depsliegue requiere nombre del despliegue y datasource.|
+|emailToNotificationDeployment|Correo principal de notificación de despliegue.|
+|emailCcNotificationDeployment|Correo de copia de notificación de despliegue.|
+|emailBccNotificationDeployment|Correo de copia oculta de notificación de despliegue.|
+|notes|Nota asociada al proceso de despliegue.|
+|stopWebServerCommand|Comando de parada del servidor de despliegue.|
+|startWebServerCommand|Comando de inicio del servidor de despliegue.|
+==== Response ====
+<code yaml>
+{
+  "code": 0,
+  "message": "string",
+  "content": {}
+}
+</code>
+^Columna^Descripcion^
+|code|Código de respuesta del proceso|
+|message|Mensaje de respuesta del proceso|
+|content|Array de mensajes complementarios del proceso|
+==== Códigos de Respuesta ====
+^Código^Mensaje^Acción^
+|0|Error en la validación.|Debe consultar el array de mensajes content para más información.|
+|-1|Error en las ejecución de las fases.|Debe consultar el array de mensajes content para más información.|
+|1|Despliegue realizado correctamente.|Puede consultar el array de mensajes content para más información.|

Wiki

Herramientas de usuario

Herramientas del sitio

Diferencias

Herramientas de la página