Add systemd timer for periodic inspector

Author: pdmars

docs/operations/chameleon-tools/periodic-inspector.md

@@ -0,0 +1,23 @@
+# Periodic Inspector
+
+The periodic inspector can be run at sites to inspect the hardware
+characteristics of individual nodes.
+
+The periodic inspector tool is bundled into the site tools Docker
+image.
+
+A systemd timer is configured to run the inspector once a day.
+
+## Configuration and Execution
+
+The site tools containing the periodic inspector are installed onto the
+`control` node in the site configuration Ansible inventory. The configuration
+steps are included in the `post-deploy`. You can also manually configure and
+run the image tools by executing the `chameleon_periodic_inspector` playbook.
+
+```shell
+cc-ansible --playbook playbooks/chameleon_periodic_inspector.yml
+```
+
+The playbook will pull the latest `chameleon_periodic_inspector` Docker image
+to run the tool.

playbooks/chameleon_periodic_inspector.yml

@@ -0,0 +1,4 @@
+---
+- hosts: chameleon-periodic-inspector
+  roles:
+    - chameleon_periodic_inspector

playbooks/post_deploy.yml

@@ -14,6 +14,9 @@
 - hosts: chameleon-image-tools
   roles: [chameleon_image_tools]
 
+- hosts: chameleon-periodic-inspector
+  roles: [chameleon_periodic_inspector]
+
 - hosts: deployment
   roles:
     - role: chameleon_mariadb

roles/chameleon_periodic_inspector/defaults/main.yml

@@ -0,0 +1,9 @@
+---
+chameleon_resource_discovery_docker_image: ghcr.io/chameleoncloud/chameleon_site_tools:sha-384af41
+chameleon_resource_discovery_config_dir: /etc/hammers
+
+chameleon_resource_discovery_parallel: 5
+chameleon_resource_discovery_limit: 5
+chameleon_resource_discovery_provide_manageable: true
+chameleon_resource_discovery_reinspect_failed: true
+chameleon_resource_discovery_expire_days: 7

roles/chameleon_periodic_inspector/tasks/main.yml

@@ -0,0 +1,48 @@
+---
+- name: Pull Docker image
+  become: True
+  docker_image:
+    source: pull
+    name: "{{ chameleon_resource_discovery_docker_image }}"
+    force_source: yes
+
+- name: Ensure config directory exists
+  become: yes
+  file:
+    path: "{{ chameleon_resource_discovery_config_dir }}"
+    state: directory
+
+- name: Template envvars file
+  become: yes
+  template:
+    src: envvars.j2
+    dest: "{{ chameleon_resource_discovery_config_dir }}/envvars"
+    mode: '0600'
+    owner: 'root'
+    group: 'root'
+
+- name: Deploy periodic-inspector service unit
+  become: yes
+  template:
+    src: periodic-inspector.service.j2
+    dest: /etc/systemd/system/periodic-inspector.service
+    mode: '0644'
+
+- name: Deploy periodic-inspector timer unit
+  become: yes
+  template:
+    src: periodic-inspector.timer.j2
+    dest: /etc/systemd/system/periodic-inspector.timer
+    mode: '0644'
+
+- name: Reload systemd
+  become: yes
+  systemd:
+    daemon_reload: yes
+
+- name: Enable and start periodic-inspector.timer
+  become: yes
+  systemd:
+    name: periodic-inspector.timer
+    enabled: yes
+    state: started

roles/chameleon_periodic_inspector/templates/envvars.j2

@@ -0,0 +1,9 @@
+OS_AUTH_URL='{{ keystone_public_url }}'
+OS_AUTH_PLUGIN='password'
+OS_IDENTITY_API_VERSION='3'
+OS_USER_DOMAIN_NAME='Default'
+OS_USERNAME='{{ keystone_admin_user }}'
+OS_PASSWORD='{{ keystone_admin_password }}'
+OS_PROJECT_DOMAIN_NAME='Default'
+OS_PROJECT_NAME='{{ keystone_admin_project }}'
+OS_REGION_NAME='{{ openstack_region_name }}'

roles/chameleon_periodic_inspector/templates/periodic-inspector.service.j2

@@ -0,0 +1,20 @@
+[Unit]
+Description=Chameleon Periodic Inspector
+After=docker.service
+Requires=docker.service
+
+[Service]
+Type=oneshot
+ExecStart=/usr/bin/docker run --rm --net=host \
+    --env-file {{ chameleon_resource_discovery_config_dir }}/envvars \
+    {{ chameleon_resource_discovery_docker_image }} \
+    periodic_inspector \
+        --parallel {{ chameleon_resource_discovery_parallel }} \
+        --limit {{ chameleon_resource_discovery_limit }} \
+        {% if chameleon_resource_discovery_provide_manageable %}--provide-manageable {% endif %}\
+        {% if chameleon_resource_discovery_reinspect_failed %}--reinspect-failed {% endif %}\
+        --expire-days {{ chameleon_resource_discovery_expire_days }} \
+        --cloud {{ cloud }}
+
+[Install]
+WantedBy=multi-user.target

roles/chameleon_periodic_inspector/templates/periodic-inspector.timer.j2

@@ -0,0 +1,9 @@
+[Unit]
+Description=Run Chameleon Periodic Inspector daily
+
+[Timer]
+OnCalendar=daily
+Persistent=true
+
+[Install]
+WantedBy=timers.target

site-config.example/inventory/hosts

@@ -842,6 +842,10 @@ control
 [chameleon-image-tools:children]
 control
 
+# Periodic Inspector
+[chameleon-periodic-inspector:children]
+control
+
 # Development, fake baremetal hypervisor host using tenks
 [fake-baremetal:children]
 ironic