#5766 "A root helper the agent can start, for a fixed set of maintenance actions and nothing else", milestone 514. The agent runs unprivileged under NoNewPrivileges, so it can't update or reboot its host. It now leaves a request in /var/lib/steward-agent/requests, the one path its unit lets it write; steward-maint.path starts maint.py as root, which reads it without following links, accepts only update, reboot, drain or undrain, deletes it, and writes the outcome to /var/lib/steward-maint/results. The agent (1.17.0) reports each new result state once as a `maintenance` event, re-checks pending updates when an update finishes, and says in its metadata whether the helper is installed. The units and the helper are served from one copy at /plugins/host_agent/files/<name> (a fixed list), and install.sh plus the install, provision and update playbooks all fetch them, replacing three inline copies of the unit. Update agent installs the helper on existing hosts; the Agent panel says under Manage agent whether it is there. Steward handing out jobs is #5767; the cadence is #5768. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
187 lines
6.9 KiB
YAML
187 lines
6.9 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
|
|
|
|
# Let the agent read the local Docker socket so it can report this host's
|
|
# containers (the per-host docker collection path). Best-effort: skipped on
|
|
# hosts without Docker. Restart picks up the new supplementary group.
|
|
- name: Detect docker group
|
|
ansible.builtin.command: getent group docker
|
|
register: _docker_grp
|
|
changed_when: false
|
|
failed_when: false
|
|
|
|
- name: Add steward-agent to the docker group
|
|
ansible.builtin.user:
|
|
name: steward-agent
|
|
groups: docker
|
|
append: true
|
|
when: _docker_grp.rc == 0
|
|
notify: restart steward-agent
|
|
|
|
- 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
|
|
# The content carries steward_token; --diff and a failure would print it.
|
|
no_log: true
|
|
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
|
|
|
|
# The units and the maintenance helper come from Steward: one copy for
|
|
# install.sh and every playbook (#5766). The agent may write only its
|
|
# request directory; the helper and its results stay root's.
|
|
- name: Create the maintenance directories
|
|
ansible.builtin.file:
|
|
path: "{{ item.path }}"
|
|
state: directory
|
|
owner: "{{ item.owner }}"
|
|
group: "{{ item.owner }}"
|
|
mode: "{{ item.mode }}"
|
|
loop:
|
|
- {path: /var/lib/steward-agent, owner: root, mode: "0755"}
|
|
- {path: /var/lib/steward-agent/requests, owner: steward-agent, mode: "0700"}
|
|
- {path: /var/lib/steward-maint, owner: root, mode: "0755"}
|
|
- {path: /var/lib/steward-maint/results, owner: root, mode: "0755"}
|
|
|
|
- name: Download the maintenance helper
|
|
ansible.builtin.get_url:
|
|
url: "{{ steward_url }}/plugins/host_agent/files/maint.py"
|
|
dest: /usr/local/lib/steward-agent/maint.py
|
|
owner: root
|
|
mode: "0755"
|
|
force: true
|
|
|
|
- name: Install the agent and maintenance units
|
|
ansible.builtin.get_url:
|
|
url: "{{ steward_url }}/plugins/host_agent/files/{{ item }}"
|
|
dest: "/etc/systemd/system/{{ item }}"
|
|
owner: root
|
|
mode: "0644"
|
|
force: true
|
|
loop: [steward-agent.service, steward-maint.service, steward-maint.path]
|
|
notify: restart steward-agent
|
|
|
|
- name: Watch for maintenance requests
|
|
ansible.builtin.systemd:
|
|
name: steward-maint.path
|
|
enabled: true
|
|
state: started
|
|
daemon_reload: true
|
|
|
|
- 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
|