Skip to content

Commit afc59dd

Browse files
PeterMocaryPeterMocary
authored
Merge pull request #360 from PeterMocary/update-readme-tables
Update readme tables
2 parents fdebdea + 31f3a7b commit afc59dd

File tree

5 files changed

+100
-96
lines changed

5 files changed

+100
-96
lines changed

‎changelogs/fragments/360-unify-tables-in-readmes.yml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
trivial:
3+
- Unified tables in role READMEs for consistent formatting.
4+
...

‎roles/analysis/README.md‎

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -8,45 +8,45 @@ This role will not fail if there are inhibitors found, it will throw a warning.
88

99
## Role variables
1010

11-
| Name | Type | Default value | Description |
12-
|-----------------------|------|-------------------------|-------------------------------------------------|
13-
| leapp_upgrade_type | String | "cdn" | Set to "cdn" for hosts registered with Red Hat CDN, "rhui" for hosts using rhui repos, "satellite" for hosts registered to Satellite, and "custom" for custom repos. |
11+
| Name | Type | Default value | Description |
12+
|--------------------|--------|---------------|-------------|
13+
| leapp_upgrade_type | String | "cdn" | Set to "cdn" for hosts registered with Red Hat CDN, "rhui" for hosts using rhui repos, "satellite" for hosts registered to Satellite, and "custom" for custom repos. |
1414

1515
## Satellite variables
1616

1717
Activation keys provide a method to identify content views available from Red Hat Satellite. To do in-place upgrades using Satellite, both the current RHEL version and the next RHEL version repositories must be available. Use these variables to specify the activation keys for the required content views. In case the system uses a different content view than the one used for the upgrade, one can specify the `leapp_satellite_activation_key_post_analysis` in order to register to it after the analysis concludes, leaving the system in its original state. If not specified, the system will remain registered to the `leapp_satellite_activation_key` used during the analysis.
1818

19-
| Name | Type | Default value | Description |
20-
|-----------------------|------|-------------------------|-------------------------------------------------|
21-
| leapp_satellite_organization | String | "" | Organization used in Satellite definition |
22-
| leapp_satellite_activation_key | String | "" | Activation key for the content view including both the current RHEL version and the next version |
23-
| leapp_satellite_activation_key_post_analysis | String | leapp_satellite_activation_key | Activation key for the current RHEL version content view to register to after analysis |
24-
| leapp_repos_enabled | List | [] | Satellite repo for the satellite client RPM install |
19+
| Name | Type | Default value | Description |
20+
|----------------------------------------------|--------|--------------------------------|-------------|
21+
| leapp_satellite_organization | String | "" | Organization used in Satellite definition. |
22+
| leapp_satellite_activation_key | String | "" | Activation key for the content view including both the current RHEL version and the next version. |
23+
| leapp_satellite_activation_key_post_analysis | String | leapp_satellite_activation_key | Activation key for the current RHEL version content view to register to after analysis. |
24+
| leapp_repos_enabled | List | [] | Satellite repo for the satellite client RPM install. |
2525

2626
## Custom repos variables
2727

2828
See comments in defaults/main.yml for additional details.
2929

30-
| Name | Type | Default value | Description |
31-
|-----------------------|------|-------------------------|-------------------------------------------------|
32-
| leapp_local_repos_pre | List of dicts | [] | Used to configure repos before running leapp analysis / installing leapp packages.|
33-
| leapp_local_repos | List of dicts | [] | Used to configure next version repos in /etc/leapp/files/leapp_upgrade_repositories.repo. |
34-
| leapp_local_repos_post_analysis | List of dicts | [] | Used to return repos to previous state after leapp analysis if necessary. |
30+
| Name | Type | Default value | Description |
31+
|---------------------------------|---------------|---------------|-------------|
32+
| leapp_local_repos_pre | List of dicts | [] | Used to configure repos before running leapp analysis / installing leapp packages. |
33+
| leapp_local_repos | List of dicts | [] | Used to configure next version repos in /etc/leapp/files/leapp_upgrade_repositories.repo. |
34+
| leapp_local_repos_post_analysis | List of dicts | [] | Used to return repos to previous state after leapp analysis if necessary. |
3535

3636
## Optional variables
3737

