Add overcloud generate fencing

Adds tripleo_overcloud_generate_fencing to generate fencing parameters
for HA.

Change-Id: I67acaeb91dd476c195ee96ca44267722c45932ae

roles/tripleo_overcloud_generate_fencing/README.md

@@ -0,0 +1,63 @@
+tripleo_overcloud_generate_fencing
+==================================
+
+A role to generate overcloud fencing parameters.
+
+Requirements
+------------
+
+None.
+
+Role Variables
+--------------
+
+* `tripleo_overcloud_generate_fencing_action`: (String) The fencing action. Deprecated and ignored in later versions.
+* `tripleo_overcloud_generate_fencing_debug`: (Boolean) Flag to print out the delete command. Default: False
+* `tripleo_overcloud_generate_fencing_delay`: (Integer) Number of seconds to wait before fencing is started.
+* `tripleo_overcloud_generate_fencing_environment_file`: (String) REQUIRED. Path to the environment file.
+* `tripleo_overcloud_generate_fencing_home_dir`: (String) Home directory to where the command is run from. Default: "{{ ansible_env.HOME }}"
+* `tripleo_overcloud_generate_fencing_ipmi_cipher`: (String) Cipher squit to use (same as ipmitool -C)
+* `tripleo_overcloud_generate_fencing_ipmi_lanplus`: (Boolean) Use lanplus. Option deprecated because it's the default. Default: false
+* `tripleo_overcloud_generate_fencing_ipmi_level`: (String) Privilege level on IPMI device. (callback, user, operator, administrator)
+* `tripleo_overcloud_generate_fencing_ipmi_no_lanplus`: (Boolean) Do not use lanplus. Default: false
+* `tripleo_overcloud_generate_fencing_log_combine`: (Boolean) Flag to enable captching stderr with stdout. Default: true
+* `tripleo_overcloud_generate_fencing_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_generate_fencing_log`: (String) Path to a log file for the command output. Default: "{{ tripleo_overcloud_generate_fencing_home_dir }}/overcloud_generate_fencing.log"
+* `tripleo_overcloud_generate_fencing_os_cloud`: (String) (String) OS_CLOUD value to use when running the command. If `tripleo_os_cloud` is defined, it will be the default. Otherwise the default is ''. This variable takes precedence over `tripleo_overcloud_generate_fencing_rc_file`.
+* `tripleo_overcloud_generate_fencing_output_file`: (String) Destination for the output parameters.
+* `tripleo_overcloud_generate_fencing_poll`: (Integer) Number of seconds to wait between each checks to see if the command has completed. Default: 10
+* `tripleo_overcloud_generate_fencing_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_generate_fencing_timeout`: (Integer) Number in seconds to wait for the ansible execution of the command to finish. Default: 3600
+
+Output Variables
+----------------
+
+* `tripleo_overcloud_generate_fencing_output`: (String) The command standard output.
+* `tripleo_overcloud_generate_fencing_result`: Ansible shell execution results
+
+Dependencies
+------------
+
+None.
+
+Example Playbook
+----------------
+
+Example generate fencing
+
+```yaml
+- hosts: undercloud
+  gather_facts: true
+  tasks:
+    - name: Run overcloud generate fencing
+      import_role:
+        name: tripleo_overcloud_generate_fencing
+      var:
+        tripleo_overcloud_generate_fencing_debug: true
+        tripleo_overcloud_generate_fencing_environment_file: /home/stack/instackenv.json
+```
+
+License
+-------
+
+Apache-2.0

roles/tripleo_overcloud_generate_fencing/defaults/main.yml

