summaryrefslogtreecommitdiffstats
path: root/docs/release/installation/installation.instruction.rst
blob: f78b1c7f8efa8bc2d43b0db92d13250be493ffbc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. (c) Bin Hu (AT&T) and Sridhar Gaddam (RedHat)

=========================================
Install OPNFV on IPv6-Only Infrastructure
=========================================

This section provides instructions to install OPNFV on IPv6-only Infrastructure. All underlay networks
and API endpoints will be IPv6-only except:

1. "admin" network in underlay/undercloud still has to be IPv4, due to lack of support of IPMI
   over IPv6 or PXE over IPv6.
2. OVS VxLAN (or GRE) tunnel endpoint is still IPv4 only, although IPv6 traffic can be
   encapsulated within the tunnel.
3. Metadata server is still IPv4 only.

Except the limitations above, the use case scenario of the IPv6-only infrastructure includes:

1. Support OPNFV deployment on an IPv6 only infrastructure.
2. Horizon/ODL-DLUX access using IPv6 address from an external host.
3. OpenStack API access using IPv6 addresses from various python-clients.
4. Ability to create Neutron Routers, IPv6 subnets (e.g. SLAAC/DHCPv6-Stateful/
   DHCPv6-Stateless) to support North-South traffic.
5. Inter VM communication (East-West routing) when VMs are spread
   across two compute nodes.
6. VNC access into a VM using IPv6 addresses.

-------------------------------------------
Install OPNFV in OpenStack-Only Environment
-------------------------------------------

**Apex Installer**:

.. code-block:: bash

    # HA, Virtual deployment in OpenStack-only environment
    ./opnfv-deploy -v -d /etc/opnfv-apex/os-nosdn-nofeature-ha.yaml \
    -n /etc/opnfv-apex/network_setting_v6.yaml

    # HA, Bare Metal deployment in OpenStack-only environment
    ./opnfv-deploy -d /etc/opnfv-apex/os-nosdn-nofeature-ha.yaml \
    -i <inventory file> -n /etc/opnfv-apex/network_setting_v6.yaml

    # Non-HA, Virtual deployment in OpenStack-only environment
    ./opnfv-deploy -v -d /etc/opnfv-apex/os-nosdn-nofeature-noha.yaml \
    -n /etc/opnfv-apex/network_setting_v6.yaml

    # Non-HA, Bare Metal deployment in OpenStack-only environment
    ./opnfv-deploy -d /etc/opnfv-apex/os-nosdn-nofeature-noha.yaml \
    -i <inventory file> -n /etc/opnfv-apex/network_setting_v6.yaml

    # Note:
    #
    # 1. Parameter ""-v" is mandatory for Virtual deployment
    # 2. Parameter "-i <inventory file>" is mandatory for Bare Metal deployment
    # 2.1 Refer to https://git.opnfv.org/cgit/apex/tree/config/inventory for examples of inventory file
    # 3. You can use "-n /etc/opnfv-apex/network_setting.yaml" for deployment in IPv4 infrastructure

Please **NOTE** that:

* You need to refer to **installer's documentation** for other necessary
  parameters applicable to your deployment.
* You need to refer to **Release Notes** and **installer's documentation** if there is
  any issue in installation.

--------------------------------------------------
Install OPNFV in OpenStack with ODL-L2 Environment
--------------------------------------------------

**Apex Installer**:

.. code-block:: bash

    # HA, Virtual deployment in OpenStack with Open Daylight L2-only environment
    ./opnfv-deploy -v -d /etc/opnfv-apex/os-odl_l2-nofeature-ha.yaml \
    -n /etc/opnfv-apex/network_setting_v6.yaml

    # HA, Bare Metal deployment in OpenStack with Open Daylight L2-only environment
    ./opnfv-deploy -d /etc/opnfv-apex/os-odl_l2-nofeature-ha.yaml \
    -i <inventory file> -n /etc/opnfv-apex/network_setting_v6.yaml

    # Non-HA deployment in OpenStack with Open Daylight L2-only environment
    # There is no settings file provided by default for odl_l2 non-HA deployment
    # You need to copy /etc/opnfv-apex/os-odl_l2-nofeature-ha.yaml to another file
    # e.g. /etc/opnfv-apex/os-odl_l2-nofeature-noha.yaml
    # and change the "ha_enabled" parameter to be "false", i.e.: "ha_enabled: false", and:

    # - For Non-HA, Virtual deployment
    ./opnfv-deploy -v -d /etc/opnfv-apex/os-odl_l2-nofeature-noha.yaml \
    -n /etc/opnfv-apex/network_setting_v6.yaml

    # - For Non-HA, Bare Metal deployment
    ./opnfv-deploy -d /etc/opnfv-apex/os-odl_l2-nofeature-noha.yaml \
    -i <inventory file> -n /etc/opnfv-apex/network_setting_v6.yaml

    # Note:
    #
    # 1. Parameter ""-v" is mandatory for Virtual deployment
    # 2. Parameter "-i <inventory file>" is mandatory for Bare Metal deployment
    # 2.1 Refer to https://git.opnfv.org/cgit/apex/tree/config/inventory for examples of inventory file
    # 3. You can use "-n /etc/opnfv-apex/network_setting.yaml" for deployment in IPv4 infrastructure

