Fix service issue on kins installation

Add instructions on how to run on kind

Author: orannahoum

.idea/.gitignore

@@ -16,21 +16,41 @@ To set up this operator follow the instructions below:
   darwin/amd64
 
 * An openshift cluster
+    * If you wish to run this locally by using kind please check [KindInstallationREADME.md](hack/KindInstallationREADME.md)
+
 
 
 ### Modyfing the CRD
 Modify the file config/skydive_v1_skydivesuite.yaml and pick what you wish to deploy (insert true or false in the relevant field), the options are as follows:
 * Skydive agents
 * Skydive analyzer
-    * Service route - TODO: doesn't work on IBM cluster.   
+    * Service route
+    * Flow exporter
 
 Choose your logging level (defaults to INFO)
 
 
 ### Installation - Open-Shift
 
 run the zsh script :
-    ```deploy_operator_on_openshift.sh```
+    ```sh
+    deploy_operator_on_openshift.sh
+    ```
+
+#### Analyzer UI
+1a. Check that all the pods, services and routes are running and afterwards run the following command:
+
+```sh
+oc get routes
+  ```
+
+2a. post the url into your web-browser
+
+1b. If routes option doesn't work, run the following command 
+  ```sh
+oc port-forward service/skydive-analyzer 8082:8082 --namespace=skydive
+  ```
+ 
+2b. Now open web-browser on localhost:8082
+
 
-### Installation - Kubernetes
-*** to be continued

README.md

