Merge pull request #2 from citrix/git_cnc_v2

Git cnc v2

Author: janrajc

README.md

@@ -10,27 +10,26 @@
 
 # Citrix k8s node controller
 
-Citrix k8s node controller is deployed as a pod in Kubernetes cluster that provides a network between the Kubernetes cluster and the Ingress Citrix ADC.
-
->**Note:**
->Citrix k8s node controller currently works only with flannel as the Container Network Interface (CNI). The scope of Citrix node controller can be extended to other CNI.
+Citrix k8s node controller is a micro service provided by Citrix that creates network between the Kubernetes cluster and ingress device.
 
 ## Contents
 
-  + [Overview](#Overview)
-  + [Architecture](#Architecture)
-  + [How it works](#How-it-works)
-  + [Get started](#Get-started)
-  + [Questions](#Questions)
-  + [Issues](#Issues)
-  + [Code of conduct](#Code-of-conduct)
-  + [License](#License)
+  + [Overview](#overview)
+  + [Architecture](#architecture)
+  + [How it works](#how-it-works)
+  + [Get started](#get-started)
+    + [Using Citrix k8s node controller as a process](#using-citrix-k8s-node-controller-as-a-process)
+    + [Using Citrix k8s node controller as a microservice](#using-citrix-k8s-node-controller-as-a-microservice)
+  + [Questions](#questions)
+  + [Issues](#issues)
+  + [Code of conduct](#code-of-conduct)
+  + [License](#license)
 
 ## Overview
 
 In Kubernetes environments, when you expose the services for external access through the Ingress device, to route the traffic into the cluster, you need to appropriately configure the network between the Kubernetes nodes and the Ingress device. Configuring the network is challenging as the pods use private IP addresses based on the CNI framework. Without proper network configuration, the Ingress device cannot access these private IP addresses. Also, manually configuring the network to ensure such reachability is cumbersome in Kubernetes environments.
 
-Citrix k8s node controller is deployed as a pod in Kubernetes cluster that provides a network between the Kubernetes cluster and the Ingress Citrix ADC.
+Citrix provides a microservice called as **Citrix k8s node controller** that you can use to create the network between the cluster and the Ingress device.
 
 ## Architecture
 
@@ -48,47 +47,36 @@ The are the main components of the Citrix k8s node controller:
 	    This **K8s Interface** component interacts with the Kube API server through K8s Go client. It ensures the availability of the client and maintains a healthy client session.
        </details>
        <details>
-       <summary>**Node Watcher**</summary>
-	    The **Node Watcher** component monitors the node events through K8s interface. It responds to the node events such as node addition, deletion, or modification with its callback functions.
-       </details>
-       <details>
        <summary>**Input Feeder**</summary>
 	    The **Input Feeder** component provides inputs to the config decider. Some of the inputs are auto detected and the rest are taken from the Citrix k8s node controller deployment YAML file.
        </details>
        <details>
-       <summary>**Config Decider**</summary>
-	    The **Config Decider** component takes inputs from both the node watcher and the input feeder. Using the inputs it decides the best network automation required between the cluster and Citrix ADC.
-       </details>
-       <details>
        <summary>**Core**</summary>
 	    The **Core** component interacts with the node watcher and updates the corresponding config engine. It is responsible for starting the best config engine for the corresponding cluster.
        </details>
        <details>
        <summary>**Config Maps**</summary>
-	    The **Config Maps** component controls the Citrix k8s node controller.  It allows you to define the Citrix k8s node controller to automatically create, apply, and delete routing configuration on Citrix ADC.
+	    The **Config Maps** component controls the Citrix k8s node controller.  It allows you to define Citrix k8s node controller to automatically create, apply, and delete routing configuration on Citrix ADC.
        </details>
 
 ## How it works
 
-Citrix k8s node controller monitors the node events and establishes a route between the cluster nodes and Citrix ADC using VXLAN. Citrix k8s node controller adds a route on the Citrix ADC when a new node joins to the cluster. Similarly when a node leaves the cluster, Citrix k8s node controller removes the associated route from the Citrix ADC. Citrix k8s node controller uses VXLAN overlay between the Kubernetes cluster and Citrix ADC for service routing.
+Citrix k8s node controller monitors the node events and establishes a route between the node to Citrix ADC using VXLAN. Citrix k8s node controller adds route on the Citrix ADC when a new node joins to the cluster. Similarly when a node leaves the cluster, Citrix k8s node controller removes the associated route from the Citrix ADC. Citrix k8s node controller uses VXLAN overlay between the Kubernetes cluster and Citrix ADC for service routing.
 
 ## Get started
 
-Citrix k8s node controller can be used in the following two ways:
+You can run Citrix k8s node controller as:
 
--  **Inside the cluster** - In this configuration, the Citrix k8s node controller is run as **pod**.
--  **Outside the cluster** - In this configuration, the Citrix k8s node controller is run as a **process**.
+-  A **microservice** inside the Kubernetes cluser.
+-  A **process** outside the Kubernetes cluster.
 
 >**Important:**
->Citrix recommends that you use **Inside the cluster** configuration for production. And, use the **Outside the cluster** configuration for development environments.
-
-### Using Citrix k8s node controller as a pod
-
-Refer the [deployment](deploy/README.md) page for running Citrix k8s node controller as a pod inside the Kubernetes cluster.
+>
+>Citrix recommends that you use Citrix k8s node controller as a **microservice** for production environments. And, as a **process** for easy development.
   
 ### Using Citrix k8s node controller as a process
 
-Before you deploy the citrix-k8s-node-controller package, ensure that you have installed [Go package](https://golang.org/doc/).
+Before you deploy the citrix-k8s-node-controller` package, ensure that you have installed Go binary for running MIC.
 
 Perform the following:
 
@@ -100,7 +88,11 @@ Perform the following:
 
 1.  Deploy the config map using the following command:
 
-        kubectl apply -f https://raw.githubusercontent.com/citrix/citrix-k8s-node-controller/master/deploy/config_map.yaml
+        kubectl apply -f https://raw.githubusercontent.com/janraj/citrix-k8s-node-controller/master/deploy/config_map.yaml
+
+### Using Citrix k8s node controller as a microservice
+
+Refer the [deployment](deploy/README.md) page for running Citrix k8s node controller as a microservice inside the Kubernetes cluster.
 
 ## Questions
 

build/Dockerfile

@@ -1,19 +1,13 @@
 FROM golang:alpine AS builder
-#RUN apk update && apk add --no-cache git
-WORKDIR $GOPATH/src/
-COPY cmd/citrix-node-controller/k8sInterface.go .
-COPY cmd/citrix-node-controller/netScalerInterface.go .
-COPY cmd/citrix-node-controller/inputFeeder.go .
-COPY cmd/citrix-node-controller/flannel.go .
-COPY cmd/citrix-node-controller/server.go .
-COPY cmd/citrix-node-controller/main.go .
-COPY version/VERSION .
-COPY vendor .
-#RUN go get -d -v 
-RUN go build -o /go/bin/citrix-node-controller
+WORKDIR $GOPATH/src/citrix-node-controller-v2/
+COPY cmd/ cmd
+COPY version/ version
+COPY vendor/ vendor
+RUN go build -o /go/bin/citrix-node-controller ./cmd/citrix-node-controller/ 
 
-FROM alpine
-COPY --from=builder /go/bin/citrix-node-controller  /go/bin/citrix-node-controller 
-EXPOSE 8080
-ENTRYPOINT ["/go/bin/citrix-node-controller"]
+FROM quay.io/chorus/chorus-kube-router:1.8.0
+COPY --from=builder /go/bin/citrix-node-controller  /go/bin/citrix-node-controller
+COPY build/start.sh /go/bin/start.sh
+RUN ["chmod", "+x", "/go/bin/start.sh"]
+ENTRYPOINT ["sh", "/go/bin/start.sh"]
 

build/Makefile

@@ -1,5 +1,5 @@
 OWNER=Janrajc
-IMAGE_NAME=citrix-k8s-node-controller
+IMAGE_NAME=citrix-k8s-node-controller-v2
 VERSION_FILE="../version/VERSION"
 version=1.0.0
 error=0.0.0
@@ -28,5 +28,5 @@ publish:
 
 clean:
 	docker rmi -f $$(docker images -q -f dangling=true) || true
-	docker rmi -f $$(docker images | awk '$$1 ~ /citrix-k8s-node-controller/ { print $$3}') || true
+	docker rmi -f $$(docker images | awk '$$1 ~ /citrix-k8s-node-controller-v2/ { print $$3}') || true
 

build/gitpush.sh

@@ -53,9 +53,7 @@ git_push() {
 push_image() {
   echo 'publish latest and $(version) to ${DOCKER_REGISTRY}'
   echo "${QUAY_PASSWORD}" | docker login -u "${QUAY_USERNAME}" --password-stdin  quay.io
-  docker tag  ${IMAGE_NAME}:latest ${DOCKER_REGISTRY}/${IMAGE_NAME}:latest
   docker tag  ${IMAGE_NAME}:latest ${DOCKER_REGISTRY}/${IMAGE_NAME}:${version}
-  docker push ${DOCKER_REGISTRY}/${IMAGE_NAME}:latest
   docker push ${DOCKER_REGISTRY}/${IMAGE_NAME}:${version}
 }
 

build/start.sh

@@ -0,0 +1,32 @@
+#!/bin/sh
+
+# Start Kubernetes Route extender
+./go/bin/kube-chorus-router -D &
+status=$?
+if [ $status -ne 0 ]; then
+  echo "Failed to start Route Extender: $status"
+  exit $status
+fi
+
+# Start the citrix node controller
+./go/bin/citrix-node-controller -D &
+status=$?
+if [ $status -ne 0 ]; then
+  echo "Failed to start citrix Node Controller: $status"
+  exit $status
+fi
+
+
+while /bin/true; do
+  ps aux |grep kube-chorus-router |grep -q -v grep
+  PROCESS_1_STATUS=$?
+  ps aux |grep citrix-node-controller |grep -q -v grep
+  PROCESS_2_STATUS=$?
+  # If the greps above find anything, they will exit with 0 status
+  # If they are not both 0, then something is wrong
+  if [ $PROCESS_1_STATUS -ne 0 -o $PROCESS_2_STATUS -ne 0 ]; then
+    echo "One of the processes has already exited."
+    exit -1
+  fi
+  sleep 60
+done