heat_template_version: queens

description: >
  OpenStack containerized Nova Vncproxy service

parameters:
  DockerNovaVncProxyImage:
    description: image
    type: string
  DockerNovaConfigImage:
    description: The container image to use for the nova config_volume
    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.  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
  UpgradeRemoveUnusedPackages:
    default: false
    description: Remove package if the service is being disabled during upgrade
    type: boolean

resources:

  ContainersCommon:
    type: ./containers-common.yaml

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

  NovaVncProxyPuppetBase:
    type: ../../puppet/services/nova-vnc-proxy.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}

  NovaLogging:
    type: OS::TripleO::Services::Logging::NovaCommon
    properties:
      DockerNovaImage: {get_param: DockerNovaVncProxyImage}
      NovaServiceName: 'vncproxy'

outputs:
  role_data:
    description: Role data for the Nova Vncproxy service.
    value:
      service_name: {get_attr: [NovaVncProxyPuppetBase, role_data, service_name]}
      config_settings:
        map_merge:
          - {get_attr: [NovaVncProxyPuppetBase, role_data, config_settings]}
          - {get_attr: [NovaLogging, config_settings]}
      logging_source: {get_attr: [NovaVncProxyPuppetBase, role_data, logging_source]}
      logging_groups: {get_attr: [NovaVncProxyPuppetBase, role_data, logging_groups]}
      service_config_settings: {get_attr: [NovaVncProxyPuppetBase, role_data, service_config_settings]}
      # BEGIN DOCKER SETTINGS
      puppet_config:
        config_volume: nova
        puppet_tags: nova_config
        step_config:
          list_join:
            - "\n"
            - - {get_attr: [NovaVncProxyPuppetBase, role_data, step_config]}
              - {get_attr: [MySQLClient, role_data, step_config]}
        config_image: {get_param: DockerNovaConfigImage}
      kolla_config:
        /var/lib/kolla/config_files/nova_vnc_proxy.json:
          command:
            list_join:
            - ' '
            - - /usr/bin/nova-novncproxy --web /usr/share/novnc/
              - get_attr: [NovaLogging, cmd_extra_args]
          config_files:
            - source: "/var/lib/kolla/config_files/src/*"
              dest: "/"
              merge: true
              preserve_properties: true
          permissions:
            - path: /var/log/nova
              owner: nova:nova
              recurse: true
      docker_config:
        step_4:
          nova_vnc_proxy:
            image: {get_param: DockerNovaVncProxyImage}
            net: host
            privileged: false
            restart: always
            healthcheck:
              test: /openstack/healthcheck
            volumes:
              list_concat:
                - {get_attr: [ContainersCommon, volumes]}
                - {get_attr: [NovaLogging, volumes]}
                -
                  - /var/lib/kolla/config_files/nova_vnc_proxy.json:/var/lib/kolla/config_files/config.json:ro
                  - /var/lib/config-data/puppet-generated/nova/:/var/lib/kolla/config_files/src:ro
            environment:
              - KOLLA_CONFIG_STRATEGY=COPY_ALWAYS
      host_prep_tasks: {get_attr: [NovaLogging, host_prep_tasks]}
      upgrade_tasks:
        - name: Check if nova vncproxy is deployed
          command: systemctl is-enabled --quiet openstack-nova-novncproxy
          tags: common
          ignore_errors: True
          register: nova_vncproxy_enabled
        - name: "PreUpgrade step0,validation: Check service openstack-nova-novncproxy is running"
          command: systemctl is-active --quiet openstack-nova-novncproxy
          tags: step0,validation
          when: nova_vncproxy_enabled.rc == 0
        - name: Stop and disable nova_vnc_proxy service
          tags: step2
          when: nova_vncproxy_enabled.rc == 0
          service: name=openstack-nova-novncproxy state=stopped enabled=no
        - name: Remove openstack-nova-novncproxy package if operator requests it
          yum: name=openstack-nova-novncproxy state=removed
          tags: step2
          ignore_errors: True
          when: {get_param: UpgradeRemoveUnusedPackages}