Leapp Insights Tasks

Scripts related to leapp to be run via rhc-worker-script on Red Hat Insights.

Scripts themselves shouldn't have any additional requirements = they are relying on python standard library.

Structure of repository is following:

├── requirements.txt  # DEV requirements - tests & lint
├── schemas # All expected json outputs in the scripts stdouts
|   |   ...
│   └── preupgrade_schema_1.0.json
├── scripts # All available scripts for leapp related tasks
|   |   ...
│   └── preupgrade_script.py
├── playbooks # All available ansible playbooks for leapp related tasks
|   |   ...
│   └── leapp_preupgrade_ansible.yaml
└── tests
    |   ...
    └── preuprade  # Unit tests for given script

Schemas

Currently there is given format of the scripts stdout that is expected to be parsed by the Red Hat Insights Task UI. This stdout is JSON structure wrapped between agreed on separators (see below). Schemas of the JSONs for each script can be found in schemas folder.

separators (common to all scripts):
- ### JSON START ###
- ### JSON END ###

Scripts & Playbooks

Red Hat Insights Tasks are always distributed to registered systems as signed yaml files, those are either executed via rhc-worker-script or rhc-worker-playbook. For leapp this generally means that rhc-worker-script is used for RHEL 7 systems and rhc-playbook-worker is used for RHEL 8+ systems.

So in short playbooks folder contains true signed ansible playbooks and also files from scripts folder wrapped in signed yaml envelope.

Preupgrade

You can find official leapp_preupgrade_ansible.yaml for rhc-worker-playbook in playbooks folder. This playbook is officially signed and used on Red Hat Insights.

For rhc-worker-script we have only raw script leapp_preupgrade.py, signed version wrapped in yaml is still in development.

Upgrade

TBD for rhc-worker-playbook.

For rhc-worker-script we have only raw script leapp_upgrade.py, signed version wrapped in yaml is still in development.

Local Development & Contributing

Requirements

python2 - to run tests locally
virtualenv - versions < 20.22.0 to run tests locally
pre-commit - to run checks before each commit, see hook in .pre-commit-config.yml
make - to use handy commands

Run tests and lint

make install # install pre-commit hooks and python virtualenv
make tests # run pytest

oamg / leapp-insights-tasks Goto Github PK