Guía completa para supervisar el estado del clúster Proxmox en Linux

Mantener la estabilidad y el rendimiento de un clúster Proxmox es crucial para los profesionales de TI y los proveedores de servicios gestionados (MSP). Un clúster Proxmox ofrece numerosas ventajas, como alta disponibilidad, gestión eficiente de recursos y virtualización sin interrupciones. Sin embargo, controlar su estado es esencial para garantizar un buen funcionamiento.

Este post profundiza en un script Bash diseñado para supervisar el estado del clúster Proxmox y guardarlo en un campo personalizado. Exploraremos la funcionalidad del script, posibles casos de uso, comparaciones, preguntas frecuentes, implicaciones y buenas prácticas.

Contexto

Proxmox Virtual Environment (VE) es una solución de gestión de virtualización de servidores de código abierto que permite a los profesionales de TI desplegar y gestionar máquinas virtuales y contenedores. La agrupación en clústeres en Proxmox es una característica fundamental que permite que varios nodos Proxmox VE trabajen juntos, proporcionando alta disponibilidad y equilibrio de carga. Supervisar el estado del clúster Proxmox es vital para mantener la integridad y el rendimiento del entorno virtual.

Este script está diseñado para profesionales de TI que necesitan una forma eficiente de monitorizar clusters Proxmox. Obtiene el estado del clúster Proxmox y guarda la información en un campo personalizado multilínea o en un campo personalizado WYSIWYG, lo que facilita gestionar y supervisar el estado del clúster Proxmox.

El script para supervisar el estado del clúster Proxmox

#!/usr/bin/env bash

# Description: Get the Proxmox Cluster Status and save it to a multiline and/or WYSIWYG custom field
#
# Release Notes: Fixed 10% width bug.
# By using this script, you indicate your acceptance of the following legal terms as well as our Terms of Use at https://www.ninjaone.com/terms-of-use.
# Ownership Rights: NinjaOne owns and will continue to own all right, title, and interest in and to the script (including the copyright). NinjaOne is giving you a limited license to use the script in accordance with these legal terms. 
# Use Limitation: You may only use the script for your legitimate personal or internal business purposes, and you may not share the script with another party. 
# Republication Prohibition: Under no circumstances are you permitted to re-publish the script in any script library or website belonging to or under the control of any other software provider. 
# Warranty Disclaimer: The script is provided “as is” and “as available”, without warranty of any kind. NinjaOne makes no promise or guarantee that the script will be free from defects or that it will meet your specific needs or expectations. 
# Assumption of Risk: Your use of the script is at your own risk. You acknowledge that there are certain inherent risks in using the script, and you understand and assume each of those risks. 
# Waiver and Release: You will not hold NinjaOne responsible for any adverse or unintended consequences resulting from your use of the script, and you waive any legal or equitable rights or remedies you may have against NinjaOne relating to your use of the script. 
# EULA: If you are a NinjaOne customer, your use of the script is subject to the End User License Agreement applicable to you (EULA).

# Command line arguments, swap the numbers if you want the multiline custom field to be the second argument
multiline_custom_field=$1 # First argument is the multiline custom field name
wysiwyg_custom_field=$2   # Second argument is the WYSIWYG custom field name

if [[ -n "${multilineCustomField}" && "${multilineCustomField}" != "null" ]]; then
    multiline_custom_field=$multilineCustomField
fi
if [[ -n "${wysiwygCustomField}" && "${wysiwygCustomField}" != "null" ]]; then
    wysiwyg_custom_field=$wysiwygCustomField
fi

if [[ -n "${multiline_custom_field}" && "${multiline_custom_field}" == "${wysiwyg_custom_field}" ]]; then
    echo "[Error] multilineCustomField and wysiwygCustomField cannot be the same custom field."
    exit 1
fi

if [[ -z "${multiline_custom_field}" ]]; then
    echo "[Info] multilineCustomField is not set."
fi
if [[ -z "${wysiwyg_custom_field}" ]]; then
    echo "[Info] wysiwygCustomField is not set."
fi

# Check that we have the required tools
if ! command -v pvecm &>/dev/null; then
    echo "[Error] The Proxmox VE API tool 'pvecm' is required."
    exit 1
fi

# Check that we are running as root
if [[ $EUID -ne 0 ]]; then
    echo "[Error] This script must be run as root."
    exit 1
fi

