Merge "Improve comments in networking config files"

etc/kayobe/inventory/group_vars/compute/network-interfaces

@@ -2,25 +2,18 @@
 ###############################################################################
 # Network interface definitions for the compute group.
 
-# Overcloud provisioning network IP information.
+# NOTE: The content of this section is very deployment-specific, since it
-# provision_oc_net_interface:
+# depends on the names and types of networks in the deployment. It should
-# provision_oc_net_bridge_ports:
+# define the group-specific attributes of networks. The following example shows
-# provision_oc_net_bond_slaves:
+# a basic configuration for a network called "example":
-
+#
-# Internal network IP information.
+# example_interface: eth0
-# internal_net_interface:
+#
-# internal_net_bridge_ports:
+# Global network attributes such as subnet CIDRs are typically configured in
-# internal_net_bond_slaves:
+# etc/kayobe/networks.yml.
-
+#
-# External network IP information.
+# Further information on the available network attributes is provided in the
-# external_net_interface:
+# network configuration reference in the Kayobe documentation.
-# external_net_bridge_ports:
-# external_net_bond_slaves:
-
-# Storage network IP information.
-# storage_net_interface:
-# storage_net_bridge_ports:
-# storage_net_bond_slaves:
 
 ###############################################################################
 # Dummy variable to allow Ansible to accept this file.

etc/kayobe/inventory/group_vars/controllers/network-interfaces

@@ -2,35 +2,18 @@
 ###############################################################################
 # Network interface definitions for the controller group.
 
-# Overcloud provisioning network IP information.
+# NOTE: The content of this section is very deployment-specific, since it
-# provision_oc_net_interface:
+# depends on the names and types of networks in the deployment. It should
-# provision_oc_net_bridge_ports:
+# define the group-specific attributes of networks. The following example shows
-# provision_oc_net_bond_slaves:
+# a basic configuration for a network called "example":
-
+#
-# Workload provisioning network IP information.
+# example_interface: eth0
-# provision_wl_net_interface:
+#
-# provision_wl_net_bridge_ports:
+# Global network attributes such as subnet CIDRs are typically configured in
-# provision_wl_net_bond_slaves:
+# etc/kayobe/networks.yml.
-
+#
-# Internal network IP information.
+# Further information on the available network attributes is provided in the
-# internal_net_interface:
+# network configuration reference in the Kayobe documentation.
-# internal_net_bridge_ports:
-# internal_net_bond_slaves:
-
-# External network IP information.
-# external_net_interface:
-# external_net_bridge_ports:
-# external_net_bond_slaves:
-
-# Storage network IP information.
-# storage_net_interface:
-# storage_net_bridge_ports:
-# storage_net_bond_slaves:
-
-# Storage management network IP information.
-# swift_storage_net_interface:
-# swift_storage_net_bridge_ports:
-# swift_storage_net_bond_slaves:
 
 ###############################################################################
 # Dummy variable to allow Ansible to accept this file.

etc/kayobe/inventory/group_vars/infra-vms/network-interfaces

@@ -2,10 +2,18 @@
 ###############################################################################
 # Network interface definitions for the infra-vms group.
 
-# Overcloud provisioning network IP information.
+# NOTE: The content of this section is very deployment-specific, since it
-# provision_oc_net_interface:
+# depends on the names and types of networks in the deployment. It should
-# provision_oc_net_bridge_ports:
+# define the group-specific attributes of networks. The following example shows
-# provision_oc_net_bond_slaves:
+# a basic configuration for a network called "example":
+#
+# example_interface: eth0
+#
+# Global network attributes such as subnet CIDRs are typically configured in
+# etc/kayobe/networks.yml.
+#
+# Further information on the available network attributes is provided in the
+# network configuration reference in the Kayobe documentation.
 
 ###############################################################################
 # Dummy variable to allow Ansible to accept this file.

etc/kayobe/inventory/group_vars/seed-hypervisor/network-interfaces