@@ -0,0 +1,20 @@
+---
+# defaults file for tripleo_overcloud_generate_fencing
+openstack_bin: openstack
+tripleo_overcloud_generate_fencing_action:
+tripleo_overcloud_generate_fencing_debug: false
+tripleo_overcloud_generate_fencing_delay:
+tripleo_overcloud_generate_fencing_environment_file:
+tripleo_overcloud_generate_fencing_home_dir: "{{ ansible_env.HOME }}"
+tripleo_overcloud_generate_fencing_ipmi_cipher:
+tripleo_overcloud_generate_fencing_ipmi_lanplus: false
+tripleo_overcloud_generate_fencing_ipmi_level:
+tripleo_overcloud_generate_fencing_ipmi_no_lanplus: false
+tripleo_overcloud_generate_fencing_log: "{{ tripleo_overcloud_generate_fencing_home_dir }}/overcloud_generate_fencing.log"
+tripleo_overcloud_generate_fencing_log_combine: true
+tripleo_overcloud_generate_fencing_log_output: true
+tripleo_overcloud_generate_fencing_os_cloud: "{{ tripleo_os_cloud | default('') }}"
+tripleo_overcloud_generate_fencing_output_file:
+tripleo_overcloud_generate_fencing_poll: 10
+tripleo_overcloud_generate_fencing_rc_file: "{{ tripleo_rc_file | default(ansible_env.HOME ~ '/stackrc') }}"
+tripleo_overcloud_generate_fencing_timeout: 3600

roles/tripleo_overcloud_generate_fencing/meta/main.yml

@@ -0,0 +1,42 @@
+---
+# Copyright 2020 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_generate_fencing
+  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: []

roles/tripleo_overcloud_generate_fencing/molecule/default/converge.yml

@@ -0,0 +1,117 @@
+---
+- name: Converge
+  hosts: all
+  collections:
+    - tripleo.operator
+  vars:
+    openstack_bin: echo
+    tripleo_os_cloud: undercloud
+    tripleo_overcloud_generate_fencing_log_output: false
+    tripleo_overcloud_generate_fencing_poll: 1
+    tripleo_overcloud_generate_fencing_debug: true
+  tasks:
+
+    - name: "Include tripleo_overcloud_generate_fencing"
+      include_role:
+        name: "tripleo_overcloud_generate_fencing"
+
+    - name: Check role
+      assert:
+        that:
+          - tripleo_overcloud_generate_fencing_output == "overcloud generate fencing"
+
+    - name: Assert "tripleo_overcloud_generate_fencing_action"
+      include_role:
+        name: "tripleo_overcloud_generate_fencing"
+      vars:
+        tripleo_overcloud_generate_fencing_action: foo
+
+    - name: Validate tripleo_overcloud_generate_fencing_action
+      assert:
+        that:
+          - tripleo_overcloud_generate_fencing_output ==
+            "overcloud generate fencing --action foo"
+
+    - name: Assert "tripleo_overcloud_generate_fencing_delay"
+      include_role:
+        name: "tripleo_overcloud_generate_fencing"
+      vars:
+        tripleo_overcloud_generate_fencing_delay: 10
+
+    - name: Validate tripleo_overcloud_generate_fencing_delay
+      assert:
+        that:
+          - tripleo_overcloud_generate_fencing_output ==
+            "overcloud generate fencing --delay 10"
+
+    - name: Assert "tripleo_overcloud_generate_fencing_ipmi_lanplus"
+      include_role:
+        name: "tripleo_overcloud_generate_fencing"
+      vars:
+        tripleo_overcloud_generate_fencing_ipmi_lanplus: true
+
+    - name: Validate tripleo_overcloud_generate_fencing_ipmi_lanplus
+      assert:
+        that:
+          - tripleo_overcloud_generate_fencing_output ==
+            "overcloud generate fencing --ipmi-lanplus"
+
+    - name: Assert "tripleo_overcloud_generate_fencing_ipmi_no_lanplus"
+      include_role:
+        name: "tripleo_overcloud_generate_fencing"
+      vars:
+        tripleo_overcloud_generate_fencing_ipmi_no_lanplus: true
+
+    - name: Validate tripleo_overcloud_generate_fencing_ipmi_no_lanplus
+      assert:
+        that:
+          - tripleo_overcloud_generate_fencing_output ==
+            "overcloud generate fencing --ipmi-no-lanplus"
+
+    - name: Assert "tripleo_overcloud_generate_fencing_ipmi_cipher"
+      include_role:
+        name: "tripleo_overcloud_generate_fencing"
+      vars:
+        tripleo_overcloud_generate_fencing_ipmi_cipher: foo
+
+    - name: Validate tripleo_overcloud_generate_fencing_ipmi_cipher
+      assert:
+        that:
+          - tripleo_overcloud_generate_fencing_output ==
+            "overcloud generate fencing --ipmi-cipher foo"
+
+    - name: Assert "tripleo_overcloud_generate_fencing_ipmi_level"
+      include_role:
+        name: "tripleo_overcloud_generate_fencing"
+      vars:
+        tripleo_overcloud_generate_fencing_ipmi_level: foo
+
+    - name: Validate tripleo_overcloud_generate_fencing_ipmi_level
+      assert:
+        that:
+          - tripleo_overcloud_generate_fencing_output ==
+            "overcloud generate fencing --ipmi-level foo"
+
+    - name: Assert "tripleo_overcloud_generate_fencing_output_file"
+      include_role:
+        name: "tripleo_overcloud_generate_fencing"
+      vars:
+        tripleo_overcloud_generate_fencing_output_file: foo.yaml
+
+    - name: Validate tripleo_overcloud_generate_fencing_output_file
+      assert:
+        that:
+          - tripleo_overcloud_generate_fencing_output ==
+            "overcloud generate fencing --output foo.yaml"
+
+    - name: Assert "tripleo_overcloud_generate_fencing_environment_file"
+      include_role:
+        name: "tripleo_overcloud_generate_fencing"
+      vars:
+        tripleo_overcloud_generate_fencing_environment_file: foo.yaml
+
+    - name: Validate tripleo_overcloud_generate_fencing_environment_file
+      assert:
+        that:
+          - tripleo_overcloud_generate_fencing_output ==
+            "overcloud generate fencing foo.yaml"

