Add Pre/PostSync job example

blue-green-deploy/argocd.yaml

@@ -1,3 +0,0 @@
-workflows:
-- name: blue-green
-  path: workflows/bluegreen.yaml

blue-green-deploy/components/bg-guestbook.jsonnet

@@ -1,5 +1,5 @@
 local env = std.extVar("__ksonnet/environments");
-local params = std.extVar("__ksonnet/params").components["bg-deploy"];
+local params = std.extVar("__ksonnet/params").components["bg-guestbook"];
 [
    {
       "apiVersion": "v1",
@@ -7,9 +7,7 @@ local params = std.extVar("__ksonnet/params").components["bg-deploy"];
       "metadata": {
          "name": params.name,
          "annotations": {
-            "argocd.argoproj.io/workflow-sync": "blue-green",
-            "argocd.argoproj.io/workflow-param.blue-green.service-name": params.name,
-            "argocd.argoproj.io/workflow-param.blue-green.new-service-manifest": "{{manifest}}",
+             "argocd.argoproj.io/hook": "Skip",
          },
       },
       "spec": {
@@ -31,9 +29,7 @@ local params = std.extVar("__ksonnet/params").components["bg-deploy"];
       "metadata": {
          "name": params.name,
          "annotations": {
-            "argocd.argoproj.io/workflow-sync": "blue-green",
-            "argocd.argoproj.io/workflow-param.blue-green.deployment-name": params.name,
-            "argocd.argoproj.io/workflow-param.blue-green.new-deployment-manifest": "{{manifest}}",
+             "argocd.argoproj.io/hook": "Skip",
          },
       },
       "spec": {

blue-green-deploy/components/bg-workflow.jsonnet

@@ -0,0 +1,20 @@
+local bgGuestbook = std.extVar("__ksonnet/components")["bg-guestbook"];
+local bgGuestbookSvc = bgGuestbook[0];
+local bgGuestbookDeploy = bgGuestbook[1];
+local parseYaml = std.native("parseYaml");
+local bgWorkflow = parseYaml(importstr 'wf/bluegreen.yaml')[0];
+
+[
+  bgWorkflow + {
+    spec +: {
+      arguments +: {
+        parameters : [
+          {name: "deployment-name", value: bgGuestbookDeploy.metadata.name},
+          {name: "service-name", value: bgGuestbookSvc.metadata.name},
+          {name: "new-deployment-manifest", value: std.manifestJson(bgGuestbookDeploy)},
+          {name: "new-service-manifest", value: std.manifestJson(bgGuestbookSvc)},
+        ],
+      },
+    },
+  }
+]

blue-green-deploy/components/params.libsonnet

@@ -6,13 +6,14 @@
   components: {
     // Component-level parameters, defined initially from 'ks prototype use ...'
     // Each object below should correspond to a component in the components/ directory
-    "bg-deploy": {
+    "bg-guestbook": {
       containerPort: 80,
       image: "gcr.io/heptio-images/ks-guestbook-demo:0.2",
-      name: "bg-deploy",
+      name: "bg-guestbook",
       replicas: 3,
       servicePort: 80,
       type: "LoadBalancer",
     },
+    "bg-workflow": {},
   },
 }

blue-green-deploy/components/wf/bluegreen.yaml

@@ -1,11 +1,13 @@
 # This workflow performs a "blue-green" deployment, while preserving the original deployment object
 # and name. It accomplishes this by temporarily redirecting traffic to a *clone* of the original
-# deployment, then after upgrading the original deployment to a later version, transfering traffic
+# deployment. Then after upgrading the original deployment to a later version, redirects traffic
 # back to the original (now upgraded) deployment.
 apiVersion: argoproj.io/v1alpha1
 kind: Workflow
 metadata:
   generateName: k8s-bluegreen-
+  annotations:
+    argocd.argoproj.io/hook: Sync
 spec:
   entrypoint: k8s-bluegreen
   arguments:
@@ -68,30 +70,53 @@ spec:
 
 # end of steps
 
-  # clone deployment creates a "blue" clone of an existing deployment.
-  # -blue is appended to the metadata.name, as well as the values in the spec.selector.matchLabels,
-  # and spec.template.metadata.labels
+  # clone-deployment creates a "blue" clone of an existing deployment. The string -blue is appended to:
+  #  - metadata.name
+  #  - spec.selector.matchLabels
+  #  - spec.template.metadata.labels
   - name: clone-deployment
     container:
       image: argoproj/argoexec:v2.1.1
       command: [sh, -c, -x]
       args:
-      - kubectl get --export -o json deployment.apps/{{workflow.parameters.deployment-name}} > /tmp/original-deploy &&
+      - kubectl get --export -o json deployment.apps/{{workflow.parameters.deployment-name}} > /original-deploy &&
         jq -r '.metadata.name+="-blue" |
                .spec.template.metadata.labels += (.spec.template.metadata.labels | to_entries | map(select(.key != "applications.argoproj.io/app-name")) | map(.value+="-blue") | from_entries) |
                .spec.selector.matchLabels += (.spec.selector.matchLabels | to_entries | map(select(.key != "applications.argoproj.io/app-name")) | map(.value+="-blue") | from_entries)'
-            /tmp/original-deploy > /tmp/cloned-deploy &&
-        cat  /tmp/cloned-deploy &&
-        kubectl apply -o yaml -f /tmp/cloned-deploy
+            /original-deploy > /cloned-deploy &&
+        cat  /cloned-deploy &&
+        kubectl apply -o yaml -f /cloned-deploy
 
+  # apply-manifest takes a kubernetes manifest and carrys over the app-name label (if present)
+  # before running `kubectl apply`. The label is used by ArgoCD for monitoring.
   - name: apply-manifest
     inputs:
       parameters:
       - name: manifest
-    resource:
-      action: apply
-      manifest: '{{inputs.parameters.manifest}}'
+      artifacts:
+      - name: manifest-file
+        path: /manifest
+        raw:
+          data: '{{inputs.parameters.manifest}}'
+    container:
+      image: argoproj/argoexec:v2.1.1
+      command: [sh, -c, -x]
+      args:
+      - cp /manifest /manifest-new &&
+        APP_NAME=$(kubectl get -n default -f /manifest-new -o json | jq -r '.metadata.labels."applications.argoproj.io/app-name"') &&
+        if [ "$APP_NAME" != "null" ]; then
+          jq -r --arg APP_NAME "$APP_NAME" '.metadata.labels."applications.argoproj.io/app-name" = $APP_NAME' /manifest-new > /manifest-new.tmp &&
+          mv /manifest-new.tmp /manifest-new &&
+          if [ "$(jq -r .spec.template.metadata.labels /manifest-new)" != "null" ]; then
+            jq -r --arg APP_NAME "$APP_NAME" '.spec.template.metadata.labels."applications.argoproj.io/app-name" = $APP_NAME' /manifest-new > /manifest-new.tmp &&
+            mv /manifest-new.tmp /manifest-new ;
+          fi ;
+        fi &&
+        cat /manifest-new &&
+        kubectl apply -f /manifest-new
 
+  # wait-deployment-ready waits for a deployment to become fully deployed and ready, using the 
+  # `kubectl rollout` command
   - name: wait-deployment-ready
     inputs:
       parameters:
@@ -100,14 +125,15 @@ spec:
       image: argoproj/argoexec:v2.1.1
       command: [kubectl, rollout, status, --watch=true, 'deployments/{{inputs.parameters.deployment-name}}']
 
+  # patch-service updates the service selector labels to point to the "blue" deployment
   - name: patch-service
     container:
       image: argoproj/argoexec:v2.1.1
       command: [sh, -c, -x]
       args:
-      - kubectl get -n default service {{workflow.parameters.service-name}} --export -o json > /tmp/original-svc &&
-        jq '.spec.selector = (.spec.selector | with_entries(.value+="-blue"))' /tmp/original-svc > /tmp/blue-svc &&
-        kubectl apply -o yaml -f /tmp/blue-svc
+      - kubectl get -n default service {{workflow.parameters.service-name}} --export -o json > /original-svc &&
+        jq '.spec.selector = (.spec.selector | with_entries(.value+="-blue"))' /original-svc > /blue-svc &&
+        kubectl apply -o yaml -f /blue-svc
 
   - name: delete-deployment
     resource:

pre-post-sync/.gitignore

@@ -0,0 +1,4 @@
+/lib
+/.ksonnet/registries
+/app.override.yaml
+/.ks_environment

pre-post-sync/app.yaml

@@ -0,0 +1,11 @@
+apiVersion: 0.1.0
+environments:
+  default:
+    destination:
+      namespace: default
+      server: https://kubernetes.default.svc
+    k8sVersion: v1.10.0
+    path: default
+kind: ksonnet.io/app
+name: pre-post-sync
+version: 0.0.1

pre-post-sync/components/guestbook-ui.jsonnet

@@ -0,0 +1,66 @@
+local env = std.extVar("__ksonnet/environments");
+local params = std.extVar("__ksonnet/params").components["guestbook-ui"];
+[
+   {
+      "apiVersion": "v1",
+      "kind": "Service",
+      "metadata": {
+         "name": params.name
+      },
+      "spec": {
+         "ports": [
+            {
+               "port": params.servicePort,
+               "targetPort": params.containerPort
+            }
+         ],
+         "selector": {
+            "app": params.name
+         },
+         "type": params.type
+      }
+   },
+   {
+      "apiVersion": "apps/v1beta2",
+      "kind": "Deployment",
+      "metadata": {
+         "name": params.name
+      },
+      "spec": {
+         "replicas": params.replicas,
+         "selector": {
+            "matchLabels": {
+               "app": params.name
+            },
+         },
+         "template": {
+            "metadata": {
+               "labels": {
+                  "app": params.name
+               }
+            },
+            "spec": {
+               "containers": [
+                  {
+                    "image": params.image,
+                    "name": params.name,
+                    "ports": [
+                        {
+                            "containerPort": params.containerPort
+                        }
+                    ],
+                    // dummy readiness probe to slow down the rollout for demo/testing
+                    "readinessProbe": {
+                        "exec": {
+                            "command": [ "sh", "-c", "exit 0" ],
+                        },
+                        "initialDelaySeconds": 30,
+                        "periodSeconds": 120,
+                    }
+                  }
+               ]
+            }
+         }
+      }
+   }
+]

pre-post-sync/components/params.libsonnet

@@ -0,0 +1,20 @@
+{
+  global: {
+    // User-defined global parameters; accessible to all component and environments, Ex:
+    // replicas: 4,
+  },
+  components: {
+    // Component-level parameters, defined initially from 'ks prototype use ...'
+    // Each object below should correspond to a component in the components/ directory
+    "guestbook-ui": {
+      containerPort: 80,
+      image: "gcr.io/heptio-images/ks-guestbook-demo:0.1",
+      name: "pre-post-sync",
+      replicas: 1,
+      servicePort: 80,
+      type: "LoadBalancer",
+    },
+    "pre-sync-job": {},
+    "post-sync-job": {},
+  },
+}

pre-post-sync/components/post-sync-job.yaml

@@ -0,0 +1,15 @@
+apiVersion: batch/v1
+kind: Job
+metadata:
+  generateName: after-
+  annotations:
+    argocd.argoproj.io/hook: PostSync
+spec:
+  template:
+    spec:
+      containers:
+      - name: sleep
+        image: alpine:latest
+        command: ["sleep", "30"]
+      restartPolicy: Never
+  backoffLimit: 4

pre-post-sync/components/pre-sync-job.yaml

@@ -0,0 +1,15 @@
+apiVersion: batch/v1
+kind: Job
+metadata:
+  generateName: before-
+  annotations:
+    argocd.argoproj.io/hook: PreSync
+spec:
+  template:
+    spec:
+      containers:
+      - name: sleep
+        image: alpine:latest
+        command: ["sleep", "30"]
+      restartPolicy: Never
+  backoffLimit: 4

pre-post-sync/environments/base.libsonnet

@@ -0,0 +1,4 @@
+local components = std.extVar("__ksonnet/components");
+components + {
+  // Insert user-specified overrides here.
+}

pre-post-sync/environments/default/globals.libsonnet

@@ -0,0 +1,2 @@
+{
+}

pre-post-sync/environments/default/main.jsonnet

@@ -0,0 +1,8 @@
+local base = import "base.libsonnet";
+// uncomment if you reference ksonnet-lib
+// local k = import "k.libsonnet";
+
+base + {
+  // Insert user-specified overrides here. For example if a component is named \"nginx-deployment\", you might have something like:\n")
+  // "nginx-deployment"+: k.deployment.mixin.metadata.labels({foo: "bar"})
+}

pre-post-sync/environments/default/params.libsonnet

@@ -0,0 +1,17 @@
+local params = std.extVar("__ksonnet/params");
+local globals = import "globals.libsonnet";
+local envParams = params + {
+  components +: {
+    // Insert component parameter overrides here. Ex:
+    // guestbook +: {
+    //   name: "guestbook-dev",
+    //   replicas: params.global.replicas,
+    // },
+  },
+};
+
+{
+  components: {
+    [x]: envParams.components[x] + globals, for x in std.objectFields(envParams.components)
+  },
+}