heat_template_version: pike

description: >
  OpenStack Neutron SR-IOV nic agent configured with Puppet

parameters:
  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
  EndpointMap:
    default: {}
    description: Mapping of service endpoint -> protocol. Typically set
                 via parameter_defaults in the resource registry.
    type: json
  NeutronPhysicalDevMappings:
    description: >
      List of <physical_network>:<physical device>
      All physical networks listed in network_vlan_ranges
      on the server should have mappings to appropriate
      interfaces on each agent.
      Example "tenant0:ens2f0,tenant1:ens2f1"
    type: comma_delimited_list
    default: ""
  NeutronExcludeDevices:
    description: >
      List of <network_device>:<excluded_devices> mapping
      network_device to the agent's node-specific list of virtual functions
      that should not be used for virtual networking. excluded_devices is a
      semicolon separated list of virtual functions to exclude from
      network_device. The network_device in the mapping should appear in the
      physical_device_mappings list.
    type: comma_delimited_list
    default: ""
  NeutronSriovNumVFs:
    description: >
      Provide the list of VFs to be reserved for each SR-IOV interface.
      Format "<interface_name1>:<numvfs1>,<interface_name2>:<numvfs2>"
      Example "eth1:4096,eth2:128"
    type: comma_delimited_list
    default: ""
  NeutronSriovAgentExtensions:
    default: ""
    description: >
        Comma-separated list of extensions enabled for the Neutron SR-IOV agents.
    type: comma_delimited_list

resources:

  NeutronBase:
    type: ./neutron-base.yaml
    properties:
      ServiceData: {get_param: ServiceData}
      ServiceNetMap: {get_param: ServiceNetMap}
      DefaultPasswords: {get_param: DefaultPasswords}
      EndpointMap: {get_param: EndpointMap}
      RoleName: {get_param: RoleName}
      RoleParameters: {get_param: RoleParameters}

  # Merging role-specific parameters (RoleParameters) with the default parameters.
  # RoleParameters will have the precedence over the default parameters.
  RoleParametersValue:
    type: OS::Heat::Value
    properties:
      type: json
      value:
        map_replace:
          - map_replace:
            - neutron::agents::ml2::sriov::physical_device_mappings: NeutronPhysicalDevMappings
              neutron::agents::ml2::sriov::exclude_devices: NeutronExcludeDevices
              tripleo::host::sriov::number_of_vfs: NeutronSriovNumVFs
              neutron::agents::ml2::sriov::extensions: NeutronSriovAgentExtensions
            - values: {get_param: [RoleParameters]}
          - values:
              NeutronPhysicalDevMappings: {get_param: NeutronPhysicalDevMappings}
              NeutronExcludeDevices: {get_param: NeutronExcludeDevices}
              NeutronSriovNumVFs: {get_param: NeutronSriovNumVFs}
              NeutronSriovAgentExtensions: {get_param: NeutronSriovAgentExtensions}

outputs:
  role_data:
    description: Role data for the Neutron SR-IOV nic agent service.
    value:
      service_name: neutron_sriov_agent
      config_settings:
        map_merge:
          - get_attr: [NeutronBase, role_data, config_settings]
          - get_attr: [RoleParametersValue, value]
      step_config: |
        include ::tripleo::profile::base::neutron::sriov
      upgrade_tasks:
        - name: Check if neutron_sriov_agent is deployed
          command: systemctl is-enabled neutron-sriov-nic-agent
          tags: common
          ignore_errors: True
          register: neutron_sriov_nic_agent_enabled
        - name: "PreUpgrade step0,validation: Check service neutron-server is running"
          shell: /usr/bin/systemctl show 'neutron-sriov-nic-agent' --property ActiveState | grep '\bactive\b'
          when: neutron_sriov_nic_agent_enabled.rc == 0
          tags: step0,validation
        - name: Stop neutron_sriov_nic_agent service
          tags: step1
          when: neutron_sriov_nic_agent_enabled.rc == 0
          service: name=neutron-sriov-nic-agent state=stopped