38-
| Name | Type | Default value | Description |
39-
|-----------------------|------|-------------------------|-------------------------------------------------|
40-
| leapp_answerfile | Multi-line String | | If defined, this is written to `/var/log/leapp/answerfile` before generating the pre-upgrade report. |
41-
| leapp_preupg_opts | String | | Optional string to define command line options to be passed to the `leapp` command when running the pre-upgrade. |
42-
| leapp_high_sev_as_inhibitors | Boolean | False | Treat all high severity findings as inhibitors. |
43-
| leapp_known_inhibitors | List | [] | List of keys of known inhibitors ignored when setting upgrade_inhibited and leapp_inhibitors. |
44-
| leapp_env_vars | Dict | {} | Environment variables to use when running `leapp` command. See defaults/main.yml for example. |
45-
| leapp_os_path | String | $PATH | Option string to override the $PATH variable used on the target node |
46-
| leapp_async_timeout_maximum | Int | 7200 | Variable used to set the asynchronous task timeout value (in seconds) |
47-
| leapp_async_poll_interval | Int | 60 | Variable used to set the asynchronous task polling internal value (in seconds) |
48-
| leapp_bypass_fs_checks | Boolean | false | Set to `true` to bypass filesystem capacity checks |
49-
| leapp_system_roles_collection | String | fedora.linux_system_roles | Set which Ansible Collection to use for System Roles. For community/upstream, use 'fedora.linux_system_roles'. For the RHEL, AAP, use 'redhat.rhel_system_roles'. |
38+
| Name | Type | Default value | Description |
39+
|---------------------------------------------|-------------------|-----------------------------|-------------|
40+
| leapp_answerfile | Multi-line String | "" | If defined, this is written to `/var/log/leapp/answerfile` before generating the pre-upgrade report. |
41+
| leapp_preupg_opts | String | "" | Optional string to define command line options to be passed to the `leapp` command when running the pre-upgrade. |
42+
| leapp_high_sev_as_inhibitors | Boolean | false | Treat all high severity findings as inhibitors. |
43+
| leapp_known_inhibitors | List | [] | List of keys of known inhibitors ignored when setting upgrade_inhibited and leapp_inhibitors. |
44+
| leapp_env_vars | Dict | {} | Environment variables to use when running `leapp` command. See defaults/main.yml for example. |
45+
| leapp_os_path | String | $PATH | Option string to override the $PATH variable used on the target node. |
46+
| leapp_async_timeout_maximum | Int | 7200 | Variable used to set the asynchronous task timeout value (in seconds). |
47+
| leapp_async_poll_interval | Int | 60 | Variable used to set the asynchronous task polling internal value (in seconds). |
48+
| leapp_bypass_fs_checks | Boolean | false | Set to `true` to bypass filesystem capacity checks. |
49+
| leapp_infra_upgrade_system_roles_collection | String | "fedora.linux_system_roles" | Set which Ansible Collection to use for System Roles. For community/upstream, use 'fedora.linux_system_roles'. For the RHEL, AAP, use 'redhat.rhel_system_roles'. |
5050

5151
## Example playbook
5252

‎roles/common/README.md‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -14,36 +14,36 @@ Define job_name in the import as seen below.
1414

1515
## Role variables
1616

17-
| Name | Type | Optional | Default value | Description |
18-
|-----------------------|------|----------|---------------|-------------------------------------------------|
19-
| job_name | String | No | None | The string describes the job run |
20-
| leapp_log_directory | DirPath | Yes | "/var/log/ripu" | Directory under which local log files will be written. This directory will be created is it is not already present |
21-
| leapp_log_file | FilePath | Yes | "{{ leapp_log_directory }}/ripu.log" | Local log filename. When a playbook job finishes, a timestamp suffix is appended to the end of the specified filename |
17+
| Name | Type | Default value | Description |
18+
|---------------------|--------|---------------------------------------------|-------------|
19+
| job_name | String | | The string describes the job run. This variable is required. |
20+
| leapp_log_directory | String | "/var/log/ripu" | Directory under which local log files will be written. This directory will be created if it is not already present. |
21+
| leapp_log_file | String | "{{ leapp_log_directory }}/ripu.log" | Local log filename. When a playbook job finishes, a timestamp suffix is appended to the end of the specified filename. |
2222

2323
### Role variables used with parse_leapp_report.yml
2424

2525
**NOTE:** `leapp_result_filename` is **REQUIRED**. The other leapp_result_filename* parameters will be derived from it if not explicitly given.
2626

27-
| Name | Type | Default value | Description |
28-
|------------------------------|--------|-----------------------------------|----------------------------------------------------------------------------------|
29-
| leapp_result_filename | string | /var/log/leapp/leapp-report.txt | REQUIRED - Path of the Leapp pre-upgrade report file. |
30-
| leapp_result_filename_prefix | string | /var/log/leapp/leapp-report | The path used and the prefix name setting for the Leapp report |
31-
| leapp_result_filename_json | string | {{ leapp_result_filename_prefix }}.json | JSON filename using the selected "leapp_result_filename_prefix" |
32-
| leapp_result_fact_cacheable | bool | false | Allow the results from parsing the LEAPP report be cacheable (primarily for AAP) |
33-
| leapp_high_sev_as_inhibitors | bool | false | Treat all high severity findings as inhibitors. |
27+
| Name | Type | Default value | Description |
28+
|------------------------------|---------|-----------------------------------------------|-------------|
29+
| leapp_result_filename | String | "/var/log/leapp/leapp-report.txt" | REQUIRED - Path of the Leapp pre-upgrade report file. |
30+
| leapp_result_filename_prefix | String | "/var/log/leapp/leapp-report" | The path used and the prefix name setting for the Leapp report. |
31+
| leapp_result_filename_json | String | "{{ leapp_result_filename_prefix }}.json" | JSON filename using the selected "leapp_result_filename_prefix". |
32+
| leapp_result_fact_cacheable | Boolean | false | Allow the results from parsing the LEAPP report be cacheable (primarily for AAP). |
33+
| leapp_high_sev_as_inhibitors | Boolean | false | Treat all high severity findings as inhibitors. |
3434

