kubernetes version awareness

Author: travisghansen

CHANGELOG.md

@@ -0,0 +1,8 @@
+# v0.1.8
+
+Released 2019-10-22
+
+- several HAProxy fixes
+- introduce env variable `PFSENSE_DEBUG` to log all pfSense xmlrpc traffic
+- more robust logging for failure scenarios
+- k8s version awareness to prep for deprecations of several API endpoints

controller.php

@@ -51,11 +51,16 @@
     //'storeName' => $controllerName.'-controller-store',
 ];
 
-$controller = new KubernetesController\Controller($controllerName, $kubernetesClient, $options);
+$controller = new KubernetesPfSenseController\Controller($controllerName, $kubernetesClient, $options);
+$kubernetesClient = $controller->getKubernetesClient();
 
-// registry
+// register pfSenseClient
 $controller->setRegistryItem('pfSenseClient', $pfSenseClient);
 
+// register kubernetes version info
+$kubernetesVersionInfo = $kubernetesClient->request("/version");
+$controller->setRegistryItem('kubernetesVersionInfo', $kubernetesVersionInfo);
+
 // plugins
 $controller->registerPlugin('\KubernetesPfSenseController\Plugin\MetalLB');
 $controller->registerPlugin('\KubernetesPfSenseController\Plugin\HAProxyDeclarative');

examples/declarative-example.yaml

@@ -105,7 +105,17 @@ data:
           email_level:
           email_to:
           errorfiles:
-      #- type: frontend
+      - type: frontend
         # pass through directly to mimic config.xml structure
-        #definition:
-        # ...
+        # many more options available, review your config.xml for more detail
+        definition:
+          name: some-frontend-name
+          type: http
+          forwardfor: yes
+          status: active
+          backend_serverpool: some-backend-name
+          a_extaddr:
+            item:
+              - extaddr: wan_ipv4
+                extaddr_port: 443
+                extaddr_ssl: yes

src/KubernetesPfSenseController/Controller.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace KubernetesPfSenseController;
+
+class Controller extends \KubernetesController\Controller
+{
+    public function getKubernetesVersionInfo()
+    {
+        return $this->getRegistryItem('kubernetesVersionInfo');
+    }
+
+    public function getKubernetesVersionMajorMinor()
+    {
+        $versionInfo = $this->getKubernetesVersionInfo();
+
+        return $versionInfo['major'].'.'.$versionInfo['minor'];
+    }
+}

src/KubernetesPfSenseController/Plugin/DNSHAProxyIngressProxy.php

