Skip to content

bug: ensure boardwalk_operation is set during execution runs#227

Merged
asullivan-blze merged 1 commit intomainfrom
kphoenix-opsyseng-1287-ensure-boardwalk-operation-is-set
Feb 26, 2026
Merged

bug: ensure boardwalk_operation is set during execution runs#227
asullivan-blze merged 1 commit intomainfrom
kphoenix-opsyseng-1287-ensure-boardwalk-operation-is-set

Conversation

@asullivan-blze
Copy link
Contributor

@asullivan-blze asullivan-blze commented Feb 26, 2026

What and why?

It was discovered that the boardwalk_operation fact, intended to signal to other Ansible tasks that Boardwalk is running on a host, was not being set with TaskJob-type Jobs.

We mitigate this here by setting runner_kwargs["extravars"] with both boardwalk_operation and any defined extra_vars, for both TaskJob and PlaybookJob.

Internal ref: OPSYSENG-1287

How was this tested?

Example run before the change

asullivan@MBP-NT9RPG2XV7 server-client % boardwalk version                            
0.8.26
asullivan@MBP-NT9RPG2XV7 server-client % boardwalk workspace show                     
DumpHostvarsWorkspace
asullivan@MBP-NT9RPG2XV7 server-client % boardwalk run           
2026-02-26 13:49:25.606 | INFO     | boardwalk.cli_run:run:125 - Using workspace: DumpHostvarsWorkspace
2026-02-26 13:49:25.618 | INFO     | boardwalk.cli_run:filter_hosts_by_limit:375 - Reading inventory to process any --limit
2026-02-26 13:49:25.618 | INFO     | boardwalk.ansible:ansible_inventory:192 - Processing ansible-inventory
BECOME password: 
2026-02-26 13:49:31.831 | INFO     | boardwalk.cli_run:run_workflow:268 - 127.0.0.1: Workflow iteration on host 1 of 1
2026-02-26 13:49:31.847 | INFO     | boardwalk.ansible:ansible_runner_run_tasks:172 - 127.0.0.1: ansible_runner invocation: check_remote_host_lock
2026-02-26 13:49:33.097 | INFO     | boardwalk.ansible:ansible_runner_run_tasks:172 - 127.0.0.1: ansible_runner invocation: lock_remote_host
2026-02-26 13:49:37.268 | INFO     | boardwalk.cli_run:update_host_facts_in_local_state:596 - 127.0.0.1: Updating Ansible facts in local state
2026-02-26 13:49:37.271 | INFO     | boardwalk.ansible:ansible_runner_run_tasks:172 - 127.0.0.1: ansible_runner invocation: gather_facts
2026-02-26 13:49:38.844 | INFO     | boardwalk.cli_run:execute_host_workflow:708 - 127.0.0.1: Updating remote state
2026-02-26 13:49:38.857 | INFO     | boardwalk.ansible:ansible_runner_run_tasks:172 - 127.0.0.1: ansible_runner invocation: get_remote_state
2026-02-26 13:49:41.538 | INFO     | boardwalk.ansible:ansible_runner_run_tasks:172 - 127.0.0.1: ansible_runner invocation: set_remote_state
2026-02-26 13:49:47.096 | INFO     | boardwalk.cli_run:execute_workflow_jobs:670 - 127.0.0.1: Running workflow main jobs
2026-02-26 13:49:47.102 | INFO     | boardwalk.ansible:ansible_runner_run_tasks:172 - 127.0.0.1: ansible_runner invocation: main_TASK_Job_DumpHostvarsJob
BECOME password: 

PLAY [127.0.0.1] ***************************************************************

TASK [ansible.builtin.debug] ***************************************************
 [started TASK: ansible.builtin.debug on 127.0.0.1]
ok: [127.0.0.1] => {
    "hostvars[inventory_hostname]": {
[... omitted ....]
        "ansible_vmenet2": {
            "device": "vmenet2",
            "flags": [
                "UP",
                "BROADCAST",
                "SMART",
                "RUNNING",
                "PROMISC",
                "SIMPLEX",
                "MULTICAST"
            ],
            "ipv4": [],
            "ipv6": [],
            "macaddress": "22:5c:be:40:1e:7d",
            "media": "Unknown",
            "media_select": "autoselect",
            "mtu": "1500",
            "status": "active",
            "type": "ether"
        },
        "discovered_interpreter_python": "/usr/bin/python3",
        "dummyHostVar": "dummyValue",
        "gather_subset": [
            "all"
        ],
        "group_names": [
            "main_hosts"
        ],
        "groups": {
            "all": [
                "127.0.0.1"
            ],
            "main_hosts": [
                "127.0.0.1"
            ],
            "ungrouped": []
        },
        "inventory_dir": "/Users/asullivan/backblaze/github_repos/boardwalk/test/server-client",
        "inventory_file": "/Users/asullivan/backblaze/github_repos/boardwalk/test/server-client/test-inventory",
        "inventory_hostname": "127.0.0.1",
        "inventory_hostname_short": "127.0.0.1",
        "module_setup": true,
        "omit": "__omit_place_holder__7ced53e29535c4ac518dd38767a1e0dd455538db",
        "playbook_dir": "/var/folders/q_/ns6q_l2j21zb_5k5qzlb3rq40000gq/T/tmp0ypmhclw/project"
    }
}

