.. _install_guide: Guía de instalación de WOCU-Monitoring ====================================== Esta guía tiene como objetivo servir las instrucciones necesarias para la correcta instalación de **WOCU-Monitoring**, a través de unas sencillas indicaciones. Requerimientos -------------- **WOCU-Monitoring** puede ser instalado en los siguientes sistemas operativos: * RedHat 9 * RedHat 8 * Debian 10 (*deprecado* en siguiente releases) * Debian 11 * Debian 12 A continuación se detallan los requisitos mínimos para desplegar la versión **AIO** (*All-in-one*) de WOCU-Monitoring. +-------------------------------------+-------------------------------------+ | Mínimos | Recomendados | +--------------+-------------+--------+--------------+-------------+--------+ | CPU (cores) | Memory (GB) | HD (GB)| CPU (cores) | Memory (GB) | HD (GB)| +==============+=============+========+==============+=============+========+ | 8 | 16 | 600 | 32 | 32 | 600 | +--------------+-------------+--------+--------------+-------------+--------+ La capidad máxima para una instanacia **AIO** es de **5000 dispositivos** monitorizados con una media de **5 servicios** por dispositivo. En entornos mayores a **25000 servicios** WOCU-Monitoring se deberá desplegar en arquitectura distribuida, en la siguiente tabla se detallan los requisitos para cada uno de los módulos. +------------+--------------+-------------+--------+ | Módulo | CPU (cores) | Memory (GB) | HD (GB)| +============+==============+=============+========+ | Console | 16 | 32 | 120 | +------------+--------------+-------------+--------+ | Engine | 16 | 16 | 120 | +------------+--------------+-------------+--------+ | Indexer | 16 | 32 | 80 | +------------+--------------+-------------+--------+ | Metrics | 16 | 32 | 600 | +------------+--------------+-------------+--------+ | Logger | 16 | 32 | 600 | +------------+--------------+-------------+--------+ | Satellite | 16 | 32 | 120 | +------------+--------------+-------------+--------+ Cada Engine soporta **25000 servicios**, se incrementarán el número de los mismos para cubrir las necesidades del entorno a monitorizar. El uso de disco depende, en gran medida, de la cantidad de eventos generados por la herramienta, que a su vez depende de la estabilidad y disponibilidad de la plataforma monitorizada. Variará también según los tiempos de retención que se empleen para almacenar dichos eventos. Por ello, resulta complicado hacer un cálculo real del espacio en disco que va a ser utilizado. Como normal general, una instalación de este tipo con una retención de **3 meses** puede requerir :guilabel:`128 GB`, aunque lo recomendable sería emplear :guilabel:`256 GB`. `Gconf `_, se puede desplegar en ambas arquitecturas, pero requiere de un servidor adicional con los siguientes requisitos de hardware. +--------------+-------------+--------+ | CPU (cores) | Memory (GB) | HD (GB)| +==============+=============+========+ | 4 | 4 | 100 | +--------------+-------------+--------+ Para monitorizar el sistema base en el que se encuentra instalado **WOCU-Monitoring**, está a su disposición el `pack de monitorización WOCU Health `_, útil para la optimización de los recursos hardware. .. Note:: El despliegue que se aborda en este documento es una instalación de tipo AIO (*All-in-one*). Descarga del paquete de instalación ----------------------------------- Versión Enterprise ^^^^^^^^^^^^^^^^^^ La versión `Enterprise `_ de **WOCU-Monitoring** está disponible para su descarga desde el repositorio ``download.wocu-monitoring.com`` pero de forma autenticada, por lo que tendrá que solicitar credenciales desde la página de `contacto `_. Instalación de la versión Enterprise ------------------------------------ **WOCU-Monitoring** puede ser instalado con repositorios ``deb`` (Debian/Ubuntu) o repositorios ``rpm`` (RedHat). .. _install_repo_debian: Debian ^^^^^^ Existen dos vías: * Instalación con paquetes Será necesario posicionarse dentro del directorio donde se haya guardado el paquete, y a continuación, ejecutar la siguiente orden: :: apt install -f ./[NOMBRE_DEL_PAQUETE].deb -y * Instalación desde repositorio Lo primero es configurar la autenticación para el repositorio de paquetes de **WOCU-Monitoring**. .. Note:: Recuerde solicitar sus credenciales de cliente desde la página de `contacto `_ y sustituir las variables ```` y ```` por los valores proporcionados. Todos los mandatos deben ejecutarse en una consola como root o con privilegios de administrador. :: bash -c ' cat >> /etc/apt/auth.conf < password EOF' El repositorio es servido por **HTTPS**, así que si no dispone de soporte para repositorios cifrados, debe instalar el soporte para ``apt`` necesario: :: apt update apt install apt-transport-https wget Seguidamente, debe añadir el repositorio de paquetes al fichero ``sources.list`` de la máquina y obtener la llave pública para el mismo: * Debian 11 :: echo "deb [arch=amd64] https://download.wocu-monitoring.com/repository/wocu-apt-internal-deb11 bullseye main" > /etc/apt/sources.list.d/wocu-monitoring.list wget -O - https://files.wocu-monitoring.com/wocu-monitoring.gpg.key | apt-key add - * Debian 10 :: echo "deb [arch=amd64] https://download.wocu-monitoring.com/repository/wocu-apt-internal-deb10 buster main" > /etc/apt/sources.list.d/wocu-monitoring.list wget -O - https://files.wocu-monitoring.com/wocu-monitoring.gpg.key | apt-key add - Por último, es necesario la actualización del repositorio local, junto con la instalación del paquete **AIO** de **WOCU-Monitoring**: :: apt update apt install wocu .. _install_repo_redhat: RedHat ^^^^^^ Existen dos vías: * Instalación con paquetes Será necesario posicionarse dentro del directorio donde se haya guardado el paquete, y a continuación, ejecutar la siguiente orden: :: dnf install -y ./[NOMBRE_DEL_PAQUETE].rpm * Instalación desde repositorio Lo primero es configurar la autenticación para el repositorio de paquetes de **WOCU-Monitoring**. .. Note:: Recuerde solicitar sus credenciales de cliente desde la página de `contacto `_ y sustituir las variables ```` y ```` por los valores proporcionados. Todos los mandatos deben ejecutarse en una consola como root o con privilegios de administrador. :: bash -c ' cat >> /etc/yum.repos.d/wocu-monitoring.repo < /etc/apt/sources.list.d/wocu-monitoring.list wget -O - https://download.wocu-monitoring.com/files/wocu-monitoring.gpg.key | apt-key add - Por último, es necesario la actualización del repositorio local, junto con la instalación del paquete **AIO** de **WOCU-Monitoring**: :: dnf update dnf install wocu Instalación de módulos adicionales ---------------------------------- .. Note:: Solo aplicable a entornos Debian. Existen módulos adicionales que pueden ser instalados dependiendo de las necesidades y requerimientos del cliente. Snmp-mibs-downloader ^^^^^^^^^^^^^^^^^^^^ Si la monitorización que va a realizar con **WOCU-Monitoring** es basada principalmente en peticiones :guilabel:`SNMP`, se recomienda la instalación de este paquete, el cual incluye las :guilabel:`MIBS` propietarias de la mayoría de tecnologías presentes en el mercado. El paquete no es instalado por defecto en las distribuciones, por no ser un paquete con licencia *Open Source*. Para instalarlo añada el soporte para descargar paquetes del repositorio *non-free*: * Debian 11 :: echo "deb http://deb.debian.org/debian bullseye main contrib non-free" >> /etc/apt/sources.list * Debian 10 :: echo "deb http://deb.debian.org/debian buster main contrib non-free" >> /etc/apt/sources.list Inmediatamente, instale el paquete ``snmp-mibs-downloader``: :: apt update && apt install -y snmp-mibs-downloader .. _initial_conf: Configuración inicial --------------------- La configuración inicial de **WOCU-Monitoring** parte de un único fichero ubicado en: :: editor /etc/wocu/wocu.yml **No es necesario modificar dicho fichero**, ya que los valores prefijados están pensados para funcionar *out-of-the-box*. Puede revisar el fichero con los valores por defecto en la siguiente ruta: :: editor /etc/wocu/default.yml .. Attention:: Ante la necesidad de modificación, nunca realice el cambio en el fichero ``/etc/wocu/default.yml`` (es sobreescrito entre actualizaciones). En su lugar, modifique el fichero ``/etc/wocu/wocu.yml``, añadiendo nuevos valores (si fuera necesario). Obtenida la configuración final, ejecute el siguiente comando para actualizar el sistema con los valores modificados. **Este proceso puede llegar a tardar alrededor de 5 minutos**. :: wocu-ctl configure .. Note:: Adicionalmente, puede obtener información sobre el estado actual de sus procesos ejecutando (en otra terminal) el siguiente comando: :: tail -f /tmp/minion.salt.log A modo de ejemplo, esta sería una posible respuesta del comando de estado: .. image:: ../images/administrator_guide/7_073_example_response.png :align: center :scale: 25% Utilice la siguiente orden para lanzar los procesos de **WOCU-Monitoring**: :: wocu-ctl start Seguidamente, compruebe el estado de los procesos arrancados a través de esta orden: :: wocu-ctl status Por último, será necesario modificar el fichero ``/etc/hosts`` ejecutando el siguiente comando. **Omitir en caso de actualización**. :: echo -e "#WOCU \n wocu\n" >> /etc/hosts Acceda al interfaz de **WOCU-Monitoring** en la siguiente dirección desde su navegador: :: https:///aggregator Por defecto las credenciales de acceso son: User: admin Pass: admin .. Important:: Por cuestiones de seguridad, le recomendamos modificar la contraseña de administrador en el primer acceso. Puede continuar con los :ref:`first_steps` recomendados, para acceder al portal web, terminar de configurar la herramienta y empezar a monitorizar sus dispositivos. .. _free_doc_install: Instalación de la versión Free ------------------------------ A continuación se detallan las instrucciones necesarias para la correcta instalación de la versión free de **WOCU-Monitoring**. El despliegue que se aborda en este documento es una instalación de tipo **AIO** (*All-in-one*). Requerimientos ^^^^^^^^^^^^^^ **WOCU-Monitoring** puede ser instalado en los siguientes sistemas operativos: * Debian 11 * RedHat 8 .. Important:: Es necesario disponer de conexión a internet para iniciar el proceso de instalación. La licencia free de **WOCU-Monitoring** soporta hasta **1500 dispositivos**. Los requisitos para este tipo de despliegue son de :guilabel:`16 GB de RAM` y :guilabel:`4 cores de CPU`. Una instalación de este tipo requiere :guilabel:`256 GB` para **6 meses** de retención. Descarga del paquete de instalación ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ El paquete de instalación de la versión free de **WOCU-Monitoring** está disponible en: https://www.wocu-monitoring.com/download-form/ .. Important:: Todos los mandatos deben ejecutarse en una consola como root o con privilegios de administrador. A continuación, ejecutar la siguiente orden: * Debian 11 :: apt install -f ./[NOMBRE_DEL_PAQUETE].deb -y * RedHat 8 :: dnf install -y ./[NOMBRE_DEL_PAQUETE].rpm Instalación de módulos adicionales ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. Note:: Solo aplicable a entornos Debian. La monitorización mediante **TRAPS SNMP**, requiere la instalación de las **MIBS**, que se encuentran en un paquete adicional, dentro de los repositorios **non-free**. El paquete no es instalado por defecto en las distribuciones, por no ser un paquete con licencia *Open Source*. Para instalarlo, añada el soporte para descargar paquetes del repositorio **non-free**: * Debian 11 :: echo "deb http://deb.debian.org/debian bullseye main contrib non-free" >> /etc/apt/sources.list * Debian 10 :: echo "deb http://deb.debian.org/debian buster main contrib non-free" >> /etc/apt/sources.list Inmediatamente, instale el paquete ``snmp-mibs-downloader``: :: apt update && apt install -y snmp-mibs-downloader Configuración e inicio ^^^^^^^^^^^^^^^^^^^^^^ Tras instalar el paquete, se ejecutará el proceso de despliegue mediante el siguiente comando. **Este proceso puede llegar a tardar alrededor de 5 minutos**. :: wocu-ctl configure .. Note:: Adicionalmente, puede obtener información sobre el estado actual de sus procesos ejecutando (en otra terminal) el siguiente comando: :: tail -f /tmp/minion.salt.log A modo de ejemplo, esta sería una posible respuesta del comando de estado: .. image:: ../images/administrator_guide/7_073_example_response.png :align: center :scale: 25% A continuación, el fichero ``/etc/hosts`` debe ser modificado ejecutando el siguiente comando: :: echo -e "#WOCU \n wocu\n" >> /etc/hosts Utilice la siguiente orden para lanzar los procesos de **WOCU-Monitoring**: :: wocu-ctl start Seguidamente, compruebe el estado de los procesos arrancados a través de esta orden: :: wocu-ctl status && systemctl status mysql El resultado esperado sería el siguiente: :: chromium RUNNING elasticsearch RUNNING grafana RUNNING influxdb RUNNING kibana STOPPED lmd RUNNING lmd-aggregator RUNNING memcached RUNNING mongodb RUNNING nginx RUNNING npcd RUNNING php-fpm RUNNING rabbitmq RUNNING redis RUNNING rrdcached RUNNING shinken:shinken-arbiter RUNNING shinken:shinken-broker RUNNING shinken:shinken-poller RUNNING shinken:shinken-reactionner RUNNING shinken:shinken-receiver RUNNING shinken:shinken-scheduler RUNNING snmptrapd RUNNING snmptt RUNNING td-agent RUNNING thruk RUNNING wocu-aggregator RUNNING wocu-aggregator-workers:generic-worker RUNNING wocu-aggregator-workers:report-arbiter RUNNING wocu-aggregator-workers:report-notifier RUNNING wocu-aggregator-workers:report-runner RUNNING wocu-aggregator-workers:workers-beat RUNNING wocu-import-tool RUNNING wocu-import-tool-celery-beat RUNNING wocu-import-tool-celery-flower RUNNING wocu-import-tool-celery-monitor RUNNING wocu-import-tool-celery-worker RUNNING wocu-snmptrap-consumer RUNNING .. attention:: **Kibana** está siempre desactivado por defecto. Acceda al interfaz de **WOCU-Monitoring** en la siguiente dirección desde su navegador: :: https:///aggregator Por defecto las credenciales de acceso son: :: User: admin Pass: admin .. Important:: Por cuestiones de seguridad, le recomendamos modificar la contraseña de administrador en el primer acceso. Puede continuar con los :ref:`first_steps` recomendados, para acceder al portal web, terminar de configurar la herramienta y empezar a monitorizar sus dispositivos. Instalación de licencias ------------------------ Operaciones ^^^^^^^^^^^ Para configurar la licencia de **WOCU-Monitoring** a partir de la versión 57, primero será necesario obtener una licencia válida contactando con el `Equipo Comercial `_. La licencia debe incluirse en los siguientes componentes de **WOCU-Monitoring**: - Aggregator - Import-tool Lo cual significa que los siguientes componentes necesitarán una licencia: - AIO - agrgegator - monitoring - monitoring-aio - monitoring-visor Para instalar la licencia, dispondrá de un archivo comprimido (.zip) con dos archivos: - wocu.license - wocu_key.pub 1. Para el componente **Aggregator**, la referencia de esos archivos se encuentran en: ``/etc/wocu/default.yml``. :: wocu-aggregator: license_file_path: /etc/wocu/wocu.license license_public_key_file_path: /etc/wocu/wocu.license.key.pub A continuación, es necesario copiar los archivos extraídos en las rutas especificadas: - **wocu.license**: mover/copiar a ``/etc/wocu/wocu.license`` - **wocu_key.pub**: mover/copiar a ``/etc/wocu/wocu.license.key.pub`` 2. Para el componente **Import-Tool**, la referencia de esos archivos se encuentran en: ``/etc/wocu/default.yml``. :: wocu-import-tool: license_file_path: /etc/wocu/wocu.license license_public_key_file_path: /etc/wocu/wocu.license.key.pub A continuación, es necesario copiar los archivos extraídos en las rutas especificadas: - **wocu.license**: mover/copiar a ``/etc/wocu/wocu.license`` - **wocu_key.pub**: mover/copiar a ``/etc/wocu/wocu.license.key.pub`` Completado lo anterior, configure y reinicie los componentes: * **AIO and Monitoring-AIO** :: wocu-ctl configure wocu-ctl restart wocu-aggregator wocu-ctl restart wocu-import-tool * **aggregator and aggregator-api** :: wocu-ctl configure wocu-ctl restart wocu-aggregator * **monitoring and monitoring-visor** :: wocu-ctl configure wocu-ctl restart wocu-import-tool