tripleo-heat-templates/docker/services/octavia-housekeeping.yaml

heat_template_version: rocky

description: >
  OpenStack Octavia service configured with Puppet  

parameters:
  DockerOctaviaHousekeepingImage:
    description: image
    type: string
  DockerOctaviaConfigImage:
    description: The container image to use for the octavia config_volume
    type: string
  OctaviaHousekeepingLoggingSource:
    type: json
    default:
      tag: openstack.octavia.housekeeping
      path: /var/log/containers/octavia/housekeeping.log
  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.  This
                 mapping overrides those in ServiceNetMapDefaults.
    type: json
  DefaultPasswords:
    default: {}
    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

resources:

  ContainersCommon:
    type: ./containers-common.yaml

  OctaviaHousekeepingPuppetBase:
    type: ../../puppet/services/octavia-housekeeping.yaml
    properties:
      EndpointMap: {get_param: EndpointMap}
      ServiceData: {get_param: ServiceData}
      ServiceNetMap: {get_param: ServiceNetMap}
      DefaultPasswords: {get_param: DefaultPasswords}
      RoleName: {get_param: RoleName}
      RoleParameters: {get_param: RoleParameters}

outputs:
  role_data:
    description: Role data for the Octavia housekeeping role.
    value:
      service_name: {get_attr: [OctaviaHousekeepingPuppetBase, role_data, service_name]}
      config_settings: {get_attr: [OctaviaHousekeepingPuppetBase, role_data, config_settings]}
      logging_source: {get_attr: [OctaviaHousekeepingPuppetBase, role_data, logging_source]}
      logging_groups: {get_attr: [OctaviaHousekeepingPuppetBase, role_data, logging_groups]}
      service_config_settings:
        map_merge:
          - get_attr: [OctaviaHousekeepingPuppetBase, role_data, service_config_settings]
          - fluentd:
              tripleo_fluentd_groups_octavia_housekeeping:
                - octavia
              tripleo_fluentd_sources_octavia_housekeeping:
                - {get_param: OctaviaHousekeepingLoggingSource}
      # BEGIN DOCKER SETTINGS #
      puppet_config:
        config_volume: octavia
        puppet_tags: octavia_config
        step_config:
          get_attr: [OctaviaHousekeepingPuppetBase, role_data, step_config]
        config_image: {get_param: DockerOctaviaConfigImage}
      kolla_config:
        /var/lib/kolla/config_files/octavia_housekeeping.json:
          command: /usr/bin/octavia-housekeeping --config-file /usr/share/octavia/octavia-dist.conf --config-file /etc/octavia/octavia.conf --log-file /var/log/octavia/housekeeping.log --config-dir /etc/octavia/conf.d/common --config-dir /etc/octavia/conf.d/octavia-housekeeping
          config_files:
            - source: "/var/lib/kolla/config_files/src/*"
              dest: "/"
              merge: true
              preserve_properties: true
      docker_config:
        step_2:
          octavia_housekeeping_init_dirs:
            start_order: 0
            image: &octavia_housekeeping_image {get_param: DockerOctaviaHousekeepingImage}
            user: root
            volumes:
              # NOTE(mandre) we need extra dir for the service in /etc/octavia/conf.d
              # It is normally created as part of the RPM install, but it is
              # missing here because we use the same config_volume for all
              # octavia services, hence the same container image to generate
              # configuration.
              - /var/lib/config-data/puppet-generated/octavia/etc/octavia:/etc/octavia/
            command: ['/bin/bash', '-c', 'mkdir -p /etc/octavia/conf.d/octavia-housekeeping; chown -R octavia:octavia /etc/octavia/conf.d/octavia-housekeeping']
        step_4:
          octavia_housekeeping:
            start_order: 2
            image: *octavia_housekeeping_image
            net: host
            privileged: false
            restart: always
            healthcheck:
              test: /openstack/healthcheck
            volumes:
              list_concat:
                - {get_attr: [ContainersCommon, volumes]}
                -
                  - /var/lib/kolla/config_files/octavia_housekeeping.json:/var/lib/kolla/config_files/config.json:ro
                  - /var/lib/config-data/puppet-generated/octavia/:/var/lib/kolla/config_files/src:ro
                  - /var/log/containers/octavia:/var/log/octavia
            environment:
              - KOLLA_CONFIG_STRATEGY=COPY_ALWAYS
      host_prep_tasks:
        - name: create persistent logs directory
          file:
            path: /var/log/containers/octavia
            state: directory
        - name: octavia logs readme
          copy:
            dest: /var/log/octavia/readme.txt
            content: |
              Log files from octavia containers can be found under
              /var/log/containers/octavia and /var/log/containers/httpd/octavia-api.              
          ignore_errors: true
      upgrade_tasks:
        - name: Check if octavia_housekeeping is deployed
          common: systemctl is-enabled --quiet openstack-octavia-housekeeping
          tags: common
          ignore_errors: True
          register: octavia_housekeeping_enabled
        - name: "PreUpgrade step0,validation: Check service openstack-octavia-housekeeping is running"
          command: systemctl is-active --quiet openstack-octavia-housekeeping
          when:
            - step|int == 0
            - octavia_housekeeping_enabled.rc == 0
          tags: validation
        - name: Stop and disable octavia_housekeeping service
          when:
            - step|int == 2
            - octavia_housekeeping_enabled.rc == 0
          service: name=openstack-octavia-housekeeping state=stopped enabled=no