diff --git a/roles/tripleo_overcloud_ffwd_upgrade_run/README.md b/roles/tripleo_overcloud_ffwd_upgrade_run/README.md new file mode 100644 index 0000000..59fbcbf --- /dev/null +++ b/roles/tripleo_overcloud_ffwd_upgrade_run/README.md @@ -0,0 +1,61 @@ +tripleo_overcloud_ffwd_upgrade_run +================================== + +A role to execute an overcloud ffwd-upgrade run. + +Requirements +------------ + +None. + +Role Variables +-------------- + +* `tripleo_overcloud_ffwd_upgrade_run_debug`: (Boolean) Flag to print out the command that is run. Default: false +* `tripleo_overcloud_ffwd_upgrade_run_home_dir`: (String) Home directory to where the command is run from. Default: "{{ ansible_env.HOME }}" +* `tripleo_overcloud_ffwd_upgrade_run_log_combine`: (Boolean) Flag to enable captching stderr with stdout. Default: true +* `tripleo_overcloud_ffwd_upgrade_run_log_output`: (Boolean) Flag to enable logging to a file. Since the output of this command can be large, it is not recommended to disable this. Default: true +* `tripleo_overcloud_ffwd_upgrade_run_log`: (String) Path to a log file for the command output. Default: "{{ tripleo_overcloud_ffwd_upgrade_run_home_dir }}/overcloud_ffwd_upgrade_run.log" +* `tripleo_overcloud_ffwd_upgrade_run_playbook`: (List) List of playbook(s) to use for the upgrade. Defaults: [] +* `tripleo_overcloud_ffwd_upgrade_run_poll`: (Integer) Number of seconds to wait between each checks to see if the deployment command has completed. Default: 10 +* `tripleo_overcloud_ffwd_upgrade_run_rc_file`: (String) (String) Path to the credential file to use. If `tripleo_rc_file` is defined, it will be the default. Default: "{{ ansible_env.HOME }}/stackrc" +* `tripleo_overcloud_ffwd_upgrade_run_ssh_user`: (String) Username of user to be used as the ssh user. +* `tripleo_overcloud_ffwd_upgrade_run_stack`: (String) Name of the stack to deploy. +* `tripleo_overcloud_ffwd_upgrade_run_static_inventory`: (String) Path to an existing ansible inventory to use. +* `tripleo_overcloud_ffwd_upgrade_run_timeout`: (Integer) Number in seconds to wait for the ansible execution of the deployment command to finish. Default: 5700 +* `tripleo_overcloud_ffwd_upgrade_run_yes`: (Boolean) Flag to skip the confirmation required before any ffwd-upgrade operation. Default: true + +NOTE: Please note that this command should be run against the undercloud so the +OS_CLOUD or rc file variables should be set to use the 'undercloud' when +calling this role. If you are not defining `tripleo_os_cloud` or `tripleo_rc_file`, +stackrc will be used by default. + +Output Variables +---------------- + +* `tripleo_overcloud_ffwd_upgrade_run_output`: (String) The command standard output. +* `tripleo_overcloud_ffwd_upgrade_run_result`: Ansible shell execution results + +Dependencies +------------ + +None. + +Example Playbook +---------------- + +Example overcloud ffwd-upgrade run execution playbook + +```yaml +- hosts: undercloud + gather_facts: true + tasks: + - name: Run overcloud ffwd-upgrade run + import_role: + name: tripleo_overcloud_ffwd_upgrade_run +``` + +License +------- + +Apache-2.0 diff --git a/roles/tripleo_overcloud_ffwd_upgrade_run/defaults/main.yml b/roles/tripleo_overcloud_ffwd_upgrade_run/defaults/main.yml new file mode 100644 index 0000000..505c009 --- /dev/null +++ b/roles/tripleo_overcloud_ffwd_upgrade_run/defaults/main.yml @@ -0,0 +1,16 @@ +--- +# defaults file for tripleo_overcloud_ffwd_upgrade_run +openstack_bin: openstack +tripleo_overcloud_ffwd_upgrade_run_debug: false +tripleo_overcloud_ffwd_upgrade_run_home_dir: "{{ ansible_env.HOME }}" +tripleo_overcloud_ffwd_upgrade_run_log: "{{ tripleo_overcloud_ffwd_upgrade_run_home_dir }}/overcloud_ffwd_upgrade_run.log" +tripleo_overcloud_ffwd_upgrade_run_log_combine: true +tripleo_overcloud_ffwd_upgrade_run_log_output: true +tripleo_overcloud_ffwd_upgrade_run_os_cloud: "{{ tripleo_os_cloud | default('') }}" +tripleo_overcloud_ffwd_upgrade_run_poll: 10 +tripleo_overcloud_ffwd_upgrade_run_rc_file: "{{ tripleo_rc_file | default(ansible_env.HOME ~ '/stackrc') }}" +tripleo_overcloud_ffwd_upgrade_run_ssh_user: +tripleo_overcloud_ffwd_upgrade_run_stack: +tripleo_overcloud_ffwd_upgrade_run_static_inventory: +tripleo_overcloud_ffwd_upgrade_run_timeout: 5700 +tripleo_overcloud_ffwd_upgrade_run_yes: true diff --git a/roles/tripleo_overcloud_ffwd_upgrade_run/meta/main.yml b/roles/tripleo_overcloud_ffwd_upgrade_run/meta/main.yml new file mode 100644 index 0000000..98615f8 --- /dev/null +++ b/roles/tripleo_overcloud_ffwd_upgrade_run/meta/main.yml @@ -0,0 +1,42 @@ +--- +# Copyright 2019 Red Hat, Inc. +# All Rights Reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + + +galaxy_info: + author: OpenStack + description: TripleO Operator Role -- tripleo_overcloud_ffwd_upgrade_run + company: Red Hat + license: Apache-2.0 + min_ansible_version: 2.8 + # + # Provide a list of supported platforms, and for each platform a list of versions. + # If you don't wish to enumerate all versions for a particular platform, use 'all'. + # To view available platforms and versions (or releases), visit: + # https://galaxy.ansible.com/api/v1/platforms/ + # + platforms: + - name: CentOS + versions: + - 7 + - 8 + + galaxy_tags: + - tripleo + + +# List your role dependencies here, one per line. Be sure to remove the '[]' above, +# if you add dependencies to this list. +dependencies: [] diff --git a/roles/tripleo_overcloud_ffwd_upgrade_run/molecule/default/converge.yml b/roles/tripleo_overcloud_ffwd_upgrade_run/molecule/default/converge.yml new file mode 100644 index 0000000..ef43377 --- /dev/null +++ b/roles/tripleo_overcloud_ffwd_upgrade_run/molecule/default/converge.yml @@ -0,0 +1,67 @@ +--- +- name: Converge + hosts: all + collections: + - tripleo.operator + vars: + openstack_bin: echo + tripleo_os_cloud: undercloud + tripleo_overcloud_ffwd_upgrade_run_debug: true + tripleo_overcloud_ffwd_upgrade_run_yes: false + tripleo_overcloud_ffwd_upgrade_run_log_output: false + tripleo_overcloud_ffwd_upgrade_run_log_combine: false + tripleo_overcloud_ffwd_upgrade_run_poll: 1 + tasks: + + - name: "Include tripleo_overcloud_ffwd_upgrade_run" + include_role: + name: "tripleo_overcloud_ffwd_upgrade_run" + + - name: Check role + assert: + that: + - tripleo_overcloud_ffwd_upgrade_run_output == "overcloud ffwd-upgrade run" + + - name: Check parameter "tripleo_overcloud_ffwd_upgrade_run_stack" + include_role: + name: "tripleo_overcloud_ffwd_upgrade_run" + vars: + tripleo_overcloud_ffwd_upgrade_run_stack: test + + - name: Assert "tripleo_overcloud_ffwd_upgrade_run_stack" + assert: + that: + - tripleo_overcloud_ffwd_upgrade_run_output == "overcloud ffwd-upgrade run --stack test" + + - name: Check parameter "tripleo_overcloud_ffwd_upgrade_run_yes" + include_role: + name: "tripleo_overcloud_ffwd_upgrade_run" + vars: + tripleo_overcloud_ffwd_upgrade_run_yes: true + + - name: Assert "tripleo_overcloud_ffwd_upgrade_run_yes" + assert: + that: + - tripleo_overcloud_ffwd_upgrade_run_output == "overcloud ffwd-upgrade run --yes" + + - name: Check parameter "tripleo_overcloud_ffwd_upgrade_run_ssh_user" + include_role: + name: "tripleo_overcloud_ffwd_upgrade_run" + vars: + tripleo_overcloud_ffwd_upgrade_run_ssh_user: username + + - name: Assert "tripleo_overcloud_ffwd_upgrade_run_ssh_user" + assert: + that: + - tripleo_overcloud_ffwd_upgrade_run_output == "overcloud ffwd-upgrade run --ssh-user username" + + - name: Check parameter "tripleo_overcloud_ffwd_upgrade_run_static_inventory" + include_role: + name: "tripleo_overcloud_ffwd_upgrade_run" + vars: + tripleo_overcloud_ffwd_upgrade_run_static_inventory: /home/foo/inventory.yml + + - name: Assert "tripleo_overcloud_ffwd_upgrade_run_static_inventory" + assert: + that: + - tripleo_overcloud_ffwd_upgrade_run_output == "overcloud ffwd-upgrade run --static-inventory /home/foo/inventory.yml" diff --git a/roles/tripleo_overcloud_ffwd_upgrade_run/molecule/default/molecule.yml b/roles/tripleo_overcloud_ffwd_upgrade_run/molecule/default/molecule.yml new file mode 100644 index 0000000..2841806 --- /dev/null +++ b/roles/tripleo_overcloud_ffwd_upgrade_run/molecule/default/molecule.yml @@ -0,0 +1,19 @@ +--- +driver: + name: delegated + options: + managed: false + ansible_connection_options: + ansible_connection: local +log: true +platforms: + - name: instance +provisioner: + name: ansible +scenario: + name: default + test_sequence: + - prepare + - syntax + - converge + - verify diff --git a/roles/tripleo_overcloud_ffwd_upgrade_run/molecule/default/prepare.yml b/roles/tripleo_overcloud_ffwd_upgrade_run/molecule/default/prepare.yml new file mode 100644 index 0000000..63bb6ab --- /dev/null +++ b/roles/tripleo_overcloud_ffwd_upgrade_run/molecule/default/prepare.yml @@ -0,0 +1,8 @@ +--- +- name: Prepare + hosts: all + tasks: + + - name: Include molecule prep + include_role: + name: test_molecule_prep diff --git a/roles/tripleo_overcloud_ffwd_upgrade_run/tasks/main.yml b/roles/tripleo_overcloud_ffwd_upgrade_run/tasks/main.yml new file mode 100644 index 0000000..828d2e0 --- /dev/null +++ b/roles/tripleo_overcloud_ffwd_upgrade_run/tasks/main.yml @@ -0,0 +1,50 @@ +--- +# tasks file for tripleo_overcloud_ffwd_upgrade_run +- name: Setup overcloud ffwd-upgrade run facts + set_fact: + _run_cmd: >- + {{ tripleo_overcloud_ffwd_upgrade_run_os_cloud | ternary('', "source " ~ tripleo_overcloud_ffwd_upgrade_run_rc_file ~ "; ") }} + {{ openstack_bin }} overcloud ffwd-upgrade run + {{ tripleo_overcloud_ffwd_upgrade_run_ssh_user | ternary('--ssh-user $FFWD_SSH_USER', '') }} + {{ tripleo_overcloud_ffwd_upgrade_run_static_inventory | ternary('--static-inventory $FFWD_STATIC_INVENTORY', '') }} + {{ tripleo_overcloud_ffwd_upgrade_run_stack | ternary('--stack $FFWD_STACK', '') }} + {{ tripleo_overcloud_ffwd_upgrade_run_yes | ternary('--yes', '') }} + {{ tripleo_overcloud_ffwd_upgrade_run_log_output | ternary((">" ~ tripleo_overcloud_ffwd_upgrade_run_log), '') }} + {{ tripleo_overcloud_ffwd_upgrade_run_log_combine | ternary("2>&1", '') }} + _run_env: + FFWD_SSH_USER: "{{ tripleo_overcloud_ffwd_upgrade_run_ssh_user }}" + FFWD_STATIC_INVENTORY: "{{ tripleo_overcloud_ffwd_upgrade_run_static_inventory }}" + FFWD_STACK: "{{ tripleo_overcloud_ffwd_upgrade_run_stack }}" + OS_CLOUD: "{{ tripleo_overcloud_ffwd_upgrade_run_os_cloud }}" + +- name: Preserve existing log file if exists + timestamp_file: + path: "{{ tripleo_overcloud_ffwd_upgrade_run_log }}" + when: tripleo_overcloud_ffwd_upgrade_run_log_output|bool + +- name: Show debug information + when: tripleo_overcloud_ffwd_upgrade_run_debug|bool + block: + - name: Show the overcloud ffwd-upgrade run command + debug: + var: _run_cmd + + - name: Show the overcloud ffwd-upgrade run environment + debug: + var: _run_env + +- name: overcloud ffwd-upgrade run + shell: "{{ _run_cmd }}" # noqa 305 + environment: "{{ _run_env }}" + args: + chdir: "{{ tripleo_overcloud_ffwd_upgrade_run_home_dir }}" + warn: false + register: tripleo_overcloud_ffwd_upgrade_run_result + async: "{{ tripleo_overcloud_ffwd_upgrade_run_timeout }}" + poll: "{{ tripleo_overcloud_ffwd_upgrade_run_poll }}" + changed_when: false + when: not ansible_check_mode|bool + +- name: Set output fact + set_fact: + tripleo_overcloud_ffwd_upgrade_run_output: "{{ tripleo_overcloud_ffwd_upgrade_run_result.stdout }}" diff --git a/roles/tripleo_overcloud_ffwd_upgrade_run/tests/inventory b/roles/tripleo_overcloud_ffwd_upgrade_run/tests/inventory new file mode 100644 index 0000000..2fbb50c --- /dev/null +++ b/roles/tripleo_overcloud_ffwd_upgrade_run/tests/inventory @@ -0,0 +1 @@ +localhost diff --git a/roles/tripleo_overcloud_ffwd_upgrade_run/tests/test.yml b/roles/tripleo_overcloud_ffwd_upgrade_run/tests/test.yml new file mode 100644 index 0000000..c3406b0 --- /dev/null +++ b/roles/tripleo_overcloud_ffwd_upgrade_run/tests/test.yml @@ -0,0 +1,4 @@ +--- +- hosts: localhost + roles: + - tripleo_overcloud_ffwd_upgrade_run diff --git a/zuul.d/molecule.yaml b/zuul.d/molecule.yaml index 1a64f50..3f1da1f 100644 --- a/zuul.d/molecule.yaml +++ b/zuul.d/molecule.yaml @@ -25,6 +25,7 @@ - tripleo-operator-molecule-tripleo_overcloud_external_upgrade_run - tripleo-operator-molecule-tripleo_overcloud_failures - tripleo-operator-molecule-tripleo_overcloud_ffwd_upgrade_prepare + - tripleo-operator-molecule-tripleo_overcloud_ffwd_upgrade_run - tripleo-operator-molecule-tripleo_overcloud_generate_fencing - tripleo-operator-molecule-tripleo_overcloud_image_build - tripleo-operator-molecule-tripleo_overcloud_netenv_validate @@ -77,6 +78,7 @@ - tripleo-operator-molecule-tripleo_overcloud_external_upgrade_run - tripleo-operator-molecule-tripleo_overcloud_failures - tripleo-operator-molecule-tripleo_overcloud_ffwd_upgrade_prepare + - tripleo-operator-molecule-tripleo_overcloud_ffwd_upgrade_run - tripleo-operator-molecule-tripleo_overcloud_generate_fencing - tripleo-operator-molecule-tripleo_overcloud_image_build - tripleo-operator-molecule-tripleo_overcloud_netenv_validate @@ -407,6 +409,20 @@ vars: tox_extra_args: tripleo_overcloud_ffwd_upgrade_prepare +- job: + files: + - ^roles/tripleo_overcloud_ffwd_upgrade_run/.* + - ^bindep.txt + - ^galaxy.yml + - ^requirements.txt + - ^setup.cfg + - ^test-requirements.txt + - ^tox.ini + name: tripleo-operator-molecule-tripleo_overcloud_ffwd_upgrade_run + parent: tripleo-operator-molecule-base + vars: + tox_extra_args: tripleo_overcloud_ffwd_upgrade_run + - job: files: - ^roles/tripleo_overcloud_generate_fencing/.*