Inicializando wis2box

Resultados de aprendizaje

Al final de esta sesión práctica, podrás:

• ejecutar el script wis2box-create-config.py para crear la configuración inicial
• iniciar wis2box y verificar el estado de sus componentes
• ver el contenido de wis2box-api
• acceder a wis2box-webapp
• conectarte al wis2box-broker local usando MQTT Explorer

Note

Los materiales de formación actuales están basados en wis2box-release 1.0.0.

Consulta accessing-your-student-vm para obtener instrucciones sobre cómo descargar e instalar el stack de software de wis2box si estás realizando esta formación fuera de una sesión de entrenamiento local.

Preparación

Inicia sesión en tu VM designada con tu nombre de usuario y contraseña y asegúrate de estar en el directorio wis2box:

cd ~/wis2box

Creando la configuración inicial

La configuración inicial para wis2box requiere:

• un archivo de entorno wis2box.env que contenga los parámetros de configuración
• un directorio en la máquina anfitriona para compartir entre la máquina anfitriona y los contenedores de wis2box definidos por la variable de entorno WIS2BOX_HOST_DATADIR

El script wis2box-create-config.py se puede utilizar para crear la configuración inicial de tu wis2box.

Te hará un conjunto de preguntas para ayudarte a configurar tu configuración.

Podrás revisar y actualizar los archivos de configuración después de que el script haya terminado.

Ejecuta el script de la siguiente manera:

python3 wis2box-create-config.py

Directorio wis2box-host-data

El script te pedirá que ingreses el directorio que se utilizará para la variable de entorno WIS2BOX_HOST_DATADIR.

Ten en cuenta que necesitas definir la ruta completa a este directorio.

Por ejemplo, si tu nombre de usuario es username, la ruta completa al directorio es /home/username/wis2box-data:

username@student-vm-username:~/wis2box$ python3 wis2box-create-config.py
Por favor, ingresa el directorio que se utilizará para WIS2BOX_HOST_DATADIR:
/home/username/wis2box-data
El directorio que se utilizará para WIS2BOX_HOST_DATADIR se establecerá en:
    /home/username/wis2box-data
¿Es correcto? (s/n/salir)
s
El directorio /home/username/wis2box-data ha sido creado.

URL de wis2box

A continuación, se te pedirá que ingreses la URL de tu wis2box. Esta es la URL que se utilizará para acceder a la aplicación web de wis2box, API y UI.

Por favor, utiliza http://<tu-nombre-de-host-o-ip> como URL.

Por favor, ingresa la URL de wis2box:
 Para pruebas locales la URL es http://localhost
 Para habilitar el acceso remoto, la URL debe apuntar a la dirección IP pública o al nombre de dominio del servidor que aloja wis2box.
http://username.wis2.training
La URL de wis2box se establecerá en:
  http://username.wis2.training
¿Es correcto? (s/n/salir)

Contraseñas de WEBAPP, STORAGE y BROKER

Puedes usar la opción de generación de contraseña aleatoria cuando se te solicite y WIS2BOX_WEBAPP_PASSWORD, WIS2BOX_STORAGE_PASSWORD, WIS2BOX_BROKER_PASSWORD y definir las tuyas.

No te preocupes por recordar estas contraseñas, se almacenarán en el archivo wis2box.env en tu directorio de wis2box.

Revisar wis2box.env

Una vez que el script se haya completado, verifica el contenido del archivo wis2box.env en tu directorio actual:

cat ~/wis2box/wis2box.env

O verifica el contenido del archivo a través de WinSCP.

Question

¿Cuál es el valor de WISBOX_BASEMAP_URL en el archivo wis2box.env?

Haz clic para revelar la respuesta

El valor predeterminado para WIS2BOX_BASEMAP_URL es https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png.

Esta URL se refiere al servidor de mosaicos de OpenStreetMap. Si deseas usar un proveedor de mapas diferente, puedes cambiar esta URL para que apunte a un servidor de mosaicos diferente.

Question

¿Cuál es el valor de la variable de entorno WIS2BOX_STORAGE_DATA_RETENTION_DAYS en el archivo wis2box.env?

Haz clic para revelar la respuesta

El valor predeterminado para WIS2BOX_STORAGE_DATA_RETENTION_DAYS es de 30 días. Puedes cambiar este valor a un número diferente de días si lo deseas.

