Browse Source

Merge "Add documentation for subnet onboard"

Zuul 1 month ago
parent
commit
c7ab5b8729
2 changed files with 192 additions and 0 deletions
  1. 191
    0
      doc/source/admin/config-subnet-onboard.rst
  2. 1
    0
      doc/source/admin/config.rst

+ 191
- 0
doc/source/admin/config-subnet-onboard.rst View File

@@ -0,0 +1,191 @@
1
+.. _config-subnet-onboard:
2
+
3
+==============
4
+Subnet onboard
5
+==============
6
+
7
+The subnet onboard feature allows you to take existing subnets that have been
8
+created outside of a subnet pool and move them into an existing subnet pool.
9
+This enables you to begin using subnet pools and address scopes if you haven't
10
+allocated existing subnets from subnet pools. It also allows you to move
11
+individual subnets between subnet pools, and by extension, move them between
12
+address scopes.
13
+
14
+How it works
15
+~~~~~~~~~~~~
16
+
17
+One of the fundamental constraints of subnet pools is that all subnets of
18
+the same address family (IPv4, IPv6) on a network must be allocated from
19
+the same subnet pool. Because of this constraint, subnets must be moved,
20
+or "onboarded", into a subnet pool as a group at the network level rather than
21
+being handled individually. As such, the onboarding of subnets requires users
22
+to supply the UUID of the network the subnet(s) to onboard are associated with,
23
+and the UUID of the target subnet pool to perform the operation.
24
+
25
+Does my environment support subnet onboard?
26
+-------------------------------------------
27
+
28
+To test that subnet onboard is supported in your environment, execute
29
+the following command:
30
+
31
+.. code-block:: console
32
+
33
+    $ openstack extension list --network -c Alias -c Description | grep subnet_onboard
34
+    | subnet_onboard | Provides support for onboarding subnets into subnet pools
35
+
36
+Support for subnet onboard exists in the ML2 plugin as of the Stein release. If
37
+you require subnet onboard but your current environment does not support it,
38
+consider upgrading to a release that supports subnet onboard. When using
39
+third-party plugins with neutron, check with the supplier of the plugin
40
+regarding support for subnet onboard.
41
+
42
+Demo
43
+----
44
+
45
+Suppose an administrator has an existing provider network in their environment
46
+that was created without allocating its subnets from a subnet pool.
47
+
48
+.. code-block:: console
49
+
50
+    $ openstack network list
51
+    +--------------------------------------+----------------+--------------------------------------+
52
+    | ID                                   | Name           | Subnets                              |
53
+    +--------------------------------------+----------------+--------------------------------------+
54
+    | f643a4f5-f8d3-4325-b1fe-6061a9af0f07 | provider-net-1 | 5153cab7-7ab6-4956-8466-39aa85dccc9a |
55
+    +--------------------------------------+----------------+--------------------------------------+
56
+
57
+    $ openstack subnet show 5153cab7-7ab6-4956-8466-39aa85dccc9a
58
+    +-------------------+--------------------------------------+
59
+    | Field             | Value                                |
60
+    +-------------------+--------------------------------------+
61
+    | allocation_pools  | 192.168.0.2-192.168.7.254            |
62
+    | cidr              | 192.168.0.0/21                       |
63
+    | description       |                                      |
64
+    | dns_nameservers   |                                      |
65
+    | enable_dhcp       | True                                 |
66
+    | gateway_ip        | 192.168.0.1                          |
67
+    | host_routes       |                                      |
68
+    | id                | 5153cab7-7ab6-4956-8466-39aa85dccc9a |
69
+    | ip_version        | 4                                    |
70
+    | ipv6_address_mode | None                                 |
71
+    | ipv6_ra_mode      | None                                 |
72
+    | network_id        | f643a4f5-f8d3-4325-b1fe-6061a9af0f07 |
73
+    | prefix_length     | None                                 |
74
+    | project_id        | 7b80998e5e044cee91c1cdb2e9c63afd     |
75
+    | revision_number   | 0                                    |
76
+    | segment_id        | None                                 |
77
+    | service_types     |                                      |
78
+    | subnetpool_id     | None                                 |
79
+    | tags              |                                      |
80
+    | updated_at        | 2019-03-13T18:24:37Z                 |
81
+    +-------------------+--------------------------------------+
82
+
83
+The administrator has created a subnet pool named ``routable-prefixes`` and
84
+wants to onboard the subnets associated with network ``provider-net-1``. The
85
+administrator now wants to manage the address space for provider networks using
86
+a subnet pool, but doesn't have the prefixes used by these provider networks
87
+under the management of a subnet pool or address scope.
88
+
89
+.. code-block:: console
90
+
91
+    $ openstack subnet pool list
92
+    +--------------------------------------+-------------------+--------------+
93
+    | ID                                   | Name              | Prefixes     |
94
+    +--------------------------------------+-------------------+--------------+
95
+    | d05e9f61-248c-43f2-98f4-5142570127e1 | routable-prefixes | 10.10.0.0/16 |
96
+    +--------------------------------------+-------------------+--------------+
97
+
98
+.. code-block:: console
99
+
100
+    $ openstack subnet pool show routable-prefixes
101
+    +-------------------+--------------------------------+
102
+    | Field             | Value                          |
103
+    +-------------------+--------------------------------+
104
+    | address_scope_id  | None                           |
105
+    | created_at        | 2019-03-102T05:45:01Z          |
106
+    | default_prefixlen | 26                             |
107
+    | default_quota     | None                           |
108
+    | description       | Routable prefixes for projects |
109
+    | headers           |                                |
110
+    | id                | d3aefb76-2527-43d4-bc21-0ec253 |
111
+    |                   | 908545                         |
112
+    | ip_version        | 4                              |
113
+    | is_default        | False                          |
114
+    | max_prefixlen     | 32                             |
115
+    | min_prefixlen     | 8                              |
116
+    | name              | routable-prefixes              |
117
+    | prefixes          | 10.10.0.0/16                   |
118
+    | project_id        | cfd1889ac7d64ad891d4f20aef9f8d |
119
+    |                   | 7c                             |
120
+    | revision_number   | 1                              |
121
+    | shared            | True                           |
122
+    | tags              | []                             |
123
+    | updated_at        | 2019-03-10T05:45:01Z           |
124
+    +-------------------+--------------------------------+
125
+
126
+The administrator can use the following command to bring these subnets under
127
+the management of a subnet pool:
128
+
129
+.. code-block:: console
130
+
131
+    $ openstack network onboard subnets provider-net-1 routable-prefixes
132
+
133
+The subnets on ``provider-net-1`` should now all have their subnetpool_id
134
+updated to match the UUID of the ``routable-prefixes`` subnet pool:
135
+
136
+.. code-block:: console
137
+
138
+    $ openstack subnet show 5153cab7-7ab6-4956-8466-39aa85dccc9a
139
+    +-------------------+--------------------------------------+
140
+    | Field             | Value                                |
141
+    +-------------------+--------------------------------------+
142
+    | allocation_pools  | 192.168.0.2-192.168.7.254            |
143
+    | cidr              | 192.168.0.0/21                       |
144
+    | description       |                                      |
145
+    | dns_nameservers   |                                      |
146
+    | enable_dhcp       | True                                 |
147
+    | gateway_ip        | 192.168.0.1                          |
148
+    | host_routes       |                                      |
149
+    | id                | 5153cab7-7ab6-4956-8466-39aa85dccc9a |
150
+    | ip_version        | 4                                    |
151
+    | ipv6_address_mode | None                                 |
152
+    | ipv6_ra_mode      | None                                 |
153
+    | network_id        | f643a4f5-f8d3-4325-b1fe-6061a9af0f07 |
154
+    | prefix_length     | None                                 |
155
+    | project_id        | 7b80998e5e044cee91c1cdb2e9c63afd     |
156
+    | revision_number   | 0                                    |
157
+    | segment_id        | None                                 |
158
+    | service_types     |                                      |
159
+    | subnetpool_id     | d3aefb76-2527-43d4-bc21-0ec253908545 |
160
+    | updated_at        | 2019-03-13T18:24:37Z                 |
161
+    +-------------------+--------------------------------------+
162
+
163
+The subnet pool will also now show the onboarded prefix(es) in its prefix list:
164
+
165
+.. code-block:: console
166
+
167
+    $ openstack subnet pool show routable-prefixes
168
+    +-------------------+--------------------------------+
169
+    | Field             | Value                          |
170
+    +-------------------+--------------------------------+
171
+    | address_scope_id  | None                           |
172
+    | created_at        | 2019-03-102T05:45:01Z          |
173
+    | default_prefixlen | 26                             |
174
+    | default_quota     | None                           |
175
+    | description       | Routable prefixes for projects |
176
+    | headers           |                                |
177
+    | id                | d3aefb76-2527-43d4-bc21-0ec253 |
178
+    |                   | 908545                         |
179
+    | ip_version        | 4                              |
180
+    | is_default        | False                          |
181
+    | max_prefixlen     | 32                             |
182
+    | min_prefixlen     | 8                              |
183
+    | name              | routable-prefixes              |
184
+    | prefixes          | 10.10.0.0/16, 192.168.0.0/21   |
185
+    | project_id        | cfd1889ac7d64ad891d4f20aef9f8d |
186
+    |                   | 7c                             |
187
+    | revision_number   | 1                              |
188
+    | shared            | True                           |
189
+    | tags              | []                             |
190
+    | updated_at        | 2019-03-12T13:11:037Z          |
191
+    +-------------------+--------------------------------+

+ 1
- 0
doc/source/admin/config.rst View File

@@ -35,6 +35,7 @@ Configuration
35 35
    config-sfc
36 36
    config-sriov
37 37
    config-subnet-pools
38
+   config-subnet-onboard
38 39
    config-service-subnets
39 40
    config-trunking
40 41
    config-wsgi

Loading…
Cancel
Save