heat_template_version: wallaby

description: >
  OpenStack containerized Cinder Backup service

parameters:
  ContainerCinderBackupImage:
    description: image
    type: string
    tags:
      - role_specific
  ContainerCinderConfigImage:
    description: The container image to use for the cinder config_volume
    type: string
    tags:
      - role_specific
  ClusterCommonTag:
    default: false
    description: When set to false, a pacemaker service is configured
                 to use a floating tag for its container image name,
                 e.g. 'REGISTRY/NAMESPACE/IMAGENAME:pcmklatest'. When
                 set to true, the service uses a floating prefix as
                 well, e.g. 'cluster.common.tag/IMAGENAME:pcmklatest'.
    type: boolean
  ClusterFullTag:
    default: true
    description: When set to true, the pacemaker service uses a fully
                 constant tag for its container image name, e.g.
                 'cluster.common.tag/SERVICENAME:pcmklatest'.
    type: boolean
  CinderBackupBackend:
    default: swift
    description: The short name of the Cinder Backup backend to use.
    type: string
    constraints:
    - allowed_values: ['swift', 'ceph', 'nfs', 'gcs', 's3']
  CinderBackupRbdPoolName:
    default: backups
    type: string
  CephClientUserName:
    default: openstack
    type: string
  EndpointMap:
    default: {}
    description: Mapping of service endpoint -> protocol. Typically set
                 via parameter_defaults in the resource registry.
    type: json
  ServiceData:
    default: {}
    description: Dictionary packing service data
    type: json
  ServiceNetMap:
    default: {}
    description: Mapping of service_name -> network name. Typically set
                 via parameter_defaults in the resource registry. Use
                 parameter_merge_strategies to merge it with the defaults.
    type: json
  RoleName:
    default: ''
    description: Role name on which the service is applied
    type: string
  RoleParameters:
    default: {}
    description: Parameters specific to the role
    type: json
  ConfigDebug:
    default: false
    description: Whether to run config management (e.g. Puppet) in debug mode.
    type: boolean
  ContainerCli:
    type: string
    default: 'podman'
    description: CLI tool used to manage containers.
    constraints:
      - allowed_values: ['docker', 'podman']
  DeployIdentifier:
    default: ''
    type: string
    description: >
      Setting this to a unique value will re-run any deployment tasks which
      perform configuration on a Heat stack-update.
  DockerCinderBackupLoggingSource:
    type: json
    default:
      tag: openstack.cinder.backup
      file: /var/log/containers/cinder/cinder-backup.log
  CephConfigPath:
    type: string
    default: "/var/lib/tripleo-config/ceph"
    description: |
      The path where the Ceph Cluster config files are stored on the host.

resources:
  ContainersCommon:
    type: ../containers-common.yaml

  MySQLClient:
    type: ../database/mysql-client.yaml

  CinderBackupBase:
    type: ./cinder-backup-container-puppet.yaml
    properties:
      EndpointMap: {get_param: EndpointMap}
      ServiceData: {get_param: ServiceData}
      ServiceNetMap: {get_param: ServiceNetMap}
      RoleName: {get_param: RoleName}
      RoleParameters: {get_param: RoleParameters}
      CinderBackupBackend: {get_param: CinderBackupBackend}
      CinderBackupRbdPoolName: {get_param: CinderBackupRbdPoolName}
      CephClientUserName: {get_param: CephClientUserName}

  CinderCommon:
    type: ./cinder-common-container-puppet.yaml

  RoleParametersValue:
    type: OS::Heat::Value
    properties:
      type: json
      value:
        map_replace:
          - map_replace:
            - ContainerCinderBackupImage: ContainerCinderBackupImage
              ContainerCinderConfigImage: ContainerCinderConfigImage
            - values: {get_param: [RoleParameters]}
          - values:
              ContainerCinderBackupImage: {get_param: ContainerCinderBackupImage}
              ContainerCinderConfigImage: {get_param: ContainerCinderConfigImage}