# Check if ninjarmm-cli command exists
ninjarmm_cli="/opt/NinjaRMMAgent/programdata/ninjarmm-cli"
if [[ -z $ninjarmm_cli ]]; then
    echo "[Error] The ninjarmm-cli command does not exist in the default path. Please ensure the NinjaRMM agent is installed before running this script."
    exit 1
else
    # ninjarmm-cli command exists in the default path
    echo -n
fi

# Run the pvecm command to get the status information
if ! pvecm_status_output=$(pvecm status); then
    echo "[Error] Failed to get the Proxmox Cluster Status."
    echo "$pvecm_status_output"
    exit 1
fi
# Example Output:
# Cluster information
# -------------------
# Name:             cluster1
# Config Version:   4
# Transport:        knet
# Secure auth:      on
#
# Quorum information
# ------------------
# Date:             Mon Apr  8 10:33:16 2024
# Quorum provider:  corosync_votequorum
# Nodes:            4
# Node ID:          0x00000004
# Ring ID:          1.631
# Quorate:          Yes
#
# Votequorum information
# ----------------------
# Expected votes:   4
# Highest expected: 4
# Total votes:      4
# Quorum:           3
# Flags:            Quorate
#
# Membership information
# ----------------------
#     Nodeid      Votes Name
# 0x00000001          1 10.10.10.17
# 0x00000002          1 10.10.10.18
# 0x00000003          1 10.10.10.19
# 0x00000004          1 10.10.10.20 (local)

# Cluster Table
# Get the cluster name
cluster_name=$(echo "$pvecm_status_output" | grep -oP 'Name:\s+\K\w+' | head -n 1)
# Get the Config Version
config_version=$(echo "$pvecm_status_output" | grep -oP 'Config Version:\s+\K\d+' | head -n 1)
# Get the Transport
transport=$(echo "$pvecm_status_output" | grep -oP 'Transport:\s+\K\w+' | head -n 1)
# Get the Secure auth
secure_auth=$(echo "$pvecm_status_output" | grep -oP 'Secure auth:\s+\K\w+' | head -n 1)

# Create Cluster Status label
cluster_table="<h2>Cluster Status</h2>"
# Create the Cluster Status table
cluster_table+="<table style='white-space:nowrap;'><tr><th>Cluster Name</th><th>Config Version</th><th>Transport</th><th>Secure Auth</th></tr>"
cluster_table+="<tr><td>$cluster_name</td><td>$config_version</td><td>$transport</td><td>$secure_auth</td></tr></table>"

# Quorum Table
# Get the Quorum Date
quorum_date=$(echo "$pvecm_status_output" | grep -oP 'Date:\s+\K.*' | head -n 1)
# Get the Quorum provider
quorum_provider=$(echo "$pvecm_status_output" | grep -oP 'Quorum provider:\s+\K\w+' | head -n 1)
# Get the Nodes
nodes=$(echo "$pvecm_status_output" | grep -oP 'Nodes:\s+\K\d+' | head -n 1)
# Get the Node ID
node_id=$(echo "$pvecm_status_output" | grep -oP 'Node ID:\s+\K\w+' | head -n 1)
# Get the Ring ID
ring_id=$(echo "$pvecm_status_output" | grep -oP 'Ring ID:\s+\K[\d.]+')
# Get the Quorate
quorate=$(echo "$pvecm_status_output" | grep -oP 'Quorate:\s+\K\w+')

# Create Quorum Status label
quorum_table="<h2>Quorum Status</h2>"
# Create the Quorum Status table
quorum_table+="<table style='white-space:nowrap;'><tr><th>Quorum Date</th><th>Quorum Provider</th><th>Nodes</th><th>Node ID</th><th>Ring ID</th><th>Quorate</th></tr>"
quorum_table+="<tr><td>$quorum_date</td><td>$quorum_provider</td><td>$nodes</td><td>$node_id</td><td>$ring_id</td><td>$quorate</td></tr></table>"

# Votequorum Table
# Get the Expected votes
expected_votes=$(echo "$pvecm_status_output" | grep -oP 'Expected votes:\s+\K\d+')
# Get the Highest expected
highest_expected=$(echo "$pvecm_status_output" | grep -oP 'Highest expected:\s+\K\d+')
# Get the Total votes
total_votes=$(echo "$pvecm_status_output" | grep -oP 'Total votes:\s+\K\d+')
# Get the Quorum
quorum=$(echo "$pvecm_status_output" | grep -oP 'Quorum:\s+\K\d+')
# Get the Flags
flags=$(echo "$pvecm_status_output" | grep -oP 'Flags:\s+\K\w+')