PLAY RECAP *********************************************************************
127.0.0.1                  : ok=1    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   
2026-02-26 13:49:47.705 | INFO     | boardwalk.cli_run:execute_host_workflow:744 - 127.0.0.1: Updating remote state
2026-02-26 13:49:47.708 | INFO     | boardwalk.ansible:ansible_runner_run_tasks:172 - 127.0.0.1: ansible_runner invocation: get_remote_state
2026-02-26 13:49:51.395 | INFO     | boardwalk.ansible:ansible_runner_run_tasks:172 - 127.0.0.1: ansible_runner invocation: set_remote_state
2026-02-26 13:49:57.029 | SUCCESS  | boardwalk.cli_run:execute_host_workflow:761 - 127.0.0.1: Host completed successfully; wrapping up
2026-02-26 13:49:57.032 | INFO     | boardwalk.cli_run:update_host_facts_in_local_state:596 - 127.0.0.1: Updating Ansible facts in local state
2026-02-26 13:49:57.035 | INFO     | boardwalk.ansible:ansible_runner_run_tasks:172 - 127.0.0.1: ansible_runner invocation: gather_facts
2026-02-26 13:49:59.712 | INFO     | boardwalk.cli_run:run_workflow:296 - 127.0.0.1: Release remote host lock
2026-02-26 13:49:59.716 | INFO     | boardwalk.ansible:ansible_runner_run_tasks:172 - 127.0.0.1: ansible_runner invocation: release_remote_host

Example run after the change

(boardwalk-py3.12) asullivan@MBP-NT9RPG2XV7 server-client % boardwalk workspace show
DumpHostvarsWorkspace
(boardwalk-py3.12) asullivan@MBP-NT9RPG2XV7 server-client % boardwalk version
0.8.26
(boardwalk-py3.12) asullivan@MBP-NT9RPG2XV7 server-client % boardwalk run                                
2026-02-26 14:00:55.775 | INFO     | boardwalk.cli_run:run:125 - Using workspace: DumpHostvarsWorkspace
2026-02-26 14:00:55.784 | INFO     | boardwalk.cli_run:filter_hosts_by_limit:375 - Reading inventory to process any --limit
2026-02-26 14:00:55.784 | INFO     | boardwalk.ansible:ansible_inventory:194 - Processing ansible-inventory
BECOME password: 
2026-02-26 14:01:01.048 | INFO     | boardwalk.cli_run:run_workflow:268 - 127.0.0.1: Workflow iteration on host 1 of 1
2026-02-26 14:01:01.065 | INFO     | boardwalk.ansible:ansible_runner_run_tasks:174 - 127.0.0.1: ansible_runner invocation: check_remote_host_lock
2026-02-26 14:01:02.560 | INFO     | boardwalk.ansible:ansible_runner_run_tasks:174 - 127.0.0.1: ansible_runner invocation: lock_remote_host
2026-02-26 14:01:06.702 | INFO     | boardwalk.cli_run:update_host_facts_in_local_state:596 - 127.0.0.1: Updating Ansible facts in local state
2026-02-26 14:01:06.706 | INFO     | boardwalk.ansible:ansible_runner_run_tasks:174 - 127.0.0.1: ansible_runner invocation: gather_facts
2026-02-26 14:01:08.363 | INFO     | boardwalk.cli_run:execute_host_workflow:708 - 127.0.0.1: Updating remote state
2026-02-26 14:01:08.366 | INFO     | boardwalk.ansible:ansible_runner_run_tasks:174 - 127.0.0.1: ansible_runner invocation: get_remote_state
2026-02-26 14:01:09.920 | INFO     | boardwalk.ansible:ansible_runner_run_tasks:174 - 127.0.0.1: ansible_runner invocation: set_remote_state
2026-02-26 14:01:16.157 | INFO     | boardwalk.cli_run:execute_workflow_jobs:670 - 127.0.0.1: Running workflow main jobs
2026-02-26 14:01:16.165 | INFO     | boardwalk.ansible:ansible_runner_run_tasks:174 - 127.0.0.1: ansible_runner invocation: main_TASK_Job_DumpHostvarsJob
BECOME password: 