@@ -44,6 +44,10 @@ type EnableSpec struct {
 	// +optional
 	// +kubebuilder:default=false
 	Route bool `json:"route,omitempty"`
+
+	// +optional
+	// +kubebuilder:default=true
+	FlowExporter bool `json:"flowExporter,omitempty"`
 }
 
 type LoggingSpec struct {

api/v1/skydivesuite_types.go

@@ -0,0 +1,29 @@
+# Skydive FlowExporter (Deployment)
+#
+# Containers included in this pod::
+# (1) Skydive Flow Exporter - Flow exporter (connects to Skydive Analyzer)
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: skydive-flow-exporter
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: skydive-flow-exporter
+      tier: flow-exporter
+  template:
+    metadata:
+      labels:
+        app: skydive-flow-exporter
+        tier: flow-exporter
+    spec:
+      containers:
+        - image: skydive/skydive-flow-exporter
+          imagePullPolicy: Always
+          name: skydive-flow-exporter
+          env:
+            - name: SKYDIVE_LOGGING_LEVEL
+              value: ${SKYDIVE_LOGGING_LEVEL}
+            - name: SKYDIVE_PIPELINE_SUBSCRIBER_URL
+              value: ws://skydive-analyzer:8082/ws/subscriber/flow

assets/flow-exporter/deployment.yaml

@@ -2,33 +2,32 @@
 apiVersion: v1
 kind: Service
 metadata:
+  name: skydive-analyzer
   labels:
     app: skydive-analyzer
-  name: skydive-analyzer
 spec:
+  type: ClusterIP
   ports:
-    - name: api
-      port: 8082
+    - port: 8082
+      name: api
       protocol: TCP
       targetPort: 8082
-    - name: protobuf
-      port: 8082
+    - port: 8082
+      name: protobuf
       protocol: UDP
       targetPort: 8082
-    - name: etcd
-      port: 12379
+    - port: 12379
+      name: etcd
       protocol: TCP
       targetPort: 12379
-    - name: etcd-cluster
-      port: 12380
+    - port: 12380
+      name: etcd-cluster
       protocol: TCP
       targetPort: 12380
-    - name: es
-      port: 9200
+    - port: 9200
+      name: es
       protocol: TCP
       targetPort: 9200
   selector:
     app: skydive
     tier: analyzer
-  sessionAffinity: None
-  type: NodePort

assets/skydive-analyzer/service.yaml

@@ -44,6 +44,9 @@ spec:
                   analyzer:
                     default: true
                     type: boolean
+                  flowExporter:
+                    default: true
+                    type: boolean
                   route:
                     default: false
                     type: boolean

config/crd/bases/skydive.example.com_skydivesuites.yaml

@@ -7,6 +7,7 @@ spec:
   enable:
     analyzer: true
     agents: true
-    route: true
+    route: false
+    flowExporter: false
   logging:
     level: "INFO"

config/skydive_v1_skydivesuite.yaml

@@ -35,6 +35,7 @@ var (
 	SkydiveAnalyzerDeployment = "skydive-analyzer/deployment.yaml"
 	SkydiveAnalyzerRoute      = "skydive-analyzer/route.yaml"
 	SkydiveAnalyzerService    = "skydive-analyzer/service.yaml"
+	SkydiveFlowExporter       = "flow-exporter/deployment.yaml"
 )
 
 // SkydiveSuiteReconciler reconciles a SkydiveSuite object
@@ -82,7 +83,7 @@ func (r *SkydiveSuiteReconciler) Reconcile(ctx context.Context, req ctrl.Request
 
 		err = kclient_instance.CreateOrUpdateDeployment(dep)
 		if err != nil {
-			return ctrl.Result{}, errors.Wrap(err, "Deployment creation has failed")
+			return ctrl.Result{}, errors.Wrap(err, "Skydive analyzer deployment creation has failed")
 		}
 
 		svc, err := kclient.NewService(assets.MustNewAssetReader(SkydiveAnalyzerService))
@@ -99,35 +100,63 @@ func (r *SkydiveSuiteReconciler) Reconcile(ctx context.Context, req ctrl.Request
 		if skydive_suite.Spec.Enable.Route {
 			route, err := kclient.NewRoute(assets.MustNewAssetReader(SkydiveAnalyzerRoute))
 			if err != nil {
-				return ctrl.Result{}, errors.Wrap(err, "initializing skydive-analyzer Route failed")
+				log.Error(err, "initializing skydive-analyzer Route failed")
 			}
 			route.Namespace = skydive_suite.Spec.Namespace
 
 			err = kclient_instance.CreateRouteIfNotExists(route)
 			if err != nil {
-				return ctrl.Result{}, errors.Wrap(err, "Route creation has failed")
+				log.Error(err, "Route creation has failed")
 			}
 
 			_, err = kclient_instance.WaitForRouteReady(route)
 			if err != nil {
-				return ctrl.Result{}, errors.Wrap(err, "waiting for Skydive Route to become ready failed")
+				log.Error(err, "waiting for Skydive Route to become ready failed")
 			}
 		}
 
 	}
 
 	// Creating skydive Agents
 	if skydive_suite.Spec.Enable.Agents {
-
 		ds, err := kclient.NewDaemonSet(assets.MustNewAssetReader(SkydiveAgentsDaemonSet))
 		if err != nil {
 			return ctrl.Result{}, errors.Wrap(err, "initializing skydive-agents DaemonSet failed")
 		}
 		ds.Namespace = skydive_suite.Spec.Namespace
-
+		for _, container := range ds.Spec.Template.Spec.Containers {
+			for _, env := range container.Env {
+				switch env.Name {
+				case "SKYDIVE_LOGGING_LEVEL":
+					env.Value = skydive_suite.Spec.Logging.Level
+				}
+			}
+		}
 		err = kclient_instance.CreateOrUpdateDaemonSet(ds)
 		if err != nil {
-			return ctrl.Result{}, errors.Wrap(err, "UI-Route creation has failed")
+			return ctrl.Result{}, errors.Wrap(err, "DaemonSet creation failed")
+		}
+	}
+
+	if skydive_suite.Spec.Enable.FlowExporter {
+		dep, err := kclient.NewDeployment(assets.MustNewAssetReader(SkydiveFlowExporter))
+		if err != nil {
+			log.Error(err, "initializing skydive flow-exporter Deployment failed")
+			return ctrl.Result{}, errors.Wrap(err, "initializing skydive flow-exporter Deployment failed")
+		}
+		dep.Namespace = skydive_suite.Spec.Namespace
+		for _, container := range dep.Spec.Template.Spec.Containers {
+			for _, env := range container.Env {
+				switch env.Name {
+				case "SKYDIVE_LOGGING_LEVEL":
+					env.Value = skydive_suite.Spec.Logging.Level
+				}
+			}
+		}
+
+		err = kclient_instance.CreateOrUpdateDeployment(dep)
+		if err != nil {
+			return ctrl.Result{}, errors.Wrap(err, "Flow exporter deployment creation has failed")
 		}
 	}
 

controllers/skydivesuite_controller.go

@@ -25,6 +25,13 @@ oc_set_credentials() {
   oc adm policy add-cluster-role-to-user cluster-reader -z default
 }
 
+oc_clear_skydivesuite_crd() {
+SKYDIVE_SUITE_CRD=$(oc get skydivesuite)
+if [ ! -z "$SKYDIVE_SUITE_CRD" ]; then
+  oc delete -f config/crd/bases
+fi
+}
+
 # deoploy skydive
 oc_deploy_skydive() {
   make manifests
@@ -35,10 +42,11 @@ oc_deploy_skydive() {
 
 # main
 main() {
-  echo "starting"
   oc_delete_skydive_project_if_exists
   oc_create_skydive_project
   oc_set_credentials
+  oc_clear_skydivesuite_crd
   oc_deploy_skydive
 }
+
 main

deploy_operator_on_openshift.sh

@@ -0,0 +1,45 @@
+<!-- ABOUT THE PROJECT -->
+
+# Running Skydive Operator on Kind cluster
+
+This is a simple deployment guide for the operator on a kind cluster
+
+<!-- GETTING STARTED -->
+
+## Getting Started
+
+To set up this operator on a kind follow the instructions below:
+
+### Prerequisites
+
+* Make sure you have golang installed on your machine, The go-lang version that this operator was built on is go1.15.7
+  darwin/amd64
+
+* Kind installed
+
+### Modyfing the CRD
+Modify the file config/skydive_v1_skydivesuite.yaml and pick what you wish to deploy (insert true or false in the relevant field), the options are as follows:
+* Skydive agents
+* Skydive analyzer
+    * Service route
+    * Flow exporter
+
+Choose your logging level (defaults to INFO)
+
+### Installation
+
+#### Kind
+Install kind on your machine, use [this](https://kind.sigs.k8s.io/docs/user/quick-start/) quick start guide for help, 
+make sure that your have a running kind cluster and that kubectl commands refer to relevant context.
+
+run the zsh script :
+```deploy_operator_on_kind.sh```
+
+#### Analyzer UI
+1. Check that all the pods and services are running and afterwards run the following command:
+
+  ```sh
+kubectl port-forward service/skydive-analyzer 8082:8082 --namespace=skydive
+  ```
+
+2. Now open browser on localhost:8082

hack/KindInstallationREADME.md

@@ -0,0 +1,43 @@
+# delete skydive project if it exists (to get new frech deployment)
+kubectl_delete_skydive_project_if_exists() {
+NAMESPACE_SKYDIVE=$(kubectl get namespace | grep skydive)
+if [ ! -z "$NAMESPACE_SKYDIVE" ]; then
+  kubectl delete namespace skydive
+  while : ; do
+    NAMESPACE_SKYDIVE=$(kubectl get project | grep skydive)
+    if [ -z "$PROJECT_SKYDIVE" ]; then break; fi
+    sleep 1
+  done
+fi
+}
+
+# create and switch context to skydive project
+kubectl_create_skydive_project() {
+  kubectl create namespace skydive
+}
+
+kubectl_clear_skydivesuite_crd() {
+SKYDIVE_SUITE_CRD=$(kubectl get skydivesuite)
+if [ ! -z "$SKYDIVE_SUITE_CRD" ]; then
+  kubectl delete -f ../config/crd/bases
+fi
+}
+
+# deoploy skydive
+kubectl_deploy_skydive() {
+  cd ..
+  make manifests
+  kubectl create -f config/crd/bases
+  kubectl create -f config/skydive_v1_skydivesuite.yaml
+  make run
+}
+
+# main
+main() {
+  kubectl_delete_skydive_project_if_exists
+  kubectl_create_skydive_project
+  kubectl_clear_skydivesuite_crd
+  kubectl_deploy_skydive
+}
+
+main