roles/tripleo_overcloud_generate_fencing/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

roles/tripleo_overcloud_generate_fencing/molecule/default/prepare.yml

@@ -0,0 +1,8 @@
+---
+- name: Prepare
+  hosts: all
+  tasks:
+
+    - name: Include molecule prep
+      include_role:
+        name: test_molecule_prep

roles/tripleo_overcloud_generate_fencing/tasks/main.yml

@@ -0,0 +1,57 @@
+---
+# tasks file for tripleo_overcloud_generate_fencing
+- name: Set overcloud generate fencing facts
+  set_fact:
+    _fencing_cmd: >-
+      {{ tripleo_overcloud_generate_fencing_os_cloud | ternary('', "source " ~ tripleo_overcloud_generate_fencing_rc_file ~ "; ") }}
+      {{ openstack_bin }} overcloud generate fencing
+      {{ tripleo_overcloud_generate_fencing_action | ternary('--action $FENCING_ACTION', '') }}
+      {{ tripleo_overcloud_generate_fencing_delay | ternary('--delay $FENCING_DELAY', '') }}
+      {{ tripleo_overcloud_generate_fencing_ipmi_lanplus | ternary('--ipmi-lanplus', '') }}
+      {{ tripleo_overcloud_generate_fencing_ipmi_no_lanplus | ternary('--ipmi-no-lanplus', '') }}
+      {{ tripleo_overcloud_generate_fencing_ipmi_cipher | ternary('--ipmi-cipher $FENCING_CIPHER', '') }}
+      {{ tripleo_overcloud_generate_fencing_ipmi_level | ternary('--ipmi-level $FENCING_LEVEL', '') }}
+      {{ tripleo_overcloud_generate_fencing_output_file | ternary('--output $FENCING_OUTPUT', '') }}
+      {{ tripleo_overcloud_generate_fencing_environment_file }}
+      {{ tripleo_overcloud_generate_fencing_log_output | ternary((">" ~ tripleo_overcloud_generate_fencing_log), '') }}
+      {{ tripleo_overcloud_generate_fencing_log_combine | ternary("2>&1", '') }}
+    _fencing_env:
+      OS_CLOUD: "{{ tripleo_overcloud_generate_fencing_os_cloud }}"
+      FENCING_ACTION: "{{ tripleo_overcloud_generate_fencing_action | quote }}"
+      FENCING_DELAY: "{{ tripleo_overcloud_generate_fencing_delay | quote }}"
+      FENCING_CIPHER: "{{ tripleo_overcloud_generate_fencing_ipmi_cipher | quote }}"
+      FENCING_LEVEL: "{{ tripleo_overcloud_generate_fencing_ipmi_level | quote }}"
+      FENCING_OUTPUT: "{{ tripleo_overcloud_generate_fencing_output_file | quote }}"
+
+- name: Preserve existing log file if exists
+  timestamp_file:
+    path: "{{ tripleo_overcloud_generate_fencing_log }}"
+  when: tripleo_overcloud_generate_fencing_log_output|bool
+
+- name: Show debug information
+  when: tripleo_overcloud_generate_fencing_debug|bool
+  block:
+    - name: Show the command
+      debug:
+        var: _fencing_cmd
+
+    - name: Show the environment
+      debug:
+        var: _fencing_env
+
+- name: overcloud generate fencing
+  shell: "{{ _fencing_cmd }}"  # noqa 305
+  environment: "{{ _fencing_env }}"
+  args:
+    executable: /bin/bash
+    chdir: "{{ tripleo_overcloud_generate_fencing_home_dir }}"
+    warn: false
+  register: tripleo_overcloud_generate_fencing_result
+  async: "{{ tripleo_overcloud_generate_fencing_timeout }}"
+  poll: "{{ tripleo_overcloud_generate_fencing_poll }}"
+  changed_when: false
+  when: not ansible_check_mode|bool
+
+- name: Set output fact
+  set_fact:
+    tripleo_overcloud_generate_fencing_output: "{{ tripleo_overcloud_generate_fencing_result.stdout }}"

