Files
fait-zabbix-public/bootstrap.sh
T

433 lines
19 KiB
Bash

#!/usr/bin/env bash
set -euo pipefail
export LC_ALL=C
################################################################################
# FAIT Zabbix - Enrolement d un noeud de supervision
#
# curl -fsSL https://.../bootstrap.sh | sudo FAIT_CLIENT=acme FAIT_TOKEN=xxx bash
#
# La meme ligne vaut pour toutes les machines d un meme client : rien n est a
# personnaliser par machine.
#
# FAIT_TOKEN sur la ligne de commande ci-dessus finit dans l argv de sudo,
# donc dans /proc/<pid>/cmdline, lisible par tout utilisateur local le temps
# que la commande tourne. Pour l eviter, ecrire le jeton dans un fichier et
# passer FAIT_TOKEN_FILE a la place :
#
# curl -fsSL https://.../bootstrap.sh | sudo FAIT_CLIENT=acme FAIT_TOKEN_FILE=/root/jeton bash
#
# FAIT_TOKEN reste accepte pour compatibilite, mais FAIT_TOKEN_FILE est la
# forme recommandee des que le jeton n est pas jetable.
#
# Le script demande qui collecte ce noeud : le serveur central en direct (le
# defaut), ou un proxy dont on donne l adresse. Sans terminal, la question ne
# se pose pas et le defaut s applique ; pour viser un proxy en provisionnement,
# passer ZBX_PROXY_IP :
#
# curl -fsSL https://.../bootstrap.sh | sudo FAIT_CLIENT=acme \
# FAIT_TOKEN_FILE=/root/jeton ZBX_PROXY_IP=10.20.0.5 bash
#
# Le noeud ne clone plus le depot. Il recoit un paquet Debian signe, et se met
# a jour tout seul ensuite via fait-zabbix-update.timer.
#
# Sur une machine qui a deja eu un Zabbix, l ancienne conf de l agent et les
# anciens scripts sont deplaces dans /var/backups/fait-zabbix/avant-fait-<date>
# avant l installation, et un ancien zabbix-agent est desactive. Rien n est
# supprime (voir reprendre_existant).
################################################################################
FAIT_CLIENT="${FAIT_CLIENT:-}"
FAIT_TOKEN="${FAIT_TOKEN:-}"
FAIT_TOKEN_FILE="${FAIT_TOKEN_FILE:-}"
ZABBIX_MAJOR="${ZABBIX_MAJOR:-7.0}"
ZBX_SERVER="${ZBX_SERVER:-sup.fabout.it}"
ZBX_SERVER_ACTIVE="${ZBX_SERVER_ACTIVE:-${ZBX_SERVER}}"
ZBX_HOSTNAME="${ZBX_HOSTNAME:-}"
ZBX_BIND_IP="${ZBX_BIND_IP:-}"
# Qui collecte ce noeud : vide = le serveur central en direct. Renseignee, la
# valeur remplace Server ET ServerActive (voir choisir_collecteur).
ZBX_PROXY_IP="${ZBX_PROXY_IP:-}"
REPO_HOST="${FAIT_REPO_HOST:-repo.fabout.it}"
AUTH_FILE=/etc/apt/auth.conf.d/fait-zabbix.conf
KEYRING=/etc/apt/keyrings/fait-supervision.asc
SOURCE_LIST=/etc/apt/sources.list.d/fait-zabbix.list
CLIENT_FILE=/etc/fait-zabbix/client
# Lu par update.sh : si FAIT_REPO_HOST a surcharge le defaut ici, l updater
# doit interroger le meme hote, sinon le fichier d authentification (dont la
# ligne "machine" vise REPO_HOST) ne correspond plus a l URL interrogee et
# les requetes partent sans identifiants.
REPO_HOST_FILE=/etc/fait-zabbix/repo-host
# Reprise d une machine qui a deja eu un Zabbix : ce qui en est mis de cote, et
# ou. Variables plutot qu en dur pour que tests/test_bootstrap.sh rejoue la
# reprise dans un repertoire jetable.
ZBX_ETC=/etc/zabbix
SUDOERS_FAIT=/etc/sudoers.d/zabbix-fait
SAUVEGARDE_RACINE=/var/backups/fait-zabbix
log() { echo "INFO: $*" >&2; }
warn() { echo "WARN: $*" >&2; }
err() { echo "ERROR: $*" >&2; exit 1; }
# Les parametres passent avant le controle de root : signaler une variable
# oubliee est plus utile que reclamer un sudo quand les deux manquent, et
# evite de relancer en root juste pour decouvrir la vraie erreur.
[[ -n "${FAIT_CLIENT}" ]] || err "FAIT_CLIENT est obligatoire : le nom du client, tel qu il figure dans le manifeste."
# FAIT_TOKEN_FILE evite que le jeton apparaisse dans /proc/<pid>/cmdline : on
# le lit ici, avant le controle d absence, pour que les deux formes soient
# equivalentes au reste du script.
if [[ -n "${FAIT_TOKEN_FILE}" ]]; then
[[ -r "${FAIT_TOKEN_FILE}" ]] || err "FAIT_TOKEN_FILE illisible : ${FAIT_TOKEN_FILE}"
FAIT_TOKEN="$(tr -d ' \t\r\n' < "${FAIT_TOKEN_FILE}")"
fi
[[ -n "${FAIT_TOKEN}" ]] || err "FAIT_TOKEN (ou FAIT_TOKEN_FILE) est obligatoire : le jeton de lecture du client."
[[ "${EUID}" -eq 0 ]] || err "A lancer en root (sudo)."
[[ -r /etc/os-release ]] || err "/etc/os-release introuvable, distribution non supportee."
# shellcheck disable=SC1091
. /etc/os-release
# --- prerequis ----------------------------------------------------------------
ensure_prereqs() {
local manquants=()
# shellcheck disable=SC2043
# La boucle ne porte qu un seul outil aujourd hui, mais reste une boucle :
# c est la ou un futur prerequis obligatoire s ajouterait, sans reprendre
# toute la fonction.
for c in curl; do command -v "$c" >/dev/null 2>&1 || manquants+=("$c"); done
if [[ ${#manquants[@]} -gt 0 ]] || ! dpkg -s ca-certificates >/dev/null 2>&1; then
log "Installation des prerequis : ${manquants[*]:-} ca-certificates"
apt-get update -y >/dev/null 2>&1 || true
DEBIAN_FRONTEND=noninteractive apt-get install -y \
${manquants[@]+"${manquants[@]}"} ca-certificates >/dev/null
fi
}
# --- depot Zabbix officiel ----------------------------------------------------
# zabbix-agent2 est une dependance stricte du paquet : sans ce depot, apt
# refuserait la transaction entiere.
ajouter_depot_zabbix() {
if command -v zabbix_agent2 >/dev/null 2>&1; then
log "zabbix-agent2 deja installe."
return 0
fi
local dist relver url tmp_deb
dist="${ID}"; [[ "${dist}" == "ubuntu" ]] || dist="debian"
# Zabbix nomme ses artefacts Ubuntu avec la version complete (ubuntu22.04),
# mais Debian avec le seul majeur (debian12) : un relver tronque a la
# majeure donnerait ubuntu22, qui n existe pas au depot Zabbix.
if [[ "${dist}" == "ubuntu" ]]; then
relver="${VERSION_ID}"
else
relver="${VERSION_ID%%.*}"
fi
url="https://repo.zabbix.com/zabbix/${ZABBIX_MAJOR}/${dist}/pool/main/z/zabbix-release/zabbix-release_latest+${dist}${relver}_all.deb"
log "Ajout du depot Zabbix ${ZABBIX_MAJOR} : ${url}"
# Pas de --remove-on-error : absent avant curl 7.83, donc de Debian 11 et
# Ubuntu 22.04. On telecharge dans un fichier temporaire et on ne l installe
# que si le telechargement a reussi ; un transfert tronque ne passe jamais
# a dpkg.
tmp_deb="$(mktemp --suffix=.deb)"
if ! curl -fsSL -o "${tmp_deb}" "${url}"; then
rm -f "${tmp_deb}"
err "Telechargement zabbix-release echoue."
fi
DEBIAN_FRONTEND=noninteractive dpkg -i "${tmp_deb}" >/dev/null
rm -f "${tmp_deb}"
}
# --- identifiants du client ---------------------------------------------------
poser_identifiants() {
install -d -m 0755 /etc/apt/auth.conf.d
# Cree en 0600 AVANT toute ecriture : l ecrire puis le restreindre laisserait
# le jeton lisible par tous dans l intervalle.
install -m 0600 /dev/null "${AUTH_FILE}"
cat > "${AUTH_FILE}" <<EOF
machine ${REPO_HOST}
login ${FAIT_CLIENT}
password ${FAIT_TOKEN}
EOF
install -d -m 0755 /etc/fait-zabbix
printf '%s\n' "${FAIT_CLIENT}" > "${CLIENT_FILE}"
chmod 0644 "${CLIENT_FILE}"
printf '%s\n' "${REPO_HOST}" > "${REPO_HOST_FILE}"
chmod 0644 "${REPO_HOST_FILE}"
log "Identifiants poses pour le client ${FAIT_CLIENT}."
}
# --- cle de signature ---------------------------------------------------------
# L organisation etant privee, la cle n est pas servie anonymement : elle est
# recuperee avec les identifiants poses juste avant, jamais passes en argument.
# Pas de --remove-on-error (absent avant curl 7.83, donc de Debian 11 et
# Ubuntu 22.04) : on telecharge vers un fichier temporaire et on ne le
# promeut en cle qu apres coup, ce qui protege pareillement contre un
# transfert tronque qui passerait quand meme le controle head -1 ci-dessous.
poser_cle() {
install -d -m 0755 /etc/apt/keyrings
local tmp_cle
tmp_cle="$(mktemp)"
if ! curl -fsSL --netrc-file "${AUTH_FILE}" \
"https://${REPO_HOST}/repository.key" -o "${tmp_cle}"; then
rm -f "${tmp_cle}"
err "Recuperation de la cle de signature echouee."
fi
head -1 "${tmp_cle}" | grep -q "BEGIN PGP PUBLIC KEY BLOCK" || {
rm -f "${tmp_cle}"
err "Le fichier recupere n est pas une cle PGP."
}
install -m 0644 "${tmp_cle}" "${KEYRING}"
rm -f "${tmp_cle}"
log "Cle de signature en place."
}
# arch=all : le registre Debian de Gitea annonce "Architectures: all" et ne
# publiera jamais d index binary-amd64. Sans cette mention, apt en reclame un a
# chaque update et affiche un Notice sur la machine du client - inoffensif, mais
# c est le genre de ligne rouge qui fait ouvrir un ticket. A ne retirer que si
# le paquet cesse un jour d etre Architecture: all.
poser_source() {
cat > "${SOURCE_LIST}" <<EOF
deb [arch=all signed-by=${KEYRING}] https://${REPO_HOST} stable main
EOF
chmod 0644 "${SOURCE_LIST}"
}
# --- qui collecte ce noeud ----------------------------------------------------
# [[ -r /dev/tty ]] ne suffit pas : sous cron ou systemd, le fichier existe et
# passe le test, mais l ouvrir rend "No such device or address". On tente donc
# reellement l ouverture, en silencant l erreur, plutot que de se fier au test.
tty_disponible() {
{ : < /dev/tty; } 2>/dev/null
}
# Lit sur /dev/tty et non sur stdin : sous "curl ... | sudo bash", stdin est le
# code source du script, et un read classique en avalerait la suite. Meme
# mecanisme que setup_proxy.sh, pour la meme raison.
demander() {
local invite="$1" defaut="${2:-}" reponse=""
tty_disponible || return 1
if [[ -n "${defaut}" ]]; then
printf '%s [%s] : ' "${invite}" "${defaut}" > /dev/tty
else
printf '%s : ' "${invite}" > /dev/tty
fi
IFS= read -r reponse < /dev/tty || return 1
printf '%s' "${reponse:-${defaut}}"
}
# Contrairement a setup_proxy.sh, l absence de reponse a un defaut sur : le
# serveur central en direct, qui est la configuration du parc aujourd hui. On
# n exige donc rien en non-interactif, et un provisionnement existant qui ne
# passe pas ZBX_PROXY_IP continue de produire exactement la meme conf qu avant.
choisir_collecteur() {
# Une valeur passee en variable tranche deja la question : ne pas la reposer.
if [[ -z "${ZBX_PROXY_IP}" ]] && tty_disponible; then
local reponse
reponse="$(demander "Qui collecte ce noeud ? [D]irect depuis ${ZBX_SERVER}, ou IP d un proxy" "D")" || reponse="D"
case "${reponse}" in
D|d|Direct|direct|"") ;;
*) ZBX_PROXY_IP="${reponse}" ;;
esac
fi
[[ -n "${ZBX_PROXY_IP}" ]] || { log "Collecte en direct depuis ${ZBX_SERVER}."; return 0; }
# Un nom d hote est accepte autant qu une IP : l agent resout l un comme l
# autre. On refuse en revanche les espaces, qui signalent une saisie prise
# pour une phrase et produiraient une directive Server invalide.
[[ "${ZBX_PROXY_IP}" != *[[:space:]]* ]] \
|| err "Adresse de proxy invalide : ${ZBX_PROXY_IP}"
# Les deux directives visent le proxy : le noeud ne parle qu a lui, et n a
# plus besoin de joindre le serveur central. C est la raison d etre du proxy
# (voir docs/installation-proxy.md) ; laisser Server= sur le serveur central
# exigerait que le noeud reste joignable depuis lui, ce que le proxy existe
# justement pour eviter.
ZBX_SERVER="${ZBX_PROXY_IP}"
ZBX_SERVER_ACTIVE="${ZBX_PROXY_IP}"
log "Collecte via le proxy ${ZBX_PROXY_IP}."
# Le proxy doit connaitre ce noeud du cote serveur : l hote doit y etre
# rattache dans Zabbix, sinon l agent emet dans le vide sans erreur locale.
warn "Rattacher cet hote au proxy ${ZBX_PROXY_IP} dans Zabbix, sinon ses donnees n arriveront pas."
}
# --- reprise d une installation existante -------------------------------------
# Sur une machine qui a deja eu un Zabbix, l ancienne conf de l agent survit a
# l installation du paquet : un UserParameter en double empeche agent2 de
# demarrer, une conf sans Include de plugins.d laisse nos items sans donnees,
# et un ancien agent classique garde le port 10050. On ne supprime rien : ce
# que l agent2 lit, plus les anciens scripts, est deplace dans une sauvegarde
# datee qui garde les chemins d origine. Le reste de /etc/zabbix (conf d un
# proxy pose par setup_proxy.sh, d un serveur) ne concerne pas l agent et
# reste en place.
reprendre_existant() {
# On ne reprend que si notre paquet n a jamais ete installe, ou n en a laisse
# que ses conffiles. Tout autre etat (installed, mais aussi unpacked ou
# half-configured apres un bootstrap ou un update.sh interrompu) est un de nos
# noeuds : y deplacer nos fichiers les perdrait, car apt-get install verrait
# le paquet deja a jour et ne les reposerait jamais.
local statut
statut="$(dpkg-query -W -f='${db:Status-Status}' fait-zabbix 2>/dev/null || true)"
case "${statut}" in
''|not-installed|config-files) ;;
*) return 0 ;;
esac
local a_deplacer=() c conf_agent=0 agent1=0
for c in "${ZBX_ETC}/zabbix_agent2.conf" "${ZBX_ETC}/zabbix_agent2.d" \
"${ZBX_ETC}/scripts" "${SUDOERS_FAIT}"; do
[[ -e "${c}" || -L "${c}" ]] || continue
a_deplacer+=("${c}")
if [[ "${c}" == "${ZBX_ETC}/zabbix_agent2"* ]]; then conf_agent=1; fi
done
if systemctl is-active --quiet zabbix-agent 2>/dev/null \
|| systemctl is-enabled --quiet zabbix-agent 2>/dev/null; then
agent1=1
fi
[[ ${#a_deplacer[@]} -gt 0 || ${agent1} -eq 1 ]] || return 0
log "Installation Zabbix existante detectee : reprise sans suppression."
# Une conf deplacee est, pour dpkg, une conf que l operateur a supprimee
# expres : il ne la reposerait jamais. Il faut donc reinstaller agent2 (et
# ses plugins chargeables) avec --force-confmiss.
local paquets=()
if [[ ${conf_agent} -eq 1 ]]; then
paquets=(zabbix-agent2)
mapfile -t -O 1 paquets < <(
dpkg-query -W -f='${Package} ${db:Status-Status}\n' 'zabbix-agent2-plugin-*' 2>/dev/null \
| awk '$2 == "installed" { print $1 }')
fi
# Tout ce qui doit s installer apres le deplacement est d abord telecharge :
# en cas d echec, rien n a encore bouge. fait-zabbix en fait partie, sinon
# une dependance introuvable laisserait la machine avec une conf vierge
# pointant 127.0.0.1, supervisee par personne. Le code de retour ne suffit
# pas : une version installee qui n est plus au depot fait repondre a apt
# "Reinstallation of X is not possible" avec un code 0.
local sortie
sortie="$(DEBIAN_FRONTEND=noninteractive apt-get install -y --reinstall --download-only \
${paquets[@]+"${paquets[@]}"} fait-zabbix 2>&1)" \
&& ! grep -q "is not possible" <<< "${sortie}" \
|| err "Paquets non telechargeables, reprise abandonnee. Rien n a ete modifie.
$(grep -E "^E: |is not possible" <<< "${sortie}")"
# Desactive, pas desinstalle : il suffit qu il libere le port 10050. Avant
# tout deplacement : s il refuse de s arreter, on s arrete aussi, la machine
# intacte, plutot que d installer un agent2 qui ne pourra jamais ecouter.
if [[ ${agent1} -eq 1 ]]; then
systemctl disable --now zabbix-agent >/dev/null 2>&1 \
|| err "Impossible d arreter l ancien zabbix-agent, qui garde le port 10050. Rien n a ete modifie."
log "Ancien zabbix-agent arrete et desactive (paquet conserve)."
fi
if [[ ${#a_deplacer[@]} -gt 0 ]]; then
local dest
dest="${SAUVEGARDE_RACINE}/avant-fait-$(date +%Y%m%d-%H%M%S)"
# 0700 : on y deplace un sudoers et des confs qui peuvent nommer un
# fichier PSK.
( umask 077; mkdir -p "${dest}" ) || err "Impossible de creer ${dest}. Rien n a ete deplace."
for c in "${a_deplacer[@]}"; do
{ mkdir -p "$(dirname "${dest}${c}")" && mv "${c}" "${dest}${c}"; } \
|| err "Echec du deplacement de ${c} vers ${dest} (disque plein ?). Ce qui est deja deplace y est ; remettre en place avant de relancer."
log " ${c} -> ${dest}${c}"
done
log "Anciennes confs et scripts mis de cote dans ${dest}"
fi
if [[ ${#paquets[@]} -gt 0 ]]; then
local conf="${ZBX_ETC}/zabbix_agent2.conf"
DEBIAN_FRONTEND=noninteractive apt-get install -y --reinstall \
-o Dpkg::Options::=--force-confmiss "${paquets[@]}" >/dev/null \
|| err "Reinstallation de ${paquets[*]} echouee ; les anciennes confs sont dans ${dest}."
# apt peut repondre 0 sans rien reinstaller : on juge sur le resultat.
[[ -f "${conf}" ]] \
|| err "Aucune conf agent2 reposee apres reinstallation ; les anciennes confs sont dans ${dest}."
# La conf livree par un agent2 ancien n inclut pas forcement plugins.d,
# ou le paquet pose nos UserParameter : sans cette ligne, nos items
# resteraient sans donnees, sans erreur.
if ! grep -q '^Include=.*plugins\.d' "${conf}"; then
printf 'Include=%s/zabbix_agent2.d/plugins.d/*.conf\n' "${ZBX_ETC}" >> "${conf}"
log "Include de plugins.d ajoute a ${conf}."
fi
log "Conf vierge de zabbix-agent2 reposee."
fi
}
# --- conf agent ---------------------------------------------------------------
render_conf() {
local dest=/etc/zabbix/zabbix_agent2.conf host bind
host="${ZBX_HOSTNAME:-$(hostname -f 2>/dev/null || hostname)}"
bind="${ZBX_BIND_IP:-$(ip route get 1.1.1.1 2>/dev/null | awk '{for(i=1;i<=NF;i++) if($i=="src"){print $(i+1); exit}}')}"
[[ -n "${bind}" ]] || bind="0.0.0.0"
[[ -f "${dest}" ]] || { warn "Conf agent absente, elle sera celle du paquet zabbix-agent2."; return 0; }
local bak; bak="${dest}.bak.$(date +%Y%m%d-%H%M%S 2>/dev/null || echo "$$")"
# shellcheck disable=SC2015
# log() est un echo qui ne rend jamais un code non nul : le A && B || C
# ci-dessous ne peut pas executer C apres un A reussi.
cp -a "${dest}" "${bak}" \
&& log "Conf existante sauvegardee : ${bak}" \
|| warn "Echec de la sauvegarde de ${dest} ; la conf va etre reecrite sans copie."
sed -i -e "s|^SourceIP=.*|SourceIP=${bind}|" \
-e "s|^ListenIP=.*|ListenIP=${bind}|" \
-e "s|^Hostname=.*|Hostname=${host}|" \
-e "s|^Server=.*|Server=${ZBX_SERVER}|" \
-e "s|^ServerActive=.*|ServerActive=${ZBX_SERVER_ACTIVE}|" \
"${dest}"
log "Conf agent ajustee (Hostname=${host}, Server=${ZBX_SERVER})."
}
ensure_docker_access() {
command -v docker >/dev/null 2>&1 || return 0
getent group docker >/dev/null 2>&1 || return 0
id zabbix >/dev/null 2>&1 || return 0
id -nG zabbix 2>/dev/null | tr ' ' '\n' | grep -qx docker && return 0
log "Ajout de l utilisateur zabbix au groupe docker."
usermod -aG docker zabbix || warn "Echec de l ajout au groupe docker."
}
main() {
# Avant toute installation : une question posee ici echoue vite, alors que la
# meme question apres apt-get laisserait l operateur devant un terminal apres
# plusieurs minutes de telechargement.
choisir_collecteur
ensure_prereqs
ajouter_depot_zabbix
poser_identifiants
poser_cle
poser_source
apt-get update -y >/dev/null
# Apres l update : la reprise verifie que zabbix-agent2 est telechargeable
# avant de deplacer quoi que ce soit.
reprendre_existant
log "Installation de fait-zabbix..."
# --force-confmiss : un fait-zabbix desinstalle sans purge laisse ses
# conffiles connus de dpkg ; la reprise vient de les deplacer, et sans cette
# option dpkg les tiendrait pour supprimes expres et ne poserait aucun
# UserParameter. Sans effet sur un noeud deja a jour.
DEBIAN_FRONTEND=noninteractive apt-get install -y \
-o Dpkg::Options::=--force-confmiss fait-zabbix
render_conf
ensure_docker_access
systemctl restart zabbix-agent2 || true
# Le paquet vient d etre installe a la version la plus recente du depot ;
# le manifeste peut en vouloir une autre, ou geler ce client. On converge
# donc une fois, tout de suite, plutot que d attendre le premier reveil du
# timer et de laisser tourner une version non assignee pendant dix minutes.
if [[ -x /usr/lib/fait-zabbix/update.sh ]]; then
/usr/lib/fait-zabbix/update.sh || warn "La convergence initiale a echoue ; le timer reessaiera."
fi
log "Enrolement termine. La machine converge desormais seule vers le manifeste."
}
main "$@"