chore(ci): re-arrange ci artifacts (#103)

This commit re-arranges the ci artifacts that build the ci
framework required to run end to end tests for d-operators.

README about E to E has been updated to make it simpler to
understand the motive behind this custom ci framework.

Signed-off-by: AmitKumarDas <[email protected]>

Author: Amit Kumar Das

README.md

@@ -10,9 +10,9 @@ It is important to understand that these declarative patterns are built upon pro
 D-operators is not meant to build complex controller logic like Deployment, StatefulSet or Pod in a declarative yaml. However, if one needs to use available Kubernetes resources to build new k8s controller(s) then d-operators should be considered to build one. D-operators helps implement the last mile automation needed to manage applications & infrastructure in Kubernetes clusters.
 
 ### E to E testing
-D-operators make use of d-operators _(i.e. its own self)_ to test its controllers. It does not need kubectl, bash, sed, awk etc to test its controllers. In addition, it does not depend on writing go code to write tests. It makes use of declarative YAMLs to test its controllers.
+D-operators make use of its custom resource(s) to test its controllers. One can imagine these custom resources acting as the building blocks to implement a custom CI framework. One of the primary advantages with this approach, is to let custom resources remove the need to write code to implement test cases.
 
-_NOTE: One can make use of these YAMLs (kind: Recipe) to test any Kubernetes controllers declaratively_
+_NOTE: One can make use of these YAMLs (kind: Recipe) to test their own Kubernetes controllers declaratively_
 
 Navigate to test/experiments to learn more on these YAMLs.
 

test/e2e/ci.yaml

@@ -0,0 +1,114 @@
+# This yaml file demonstrates the use of Kubernetes
+# and few custom resources to build a custom CI 
+# infrastructure. In this infrastructure, Kubernetes 
+# is the CI runner and custom resources are the test 
+# cases.
+--- 
+# d-testing is the Kubernetes namespace that can
+# be used to deploy any test artifacts
+apiVersion: v1
+kind: Namespace
+metadata:
+  name: d-testing
+---
+# dope is the Kubernetes namespace used to deploy
+# dope statefulset
+apiVersion: v1
+kind: Namespace
+metadata:
+  name: dope
+---
+# Recipe custom resource is used to write test cases
+# in a declarative approach
+apiVersion: apiextensions.k8s.io/v1beta1
+kind: CustomResourceDefinition
+metadata:
+  annotations:
+  name: recipes.dope.metacontroller.io
+spec:
+  group: dope.metacontroller.io
+  names:
+    kind: Recipe
+    listKind: RecipeList
+    plural: recipes
+    shortNames:
+    - rcp
+    singular: recipe
+  scope: Namespaced
+  subresources:
+    status: {}
+  version: v1
+  versions:
+  - name: v1
+    served: true
+    storage: true
+---
+# dope is the Kubernetes service account that has
+# all priviledges to manage any Kubernetes resources
+apiVersion: v1
+kind: ServiceAccount
+metadata:
+  name: dope
+  namespace: dope
+---
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRole
+metadata:
+  name: dope
+rules:
+- apiGroups:
+  - "*"
+  resources:
+  - "*"
+  verbs:
+  - "*"
+---
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRoleBinding
+metadata:
+  name: dope
+subjects:
+- kind: ServiceAccount
+  name: dope
+  namespace: dope
+roleRef:
+  kind: ClusterRole
+  name: dope
+  apiGroup: rbac.authorization.k8s.io
+---
+# dope statefulset holds the dope binary which is responsible
+# to reconcile all Recipe custom resources
+apiVersion: apps/v1
+kind: StatefulSet
+metadata:
+  labels:
+    app.mayadata.io/name: dope
+  name: dope
+  namespace: dope
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app.mayadata.io/name: dope
+  serviceName: ""
+  template:
+    metadata:
+      labels:
+        app.mayadata.io/name: dope
+    spec:
+      serviceAccountName: dope
+      containers:
+      - name: dope
+        # this may be replaced by a stable release tag
+        #
+        # Since dope itself is the target under test, this
+        # ci.yaml uses the master build available in the local
+        # container registry
+        image: localhost:5000/dope
+        command: ["/usr/bin/dope"]
+        args:
+        - --logtostderr
+        - --run-as-local
+        - -v=1
+        - --discovery-interval=30s
+        - --cache-flush-interval=240s

test/experiments/inference.yaml renamed to test/e2e/inference.yaml

@@ -44,13 +44,13 @@ echo "--------------------------"
 echo "++ E to E suite started"
 echo "--------------------------"
 
-# Name of the Kubernetes controller binary under test
+# Name of the targeted controller binary under test
 ctrlbin="dope"
 
-# kind: Recipe custom resource is used to build the test cases
+# group that defines the Recipe custom resource
 group="recipes.dope.metacontroller.io"
 
-# Namespace used by all Recipe custom resources
+# Namespace used by inference Recipe custom resource
 ns="d-testing"
 
 echo -e "\n Remove locally cached image $ctrlbin:e2e"
@@ -87,44 +87,11 @@ fi
 echo -e "\n Verify if K3s is up and running"
 k3s kubectl get node
 
-echo -e "\n Apply $ctrlbin manifests to K3s cluster..."
-k3s kubectl apply -f ./../../manifests/
-
-echo -e "\n Apply $ctrlbin as a statefulset to K3s cluster..."
-cat <<EOF | k3s kubectl apply -f -
-apiVersion: apps/v1
-kind: StatefulSet
-metadata:
-  labels:
-    app.mayadata.io/name: dope
-  name: dope
-  namespace: dope
-spec:
-  replicas: 1
-  selector:
-    matchLabels:
-      app.mayadata.io/name: dope
-  serviceName: ""
-  template:
-    metadata:
-      labels:
-        app.mayadata.io/name: dope
-    spec:
-      serviceAccountName: dope
-      containers:
-      - name: dope
-        image: localhost:5000/dope
-        command: ["/usr/bin/dope"]
-        args:
-        - --logtostderr
-        - --run-as-local
-        - -v=1
-        - --discovery-interval=30s
-        - --cache-flush-interval=240s
-EOF
-
-echo -e "\n Apply test namespace to K3s cluster"
-k3s kubectl apply -f namespace.yaml
+echo -e "\n Apply d-operators based ci to K3s cluster"
+k3s kubectl apply -f ci.yaml
+
+echo -e "\n Apply ci inference to K3s cluster"
+k3s kubectl apply -f inference.yaml
 
 echo -e "\n Apply test experiments to K3s cluster"
 k3s kubectl apply -f ./../experiments/