@@ -33,9 +33,20 @@ public function init()
     {
         $controller = $this->getController();
 
+        // 1.20 will kill the old version
+        // https://kubernetes.io/blog/2019/07/18/api-deprecations-in-1-16/
+        $kubernetesMajorMinor = $controller->getKubernetesVersionMajorMinor();
+        if (\Composer\Semver\Comparator::greaterThanOrEqualTo($kubernetesMajorMinor, '1.14')) {
+            $ingressResourcePath = '/apis/networking.k8s.io/v1beta1/ingresses';
+            $ingressResourceWatchPath = '/apis/networking.k8s.io/v1beta1/watch/ingresses';
+        } else {
+            $ingressResourcePath = '/apis/extensions/v1beta1/ingresses';
+            $ingressResourceWatchPath = '/apis/extensions/v1beta1/watch/ingresses';
+        }
+
         // initial load of ingresses
         $params = [];
-        $ingresses = $controller->getKubernetesClient()->request('/apis/extensions/v1beta1/ingresses', 'GET', $params);
+        $ingresses = $controller->getKubernetesClient()->request($ingressResourcePath, 'GET', $params);
         $this->state['ingresses'] = $ingresses['items'];
 
         // watch for ingress changes
@@ -45,7 +56,7 @@ public function init()
         $options = [
             'trigger' => false,
         ];
-        $watch = $controller->getKubernetesClient()->createWatch('/apis/extensions/v1beta1/watch/ingresses', $params, $this->getWatchCallback('ingresses', $options));
+        $watch = $controller->getKubernetesClient()->createWatch($ingressResourceWatchPath, $params, $this->getWatchCallback('ingresses', $options));
         $this->addWatch($watch);
 
         $this->generateHash();

src/KubernetesPfSenseController/Plugin/DNSIngresses.php

@@ -28,12 +28,23 @@ public function init()
         $ingressLabelSelector = $pluginConfig['serviceLabelSelector'];
         $ingressFieldSelector = $pluginConfig['serviceFieldSelector'];
 
+        // 1.20 will kill the old version
+        // https://kubernetes.io/blog/2019/07/18/api-deprecations-in-1-16/
+        $kubernetesMajorMinor = $controller->getKubernetesVersionMajorMinor();
+        if (\Composer\Semver\Comparator::greaterThanOrEqualTo($kubernetesMajorMinor, '1.14')) {
+            $ingressResourcePath = '/apis/networking.k8s.io/v1beta1/ingresses';
+            $ingressResourceWatchPath = '/apis/networking.k8s.io/v1beta1/watch/ingresses';
+        } else {
+            $ingressResourcePath = '/apis/extensions/v1beta1/ingresses';
+            $ingressResourceWatchPath = '/apis/extensions/v1beta1/watch/ingresses';
+        }
+
         // initial load of ingresses
         $params = [
             'labelSelector' => $ingressLabelSelector,
             'fieldSelector' => $ingressFieldSelector,
         ];
-        $ingresses = $controller->getKubernetesClient()->request('/apis/extensions/v1beta1/ingresses', 'GET', $params);
+        $ingresses = $controller->getKubernetesClient()->request($ingressResourcePath, 'GET', $params);
         $this->state['resources'] = $ingresses['items'];
 
         // watch for ingress changes
@@ -42,7 +53,7 @@ public function init()
             'fieldSelector' => $ingressFieldSelector,
             'resourceVersion' => $ingresses['metadata']['resourceVersion'],
         ];
-        $watch = $controller->getKubernetesClient()->createWatch('/apis/extensions/v1beta1/watch/ingresses', $params, $this->getWatchCallback('resources'));
+        $watch = $controller->getKubernetesClient()->createWatch($ingressResourceWatchPath, $params, $this->getWatchCallback('resources'));
         $this->addWatch($watch);
         $this->delayedAction();
     }

src/KubernetesPfSenseController/Plugin/HAProxyIngressProxy.php

@@ -52,12 +52,23 @@ public function init()
         $ingressLabelSelector = $pluginConfig['ingressLabelSelector'];
         $ingressFieldSelector = $pluginConfig['ingressFieldSelector'];
 
+        // 1.20 will kill the old version
+        // https://kubernetes.io/blog/2019/07/18/api-deprecations-in-1-16/
+        $kubernetesMajorMinor = $controller->getKubernetesVersionMajorMinor();
+        if (\Composer\Semver\Comparator::greaterThanOrEqualTo($kubernetesMajorMinor, '1.14')) {
+            $ingressResourcePath = '/apis/networking.k8s.io/v1beta1/ingresses';
+            $ingressResourceWatchPath = '/apis/networking.k8s.io/v1beta1/watch/ingresses';
+        } else {
+            $ingressResourcePath = '/apis/extensions/v1beta1/ingresses';
+            $ingressResourceWatchPath = '/apis/extensions/v1beta1/watch/ingresses';
+        }
+
         // initial load of ingresses
         $params = [
             'labelSelector' => $ingressLabelSelector,
             'fieldSelector' => $ingressFieldSelector,
         ];
-        $ingresses = $controller->getKubernetesClient()->request('/apis/extensions/v1beta1/ingresses', 'GET', $params);
+        $ingresses = $controller->getKubernetesClient()->request($ingressResourcePath, 'GET', $params);
         $this->state['ingresses'] = $ingresses['items'];
 
         // watch for ingress changes
@@ -66,7 +77,7 @@ public function init()
             'fieldSelector' => $ingressFieldSelector,
             'resourceVersion' => $ingresses['metadata']['resourceVersion'],
         ];
-        $watch = $controller->getKubernetesClient()->createWatch('/apis/extensions/v1beta1/watch/ingresses', $params, $this->getWatchCallback('ingresses'));
+        $watch = $controller->getKubernetesClient()->createWatch($ingressResourceWatchPath, $params, $this->getWatchCallback('ingresses'));
         $this->addWatch($watch);
 
         $this->delayedAction();