@@ -0,0 +1,20 @@
+---
+###############################################################################
+# Network interface definitions for the seed-hypervisor group.
+
+# NOTE: The content of this section is very deployment-specific, since it
+# depends on the names and types of networks in the deployment. It should
+# define the group-specific attributes of networks. The following example shows
+# a basic configuration for a network called "example":
+#
+# example_interface: eth0
+#
+# Global network attributes such as subnet CIDRs are typically configured in
+# etc/kayobe/networks.yml.
+#
+# Further information on the available network attributes is provided in the
+# network configuration reference in the Kayobe documentation.
+
+###############################################################################
+# Dummy variable to allow Ansible to accept this file.
+workaround_ansible_issue_8743: yes

etc/kayobe/inventory/group_vars/seed/network-interfaces

@@ -2,30 +2,18 @@
 ###############################################################################
 # Network interface definitions for the seed group.
 
-# Overcloud provisioning network IP information.
+# NOTE: The content of this section is very deployment-specific, since it
-# provision_oc_net_interface:
+# depends on the names and types of networks in the deployment. It should
-# provision_oc_net_bridge_ports:
+# define the group-specific attributes of networks. The following example shows
-# provision_oc_net_bond_slaves:
+# a basic configuration for a network called "example":
-
+#
-# Workload provisioning network IP information.
+# example_interface: eth0
-# provision_wl_net_interface:
+#
-# provision_wl_net_bridge_ports:
+# Global network attributes such as subnet CIDRs are typically configured in
-# provision_wl_net_bond_slaves:
+# etc/kayobe/networks.yml.
-
+#
-# Internal network IP information.
+# Further information on the available network attributes is provided in the
-# internal_net_interface:
+# network configuration reference in the Kayobe documentation.
-# internal_net_bridge_ports:
-# internal_net_bond_slaves:
-
-# External network IP information.
-# external_net_interface:
-# external_net_bridge_ports:
-# external_net_bond_slaves:
-
-# Storage network IP information.
-# storage_net_interface:
-# storage_net_bridge_ports:
-# storage_net_bond_slaves:
 
 ###############################################################################
 # Dummy variable to allow Ansible to accept this file.

etc/kayobe/inventory/group_vars/storage/network-interfaces

@@ -2,35 +2,18 @@
 ###############################################################################
 # Network interface definitions for the storage group.
 
-# Overcloud provisioning network IP information.
+# NOTE: The content of this section is very deployment-specific, since it
-# provision_oc_net_interface:
+# depends on the names and types of networks in the deployment. It should
-# provision_oc_net_bridge_ports:
+# define the group-specific attributes of networks. The following example shows
-# provision_oc_net_bond_slaves:
+# a basic configuration for a network called "example":
-
+#
-# External network IP information.
+# example_interface: eth0
-# external_net_interface:
+#
-# external_net_bridge_ports:
+# Global network attributes such as subnet CIDRs are typically configured in
-# external_net_bond_slaves:
+# etc/kayobe/networks.yml.
-
+#
-# Storage network IP information.
+# Further information on the available network attributes is provided in the
-# storage_net_interface:
+# network configuration reference in the Kayobe documentation.
-# storage_net_bridge_ports:
-# storage_net_bond_slaves:
-
-# Storage management network IP information.
-# storage_mgmt_net_interface:
-# storage_mgmt_net_bridge_ports:
-# storage_mgmt_net_bond_slaves:
-
-# Swift storage network IP information.
-# swift_storage_net_interface:
-# swift_storage_net_bridge_ports:
-# swift_storage_net_bond_slaves:
-
-# Swift storage management network IP information.
-# swift_storage_replication_net_interface:
-# swift_storage_replication_net_bridge_ports:
-# swift_storage_replication_net_bond_slaves:
 
 ###############################################################################
 # Dummy variable to allow Ansible to accept this file.

etc/kayobe/networks.yml

@@ -62,115 +62,22 @@
 ###############################################################################
 # Network definitions.
 