El contenedor wis2box-management ejecuta un trabajo cron diariamente para eliminar datos anteriores al número de días definido por WIS2BOX_STORAGE_DATA_RETENTION_DAYS del bucket wis2box-public y del backend de la API:

0 0 * * * su wis2box -c "wis2box data clean --days=$WIS2BOX_STORAGE_DATA_RETENTION_DAYS"

Note

El archivo wis2box.env contiene variables de entorno que definen la configuración de tu wis2box. Para obtener más información, consulta la wis2box-documentation.

No edites el archivo wis2box.env a menos que estés seguro de los cambios que estás haciendo. Los cambios incorrectos pueden hacer que tu wis2box deje de funcionar.

No compartas el contenido de tu archivo wis2box.env con nadie, ya que contiene información sensible como contraseñas.

Iniciar wis2box

Asegúrate de estar en el directorio que contiene los archivos de definición del stack de software de wis2box:

cd ~/wis2box

Inicia wis2box con el siguiente comando:

python3 wis2box-ctl.py start

Cuando ejecutes este comando por primera vez, verás la siguiente salida:

No se encontraron archivos docker-compose.images-*.yml, creando uno
Versión actual=Indefinida, última versión=1.0.0
¿Te gustaría actualizar? (s/n/salir)

Selecciona s y el script creará el archivo docker-compose.images-1.0.0.yml, descargará las imágenes Docker requeridas e iniciará los servicios.

La descarga de las imágenes puede llevar algún tiempo dependiendo de la velocidad de tu conexión a internet. Este paso solo es necesario la primera vez que inicies wis2box.

Inspecciona el estado con el siguiente comando:

python3 wis2box-ctl.py status

Repite este comando hasta que todos los servicios estén en funcionamiento.

wis2box y Docker

wis2box funciona como un conjunto de contenedores Docker gestionados por docker-compose.

Los servicios están definidos en los diversos docker-compose*.yml que se pueden encontrar en el directorio ~/wis2box/.

El script de Python wis2box-ctl.py se utiliza para ejecutar los comandos subyacentes de Docker Compose que controlan los servicios de wis2box.

No necesitas conocer los detalles de los contenedores Docker para ejecutar el stack de software de wis2box, pero puedes inspeccionar los archivos docker-compose*.yml para ver cómo se definen los servicios. Si estás interesado en aprender más sobre Docker, puedes encontrar más información en la documentación de Docker.

Para iniciar sesión en el contenedor de wis2box-management, utiliza el siguiente comando:

python3 wis2box-ctl.py login

Dentro del contenedor de wis2box-management puedes ejecutar varios comandos para gestionar tu wis2box, como:

• wis2box auth add-token --path processes/wis2box : para crear un token de autorización para el endpoint processes/wis2box
• wis2box data clean --days=<número-de-días> : para limpiar datos anteriores a cierto número de días del bucket wis2box-public

Para salir del contenedor y volver a la máquina anfitriona, utiliza el siguiente comando:

exit

Ejecuta el siguiente comando para ver los contenedores docker que se están ejecutando en tu máquina anfitriona:

docker ps

Deberías ver los siguientes contenedores en funcionamiento:

• wis2box-management
• wis2box-api
• wis2box-minio
• wis2box-webapp
• wis2box-auth
• wis2box-ui
• wis2downloader
• elasticsearch
• elasticsearch-exporter
• nginx
• mosquitto
• prometheus
• grafana
• loki

Estos contenedores son parte del stack de software de wis2box y proporcionan los diversos servicios necesarios para ejecutar wis2box.

Ejecuta el siguiente comando para ver los volúmenes docker que se están ejecutando en tu máquina anfitriona:

docker volume ls

Deberías ver los siguientes volúmenes:

• wis2box_project_auth-data
• wis2box_project_es-data
• wis2box_project_htpasswd
• wis2box_project_minio-data
• wis2box_project_prometheus-data
• wis2box_project_loki-data
• wis2box_project_mosquitto-config

Así como algunos volúmenes anónimos utilizados por los diversos contenedores.

Los volúmenes que comienzan con wis2box_project_ se utilizan para almacenar datos persistentes para los diversos servicios en el stack de software de wis2box.

API de wis2box

wis2box contiene una API (Interfaz de Programación de Aplicaciones) que proporciona acceso a datos y procesos para visualización interactiva, transformación de datos y publicación.