outputs:
  role_data:
    description: Role data for the Cinder Backup role.
    value:
      service_name: cinder_backup
      monitoring_subscription: {get_attr: [CinderBackupBase, role_data, monitoring_subscription]}
      config_settings:
        map_merge:
          - get_attr: [CinderBackupBase, role_data, config_settings]
          - tripleo::profile::pacemaker::cinder::backup_bundle::cinder_backup_docker_image: &cinder_backup_image_pcmklatest
              if:
                - {get_param: ClusterFullTag}
                - "cluster.common.tag/cinder-backup:pcmklatest"
                - yaql:
                    data:
                      if:
                        - {get_param: ClusterCommonTag}
                        - yaql:
                            data: {get_attr: [RoleParametersValue, value, ContainerCinderBackupImage]}
                            expression: concat("cluster.common.tag/", $.data.rightSplit(separator => "/", maxSplits => 1)[1])
                        - {get_attr: [RoleParametersValue, value, ContainerCinderBackupImage]}
                    expression: concat($.data.rightSplit(separator => ":", maxSplits => 1)[0], ":pcmklatest")
            tripleo::profile::pacemaker::cinder::backup_bundle::docker_volumes: {get_attr: [CinderCommon, cinder_backup_volumes]}
            tripleo::profile::pacemaker::cinder::backup_bundle::docker_environment: {get_attr: [CinderCommon, cinder_backup_environment]}
            tripleo::profile::pacemaker::cinder::backup_bundle::container_backend: {get_param: ContainerCli}
            tripleo::profile::pacemaker::cinder::backup_bundle::ceph_conf_path: {get_param: CephConfigPath}
            cinder::backup::manage_service: false
            cinder::backup::enabled: false
      service_config_settings:
          get_attr: [CinderBackupBase, role_data, service_config_settings]
      # BEGIN DOCKER SETTINGS
      puppet_config:
        config_volume: cinder
        puppet_tags: cinder_config,file,concat,file_line
        step_config:
          list_join:
            - "\n"
            - - {get_attr: [CinderBackupBase, role_data, puppet_config, step_config]}
              - "include tripleo::profile::pacemaker::cinder::backup_bundle"
        config_image: {get_attr: [RoleParametersValue, value, ContainerCinderConfigImage]}
      kolla_config:
        /var/lib/kolla/config_files/cinder_backup.json:
          command: /usr/bin/cinder-backup --config-file /usr/share/cinder/cinder-dist.conf --config-file /etc/cinder/cinder.conf
          config_files: {get_attr: [CinderCommon, cinder_common_kolla_config_files]}
          permissions: {get_attr: [CinderCommon, cinder_common_kolla_permissions]}
      container_config_scripts: {get_attr: [ContainersCommon, container_config_scripts]}
      docker_config:
        step_3:
          cinder_backup_init_logs:
            start_order: 0
            image: {get_attr: [RoleParametersValue, value, ContainerCinderBackupImage]}
            net: none
            privileged: false
            user: root
            volumes:
              - /var/log/containers/cinder:/var/log/cinder:z
            command: ['/bin/bash', '-c', 'chown -R cinder:cinder /var/log/cinder']
      host_prep_tasks: {get_attr: [CinderCommon, cinder_backup_host_prep_tasks]}
      deploy_steps_tasks:
        - name: Cinder Backup tag container image for pacemaker
          when: step|int == 1
          import_role:
            name: tripleo_container_tag
          vars:
            container_image: {get_attr: [RoleParametersValue, value, ContainerCinderBackupImage]}
            container_image_latest: *cinder_backup_image_pcmklatest
        - name: Cinder Backup HA Wrappers Step
          when: step|int == 5
          block: &cinder_backup_puppet_bundle
            - name: Cinder backup puppet bundle
              import_role:
                name: tripleo_ha_wrapper
              vars:
                tripleo_ha_wrapper_service_name: cinder_backup
                tripleo_ha_wrapper_resource_name: openstack-cinder-backup
                tripleo_ha_wrapper_bundle_name: openstack-cinder-backup
                tripleo_ha_wrapper_resource_state: _ Started
                tripleo_ha_wrapper_puppet_config_volume: cinder
                tripleo_ha_wrapper_puppet_execute: 'include ::tripleo::profile::base::pacemaker; include ::tripleo::profile::pacemaker::cinder::backup_bundle'
                tripleo_ha_wrapper_puppet_tags: 'pacemaker::resource::bundle,pacemaker::property,pacemaker::resource::ip,pacemaker::resource::ocf,pacemaker::constraint::order,pacemaker::constraint::colocation'
                tripleo_ha_wrapper_puppet_debug: {get_param: ConfigDebug}
                tripleo_ha_wrapper_config_suffix: .cinder_backup_previous_run

      external_update_tasks:
        - when: step|int == 1
          tags: ha_image_update
          block:
            - block: &cinder_backup_container_image_facts
              - name: Get cinder_backup image from pacemaker
                become: true
                register: xmllint_pcmk_cinder_backup_image
                # retrieve info even when pacemaker is stopped
                shell: 'xmllint --xpath "string(//bundle[@id=''openstack-cinder-backup'']/podman/@image)" /var/lib/pacemaker/cib/cib.xml'
              - name: Get container cinder_backup image
                set_fact:
                  # container image to use for deployment
                  cinder_backup_image: {get_attr: [RoleParametersValue, value, ContainerCinderBackupImage]}
                  # pacemaker bundle image name to use for deployment
                  cinder_backup_image_latest: *cinder_backup_image_pcmklatest
                  # image currently configured in pacemaker bundle
                  pcmk_cinder_backup_image: '{{xmllint_pcmk_cinder_backup_image.stdout}}'
              delegate_to: '{{ (groups["cinder_backup"] | difference(groups["excluded_overcloud"]))[0] }}'
            - name: cinder-backup temporary pacemaker container tag in case of image switch
              become: true
              import_role:
                name: tripleo_ha_image_update
              vars:
                tripleo_ha_image_update_node_names: '{{ groups["cinder_backup"] | difference(groups["excluded_overcloud"]) }}'
                tripleo_ha_image_update_bundle: openstack-cinder-backup
                tripleo_ha_image_update_new_image: '{{cinder_backup_image_latest}}'
                tripleo_ha_image_update_old_image: '{{pcmk_cinder_backup_image}}'
              when:
                - (pcmk_cinder_backup_image != "")
                - (pcmk_cinder_backup_image != cinder_backup_image_latest)

      update_tasks:
        - block: *cinder_backup_container_image_facts
          when: (step|int == 0 or step|int == 2)
        - name: Check for update of cinder-backup container image name
          when: step|int == 0
          assert:
            that: pcmk_cinder_backup_image == cinder_backup_image_latest
            fail_msg: "cinder-backup image change detected, run overcloud external-update --tags ha_image_update first"
        - name: Tear-down non-HA cinder-backup container
          when:
            - step|int == 1
          block: &cinder_backup_teardown_nonha
            - name: Remove non-HA cinder-backup container
              include_role:
                name: tripleo_container_rm
              vars:
                tripleo_container_cli: "{{ container_cli }}"
                tripleo_containers_to_rm:
                  - cinder_backup
        - name: cinder_backup fetch and retag container image for pacemaker
          when: step|int == 2
          block: &cinder_backup_fetch_retag_container_tasks
            - name: Retag pcmklatest to latest cinder_backup image
              include_role:
                name: tripleo_container_tag
              vars:
                container_image: "{{cinder_backup_image}}"
                container_image_latest: "{{cinder_backup_image_latest}}"

      post_update_tasks:
        - name: Cinder backup bundle post update
          when: step|int == 1
          block: *cinder_backup_puppet_bundle
          vars:
            tripleo_ha_wrapper_minor_update: true

      upgrade_tasks:
        - name: Tear-down non-HA cinder_backup container
          when:
            - step|int == 0
          block: *cinder_backup_teardown_nonha
        - name: Prepare switch of cinder_backup image name
          when:
            - step|int == 0
          block:
            - name: Get cinder_backup image id currently used by pacemaker
              shell: "pcs resource config openstack-cinder-backup | grep -Eo 'image=[^ ]+' | awk -F= '{print $2;}'"
              register: cinder_backup_image_current_res
              failed_when: false
            - name: cinder_backup image facts
              set_fact:
                cinder_backup_image_latest: *cinder_backup_image_pcmklatest
                cinder_backup_image_current: "{{cinder_backup_image_current_res.stdout}}"
            - name: Temporarily tag the current cinder_backup image id with the upgraded image name
              import_role:
                name: tripleo_container_tag
              vars:
                container_image: "{{cinder_backup_image_current}}"
                container_image_latest: "{{cinder_backup_image_latest}}"
                pull_image: false
              when:
                - cinder_backup_image_current != ''
                - cinder_backup_image_current != cinder_backup_image_latest
            # Steps are separate playbook runs and we need to keep state
            - name: Create cinder_backup retag statefile
              file:
                path: '/var/lib/tripleo/cinder_backup_needs_retag'
                state: touch
              when:
                - cinder_backup_image_current != ''
                - cinder_backup_image_current != cinder_backup_image_latest
        - name: Update cinder_backup pcs resource bundle for new container image - check
          when:
            - step|int == 1
          block:
            - name: set is_cinder_backup_bootstrap_node fact
              tags: common
              set_fact: is_cinder_backup_bootstrap_node={{cinder_backup_short_bootstrap_node_name|lower == ansible_facts['hostname']|lower}}
            - name: Check for cinder_backup retag statefile
              stat:
                path: '/var/lib/tripleo/cinder_backup_needs_retag'
              register: cinder_backup_retag_state_file
        - name: Update cinder_backup pcs resource bundle for new container image
          when:
            - step|int == 1
            - is_cinder_backup_bootstrap_node
            - cinder_backup_retag_state_file.stat.exists|bool
          block:
            - name: Disable the cinder_backup cluster resource before container upgrade step1
              pacemaker_resource:
                resource: openstack-cinder-backup
                state: disable
                wait_for_resource: true
              register: output
              retries: 5
              until: output.rc == 0
            - name: Update the cinder_backup bundle to use the new container image name
              command: "pcs resource bundle update openstack-cinder-backup container image={{cinder_backup_image_latest}}"
            - name: Enable the cinder_backup cluster resource
              pacemaker_resource:
                resource: openstack-cinder-backup
                state: enable
                wait_for_resource: true
              register: output
              retries: 5
              until: output.rc == 0
        - name: Check for cinder_backup retag statefile
          when:
            - step|int == 3
          stat:
            path: '/var/lib/tripleo/cinder_backup_needs_retag'
          register: cinder_backup_retag_state_file
        - name: Retag the pacemaker image for cinder_backup
          when:
            - step|int == 3
            - cinder_backup_retag_state_file.stat.exists|bool
          block:
            - name: Disable the cinder_backup cluster resource before container upgrade step3
              pacemaker_resource:
                resource: openstack-cinder-backup
                state: disable
                wait_for_resource: true
              register: output
              retries: 5
              until: output.rc == 0
            - name: Retag the pacemaker image if containerized
              block:
                - block: *cinder_backup_container_image_facts
                - block: *cinder_backup_fetch_retag_container_tasks
            - name: Enable the cinder_backup cluster resource
              pacemaker_resource:
                resource: openstack-cinder-backup
                state: enable
                wait_for_resource: true
              register: output
              retries: 5
              until: output.rc == 0
            - name: Remove cinder_backup retag statefile
              file:
                path: '/var/lib/tripleo/cinder_backup_needs_retag'
                state: absent