Updated documentation

pull/1/head
Nicolas Arenas 2025-05-14 08:47:28 +02:00
parent 1becf86e79
commit c5e31d3063
11 changed files with 82 additions and 42 deletions

View File

@ -39,24 +39,65 @@ Ejecutamos los siguientes comandos:
chmod 755 opengnsys_installer.sh
./opengnsys_installer.sh devel
./opengnsys_installer.sh
```
En caso de querer instalar los ultimos paquetes creados desde la rama principal de cada uno de los repositorios, ejecutaremos lo siguiente:
```bash
curl -q -k https://ognproject.evlt.uma.es/gitea/api/v1/repos/opengnsys/oginstaller/raw/non_graf_installer/python-installer/opengnsys_installer-v2.sh?ref=main -o opengnsys_installer.sh
chmod 755 opengnsys_installer.sh
./opengnsys_installer.sh nightly
```
![Imagen2.png](./imagenes/Imagen2.png)
Nos aparece una pantalla con los componentes que queremos instalar y versión que queremos instalar, seleccionaremos los componentes deseados y la versión que se requiera del producto. En este caso seleccionaremos todos los componentes y la versión opengnsys_devel-0.0.10
![Imagen3.png](./imagenes/Imagen3.png)
### ogCore
### Selección del tipo de instalacion
A continucación aparece una pantalla donde elegiremos si queremos instalar todos los componenentes en un único nodo o en varios.
#### Instalación mononodo
Si seleccionamos la opción mononodo
![select_mono](./imagenes/Installatiion_type_selection.png)
A continuación nos aprece una pantalla donde tendremos que introducir cual es la IP en la que todos los componentes se van a comunicar.
![mononode_ip](./imagenes/mononode_ip.png)
A continuación aparece una pantalla con todos los componentes seleccionados donde simplemente le daremos a ok
![mononode_comp_select](./imagenes/mononode_comp_selection.png)
#### Instalación multinodo
Para hacer una instalación multinodo, esto es una instalación donde cada componente podrá ir por separado
![select_multi](./imagenes/select_multinode.png)
Nos aparece un cuadro para introducir las ips de las máquinas donde van a ir situados los diferentes componentes.
![multinode_ip](./imagenes/multinode_ip.png)
Una vez completados estos pasos tanto en mononodo como en multinodo se muestran las diferentes pantallas para que se confirmen los diferentes parametros de entrada, si son correctos con darle a OK es suficiente. El detalle de cada componente se explica a continucación.
### ogCore
Para el servicio ogCore los datos que se requieren son:
- Usuario Administrador: Valor por defecto ogadmin
- Contraseña del usuario: Valor por defecto 12345678
![Imagen4.png](./imagenes/Imagen4.png)
![ogcore_install.png](./imagenes/ogcore_install.png)
### ogGui
@ -64,18 +105,17 @@ Para el servicio de Interfaz gráfica, los datos que se piden son:
- URL de Conexión al servidor de ogCore: Valor por defecto https://\<ip del interfaz asociada a la ruta por defecto>:8443
- URL de Conexion a Mercure: Valor por defecto https://\<ip del interfaz asociada a la ruta por defecto>:3000/.well-known/mercure
![Imagen5.png](./imagenes/Imagen5.png)
![oggui_install](./imagenes/oggui_install.png)
### ogDHCP
Para el servicio de DHCP los parámetros que se piden son:
- Interfaces de red por las que se servirá el servicio de DHCP. Se muestra una lista con los interfaces de red disponibles para la instalación y se introducen como una lista separada por comas en el campo de selección.
- Interfaces de red por las que se servirá el servicio de DHCP. Se muestra una lista con los interfaces de red disponibles para la instalación y se espera que se seleccionen los interfaces por los que se pueden servir IPs.
- IP del servidor de ogBoot (Valor por defecto la IP de la interfaz asociada a la ruta por defecto)
- IP del propio servidor de DHCP (Valor por defecto la IP de la interfaz asociada a la ruta por defecto)
![Imagen6.png](./imagenes/Imagen6.png)
![ogdhcp_install.png](./imagenes/ogdhcp_install.png)
### ogBoot (PXE)
@ -89,7 +129,7 @@ Los parámetros que se requieren son:
- Password del usuario de Samba (¡cuidado, este parámetro está embebido en los ogLive, por lo que no es conveniente cambiarlo a no ser que se haya creado un ogLive con la configuración para ello!)
![Imagen7.png](./imagenes/Imagen7.png)
![ogboot_install](./imagenes/ogboot_install.png)
### ogRepository
@ -100,7 +140,7 @@ Los parámetros que se requieren son
- Usuario para realizar los exports de SAMBA (¡cuidado, este parámetro está embebido en los ogLive, por lo que no es conveniente cambiarlo a no ser que se haya creado un ogLive con la configuración para ello!)
- Password del usuario de Samba (¡cuidado, este parámetro está embebido en los ogLive, por lo que no es conveniente cambiarlo a no ser que se haya creado un ogLive con la configuración para ello!)
![Imagen8.png](./imagenes/Imagen8.png)
![ogrepository_install](./imagenes/ogrepository_install.png)
## Instalación
@ -112,6 +152,7 @@ Una vez que el proceso de instalación termina se muestra un resumen del proceso
![Imagen31.png](./imagenes/Imagen31.png)
Se crea el archivo /opt/opengnsys/release con la versión instalada de Opengnsys
```sh
@ -119,6 +160,8 @@ Se crea el archivo /opt/opengnsys/release con la versión instalada de Opengnsys
Versión instalada: opengnsys-1.6.0-beta
```
***NOTA: En caso de realizar una instalación desde el repositorio de nightlys el archivo relese no se crea***
## Chequeo de los servicios
Una vez que la instalación se ha completado, podemos comprobar que los servicios se han instalado correctamente y ha funcionado según lo esperado.
@ -135,7 +178,7 @@ Todos los componentes se han debido instalar en /opt/opengnsys/<carpeta servicio
- oggui
- ogclient
Actualmente existe una carpeta llamada ogclient_log que se usa para montarse en los clientes y donde dejan sus logs. En proximas versiones esta carpeta va a desaparecer.
Actualmente existe una carpeta llamada ogclient_log que se usa para montarse en los clientes y donde dejan sus logs. En proximas versiones esta carpeta va a desaparecer.
Todas los directorios pertenecen al usuario opengnsys grupo www-data excepto los directorios ogclient y ogclient_log que pertenecen al grupo opengnsys.
@ -171,35 +214,32 @@ El esquema de ogCore se representaría en este grafico.
![ogcore-schema](imagenes/opengsys-ogcore.png)
#### Parada y arranque de los servicios
```bash
# Arranque
root@qindel-box:~# systemctl start ogcore
root@qindel-box:~# systemctl start nginx
# Parada
root@qindel-box:~# systemctl stop ogcore
root@qindel-box:~# systemctl stop nginx
# Estado
root@qindel-box:~# systemctl status ogcore
root@qindel-box:~# systemctl status nginx
# Logs del servicio
root@qindel-box:~# journalctl -xeu ogcore
```
root@qindel-box:~# journalctl -f SYSLOG_IDENTIFIER=ogcore
```
#### Archivos de configuración
Localizados en **/opt/opengnsys/ogCore/etc/**
Localizados en **/opt/opengnsys/ogcore/**
| Fichero | Descripción |
|-----------------------------|-------------------------------------------------------|
| docker-compose-deploy.yml | Configuración del servicio contenerizado |
| env.json | Definición de los endpoints donde ogcore se tiene que conectar |
| .env | Archivo interno de synfony |
| /opt/opengnsys/ogcore/api/env.json | Definición de los endpoints donde ogcore se tiene que conectar |
| /opt/opengnsys/ogcore/api/.env.local.php | Archivo interno de synfony |
| /etc/nginx/sites-enabled/ogcore.conf | Archivo de configuracion de nginx de la API de ogcore |
| /etc/nginx/sites-enabled/mercure.conf | Archivo de configuracion de nginx para el servicio de mercure |
#### Acceso al servicio
@ -219,31 +259,31 @@ Desde donde se pueden probar los distintos endpoints de la API de forma estánda
#### Descripción
Es una aplicación en Angular servida por un contenedor de Docker que ejecuta un servidor de NodeJS.
Es una aplicacion estatica de angular servida por nginx.
#### Parada y arranque de los servicion
```bash
# Arranque
root@qindel-box:~# systemctl start ooggui-app
root@qindel-box:~# systemctl start nginx
# Parada
root@qindel-box:~# systemctl stop oggui-app
root@qindel-box:~# systemctl stop nginx
# Estado
root@qindel-box:~# systemctl status oggui-app
# Logs del servicio
root@qindel-box:~# journalctl -xeu oggui-app
root@qindel-box:~# systemctl status nginx
```
#### Archivos de configuración
Al ser una aplicacion de lado cliente los logs de la misma se ven en la consola de depuracion del navegador.
Situados en **/opt/opengnsys/ogGui/etc**
Ademas se pueden ver los logs de nginx para ver sus accesos y codigos de error.
| Fichero | Descripción |
|-----------------------------|-------------------------------------------------------|
| .env | URL del endpoint donde apuntar a ogCore. |
#### Archivos de configuracion
| Fichero | Descripción |
|------------------------------------- |-------------------------------------------------------|
| /etc/nginx/sites-enabled/oggui.conf | URL del endpoint donde apuntar a ogCore. |
| /opt/opengnsys/oggui/etc/config.json | Endpoint de mercure y ogcore |
#### Acceso al servicio
@ -254,11 +294,10 @@ https://**ip**:4200/
![imagen13](./imagenes/Imagen13.png)
Introduciendo el usuario y la password configuradas en la instalación accederemos a la interfaz web.
Introduciendo el usuario y la password configuradas en la instalación accederemos a la interfaz web.
![imagen14](./imagenes/Imagen14.png)
### ogBoot
Servicio que engloba varios componentes que se ejecutan ahora mismo directamente en la máquina donde se ha desplegado. La API se ejecuta debajo de un servidor nginx que corre en el host y que se encarga de gestionar el servicio.
@ -304,11 +343,12 @@ Los logs del servicio de nginx y de la api se encuentran en:
#### Archivos de configuración
| Ubicación | Fichero | Descripción |
|------------------------------------|------------------|--------------------------------------|
| /opt/opengnsys/ogboot/ | .env | Archivo de configuración de synfony. |
| /etc/nginx/sites-available/ | ogboot.conf | Archivo de configuración de nginx. |
| /etc/samba | smb-ogboot.conf | Archivo de configuración de samba. |
| Ubicación | Fichero | Descripción |
|------------------------------------|------------------|------------------------------------------------------- |
| /opt/opengnsys/ogboot/ | .env | Archivo de configuración de synfony. |
| /etc/nginx/sites-available/ | ogboot.conf | Archivo de configuración de nginx. |
| /etc/samba | smb-ogboot.conf | Archivo de configuración de samba. |
| /etc/samba | smb-ogclient.conf| Archivo de configuracion de samba para el clone-engine |
#### Acceso al servicio

Binary file not shown.

After

Width:  |  Height:  |  Size: 94 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 156 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 93 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 149 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 200 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 122 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 145 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 145 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 154 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 138 KiB