# Create Votequorum Status label
votequorum_table="<h2>Votequorum Status</h2>"
# Create the Votequorum Status table
votequorum_table+="<table style='white-space:nowrap;'><tr><th>Expected Votes</th><th>Highest Expected</th><th>Total Votes</th><th>Quorum</th><th>Flags</th></tr>"
votequorum_table+="<tr><td>$expected_votes</td><td>$highest_expected</td><td>$total_votes</td><td>$quorum</td><td>$flags</td></tr></table>"

# Get the Membership information table
memberships=$(echo "$pvecm_status_output" | grep -oP '0x000000\d+\s+\d+\s+\d+\.\d+\.\d+\.\d+')
# Split memberships into an array
OLDIFS=$IFS
IFS=$'\n' read -r -d '' -a membership_array <<<"$memberships"
IFS=$OLDIFS

# Membership Table
# Create Membership Status label
membership_table="<h2>Membership Status</h2>"
# Create the Membership Status table
membership_table+="<table style='white-space:nowrap;'><tr><th>Node ID</th><th>Votes</th><th>Name</th></tr>"
for membership in "${membership_array[@]}"; do
    node_id=$(echo "$membership" | grep -oP '0x000000\d+')
    votes=$(echo "$membership" | grep -oP '\d+\s+(?=\d+\.\d+\.\d+\.\d+)')
    name=$(echo "$membership" | grep -oP '\d+\.\d+\.\d+\.\d+')
    membership_table+="<tr><td>$node_id</td><td>$votes</td><td>$name</td></tr>"
done
membership_table+="</table>"

# Combine all tables into one
result_table="$cluster_table</br>$quorum_table</br>$votequorum_table</br>$membership_table"

# Save the result to the custom field
_exit_code=0
if [[ -n "$multiline_custom_field" ]]; then
    if [[ -x "$ninjarmm_cli" ]]; then
        if hideOutput=$("$ninjarmm_cli" set "$multiline_custom_field" "$pvecm_status_output" 2>&1); then
            echo "[Info] Successfully set custom field: $multiline_custom_field"
        else
            echo "[Error] Failed to set custom field: $multiline_custom_field. Custom Field does not exit or does not have write permissions."
            _exit_code=1
        fi
    else
        echo "[Error] NinjaRMM CLI not found or not executable"
        _exit_code=1
    fi
fi

if [[ -n "$wysiwyg_custom_field" ]]; then
    if [[ -x "$ninjarmm_cli" ]]; then
        if hideOutput=$("$ninjarmm_cli" set "$wysiwyg_custom_field" "$result_table" 2>&1); then
            echo "[Info] Successfully set custom field: $wysiwyg_custom_field"
        else
            echo "[Error] Failed to set custom field: $wysiwyg_custom_field. Custom Field does not exit or does not have write permissions."
            _exit_code=1
        fi
    else
        echo "[Error] NinjaRMM CLI not found or not executable"
        _exit_code=1
    fi
fi

# Error out after checking both custom fields
if [[ $_exit_code -ne 0 ]]; then
    exit 1
fi

# Output the result if no custom fields are set
if [[ -z "${wysiwyg_custom_field}" ]] && [[ -z "${multiline_custom_field}" ]]; then
    echo "${pvecm_status_output}"
fi

Análisis detallado

Vamos a desglosar el script paso a paso para entender su funcionamiento y la lógica que hay detrás.

Inicialización y argumentos de la línea de comandos: el script comienza tomando dos argumentos de la línea de comandos: los nombres de los campos personalizados multilínea y WYSIWYG.
Validación y configuración: valida y asigna valores a los campos personalizados, asegurándose de que no sean nulos o idénticos.
Comprobación de disponibilidad y permisos de la herramienta: el script comprueba si las herramientas necesarias, como pvecm y ninjarmm-cli, están disponibles y se asegura de que el script se ejecuta con privilegios de root.
Recuperación y análisis del estado del clúster Proxmox: ejecuta el comando pvecm status para recuperar el estado del clúster Proxmox y almacena el resultado en una variable.
Extracción de información relevante: el script utiliza grep y expresiones regulares para analizar y extraer información relevante, como el nombre del clúster, la versión de configuración, el método de transporte, el estado de autenticación segura, la información de quórum y los detalles de los miembros.
Creación de tablas HTML: el script formatea los datos extraídos en tablas HTML para una mejor legibilidad y organización.
Guardado de resultados en campos personalizados: dependiendo de la disponibilidad de los campos personalizados, el script guarda los resultados sin procesar y formateados en los campos personalizados especificados utilizando el comando ninjarmm-cli.

