Merge pull request #37 from projectsyn/feat/refactor-plan-management

Add support for arbitrary configurations in `Plan` resources

Author: simu

class/defaults.yml

@@ -14,6 +14,5 @@ parameters:
     service_account: system-upgrade
     plan_polling_interval: "15m"
     suc_image: docker.io/rancher/system-upgrade-controller:v0.6.2
-    floodgate_url: https://floodgate.syn.vshn.net/
+    floodgate_url: https://floodgate.syn.vshn.net
     disable_grafana_dashboard: false
-    plans: []

component/main.jsonnet

@@ -153,49 +153,82 @@ local deployment = kube.Deployment('system-upgrade-controller') {
   },
 };
 
-local plan = [
+local optionalKey(p, k) =
+  if std.objectHas(p, k) then k;
+
+local convertLegacyPlan(p) = std.trace(
+  'Converting legacy SUC plan "%(name)s", please update your config' % p,
+  {
+    spec: {
+      concurrency: p.concurrency,
+      [optionalKey(p, 'channel')]: p.channel,
+      [optionalKey(p, 'version')]: p.version,
+      upgrade: {
+        image: p.image,
+        [optionalKey(p, 'command')]: p.command,
+        // todo verify old structure
+        [optionalKey(p, 'args')]: p.args,
+      },
+    },
+    [optionalKey(p, 'push_gateway')]: p.push_gateway,
+    label_selectors: {
+      [l.key]: l
+      for l in p.label_selectors
+    },
+    tolerations: {
+      [t.key]: t
+      for t in com.getValueOrDefault(p, 'tolerations', [])
+    },
+    floodgate: {
+      day: p.day,
+      hour: p.hour,
+    },
+  }
+);
+
+local planConfigs =
+  if !std.objectHas(params, 'plans') then
+    {}
+  else if std.isArray(params.plans) then
+    {
+      [p.name]: convertLegacyPlan(p)
+      for p in params.plans
+    }
+  else
+    params.plans;
+
+local plans = [
+  local p = planConfigs[pname];
+  local pspec = p.spec;
 
-  local channel = (
-    if std.objectHas(p, 'channel') then
-      p.channel
+  local fixup_command(command) =
+    if std.type(command) == 'string' then
+      [ command ]
+    else if std.type(command) == 'array' then
+      command
     else
-      params.floodgate_url + 'window/' + p.day + '/' + p.hour
-  );
-
-  local args(p) =
-    if std.objectHas(p, 'args') then (
-      if std.type(p.args) == 'array' then
-        if std.objectHas(p, 'push_gateway') then
-          std.prune(p.args + [ p.push_gateway ])
-        else
-          p.args
-      else
-        error 'Field `args` of plan "%(name)s" is not an array' % p
-    ) else (
-      if std.objectHas(p, 'push_gateway') then
-        [ p.push_gateway ]
-      else
-        null
-    );
-
-  local command(p) =
-    if std.objectHas(p, 'command') then (
-      if std.type(p.command) == 'string' then (
-        [ p.command ]
-      )
-      else (
-        if std.type(p.command) == 'array' then (
-          p.command
-        ) else
-          error 'Field `command` of plan "%(name)s" is not an array nor a string' % p
-      )
-    ) else
-      null;
-
-  local version = if std.objectHas(p, 'version') then p.version;
-
-  suc.Plan(p.name, channel, version, p.label_selectors, p.concurrency, p.tolerations, p.image, command(p), args(p))
-  for p in params.plans
+      error 'Field `spec.upgrade.command` of plan "%s" is not an array nor a string' % pname;
+
+  local tolerations = com.getValueOrDefault(p, 'tolerations', {});
+
+  local sp = suc.Plan(pname, p.label_selectors, tolerations) {
+    spec+: com.makeMergeable(p.spec),
+  };
+  local needsFG = !std.objectHas(sp.spec, 'channel') && !std.objectHas(sp.spec, 'version');
+
+  sp {
+    spec+: {
+      [if needsFG then 'channel']: suc.floodgate_channel(p.floodgate),
+      upgrade+: {
+        command: fixup_command(super.command),
+        [if std.objectHas(p, 'push_gateway') then 'args']+:
+          [ p.push_gateway ],
+      },
+    },
+  }
+
+  for pname in std.sort(std.objectFields(planConfigs))
+  if planConfigs[pname] != null
 ];
 
 local controller_definition = {
@@ -208,7 +241,7 @@ local controller_definition = {
 };
 
 local plans_definition = {
-  '05_plans': plan,
+  '05_plans': plans,
 };
 
 if params.plans_only then

docs/modules/ROOT/pages/index.adoc

@@ -6,27 +6,31 @@ See the xref:references/parameters.adoc[parameters] reference for further detail
 
 == Example for Ubuntu 20.04 (Focal)
 
-A minimal example to maintain all nodes of a cluster running Kubernetes 1.18 and Ubuntu 20.04 starting Tuesday at 22:00 having a node label `plan.upgrade.cattle.io/focal`:
+A minimal example to maintain all nodes with label `plan.upgrade.cattle.io/focal` of a cluster running Kubernetes 1.18 and Ubuntu 20.04 starting Tuesday at 22:00:
 
 ```
 parameters:
   system_upgrade_controller:
     job_kubectl_image: rancher/kubectl:v1.18.0
     disable_grafana_dashboard: true
     plans:
-      - name: system-upgrade
-        concurrency: 1
-        image: docker.io/projectsyn/suc-ubuntu-focal
-        command: /scripts/run.sh
-        # push_gateway: platform-prometheus-pushgateway.syn-synsights.svc:9091
-        push_gateway: 10.43.129.22:9091
-        day: 2  # Tuesday
-        hour: 22
+      focal:
+        spec:
+          concurrency: 1
+          upgrade:
+            image: docker.io/projectsyn/suc-ubuntu-focal
+            command: /scripts/run.sh
+          # push_gateway: platform-prometheus-pushgateway.syn-synsights.svc:9091
+          push_gateway: 10.43.129.22:9091
+        floodgate:
+          day: 2  # Tuesday
+          hour: 22
         label_selectors:
-          - {key: plan.upgrade.cattle.io/focal, operator: Exists}
+          plan.upgrade.cattle.io/focal:
+            operator: Exists
         tolerations:
-          - key: node-role.kubernetes.io/controlplane
+          node-role.kubernetes.io/controlplane:
             operator: Exists
-          - key: node-role.kubernetes.io/etcd
+          node-role.kubernetes.io/etcd:
             operator: Exists
 ```