Update network-v2 documentation
* Document overcloud network vip provision * Add examples doing it all with `overcloud deploy` Depends-On: https://review.opendev.org/793385 Change-Id: Id54e00aea40980352ff72a99a3f1b07e6c7bf2e1
This commit is contained in:
parent
1d44e959ed
commit
12ddb1c1db
|
@ -138,6 +138,31 @@ The steps to define your custom networks are:
|
||||||
and do not conflict with any existing networks, otherwise your deployment
|
and do not conflict with any existing networks, otherwise your deployment
|
||||||
may fail or result in unexpected results.
|
may fail or result in unexpected results.
|
||||||
|
|
||||||
|
#. Copy one of the sample ``vip_data`` YAML definitions provided by
|
||||||
|
tripleo-heat-templates_, for example::
|
||||||
|
|
||||||
|
cp /usr/share/openstack-tripleo-heat-templates/network-data-samples/vip-data-default-network-isolation.yaml \
|
||||||
|
custom_vip_data.yaml
|
||||||
|
|
||||||
|
.. admonition:: Victoria and prior releases
|
||||||
|
|
||||||
|
For Victoria and prior releases the Virtual IP resources are created as
|
||||||
|
part of the overcloud heat stack. This step is not valid for these
|
||||||
|
releases.
|
||||||
|
|
||||||
|
#. Modify the ``custom_vip_data.yaml`` file as required. The Virtual IP data
|
||||||
|
is a list of Virtual IP address definitions, each containing at a minimum
|
||||||
|
the name of the network where the IP address should be allocated.
|
||||||
|
|
||||||
|
See `Network Virtual IPs data YAML options`_ for a list of all documented
|
||||||
|
options for the ``vip_data`` YAML network Virtual IPs definition.
|
||||||
|
|
||||||
|
.. admonition:: Victoria and prior releases
|
||||||
|
|
||||||
|
For Victoria and prior releases the Virtual IP resources are created as
|
||||||
|
part of the overcloud heat stack. This step is not valid for these
|
||||||
|
releases.
|
||||||
|
|
||||||
#. Copy network configuration templates, add new networks.
|
#. Copy network configuration templates, add new networks.
|
||||||
|
|
||||||
Prior to Victoria, Heat templates were used to define nic configuration
|
Prior to Victoria, Heat templates were used to define nic configuration
|
||||||
|
@ -208,14 +233,54 @@ The steps to define your custom networks are:
|
||||||
releases. Network resources was created as part of the overcloud heat
|
releases. Network resources was created as part of the overcloud heat
|
||||||
stack.
|
stack.
|
||||||
|
|
||||||
|
.. note:: This step is optional when using the ``--baremetal-deployment``
|
||||||
|
and ``--vip-data`` options with the ``overcloud deploy`` command.
|
||||||
|
The deploy command will detect the new format of the network data
|
||||||
|
YAML definition, run the workflow to create the networks and
|
||||||
|
include the ``networks-deployed-environment.yaml`` automatically.
|
||||||
|
|
||||||
|
#. Create the overcloud network Virtual IPs and generate the
|
||||||
|
``vip-deployed-environment.yaml`` which will be used as an environment file
|
||||||
|
when deploying the overcloud.
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
$ openstack overcloud network vip provision \
|
||||||
|
--output ~/templates/vip-deployed-environment.yaml \
|
||||||
|
~/templates/custom_vip_data.yaml
|
||||||
|
|
||||||
|
.. note:: This step is optional if using the ``--vip-data`` options with the
|
||||||
|
``overcloud deploy`` command. In that case workflow to create the
|
||||||
|
Virtual IPs and including the environment is automated.
|
||||||
|
|
||||||
#. To deploy you pass the ``custom_network_data.yaml`` file via the ``-n``
|
#. To deploy you pass the ``custom_network_data.yaml`` file via the ``-n``
|
||||||
option to the overcloud deploy, for example::
|
option to the overcloud deploy, for example:
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
openstack overcloud deploy --templates \
|
openstack overcloud deploy --templates \
|
||||||
-n custom_network_data.yaml \
|
-n custom_network_data.yaml \
|
||||||
-e networks-deployed-environment.yaml \
|
-e networks-deployed-environment.yaml \
|
||||||
|
-e vip-deployed-environment.yaml \
|
||||||
-e custom-net-single-nic-with-vlans.yaml
|
-e custom-net-single-nic-with-vlans.yaml
|
||||||
|
|
||||||
|
Alternatively include the network, Virtual IPs and baremetal provisioning
|
||||||
|
in the ``overcloud deploy`` command to do it all in one:
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
openstack overcloud deploy --templates \
|
||||||
|
--networks-file custom_network_data.yaml \
|
||||||
|
--vip-file custom_vip_data.yaml \
|
||||||
|
--baremetal-deployment baremetal_deployment.yaml \
|
||||||
|
--network-config \
|
||||||
|
-e custom-net-single-nic-with-vlans.yaml
|
||||||
|
|
||||||
|
.. note:: Please refer to :doc:`../provisioning/baremetal_provision`
|
||||||
|
document page for a reference on the ``baremetal_deployment.yaml``
|
||||||
|
used in the above example.
|
||||||
|
|
||||||
|
|
||||||
.. admonition:: Victoria and prior releases
|
.. admonition:: Victoria and prior releases
|
||||||
|
|
||||||
::
|
::
|
||||||
|
@ -463,6 +528,44 @@ Options for network data YAML subnet definitions
|
||||||
type: *number*
|
type: *number*
|
||||||
|
|
||||||
|
|
||||||
|
.. _virtual_ips_definition_opts:
|
||||||
|
|
||||||
|
Network Virtual IPs data YAML options
|
||||||
|
-------------------------------------
|
||||||
|
|
||||||
|
:network:
|
||||||
|
Neutron Network name
|
||||||
|
|
||||||
|
type: *string*
|
||||||
|
|
||||||
|
:ip_address:
|
||||||
|
*(optional)* IP address, a pre-defined fixed IP address.
|
||||||
|
|
||||||
|
type: *string*
|
||||||
|
|
||||||
|
:subnet:
|
||||||
|
*(optional)* Neutron Subnet name, used to specify the subnet to use when
|
||||||
|
creating the Virtual IP neutron port.
|
||||||
|
|
||||||
|
This is required for deployments using routed networks, to ensure the Virtual
|
||||||
|
IP is allocated on the subnet where controller nodes are attached.
|
||||||
|
|
||||||
|
type: *string*
|
||||||
|
|
||||||
|
:dns_name:
|
||||||
|
*(optional)* Dns Name, the hostname part of the FQDN (Fully Qualified Domain
|
||||||
|
Name)
|
||||||
|
|
||||||
|
type: *string*
|
||||||
|
|
||||||
|
default: overcloud
|
||||||
|
|
||||||
|
:name:
|
||||||
|
*(optional)* Virtual IP name
|
||||||
|
|
||||||
|
type: *string*
|
||||||
|
default: $network_name_virtual_ip
|
||||||
|
|
||||||
.. _tripleo-heat-templates: https://opendev.org/openstack/tripleo-heat-templates
|
.. _tripleo-heat-templates: https://opendev.org/openstack/tripleo-heat-templates
|
||||||
.. _default-network-isolation: https://opendev.org/openstack/tripleo-heat-templates/network-data-samples/default-network-isolation.yaml
|
.. _default-network-isolation: https://opendev.org/openstack/tripleo-heat-templates/network-data-samples/default-network-isolation.yaml
|
||||||
.. _network_data.yaml: https://opendev.org/openstack/tripleo-heat-templates/src/branch/master/network_data.yaml
|
.. _network_data.yaml: https://opendev.org/openstack/tripleo-heat-templates/src/branch/master/network_data.yaml
|
||||||
|
|
|
@ -164,7 +164,9 @@ the network data YAML schema.
|
||||||
.. admonition:: Victoria and prior releases
|
.. admonition:: Victoria and prior releases
|
||||||
|
|
||||||
Copy the default ``network_data.yaml`` file and customize the networks, IP
|
Copy the default ``network_data.yaml`` file and customize the networks, IP
|
||||||
subnets, VLANs, etc., as per the cluster requirements::
|
subnets, VLANs, etc., as per the cluster requirements:
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
$ cp /usr/share/openstack-tripleo-heat-templates/network_data.yaml ~/templates/network_data.yaml
|
$ cp /usr/share/openstack-tripleo-heat-templates/network_data.yaml ~/templates/network_data.yaml
|
||||||
|
|
||||||
|
@ -181,11 +183,72 @@ networks on the Undercloud. This command will also generate the
|
||||||
``networks-deployed-environment.yaml`` environment file which must be be used
|
``networks-deployed-environment.yaml`` environment file which must be be used
|
||||||
when deploying the overcloud.
|
when deploying the overcloud.
|
||||||
|
|
||||||
::
|
.. code-block:: bash
|
||||||
|
|
||||||
openstack overcloud network provision \
|
$ openstack overcloud network provision \
|
||||||
--output ~/templates/networks-deployed-environment.yaml \
|
--output ~/templates/networks-deployed-environment.yaml \
|
||||||
~/templates/custom_network_data.yaml
|
~/templates/custom_network_data.yaml
|
||||||
|
|
||||||
|
.. note:: This step is optional when using the ``--baremetal-deployment`` and
|
||||||
|
``--vip-data`` options with the ``overcloud deploy`` command. The
|
||||||
|
deploy command will detect the new format of the network data YAML
|
||||||
|
definition, run the workflow to create the networks and include the
|
||||||
|
``networks-deployed-environment.yaml`` automatically.
|
||||||
|
|
||||||
|
Create and Edit network Virtual IPs YAML definition file
|
||||||
|
--------------------------------------------------------
|
||||||
|
|
||||||
|
.. admonition:: Victoria and prior releases
|
||||||
|
|
||||||
|
For Victoria and prior releases the Virtual IP resources are created as part
|
||||||
|
of the overcloud heat stack. This step is not valid for these releases.
|
||||||
|
|
||||||
|
Use the vip-data-samples_ in tripleo-heat-templates_ as a reference and
|
||||||
|
customize the networks, subnet, fixed_ips, dns_names etc., as per the cluster
|
||||||
|
requirements.
|
||||||
|
|
||||||
|
Please refer to the :ref:`virtual_ips_definition_opts` reference section on the
|
||||||
|
:ref:`custom_networks` document page for a reference on available options in
|
||||||
|
the network Virtual IPs data YAML schema.
|
||||||
|
|
||||||
|
The below example show a Virtual IPs definition for the default
|
||||||
|
network-isolation isolation scenario.
|
||||||
|
|
||||||
|
.. code-block:: yaml
|
||||||
|
|
||||||
|
- network: ctlplane
|
||||||
|
dns_name: overcloud
|
||||||
|
- network: external
|
||||||
|
dns_name: overcloud
|
||||||
|
- network: internal_api
|
||||||
|
dns_name: overcloud
|
||||||
|
- network: storage
|
||||||
|
dns_name: overcloud
|
||||||
|
- network: storage_mgmt
|
||||||
|
dns_name: overcloud
|
||||||
|
|
||||||
|
Create the overcloud network Virtual IPs on the Undercloud
|
||||||
|
----------------------------------------------------------
|
||||||
|
|
||||||
|
.. admonition:: Victoria and prior releases
|
||||||
|
|
||||||
|
For Victoria and prior releases the Virtual IP resources are created as part
|
||||||
|
of the overcloud heat stack. This step is not valid for these releases.
|
||||||
|
|
||||||
|
Run the "openstack overcloud network vip provision" command to create/update
|
||||||
|
the network Virtual IPs on the Undercloud. This command will also generate the
|
||||||
|
``vips-deployed-environment.yaml`` environment file which must be be used when
|
||||||
|
deploying the overcloud.
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
$ openstack overcloud network vip provision \
|
||||||
|
--output ~/templates/vips-deployed-environment.yaml \
|
||||||
|
~/templates/custom_vip_data.yaml
|
||||||
|
|
||||||
|
.. note:: This step is optional if using the ``--vip-data`` options with the
|
||||||
|
``overcloud deploy`` command. In that case workflow to create the
|
||||||
|
Virtual IPs and including the environment is automated.
|
||||||
|
|
||||||
Generate Templates from Jinja2
|
Generate Templates from Jinja2
|
||||||
------------------------------
|
------------------------------
|
||||||
|
@ -864,16 +927,37 @@ type if on bare metal, so that hardware virtualization will be used.
|
||||||
To deploy with network isolation and include the network environment file, use
|
To deploy with network isolation and include the network environment file, use
|
||||||
the ``-e`` and ``--networks-file`` parameters with the
|
the ``-e`` and ``--networks-file`` parameters with the
|
||||||
``openstack overcloud deploy`` command. The following deploy command should
|
``openstack overcloud deploy`` command. The following deploy command should
|
||||||
work for all of the subsequent examples::
|
work for all of the subsequent examples:
|
||||||
|
|
||||||
openstack overcloud deploy --templates \
|
.. code-block:: bash
|
||||||
--networks-file ~/templates/custom_network_data.yaml \
|
|
||||||
-e ~/templates/networks-deployed-environment.yaml \
|
openstack overcloud deploy \
|
||||||
-e /usr/share/openstack-tripleo-heat-templates/environments/network-isolation.yaml \
|
--templates \
|
||||||
|
--networks-file ~/templates/custom_network_data.yaml \
|
||||||
|
-e ~/templates/networks-deployed-environment.yaml \
|
||||||
|
-e ~/templates/vips-deployed-environment.yaml \
|
||||||
|
-e /usr/share/openstack-tripleo-heat-templates/environments/network-environment.yaml \
|
||||||
|
-e ~/templates/network-environment-overrides.yaml \
|
||||||
|
--ntp-server pool.ntp.org
|
||||||
|
|
||||||
|
Alternatively include the network, Virtual IPs and baremetal provisioning
|
||||||
|
in the ``overcloud deploy`` command to do it all in one:
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
openstack overcloud deploy \
|
||||||
|
--templates \
|
||||||
|
--networks-file custom_network_data.yaml \
|
||||||
|
--vip-file custom_vip_data.yaml \
|
||||||
|
--baremetal-deployment baremetal_deployment.yaml \
|
||||||
|
--network-config \
|
||||||
-e /usr/share/openstack-tripleo-heat-templates/environments/network-environment.yaml \
|
-e /usr/share/openstack-tripleo-heat-templates/environments/network-environment.yaml \
|
||||||
-e ~/templates/network-environment-overrides.yaml \
|
-e ~/templates/network-environment-overrides.yaml \
|
||||||
--ntp-server pool.ntp.org
|
--ntp-server pool.ntp.org
|
||||||
|
|
||||||
|
.. note:: Please refer to :doc:`../provisioning/baremetal_provision`
|
||||||
|
document page for a reference on the ``baremetal_deployment.yaml``
|
||||||
|
used in the above example.
|
||||||
|
|
||||||
.. admonition:: Victoria and prior releases
|
.. admonition:: Victoria and prior releases
|
||||||
|
|
||||||
|
@ -994,4 +1078,5 @@ to a provider network if Neutron is to provide DHCP services to tenant VMs::
|
||||||
|
|
||||||
.. _tripleo-heat-templates: https://opendev.org/openstack/tripleo-heat-templates
|
.. _tripleo-heat-templates: https://opendev.org/openstack/tripleo-heat-templates
|
||||||
.. _default-network-isolation: https://opendev.org/openstack/tripleo-heat-templates/network-data-samples/default-network-isolation.yaml
|
.. _default-network-isolation: https://opendev.org/openstack/tripleo-heat-templates/network-data-samples/default-network-isolation.yaml
|
||||||
.. _network-data-samples: https://opendev.org/openstack/tripleo-heat-templates/network-data-samples
|
.. _network-data-samples: https://opendev.org/openstack/tripleo-heat-templates/network-data-samples
|
||||||
|
.. _vip-data-samples: https://opendev.org/openstack/tripleo-heat-templates/network-data-samples
|
Loading…
Reference in New Issue