Files

Alex Schultz c8f6348079 Update docs around output variables

Per the comments in
https://review.opendev.org/#/c/702284/6/roles/tripleo-container-image-list/tasks/main.yml,
we should have a consistent result naming convention. I'm proposing that
we return the shell exection results always via
<underscored role name>_result. If there is output that a user might
want to use in ansible then we can also return the stdout via
<underscored role name>_output.

Change-Id: I5c0b95a7037eeca0f849fb24248a0ffd16dc82c0

2020-01-15 11:27:34 -07:00

defaults

Add basic role for undercloud function

2020-01-14 07:58:22 -07:00

README.md

tripleo-undercloud-upgrade

A role to run the upgrade of a TripleO undercloud.

Requirements

None.

Role Variables

tripleo_undercloud_upgrade_debug: (Boolean) Flag used to enable the debug version of commands. Default: false
tripleo_undercloud_upgrade_dry_run: (Boolean) Flag to add --dry-run to the upgrade command. Default: false
tripleo_undercloud_upgrade_force_stack_update: (Boolean) Flag to add --force-stack-update to the upgrade command. Default: false
tripleo_undercloud_upgrade_home_dir: (String) Home directory for the undercloud user. Default: "{{ ansible_env.HOME }}"
tripleo_undercloud_upgrade_inflight_validations: (Boolean) Flag to add --inflight-validations to the upgrade. Default: false
tripleo_undercloud_upgrade_log_combine: (Boolean) Flag to combine stdout and stderr in the logfile. Default: true
tripleo_undercloud_upgrade_log_output: (Boolean) Flag to log the output to a file rather than show it in the ansible output. Default: true
tripleo_undercloud_upgrade_no_validations: (Boolean) Flag to add --no-validations to the upgrade. Default: false
tripleo_undercloud_upgrade_timeout: (Number) Timeout for the upgrade command. Default: 7200
tripleo_undercloud_upgrade_yes: (Boolean) Flag to add --yes to the upgrade. Default: false
tripleo_undercloud_upgrade_log: (String) Upgrade log file path. Default: "{{ tripleo_undercloud_upgrade_home_dir }}/undercloud_upgrade.log"

Output Variables

tripleo_undercloud_upgrade_result: Ansible shell execution results

Dependencies

None.

Example Playbook

Example upgrade execution playbook

- hosts: undercloud
  gather_facts: true
  tasks:
    - name: Upgrade undercloud
      import_role:
        name: tripleo-undercloud-upgrade
      vars:
        tripleo_undercloud_upgrade_debug: true

License

Apache-2.0