summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2017-06-19 14:21:43 +0000
committerGerrit Code Review <review@openstack.org>2017-06-19 14:21:43 +0000
commitf3fc8ed4c55089d8e111291fb8752d332cfc39a5 (patch)
treea083c3e33cf5f8192acbc469d240e3fbafa8b4a6
parent85b23fd060838acff67ff06cb47fbffdb93e7c9f (diff)
parent46b2892472dcbbf5b58e8e0381910fa716e6eac5 (diff)
Merge "Add ports pool configuration information at README"
-rw-r--r--doc/source/installation/index.rst1
-rw-r--r--doc/source/installation/ports-pool.rst50
2 files changed, 51 insertions, 0 deletions
diff --git a/doc/source/installation/index.rst b/doc/source/installation/index.rst
index 7f2a15c..f272ec4 100644
--- a/doc/source/installation/index.rst
+++ b/doc/source/installation/index.rst
@@ -32,3 +32,4 @@ This section describes how you can install and configure kuryr-kubernetes
32 nested-vlan 32 nested-vlan
33 nested-macvlan 33 nested-macvlan
34 https_kubernetes 34 https_kubernetes
35 ports-pool
diff --git a/doc/source/installation/ports-pool.rst b/doc/source/installation/ports-pool.rst
new file mode 100644
index 0000000..5fb67a9
--- /dev/null
+++ b/doc/source/installation/ports-pool.rst
@@ -0,0 +1,50 @@
1How to enable ports pool support
2================================
3
4To enable the utilization of the ports pool feature, the selected pool driver
5needs to be included at the kuryr.conf at the kubernetes section. So, for the
6baremetal deployment::
7
8 [kubernetes]
9 vif_pool_driver = neutron
10
11And for the nested (VLAN+Trunk) case::
12
13 [kubernetes]
14 vif_pool_driver = nested
15
16On the other hand, there are a few extra (optional) configuration options
17regarding the maximum and minimun desired sizes of the pools, where the
18maximum size can be disabled by setting it to 0::
19
20 [vif_pool]
21 ports_pool_max = 10
22 ports_pool_min = 5
23
24In addition the size of the bulk operation, e.g., the number
25of ports created in a bulk request upon pool population, can be modified::
26
27 [vif_pool]
28 ports_pool_batch = 5
29
30Note this value should be smaller than the ports_pool_max (if the
31ports_pool_max is enabled).
32
33Finally, the interval between pools updating actions (in seconds) can be
34modified, and it should be adjusted based on your specific deployment, e.g., if
35the port creation actions are slow, it is desirable to raise it in order not to
36have overlapping actions. As a simple rule of thumbs, the frequency should be
37at least as large as the time needed to perform the bulk requests (ports
38creation, including subports attachment for the nested case)::
39
40 [vif_pool]
41 ports_pool_update_frequency = 20
42
43After these configurations, the final step is to restart the
44kuryr-k8s-controller. At devstack deployment::
45
46 sudo systemctl restart devstack@kuryr-kubernetes.service
47
48And for RDO packaging based installations::
49
50 sudo systemctl restart kuryr-controller