roles/tripleo_overcloud_generate_fencing/tests/inventory

@@ -0,0 +1 @@
+localhost

roles/tripleo_overcloud_generate_fencing/tests/test.yml

@@ -0,0 +1,5 @@
+---
+- hosts: localhost
+  remote_user: root
+  roles:
+    - tripleo_overcloud_generate_fencing

zuul.d/molecule.yaml

@@ -22,6 +22,7 @@
       - tripleo-operator-molecule-tripleo_overcloud_deploy
       - tripleo-operator-molecule-tripleo_overcloud_export
       - tripleo-operator-molecule-tripleo_overcloud_failures
+      - tripleo-operator-molecule-tripleo_overcloud_generate_fencing
       - tripleo-operator-molecule-tripleo_overcloud_image_build
       - tripleo-operator-molecule-tripleo_overcloud_netenv_validate
       - tripleo-operator-molecule-tripleo_overcloud_node_bios_configure
@@ -68,6 +69,7 @@
       - tripleo-operator-molecule-tripleo_overcloud_deploy
       - tripleo-operator-molecule-tripleo_overcloud_export
       - tripleo-operator-molecule-tripleo_overcloud_failures
+      - tripleo-operator-molecule-tripleo_overcloud_generate_fencing
       - tripleo-operator-molecule-tripleo_overcloud_image_build
       - tripleo-operator-molecule-tripleo_overcloud_netenv_validate
       - tripleo-operator-molecule-tripleo_overcloud_node_bios_configure
@@ -353,6 +355,20 @@
     vars:
       tox_extra_args: tripleo_overcloud_failures
 
+- job:
+    files:
+      - ^roles/tripleo_overcloud_generate_fencing/.*
+      - ^bindep.txt
+      - ^galaxy.yml
+      - ^requirements.txt
+      - ^setup.cfg
+      - ^test-requirements.txt
+      - ^tox.ini
+    name: tripleo-operator-molecule-tripleo_overcloud_generate_fencing
+    parent: tripleo-operator-molecule-base
+    vars:
+      tox_extra_args: tripleo_overcloud_generate_fencing
+
 - job:
     files:
       - ^roles/tripleo_overcloud_image_build/.*