heat_template_version: rocky description: > OpenStack Neutron openvswitch service parameters: DockerOpenvswitchImage: description: image type: string DockerNeutronConfigImage: description: The container image to use for the neutron config_volume type: string DockerOpenvswitchUlimit: default: ['nofile=1024'] description: ulimit for Openvswitch Container type: comma_delimited_list NeutronOpenVswitchAgentLoggingSource: type: json default: tag: openstack.neutron.agent.openvswitch path: /var/log/containers/neutron/openvswitch-agent.log 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 UpgradeRemoveUnusedPackages: default: false description: Remove package if the service is being disabled during upgrade type: boolean DockerPuppetMountHostPuppet: type: boolean default: true description: Whether containerized puppet executions use modules from the baremetal host. Defaults to true. Can be set to false to consume puppet modules from containers directly. PythonInterpreter: type: string description: The python interpreter to use for python and ansible actions default: /usr/bin/python NeutronEnableL2Pop: type: string description: Enable/disable the L2 population feature in the Neutron agents. default: "False" NeutronBridgeMappings: description: > The OVS logical->physical bridge mappings to use. See the Neutron documentation for details. Defaults to mapping br-ex - the external bridge on hosts - to a physical name 'datacentre' which can be used to create provider networks (and we use this for the default floating network) - if changing this either use different post-install network scripts or be sure to keep 'datacentre' as a mapping network name. type: comma_delimited_list default: "datacentre:br-ex" tags: - role_specific NeutronTunnelTypes: default: 'vxlan' description: The tunnel types for the Neutron tenant network. type: comma_delimited_list NeutronAgentExtensions: default: "qos" description: | Comma-separated list of extensions enabled for the Neutron agents. type: comma_delimited_list NeutronEnableDVR: default: '' description: Enable Neutron DVR. type: string NeutronEnableARPResponder: default: false description: | Enable ARP responder feature in the OVS Agent. type: boolean MonitoringSubscriptionNeutronOvs: default: 'overcloud-neutron-ovs-agent' type: string NeutronOVSFirewallDriver: default: '' description: | Configure the classname of the firewall driver to use for implementing security groups. Possible values depend on system configuration. Some examples are: noop, openvswitch, iptables_hybrid. The default value of an empty string will result in a default supported configuration. type: string OvsHwOffload: default: false description: | Enable OVS Hardware Offload. This feature supported from OVS 2.8.0 type: boolean tags: - role_specific NeutronOVSTunnelCsum: default: false description: | Set or un-set the tunnel header checksum on outgoing IP packet carrying GRE/VXLAN tunnel. type: boolean RpcPort: default: 5672 description: The network port for messaging backend type: number conditions: no_firewall_driver: {equals : [{get_param: NeutronOVSFirewallDriver}, '']} docker_puppet_mount_host: {equals: [{get_param: DockerPuppetMountHostPuppet}, true]} neutron_dvr_unset: {equals : [{get_param: NeutronEnableDVR}, '']} resources: ContainersCommon: type: ../../docker/services/containers-common.yaml # 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::ovs::bridge_mappings: NeutronBridgeMappings vswitch::ovs::enable_hw_offload: OvsHwOffload - values: {get_param: [RoleParameters]} - values: NeutronBridgeMappings: {get_param: NeutronBridgeMappings} OvsHwOffload: {get_param: OvsHwOffload} NeutronBase: type: ../../puppet/services/neutron-base.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} NeutronLogging: type: OS::TripleO::Services::Logging::NeutronCommon properties: NeutronServiceName: openvswitch-agent outputs: role_data: description: Role data for Neutron openvswitch service value: service_name: neutron_ovs_agent monitoring_subscription: {get_param: MonitoringSubscriptionNeutronOvs} config_settings: map_merge: - get_attr: [NeutronBase, role_data, config_settings] - get_attr: [RoleParametersValue, value] - get_attr: [NeutronLogging, config_settings] - neutron::agents::ml2::ovs::l2_population: {get_param: NeutronEnableL2Pop} neutron::agents::ml2::ovs::arp_responder: {get_param: NeutronEnableARPResponder} neutron::agents::ml2::ovs::tunnel_types: {get_param: NeutronTunnelTypes} neutron::agents::ml2::ovs::extensions: {get_param: NeutronAgentExtensions} neutron::agents::ml2::ovs::tunnel_csum: {get_param: NeutronOVSTunnelCsum} # NOTE: bind IP is found in hiera replacing the network name with the # local node IP for the given network; replacement examples # (eg. for internal_api): # internal_api -> IP # internal_api_uri -> [IP] # internal_api_subnet - > IP/CIDR neutron::agents::ml2::ovs::local_ip: str_replace: template: "%{hiera('$NETWORK')}" params: $NETWORK: {get_param: [ServiceNetMap, NeutronTenantNetwork]} tripleo::neutron_ovs_agent::firewall_rules: '118 neutron vxlan networks': proto: 'udp' dport: 4789 '136 neutron gre networks': proto: 'gre' - if: - neutron_dvr_unset - {} - neutron::agents::ml2::ovs::enable_distributed_routing: {get_param: NeutronEnableDVR} - if: - no_firewall_driver - {} - neutron::agents::ml2::ovs::firewall_driver: {get_param: NeutronOVSFirewallDriver} service_config_settings: map_merge: - get_attr: [NeutronBase, role_data, service_config_settings] - fluentd: tripleo_fluentd_groups_neutron_ovs_agent: - neutron tripleo_fluentd_sources_neutron_ovs_agent: - {get_param: NeutronOpenVswitchAgentLoggingSource} puppet_config: config_volume: neutron puppet_tags: neutron_config,neutron_agent_ovs,neutron_plugin_ml2 step_config: | include ::tripleo::profile::base::neutron::ovs config_image: {get_param: DockerNeutronConfigImage} # We need to mount /run for puppet_config step. This is because # puppet-vswitch runs the commands "ovs-vsctl list open_vswitch ." # when running vswitch::ovs::enable_hw_offload: true # ovs-vsctl talks to the ovsdb-server (hosting conf.db) # on the unix domain socket - /run/openvswitch/db.sock volumes: - /lib/modules:/lib/modules:ro - /run/openvswitch:/run/openvswitch:shared,z kolla_config: /var/lib/kolla/config_files/neutron_ovs_agent.json: command: /neutron_ovs_agent_launcher.sh config_files: - source: "/var/lib/kolla/config_files/src/*" dest: "/" merge: true preserve_properties: true permissions: - path: /var/log/neutron owner: neutron:neutron recurse: true docker_config_scripts: neutron_ovs_agent_launcher.sh: mode: "0755" content: str_replace: template: | #!/bin/bash set -xe PYTHON -m neutron.cmd.destroy_patch_ports --config-file /usr/share/neutron/neutron-dist.conf --config-file /etc/neutron/neutron.conf --config-file /etc/neutron/plugins/ml2/openvswitch_agent.ini --config-dir /etc/neutron/conf.d/common --config-dir /etc/neutron/conf.d/neutron-openvswitch-agent /usr/bin/neutron-openvswitch-agent --config-file /usr/share/neutron/neutron-dist.conf --config-file /etc/neutron/neutron.conf --config-file /etc/neutron/plugins/ml2/openvswitch_agent.ini --config-dir /etc/neutron/conf.d/common --log-file=/var/log/neutron/openvswitch-agent.log params: PYTHON: {get_param: PythonInterpreter} docker_config: step_3: neutron_ovs_bridge: detach: false image: {get_param: DockerNeutronConfigImage} net: host pid: host user: root privileged: true security_opt: 'label=disable' command: - puppet - apply - --modulepath - /etc/puppet/modules:/usr/share/openstack-puppet/modules - --tags - file,file_line,concat,augeas,neutron::plugins::ovs::bridge,vs_config - -v - -e - include neutron::agents::ml2::ovs volumes: list_concat: - {get_attr: [ContainersCommon, volumes]} - - /var/lib/kolla/config_files/neutron_ovs_agent.json:/var/lib/kolla/config_files/config.json:ro - /var/lib/config-data/puppet-generated/neutron/:/var/lib/kolla/config_files/src:ro - /lib/modules:/lib/modules:ro - /run/openvswitch:/run/openvswitch:shared,z - /etc/puppet:/etc/puppet:ro - /var/run/openvswitch/:/var/run/openvswitch/:shared,z - if: - docker_puppet_mount_host - /usr/share/openstack-puppet/modules/:/usr/share/openstack-puppet/modules/:ro - '' environment: - KOLLA_CONFIG_STRATEGY=COPY_ALWAYS step_4: neutron_ovs_agent: start_order: 10 image: {get_param: DockerOpenvswitchImage} net: host pid: host privileged: true security_opt: 'label=disable' restart: always healthcheck: test: list_join: - ' ' - - '/openstack/healthcheck' - yaql: expression: str($.data.port) data: port: {get_param: RpcPort} ulimit: {get_param: DockerOpenvswitchUlimit} volumes: list_concat: - {get_attr: [ContainersCommon, volumes]} - {get_attr: [NeutronLogging, volumes]} - - /var/lib/kolla/config_files/neutron_ovs_agent.json:/var/lib/kolla/config_files/config.json:ro - /var/lib/config-data/puppet-generated/neutron/:/var/lib/kolla/config_files/src:ro - /var/lib/docker-config-scripts/neutron_ovs_agent_launcher.sh:/neutron_ovs_agent_launcher.sh:ro - /lib/modules:/lib/modules:ro - /run/openvswitch:/run/openvswitch:shared,z environment: - KOLLA_CONFIG_STRATEGY=COPY_ALWAYS metadata_settings: get_attr: [NeutronBase, role_data, metadata_settings] host_prep_tasks: list_concat: - {get_attr: [NeutronLogging, host_prep_tasks]} - - block: - name: load openvswitch module import_role: name: tripleo-module-load vars: modules: - name: openvswitch - name: Copy in cleanup script copy: content: {get_file: ./neutron-cleanup} dest: '/usr/libexec/neutron-cleanup' force: yes mode: '0755' - name: Copy in cleanup service copy: content: {get_file: ./neutron-cleanup.service} dest: '/usr/lib/systemd/system/neutron-cleanup.service' force: yes - name: Enabling the cleanup service service: name: neutron-cleanup enabled: yes - name: enable virt_sandbox_use_netlink for healtcheck seboolean: name: virt_sandbox_use_netlink persistent: yes state: yes upgrade_tasks: - when: step|int == 3 block: - name: Set fact for removal of openstack-neutron-openvswitch package set_fact: remove_neutron_openvswitch_package: {get_param: UpgradeRemoveUnusedPackages} - name: Remove openstack-neutron-openvswitch package if operator requests it package: name=openstack-neutron-openvswitch state=removed ignore_errors: True when: remove_neutron_openvswitch_package|bool update_tasks: # puppetlabs-firewall manages security rules via Puppet but make the rules # consistent by default. Since Neutron also creates some rules, we don't # want them to be consistent so we have to ensure that they're not stored # into sysconfig. # https://bugzilla.redhat.com/show_bug.cgi?id=1541528 - name: Remove IPv4 iptables rules created by Neutron that are persistent lineinfile: dest=/etc/sysconfig/iptables regexp=".*neutron-" state=absent when: step|int == 5 - name: Remove IPv6 iptables rules created by Neutron that are persistent lineinfile: dest=/etc/sysconfig/ip6tables regexp=".*neutron-" state=absent when: step|int == 5 post_upgrade_tasks: - when: step|int == 1 import_role: name: tripleo-docker-rm vars: containers_to_rm: - neutron_ovs_agent fast_forward_upgrade_tasks: - when: - step|int == 0 - release == 'ocata' block: - name: Check if neutron_ovs_agent is deployed command: systemctl is-enabled --quiet neutron-openvswitch-agent ignore_errors: True register: neutron_ovs_agent_enabled_result - name: Set fact neutron_ovs_agent_enabled set_fact: neutron_ovs_agent_enabled: "{{ neutron_ovs_agent_enabled_result.rc == 0 }}" - name: Stop neutron_openvswitch_agent service: name=neutron-openvswitch-agent state=stopped enabled=no when: - step|int == 1 - release == 'ocata' - neutron_ovs_agent_enabled|bool