Posibles casos de uso

Considera un MSP gestione varios clústeres Proxmox para varios clientes. Comprobar y supervisar el estado del clúster Proxmox periódicamente puede llevar mucho tiempo. Este script automatiza el proceso, garantizando que la información de estado actualizada esté siempre disponible en un formato estructurado. Por ejemplo, un profesional de TI puede utilizar este script para:

Recopilar y guardar automáticamente el estado del clúster Proxmox cada mañana.

Generar informes de estado para los clientes, destacando la salud del clúster y cualquier problema potencial.

Integrar con herramientas de supervisión para activar alertas si determinadas métricas del clúster indican problemas.

Comparaciones

Aunque existen otros métodos para monitorizar clusters Proxmox, como las comprobaciones manuales o el uso de herramientas de monitorización de terceros, este script ofrece varias ventajas:

Automatización: a diferencia de las comprobaciones manuales, este script automatiza el proceso, reduciendo las posibilidades de error humano y ahorrando tiempo.

Personalización: la posibilidad de guardar la información de estado en campos personalizados facilita la integración con los sistemas de supervisión y elaboración de informes existentes.

Rentable: esta solución usa las herramientas y los scripts integrados, lo que evita tener que recurrir a costosas soluciones de terceros.

FAQ

P1: ¿Necesito ser un experto en scripts Bash para utilizar este script?

No, sólo necesitas conocimientos básicos sobre cómo ejecutar un script y entender sus parámetros.

P2: ¿Puedo personalizar el script para otros tipos de campos personalizados?

Sí, puedes modificar el script para gestionar campos personalizados adicionales ajustando las secciones pertinentes.

P3: ¿Qué ocurre si el script encuentra un error?

El script incluye gestión de errores para informarle de herramientas que faltan, problemas de permisos o fallos de comandos.

Implicaciones

Supervisar el estado del clúster Proxmox de forma regular ayuda a mantener la fiabilidad y el rendimiento del sistema. Con este script, los profesionales de TI pueden gestionar de forma proactiva el estado del clúster Proxmox, evitar tiempos de inactividad y garantizar una utilización óptima de los recursos. Esto contribuye a la seguridad informática general y a la eficacia operativa.

Recomendaciones

Ejecuta el script con regularidad: programa el script para que se ejecute a intervalos regulares mediante cron jobs para garantizar una supervisión continua.

Revisa los resultados: revisa periódicamente los resultados guardados para detectar a tiempo cualquier anomalía o problema.

Mantén copias de seguridad: mantén copias de seguridad de las configuraciones de tu cluster y actualiza regularmente los scripts para manejar nuevas versiones de Proxmox.

Reflexiones finales

La monitorización eficiente es crucial para la gestión de clústeres Proxmox, y este script Bash proporciona una solución racionalizada para los profesionales de TI y los MSP. Al automatizar la recopilación de estados y formatear los resultados en campos personalizados, mejora la capacidad de mantener el buen rendimiento y estado del clúster Proxmox. Herramientas como NinjaOne complementan este script proporcionando una plataforma integral para la gestión de TI, asegurando que todas tus necesidades de monitorización se satisfacen de manera eficiente.

Guía completa para supervisar el estado del clúster Proxmox en Linux

Contexto

El script para supervisar el estado del clúster Proxmox

Análisis detallado

Posibles casos de uso

Comparaciones

FAQ

P1: ¿Necesito ser un experto en scripts Bash para utilizar este script?

P2: ¿Puedo personalizar el script para otros tipos de campos personalizados?

P3: ¿Qué ocurre si el script encuentra un error?

Implicaciones

Recomendaciones

Reflexiones finales

Próximos pasos

Usa este script

Conecta con otros ninjas informáticos en Discord

Recursos

Empresa

Información de contacto

Contexto

El script para supervisar el estado del clúster Proxmox

Análisis detallado

Posibles casos de uso

Comparaciones

FAQ

P1: ¿Necesito ser un experto en scripts Bash para utilizar este script?

P2: ¿Puedo personalizar el script para otros tipos de campos personalizados?

P3: ¿Qué ocurre si el script encuentra un error?

Implicaciones

Recomendaciones

Reflexiones finales

Próximos pasos

Download the script

Términos y condiciones de NinjaOne