Please **NOTE** that:

* You need to refer to **installer's documentation** for other necessary
  parameters applicable to your deployment.
* You need to refer to **Release Notes** and **installer's documentation** if there is
  any issue in installation.

-------------------
Testing Methodology
-------------------

There are 2 levels of testing to validate the deployment.

++++++++++++++++
Underlay Testing
++++++++++++++++

**Underlay** Testing is to validate that API endpoints are listening on IPv6 addresses.
This can be as simple as validating Keystone service, and as complete as validating each
API endpoint. It is important to reuse Tempest API testing.

Please **Note** that, to the best of our knowledge, Tempest API testing does not validate
API endpoints listening on IPv6 addresses. Thus Underlay Testing is postponed to future
release until Tempest API testing is ready to validate API endpoints listening on IPv6 addresses.

+++++++++++++++
Overlay Testing
+++++++++++++++

**Overlay** Testing is to validate that IPv6 is supported in tenant networks, subnets and routers.
Both Tempest API testing and Tempest Scenario testing are used in our Overlay Testing.

Tempest API testing validates that the Neutron API supports the creation of IPv6 networks, subnets, routers, etc:

.. code-block:: bash

    tempest.api.network.test_networks.BulkNetworkOpsIpV6Test.test_bulk_create_delete_network
    tempest.api.network.test_networks.BulkNetworkOpsIpV6Test.test_bulk_create_delete_port
    tempest.api.network.test_networks.BulkNetworkOpsIpV6Test.test_bulk_create_delete_subnet
    tempest.api.network.test_networks.NetworksIpV6Test.test_create_update_delete_network_subnet
    tempest.api.network.test_networks.NetworksIpV6Test.test_external_network_visibility
    tempest.api.network.test_networks.NetworksIpV6Test.test_list_networks
    tempest.api.network.test_networks.NetworksIpV6Test.test_list_subnets
    tempest.api.network.test_networks.NetworksIpV6Test.test_show_network
    tempest.api.network.test_networks.NetworksIpV6Test.test_show_subnet
    tempest.api.network.test_networks.NetworksIpV6TestAttrs.test_create_update_delete_network_subnet
    tempest.api.network.test_networks.NetworksIpV6TestAttrs.test_external_network_visibility
    tempest.api.network.test_networks.NetworksIpV6TestAttrs.test_list_networks
    tempest.api.network.test_networks.NetworksIpV6TestAttrs.test_list_subnets
    tempest.api.network.test_networks.NetworksIpV6TestAttrs.test_show_network
    tempest.api.network.test_networks.NetworksIpV6TestAttrs.test_show_subnet
    tempest.api.network.test_ports.PortsIpV6TestJSON.test_create_port_in_allowed_allocation_pools
    tempest.api.network.test_ports.PortsIpV6TestJSON.test_create_port_with_no_securitygroups
    tempest.api.network.test_ports.PortsIpV6TestJSON.test_create_update_delete_port
    tempest.api.network.test_ports.PortsIpV6TestJSON.test_list_ports
    tempest.api.network.test_ports.PortsIpV6TestJSON.test_show_port
    tempest.api.network.test_routers.RoutersIpV6Test.test_add_multiple_router_interfaces
    tempest.api.network.test_routers.RoutersIpV6Test.test_add_remove_router_interface_with_port_id
    tempest.api.network.test_routers.RoutersIpV6Test.test_add_remove_router_interface_with_subnet_id
    tempest.api.network.test_routers.RoutersIpV6Test.test_create_show_list_update_delete_router
    tempest.api.network.test_security_groups.SecGroupIPv6Test.test_create_list_update_show_delete_security_group
    tempest.api.network.test_security_groups.SecGroupIPv6Test.test_create_show_delete_security_group_rule
    tempest.api.network.test_security_groups.SecGroupIPv6Test.test_list_security_groups

Tempest Scenario testing validates some specific overlay IPv6 scenarios
(i.e. use cases) as follows:

.. code-block:: bash

    tempest.scenario.test_network_v6.TestGettingAddress.test_dhcp6_stateless_from_os
    tempest.scenario.test_network_v6.TestGettingAddress.test_dualnet_dhcp6_stateless_from_os
    tempest.scenario.test_network_v6.TestGettingAddress.test_dualnet_multi_prefix_dhcpv6_stateless
    tempest.scenario.test_network_v6.TestGettingAddress.test_dualnet_multi_prefix_slaac
    tempest.scenario.test_network_v6.TestGettingAddress.test_dualnet_slaac_from_os
    tempest.scenario.test_network_v6.TestGettingAddress.test_multi_prefix_dhcpv6_stateless
    tempest.scenario.test_network_v6.TestGettingAddress.test_multi_prefix_slaac
    tempest.scenario.test_network_v6.TestGettingAddress.test_slaac_from_os

The above Tempest API testing and Scenario testing are quite comprehensive to validate
overlay IPv6 tenant networks. They are part of OpenStack default Smoke Tests,
run in FuncTest and integrated into OPNFV's CI/CD environment.