Files
ansibleTUI/examples/ansibletui.example.yaml

99 lines
3.0 KiB
YAML

# Example configuration for ansibleTUI
# Copy to: ~/.config/ansibletui/ansibletui.yaml
#
# mkdir -p ~/.config/ansibletui
# cp examples/ansibletui.example.yaml ~/.config/ansibletui/ansibletui.yaml
#
# On first run the app can also create ansibletui.yaml automatically and
# migrate a legacy ~/.config/ansibletui/config.yaml if present.
# --- Paths (used when git is disabled, or as fallbacks) ---
# Directory scanned for *.yml / *.yaml playbooks (excluding requirements, group_vars, etc.)
playbook_dir: ~/.ansibletui/playbooks
# Ansible inventory file (YAML format managed by the TUI)
inventory_path: ~/.ansibletui/inventory/inventory.yml
# Runtime hint: auto | wsl | native (reserved for future use)
runtime: auto
# Saved Ansible log detail: error | warn | info | debug | trace
# info keeps compact play/task/finding/recap lines; debug/trace keep raw Ansible output.
log_level: info
# Last selected playbook filename (updated by the TUI)
recent_playbook: ""
# --- Compliance mapping ---
#
# The app first looks for compliance.yaml in the playbook directory.
# If that file is absent, this inline mapping is used as a fallback.
#
# compliance:
# universal:
# - site.yml
# - playbook: site.yml
# tags: [sudo]
# groups:
# dns:
# - services/pi-hole.yml
# --- Playbooks git repository (optional) ---
playbooks_git:
# When true, EffectivePlaybookDir() uses path below; sync_on_startup runs git sync
enabled: false
# Git remote URL (required when enabled)
remote: git@github.com:you/ansible-playbooks.git
# Branch to clone / pull / push
branch: main
# Local clone directory
path: ~/.ansibletui/playbooks
# When path does not exist: clone (from remote) | init (empty repo, commit, push)
on_missing: clone
# Run git sync when the application starts
sync_on_startup: true
# --- Inventory git repository (optional) ---
inventory_git:
enabled: false
remote: git@github.com:you/ansible-inventory.git
branch: main
# Local clone root (inventory file lives inside this directory)
path: ~/.ansibletui/inventory
# Inventory filename relative to path
file: inventory.yml
# clone: pull existing repo | init: create repo and push (seeds empty inventory if needed)
on_missing: init
sync_on_startup: true
# --- VM Updater tab playbook paths (optional) ---
#
# Paths are relative to playbook_dir. Defaults apply when omitted.
# Copy the template playbooks from examples/playbooks/ to your playbook_dir.
#
# check_playbook: check_updates.yml # pre-check: counts pending updates, detects docker/reboot
# update_playbook: update_packages.yml # runs apt/dnf upgrade per host
# docker_playbook: docker_maintenance.yml # docker system prune (skips hosts without docker)
# reboot_playbook: reboot.yml # graceful reboot (requires confirmation in UI)
# --- Minimal setup (no git) ---
#
# playbook_dir: ~/homelab/ansible
# inventory_path: ~/.ansibletui/inventory.yml
# runtime: auto
# (omit playbooks_git / inventory_git or set enabled: false)