PLAY [127.0.0.1] ***************************************************************

TASK [ansible.builtin.debug] ***************************************************
 [started TASK: ansible.builtin.debug on 127.0.0.1]
ok: [127.0.0.1] => {
    "hostvars[inventory_hostname]": {
[ ... omitted ... ]
        "ansible_vmenet2": {
            "device": "vmenet2",
            "flags": [
                "UP",
                "BROADCAST",
                "SMART",
                "RUNNING",
                "PROMISC",
                "SIMPLEX",
                "MULTICAST"
            ],
            "ipv4": [],
            "ipv6": [],
            "macaddress": "22:5c:be:40:1e:7d",
            "media": "Unknown",
            "media_select": "autoselect",
            "mtu": "1500",
            "status": "active",
            "type": "ether"
        },
        "boardwalk_operation": true,
        "discovered_interpreter_python": "/usr/bin/python3",
        "dummyHostVar": "dummyValue",
        "gather_subset": [
            "all"
        ],
        "group_names": [
            "main_hosts"
        ],
        "groups": {
            "all": [
                "127.0.0.1"
            ],
            "main_hosts": [
                "127.0.0.1"
            ],
            "ungrouped": []
        },
        "inventory_dir": "/Users/asullivan/backblaze/github_repos/boardwalk/test/server-client",
        "inventory_file": "/Users/asullivan/backblaze/github_repos/boardwalk/test/server-client/test-inventory",
        "inventory_hostname": "127.0.0.1",
        "inventory_hostname_short": "127.0.0.1",
        "module_setup": true,
        "omit": "__omit_place_holder__7f68169bb055c483ef3857d838668c40d96a30a1",
        "playbook_dir": "/var/folders/q_/ns6q_l2j21zb_5k5qzlb3rq40000gq/T/tmp541dczg3/project"
    }
}

PLAY RECAP *********************************************************************
127.0.0.1                  : ok=1    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   
2026-02-26 14:01:16.795 | INFO     | boardwalk.cli_run:execute_host_workflow:744 - 127.0.0.1: Updating remote state
2026-02-26 14:01:16.801 | INFO     | boardwalk.ansible:ansible_runner_run_tasks:174 - 127.0.0.1: ansible_runner invocation: get_remote_state
2026-02-26 14:01:18.400 | INFO     | boardwalk.ansible:ansible_runner_run_tasks:174 - 127.0.0.1: ansible_runner invocation: set_remote_state
2026-02-26 14:01:25.402 | SUCCESS  | boardwalk.cli_run:execute_host_workflow:761 - 127.0.0.1: Host completed successfully; wrapping up
2026-02-26 14:01:25.407 | INFO     | boardwalk.cli_run:update_host_facts_in_local_state:596 - 127.0.0.1: Updating Ansible facts in local state
2026-02-26 14:01:25.410 | INFO     | boardwalk.ansible:ansible_runner_run_tasks:174 - 127.0.0.1: ansible_runner invocation: gather_facts
2026-02-26 14:01:27.014 | INFO     | boardwalk.cli_run:run_workflow:296 - 127.0.0.1: Release remote host lock
2026-02-26 14:01:27.020 | INFO     | boardwalk.ansible:ansible_runner_run_tasks:174 - 127.0.0.1: ansible_runner invocation: release_remote_host

Checklist

  • Have you updated the version in the [project] section of
    the pyproject.toml file (if applicable)?

@asullivan-blze
bug: ensure boardwalk_operation is set during execution runs
cadb365 
It was discovered that the `boardwalk_operation` fact, intended to
signal to other Ansible tasks that Boardwalk is running on a host,
was not being set with TaskJob-type Jobs.

We mitigate this here by setting `runner_kwargs["extravars"]` with
both `boardwalk_operation` and any defined `extra_vars`, for both
TaskJob and PlaybookJob.

Internal ref: OPSYSENG-1287
@asullivan-blze asullivan-blze added bug Something isn't working python Pull requests that update Python code labels Feb 26, 2026
agouldingbb
agouldingbb approved these changes Feb 26, 2026
View reviewed changes
Copy link

@agouldingbb agouldingbb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@asullivan-blze asullivan-blze merged commit f5816cc into main Feb 26, 2026
7 checks passed
@asullivan-blze asullivan-blze deleted the kphoenix-opsyseng-1287-ensure-boardwalk-operation-is-set branch February 26, 2026 23:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@agouldingbb agouldingbb agouldingbb approved these changes

Assignees

No one assigned

Labels

bug Something isn't working python Pull requests that update Python code

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@asullivan-blze @agouldingbb