3535
### Variables exported by parse_leapp_report.yml
3636

3737
`register` means it is the result of a `command` written to a `register` variable and so has `rc`, `stdout`, etc.
3838

39-
| Name | Type | Description |
40-
|--------------------|----------|--------------------------------------------------------|
41-
| leapp_report_txt | list | List of lines from the text report |
42-
| leapp_report_json | dict | The JSON report returned as a dict object |
43-
| leapp_inhibitors | list | Raw list of inhibitors |
44-
| results_inhibitors | register | Result of parsing out inhibitors from leapp_result_filename |
45-
| results_errors | register | Result of parsing out high errors from leapp_result_filename |
46-
| upgrade_inhibited | bool | true if there are inhibitors blocking upgrade |
39+
| Name | Type | Description |
40+
|--------------------|----------|-------------|
41+
| leapp_report_txt | List | List of lines from the text report. |
42+
| leapp_report_json | Dict | The JSON report returned as a dict object. |
43+
| leapp_inhibitors | List | Raw list of inhibitors. |
44+
| results_inhibitors | Register | Result of parsing out inhibitors from leapp_result_filename. |
45+
| results_errors | Register | Result of parsing out high errors from leapp_result_filename. |
46+
| upgrade_inhibited | Boolean | true if there are inhibitors blocking upgrade. |
4747

4848
### How to use parse_leapp_report.yml
4949

‎roles/remediate/README.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,19 @@ The `remediation` role is to assist in the remediation of a system. This role co
66

77
## Role variables
88

9-
| Name | Default value | Description |
10-
|-------------------------|-----------------------|-----------------------------------------------------|
11-
| leapp_report_location | /var/log/leapp/leapp-report.json | Location of the leapp report file. |
12-
| leapp_remediation_playbooks | see [Remediation playbooks](#remediation-playbooks) | List of available remediation playbooks.|
13-
| leapp_remediation_todo | [] | List of remediation playbooks to run. |
14-
| leapp_reboot_timeout | 7200 | Integer for maximum seconds to wait for reboot to complete. |
15-
| leapp_pre_reboot_delay | 60 | Integer to pass to the reboot pre_reboot_delay option. |
16-
| leapp_post_reboot_delay | 120 | Integer to pass to the reboot post_reboot_delay option. |
17-
| leapp_remediate_ssh_password_auth | true | Add "PasswordAuthentcation no" and "PermitRootLogin prohibit-password" to sshd config |
9+
| Name | Type | Default value | Description |
10+
|-----------------------------------|---------|-----------------------------------------------------|-------------|
11+
| leapp_report_location | String | "/var/log/leapp/leapp-report.json" | Location of the leapp report file. |
12+
| leapp_remediation_playbooks | List | see [Remediation playbooks](#remediation-playbooks) | List of available remediation playbooks. |
13+
| leapp_remediation_todo | List | [] | List of remediation playbooks to run. |
14+
| leapp_reboot_timeout | Int | 7200 | Integer for maximum seconds to wait for reboot to complete. |
15+
| leapp_pre_reboot_delay | Int | 60 | Integer to pass to the reboot pre_reboot_delay option. |
16+
| leapp_post_reboot_delay | Int | 120 | Integer to pass to the reboot post_reboot_delay option. |
17+
| leapp_remediate_ssh_password_auth | Boolean | true | Add "PasswordAuthentcation no" and "PermitRootLogin prohibit-password" to sshd config |
18+
| leapp_system_roles_collection | String | "fedora.linux_system_roles" | Set which Ansible Collection to use for System Roles. For community/upstream, use "fedora.linux_system_roles". For the RHEL, AAP, use "redhat.rhel_system_roles". |
1819

1920
NOTE: If you use password authentication for Ansible (`--user root --ask-pass`), then setting `leapp_remediate_ssh_password_auth: true`
2021
might lock out your Ansible session and the play will fail.
21-
| leapp_system_roles_collection | fedora.linux_system_roles | Set which Ansible Collection to use for System Roles. For community/upstream, use 'fedora.linux_system_roles'. For the RHEL, AAP, use 'redhat.rhel_system_roles'. |
2222

2323
`leapp_remediation_todo` is a list of remediation playbooks to run. The list is empty by default. The list can be populated by the titles from [Remediation playbooks](#remediation-playbooks) section. For example:
2424

0 commit comments

Comments
 (0)