Files
FabledSteward/steward/ansible/bundled/host_agent/provision.yml
T
bvandeusen 42f7840c26
CI / lint (push) Successful in 2s
CI / unit (push) Successful in 8s
CI / integration (push) Successful in 2m14s
CI / publish (push) Successful in 59s
feat(ansible): steward:category + steward:confirm playbook metadata
Extend the playbook metadata convention with a namespaced `# steward:<key>:`
comment block:

- steward:category — free-text grouping label, shown as a badge in the browse
  list and on the run form.
- steward:confirm — true/yes/1/on marks a playbook destructive; the run form
  then requires a confirmation tick (required checkbox in the shared vars
  fragment) before it can launch.

sources.discover_playbook_meta() parses description + category + confirm (first
match per key; `# description:` still primary, `# steward:description:` alias).
discover_playbook_description() now delegates to it. The browse list reads
per-playbook meta to show category badges + descriptions; the run-form and
playbook-vars fragments render the badge + confirm gate.

Bundled playbooks tagged: docker_prune → category maintenance + confirm true;
provision/install/update → category host-agent.

Docs: docs/reference/playbook-authoring.md updated (keys now implemented) and a
quick reference added next to the code at steward/ansible/PLAYBOOK_CONVENTIONS.md.
Tests added for category/confirm/alias parsing.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-17 11:35:35 -04:00

153 lines
5.4 KiB
YAML

---
# description: Provision a fresh host — create the steward account + managed key + passwordless sudo, then install the agent.
# steward:category: host-agent
# First-contact provisioning: bring a fresh host under Steward management, then
# install the host agent — all in one idempotent run.
#
# Run this ONCE per host with bootstrap credentials (an existing login + sudo,
# typically password auth via the "Provision host" button). It:
# 1. creates a dedicated `steward` login account,
# 2. installs Steward's managed public key into its authorized_keys,
# 3. grants it passwordless sudo,
# 4. installs/updates the host agent.
# After this, every future run (agent updates, maintenance) connects as
# `steward` with the managed key — no operator credentials needed.
#
# Extra-vars (injected by the Provision card):
# steward_url, steward_token — agent → Steward auth (per-host)
# steward_pubkey — managed public key to authorize
# steward_user (default steward), agent_interval (default 30)
- name: Provision host for Steward + install agent
hosts: all
become: true
gather_facts: false
# steward_token is injected as a per-host inventory var (it differs per host),
# so it must NOT be declared here — a play var would outrank the inventory var
# and shadow it. The globals below arrive as extra-vars (highest precedence),
# which override these defaults.
vars:
steward_url: ""
steward_pubkey: ""
steward_user: steward
agent_interval: 30
tasks:
- name: Require provisioning vars
ansible.builtin.assert:
that:
- steward_url | default('') | length > 0
- steward_token | default('') | length > 0
- steward_pubkey | default('') | length > 0
fail_msg: "Pass steward_url, steward_token and steward_pubkey (Steward injects these)."
# ── Managed login account ────────────────────────────────────────────────
- name: Create the steward management account
ansible.builtin.user:
name: "{{ steward_user }}"
shell: /bin/sh
create_home: true
state: present
- name: Ensure ~/.ssh exists
ansible.builtin.file:
path: "/home/{{ steward_user }}/.ssh"
state: directory
owner: "{{ steward_user }}"
group: "{{ steward_user }}"
mode: "0700"
- name: Authorize the managed public key (replace any prior steward-managed key)
ansible.builtin.lineinfile:
path: "/home/{{ steward_user }}/.ssh/authorized_keys"
# Match on the ' steward-managed' comment so a rotated key REPLACES the
# old one in place rather than stacking a second authorized key. Any
# keys the operator added by hand (different comment) are left untouched.
regexp: ' steward-managed$'
line: "{{ steward_pubkey }}"
create: true
owner: "{{ steward_user }}"
group: "{{ steward_user }}"
mode: "0600"
- name: Grant passwordless sudo to the steward account
ansible.builtin.copy:
dest: "/etc/sudoers.d/steward"
content: "{{ steward_user }} ALL=(ALL) NOPASSWD:ALL\n"
owner: root
group: root
mode: "0440"
validate: "visudo -cf %s"
# ── Host agent (same as install.yml) ─────────────────────────────────────
- name: Create steward-agent system user
ansible.builtin.user:
name: steward-agent
system: true
shell: /usr/sbin/nologin
create_home: false
- name: Create agent directory
ansible.builtin.file:
path: /usr/local/lib/steward-agent
state: directory
mode: "0755"
- name: Download agent.py
ansible.builtin.get_url:
url: "{{ steward_url }}/plugins/host_agent/agent.py"
dest: /usr/local/lib/steward-agent/agent.py
mode: "0755"
force: true
notify: restart steward-agent
- name: Write agent config
ansible.builtin.copy:
dest: /etc/steward-agent.conf
owner: root
group: steward-agent
mode: "0640"
content: |
url = {{ steward_url }}
token = {{ steward_token }}
interval_seconds = {{ agent_interval }}
notify: restart steward-agent
- name: Install systemd unit
ansible.builtin.copy:
dest: /etc/systemd/system/steward-agent.service
mode: "0644"
content: |
[Unit]
Description=Steward host agent
After=network-online.target
Wants=network-online.target
[Service]
Type=simple
User=steward-agent
Environment=STEWARD_AGENT_CONFIG=/etc/steward-agent.conf
ExecStart=/usr/bin/env python3 /usr/local/lib/steward-agent/agent.py
Restart=on-failure
RestartSec=5
NoNewPrivileges=true
ProtectSystem=strict
ProtectHome=true
PrivateTmp=true
[Install]
WantedBy=multi-user.target
notify: restart steward-agent
- name: Enable and start the agent
ansible.builtin.systemd:
name: steward-agent
enabled: true
state: started
daemon_reload: true
handlers:
- name: restart steward-agent
ansible.builtin.systemd:
name: steward-agent
state: restarted
daemon_reload: true