Abre una nueva pestaña y navega a la página http://YOUR-HOST/oapi.

Esta es la página de inicio de la API de wis2box (ejecutándose a través del contenedor wis2box-api).

Question

¿Qué colecciones están actualmente disponibles?

Haz clic para revelar la respuesta

Para ver las colecciones actualmente disponibles a través de la API, haz clic en Ver las colecciones en este servicio:

Las siguientes colecciones están actualmente disponibles:

• Estaciones
• Notificaciones de datos
• Metadatos de descubrimiento

Question

¿Cuántas notificaciones de datos se han publicado?

Haz clic para revelar la respuesta

Haz clic en "Notificaciones de datos", luego haz clic en Explorar los elementos de "Notificaciones de Datos".

Notarás que la página dice "No hay elementos" ya que aún no se han publicado notificaciones de datos.

Aplicación web de wis2box

Abre un navegador web y visita la página http://YOUR-HOST/wis2box-webapp.

Verás un pop-up pidiendo tu nombre de usuario y contraseña. Usa el nombre de usuario predeterminado wis2box-user y el WIS2BOX_WEBAPP_PASSWORD definido en el archivo wis2box.env y haz clic en "Iniciar sesión":

Note

Consulta tu wis2box.env para conocer el valor de tu WIS2BOX_WEBAPP_PASSWORD. Puedes usar el siguiente comando para verificar el valor de esta variable de entorno:

cat ~/wis2box/wis2box.env | grep WIS2BOX_WEBAPP_PASSWORD

Una vez que hayas iniciado sesión, mueve el ratón al menú de la izquierda para ver las opciones disponibles en la aplicación web de wis2box:

Esta es la aplicación web de wis2box que te permite interactuar con tu wis2box:

• crear y gestionar conjuntos de datos
• actualizar/revisar tus metadatos de estación
• subir observaciones manuales usando el formulario FM-12 synop
• monitorear notificaciones publicadas en tu wis2box-broker

Usaremos esta aplicación web en una sesión posterior.

wis2box-broker

Abre el MQTT Explorer en tu computadora y prepara una nueva conexión para conectarte a tu broker (ejecutándose a través del contenedor wis2box-broker).

Haz clic en + para agregar una nueva conexión:

Puedes hacer clic en el botón 'ADVANCED' y verificar que tienes suscripciones a los siguientes temas:

• #
• $SYS/#

Note

El tema # es una suscripción comodín que se suscribirá a todos los temas publicados en el broker.

Los mensajes publicados bajo el tema $SYS son mensajes del sistema publicados por el servicio mosquitto en sí.

Usa los siguientes detalles de conexión, asegurándote de reemplazar el valor de <tu-host> con tu nombre de host y <WIS2BOX_BROKER_PASSWORD> con el valor de tu archivo wis2box.env:

• Protocolo: mqtt://
• Host: <tu-host>
• Puerto: 1883
• Nombre de usuario: wis2box
• Contraseña: <WIS2BOX_BROKER_PASSWORD>

Note

Puedes verificar tu wis2box.env para conocer el valor de tu WIS2BOX_BROKER_PASSWORD. Puedes usar el siguiente comando para verificar el valor de esta variable de entorno:

cat ~/wis2box/wis2box.env | grep WIS2BOX_BROKER_PASSWORD

Ten en cuenta que esta es tu contraseña interna del broker, el Global Broker utilizará diferentes credenciales (solo lectura) para suscribirse a tu broker. Nunca compartas esta contraseña con nadie.

Asegúrate de hacer clic en "GUARDAR" para almacenar los detalles de tu conexión.

Luego haz clic en "CONECTAR" para conectarte a tu wis2box-broker.

Una vez que estés conectado, verifica que las estadísticas internas de mosquitto estén siendo publicadas por tu broker bajo el tema $SYS:

Mantén el MQTT Explorer abierto, ya que lo utilizaremos para monitorear los mensajes publicados en el broker.

Conclusión

¡Felicidades!

En esta sesión práctica, aprendiste cómo:

• ejecutar el script wis2box-create-config.py para crear la configuración inicial
• iniciar wis2box y verificar el estado de sus componentes
• acceder a wis2box-webapp y wis2box-API en un navegador
• conectarte al broker MQTT en tu VM de estudiante usando MQTT Explorer