-# Admin network IP information.
+# NOTE: The content of this section is very deployment-specific, since it
-# admin_oc_net_cidr:
+# depends on the names and types of networks in the deployment. It should
-# admin_oc_net_allocation_pool_start:
+# define the global attributes of networks. The following example shows a basic
-# admin_oc_net_allocation_pool_end:
+# configuration for a network called "example":
-# admin_oc_net_gateway:
+#
-# admin_oc_net_vlan:
+# example_cidr: 10.0.0.0/24
-# admin_oc_net_mtu:
+# example_allocation_pool_start: 10.0.0.2
-# admin_oc_net_routes:
+# example_allocation_pool_start: 10.0.0.254
-
+# example_gateway: 10.0.0.1
-# Overcloud out-of-band management network IP information.
+# example_vlan: 42
-# oob_oc_net_cidr:
+#
-# oob_oc_net_allocation_pool_start:
+# Host or group-specific network attributes such as interface names are
-# oob_oc_net_allocation_pool_end:
+# typically configured via host or group variables.
-# oob_oc_net_inspection_allocation_pool_start:
+#
-# oob_oc_net_inspection_allocation_pool_end:
+# Further information on the available network attributes is provided in the
-# oob_oc_net_gateway:
+# network configuration reference in the Kayobe documentation.
-# oob_oc_net_vlan:
-# oob_oc_net_mtu:
-# oob_oc_net_routes:
-
-# Overcloud provisioning network IP information.
-# provision_oc_net_cidr:
-# provision_oc_net_allocation_pool_start:
-# provision_oc_net_allocation_pool_end:
-# provision_oc_net_inspection_allocation_pool_start:
-# provision_oc_net_inspection_allocation_pool_end:
-# provision_oc_net_gateway:
-# provision_oc_net_vlan:
-# provision_oc_net_mtu:
-# provision_oc_net_routes:
-
-# Workload out-of-band management network IP information.
-# oob_wl_net_cidr:
-# oob_wl_net_allocation_pool_start:
-# oob_wl_net_allocation_pool_end:
-# oob_wl_net_inspection_allocation_pool_start:
-# oob_wl_net_inspection_allocation_pool_end:
-# oob_wl_net_neutron_allocation_pool_start:
-# oob_wl_net_neutron_allocation_pool_end:
-# oob_wl_net_gateway:
-# oob_wl_net_vlan:
-# oob_wl_net_mtu:
-# oob_wl_net_routes:
-
-# Workload provisioning network IP information.
-# provision_wl_net_cidr:
-# provision_wl_net_allocation_pool_start:
-# provision_wl_net_allocation_pool_end:
-# provision_wl_net_inspection_allocation_pool_start:
-# provision_wl_net_inspection_allocation_pool_end:
-# provision_wl_net_neutron_allocation_pool_start:
-# provision_wl_net_neutron_allocation_pool_end:
-# provision_wl_net_gateway:
-# provision_wl_net_vlan:
-# provision_wl_net_mtu:
-# provision_wl_net_routes:
-
-# Internal network IP information.
-# internal_net_vip_address:
-# internal_net_fqdn:
-# internal_net_cidr:
-# internal_net_allocation_pool_start:
-# internal_net_allocation_pool_end:
-# internal_net_gateway:
-# internal_net_vlan:
-# internal_net_mtu:
-# internal_net_routes:
-
-# External network IP information.
-# external_net_vip_address:
-# external_net_fqdn:
-# external_net_cidr:
-# external_net_allocation_pool_start:
-# external_net_allocation_pool_end:
-# external_net_neutron_allocation_pool_start:
-# external_net_neutron_allocation_pool_end:
-# external_net_gateway:
-# external_net_vlan:
-# external_net_mtu:
-# external_net_routes:
-
-# Storage network IP information.
-# storage_net_cidr:
-# storage_net_allocation_pool_start:
-# storage_net_allocation_pool_end:
-# storage_net_gateway:
-# storage_net_vlan:
-# storage_net_mtu:
-# storage_net_routes:
-
-# Storage management network IP information.
-# storage_mgmt_net_cidr:
-# storage_mgmt_net_allocation_pool_start:
-# storage_mgmt_net_allocation_pool_end:
-# storage_mgmt_net_gateway:
-# storage_mgmt_net_vlan:
-# storage_mgmt_net_mtu:
-# storage_mgmt_net_routes:
-
-# Cleaning network IP information.
-# cleaning_net_cidr:
-# cleaning_net_allocation_pool_start:
-# cleaning_net_allocation_pool_end:
-# cleaning_net_neutron_allocation_pool_start:
-# cleaning_net_neutron_allocation_pool_end:
-# cleaning_net_gateway:
-# cleaning_net_vlan:
-# cleaning_net_mtu:
-# cleaning_net_routes:
 
 ###############################################################################
 # Network virtual patch link configuration.