From 2f828486c74412039d7f3b50910d9108c75351cd Mon Sep 17 00:00:00 2001 From: Kafilat Adeleke Date: Mon, 12 Oct 2020 08:52:19 -0700 Subject: [PATCH] corrects Kubernetes Services handlers The handlers that need to be enabled to correctly handle Kubernetes Services events are (endpoints,service,kuryrloadbalancer) and not (lb,lbaasspec) as placed in most of the docs. This was due to the recent movement to KuryrLoadBalancer custom resources definitions (CRD). Change-Id: I0eff3b68839a659d39650e2cb22956e30d2c7332 Closes-Bug: #1899013 --- devstack/local.conf.odl.sample | 2 +- devstack/local.conf.openshift.sample | 3 +-- devstack/local.conf.ovn.sample | 3 +-- devstack/local.conf.sample | 2 +- doc/source/devref/kuryr_kubernetes_design.rst | 4 ++-- doc/source/installation/network_namespace.rst | 9 ++++++--- doc/source/installation/network_policy.rst | 10 +++++++--- doc/source/installation/ports-pool.rst | 6 ++++-- kuryr_kubernetes/config.py | 3 ++- 9 files changed, 25 insertions(+), 17 deletions(-) diff --git a/devstack/local.conf.odl.sample b/devstack/local.conf.odl.sample index 581c7f2b2..e68daf865 100644 --- a/devstack/local.conf.odl.sample +++ b/devstack/local.conf.odl.sample @@ -160,7 +160,7 @@ enable_service kuryr-daemon # By default, some Kuryr Handlers are set for DevStack installation. This can be # further tweaked in order to enable additional ones such as Network Policy. If # you want to add additional handlers those can be set here: -# KURYR_ENABLED_HANDLERS = vif,lb,lbaasspec +# KURYR_ENABLED_HANDLERS = vif,endpoints,service,kuryrloadbalancer,kuryrport # Kuryr Ports Pools # ================= diff --git a/devstack/local.conf.openshift.sample b/devstack/local.conf.openshift.sample index bb283d3cc..e3f3b31a7 100644 --- a/devstack/local.conf.openshift.sample +++ b/devstack/local.conf.openshift.sample @@ -158,8 +158,7 @@ enable_service kuryr-daemon # By default, some Kuryr Handlers are set for DevStack installation. This can be # further tweaked in order to enable additional ones such as Network Policy. If # you want to add additional handlers those can be set here: -# KURYR_ENABLED_HANDLERS = vif,lb,lbaasspec - +# KURYR_ENABLED_HANDLERS = vif,endpoints,service,kuryrloadbalancer,kuryrport # Kuryr Ports Pools # ================= # diff --git a/devstack/local.conf.ovn.sample b/devstack/local.conf.ovn.sample index c226bb6d3..c1b7e5afe 100644 --- a/devstack/local.conf.ovn.sample +++ b/devstack/local.conf.ovn.sample @@ -208,8 +208,7 @@ KURYR_K8S_CONTAINERIZED_DEPLOYMENT=True # By default, some Kuryr Handlers are set for DevStack installation. This can be # further tweaked in order to enable additional ones such as Network Policy. If # you want to add additional handlers those can be set here: -# KURYR_ENABLED_HANDLERS = vif,lb,lbaasspec - +# KURYR_ENABLED_HANDLERS = vif,endpoints,service,kuryrloadbalancer,kuryrport # Kuryr Ports Pools # ================= # diff --git a/devstack/local.conf.sample b/devstack/local.conf.sample index fc52f5c75..545c902af 100644 --- a/devstack/local.conf.sample +++ b/devstack/local.conf.sample @@ -188,7 +188,7 @@ enable_service kuryr-daemon # By default, some Kuryr Handlers are set for DevStack installation. This can be # further tweaked in order to enable additional ones such as Network Policy. If # you want to add additional handlers those can be set here: -# KURYR_ENABLED_HANDLERS = vif,lb,lbaasspec +# KURYR_ENABLED_HANDLERS = vif,endpoints,service,kuryrloadbalancer,kuryrport # Kuryr Ports Pools # ================= diff --git a/doc/source/devref/kuryr_kubernetes_design.rst b/doc/source/devref/kuryr_kubernetes_design.rst index 75333e028..c91531ede 100644 --- a/doc/source/devref/kuryr_kubernetes_design.rst +++ b/doc/source/devref/kuryr_kubernetes_design.rst @@ -178,8 +178,8 @@ currently includes the following: ================ ========================= vif Pod kuryrport KuryrPort CRD -lb Endpoint -lbaasspec Service +endpoints Endpoint +service Service ================ ========================= For example, to enable only the 'vif' controller handler we should set the diff --git a/doc/source/installation/network_namespace.rst b/doc/source/installation/network_namespace.rst index caec1895b..816a81499 100644 --- a/doc/source/installation/network_namespace.rst +++ b/doc/source/installation/network_namespace.rst @@ -13,7 +13,8 @@ the next steps are needed: .. code-block:: ini [kubernetes] - enabled_handlers=vif,lb,lbaasspec,namespace,kuryrnetwork,kuryrport + enabled_handlers=vif,endpoints,service,kuryrloadbalancer,namespace, + kuryrnetwork,kuryrport Note that if you also want to enable prepopulation of ports pools upon new namespace creation, you need to also add the kuryrnetwork_population @@ -22,7 +23,8 @@ the next steps are needed: .. code-block:: ini [kubernetes] - enabled_handlers=vif,lb,lbaasspec,namespace,kuryrnetwork,kuryrport,kuryrnetwork_population + enabled_handlers=vif,endpoints,service,kuryrloadbalancer,namespace, + kuryrnetwork,kuryrport,kuryrnetwork_population #. Enable the namespace subnet driver by modifying the default pod_subnet_driver option at kuryr.conf: @@ -73,7 +75,8 @@ to add the namespace handler and state the namespace subnet driver with: .. code-block:: console KURYR_SUBNET_DRIVER=namespace - KURYR_ENABLED_HANDLERS=vif,lb,lbaasspec,namespace,kuryrnetwork,kuryrport + KURYR_ENABLED_HANDLERS=vif,endpoints,service,kuryrloadbalancer,namespace, + kuryrnetwork,kuryrport .. note:: diff --git a/doc/source/installation/network_policy.rst b/doc/source/installation/network_policy.rst index ccc2d42d2..6412b0cd1 100644 --- a/doc/source/installation/network_policy.rst +++ b/doc/source/installation/network_policy.rst @@ -10,7 +10,9 @@ be found at :doc:`./devstack/containerized`): .. code-block:: ini [kubernetes] - enabled_handlers=vif,lb,lbaasspec,policy,pod_label,namespace,kuryrnetwork,kuryrnetworkpolicy,kuryrport + enabled_handlers=vif,endpoints,service,kuryrloadbalancer,policy, + pod_label,namespace,kuryrnetwork,kuryrnetworkpolicy, + kuryrport Note that if you also want to enable prepopulation of ports pools upon new namespace creation, you need to also dd the kuryrnetwork_population handler @@ -19,7 +21,9 @@ namespace creation, you need to also dd the kuryrnetwork_population handler .. code-block:: ini [kubernetes] - enabled_handlers=vif,lb,lbaasspec,policy,pod_label,namespace,kuryrnetworkpolicy,kuryrnetwork,kuryrnetwork_population,kuryrport + enabled_handlers=vif,endpoints,service,kuryrloadbalancer,policy, + pod_label,namespace,kuryrnetworkpolicy,kuryrnetwork, + kuryrport,kuryrnetwork_population After that, enable also the security group drivers for policies: @@ -82,7 +86,7 @@ to add the policy, pod_label and namespace handler and drivers with: .. code-block:: bash - KURYR_ENABLED_HANDLERS=vif,lb,lbaasspec,policy,pod_label,namespace,kuryrnetworkpolicy,kuryrport + KURYR_ENABLED_HANDLERS=vif,endpoints,service,kuryrloadbalancer,policy,pod_label,namespace,kuryrnetworkpolicy,kuryrport KURYR_SG_DRIVER=policy KURYR_SUBNET_DRIVER=namespace diff --git a/doc/source/installation/ports-pool.rst b/doc/source/installation/ports-pool.rst index b29d98991..fcfd6185d 100644 --- a/doc/source/installation/ports-pool.rst +++ b/doc/source/installation/ports-pool.rst @@ -169,7 +169,8 @@ subnet), the next handler needs to be enabled: .. code-block:: ini [kubernetes] - enabled_handlers=vif,lb,lbaasspec,namespace,*kuryrnetwork* + enabled_handlers=vif,endpoints,service,kuryrloadbalancer,namespace, + *kuryrnetwork* This can be enabled at devstack deployment time to by adding the next to the @@ -177,4 +178,5 @@ local.conf: .. code-block:: bash - KURYR_ENABLED_HANDLERS=vif,lb,lbaasspec,namespace,*kuryrnetwork* + KURYR_ENABLED_HANDLERS=vif,endpoints,service,kuryrloadbalancer,namespace, + *kuryrnetwork* diff --git a/kuryr_kubernetes/config.py b/kuryr_kubernetes/config.py index 2c778dee7..c17344cf3 100644 --- a/kuryr_kubernetes/config.py +++ b/kuryr_kubernetes/config.py @@ -179,7 +179,8 @@ k8s_opts = [ cfg.ListOpt('enabled_handlers', help=_("The comma-separated handlers that should be " "registered for watching in the pipeline."), - default=['vif', 'lb', 'lbaasspec']), + default=['vif', 'endpoints', 'service', 'kuryrloadbalancer', + 'kuryrport']), cfg.BoolOpt('controller_ha', help=_('Enable kuryr-controller active/passive HA. Only ' 'supported in containerized deployments on Kubernetes '