Merge pull request #53 from senthilrch/senthilrch

PR for v0.6.0

Author: senthilrch

.travis.yml

@@ -1,17 +1,17 @@
 language: go
 go:
-  - 1.13.5
+  - 1.13.8
 install:
   - go get golang.org/x/tools/cmd/cover
   - go get github.com/mattn/goveralls
   - go get -u golang.org/x/lint/golint
 script:
-- hack/verify-codegen.sh
-- hack/verify-boilerplate.sh
-- hack/verify-gofmt.sh
-- hack/verify-golint.sh
-- hack/verify-govet.sh
-- make fledged-image
-- make client-image
-- make test
-- $(go env GOPATH | awk 'BEGIN{FS=":"} {print $1}')/bin/goveralls -coverprofile=coverage.out -service=travis-ci
+  - hack/verify-codegen.sh
+  - hack/verify-boilerplate.sh
+  - hack/verify-gofmt.sh
+  - hack/verify-golint.sh
+  - hack/verify-govet.sh
+  - make fledged-dev
+  - make GIT_BRANCH=${TRAVIS_BRANCH} build-images
+  - make test
+  - $(go env GOPATH | awk 'BEGIN{FS=":"} {print $1}')/bin/goveralls -coverprofile=coverage.out -service=travis-ci

Makefile

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-.PHONY: clean clean-fledged clean-client fledged-image client-image push-images test deploy update remove
+.PHONY: clean clean-fledged clean-client clean-operator fledged-dev fledged-image client-image operator-image build-images push-images test deploy update remove
 # Default tag and architecture. Can be overridden
 TAG?=$(shell git describe --tags --dirty)
 ARCH?=amd64
@@ -23,30 +23,48 @@ else
 	CGO_ENABLED=0
 endif
 
-# Go version to use for builds
-GO_VERSION=1.11.1
+GOARM=7
 
-# K8s version used for Makefile helpers
-K8S_VERSION=v1.12.0
+ifndef FLEDGED_IMAGE_REPO
+  FLEDGED_IMAGE_REPO=docker.io/senthilrch/fledged
+endif
 
-GOARM=7
+ifndef FLEDGED_DOCKER_CLIENT_IMAGE_REPO
+  FLEDGED_DOCKER_CLIENT_IMAGE_REPO=docker.io/senthilrch/fledged-docker-client
+endif
 
-ifndef FLEDGED_IMAGE_NAME
-  FLEDGED_IMAGE_NAME=senthilrch/fledged:latest
+ifndef OPERATOR_IMAGE_REPO
+  OPERATOR_IMAGE_REPO=docker.io/senthilrch/kubefledged-operator
 endif
 
-ifndef FLEDGED_DOCKER_CLIENT_IMAGE_NAME
-  FLEDGED_DOCKER_CLIENT_IMAGE_NAME=senthilrch/fledged-docker-client:latest
+ifndef RELEASE_VERSION
+  RELEASE_VERSION=v0.6.0
 endif
 
 ifndef DOCKER_VERSION
-  DOCKER_VERSION=19.03.5
+  DOCKER_VERSION=19.03.7
 endif
 
 ifndef CRICTL_VERSION
   CRICTL_VERSION=v1.17.0
 endif
 
+ifndef GOLANG_VERSION
+  GOLANG_VERSION=1.13.8
+endif
+
+ifndef ALPINE_VERSION
+  ALPINE_VERSION=3.11
+endif
+
+ifndef OPERATORSDK_VERSION
+  OPERATORSDK_VERSION=v0.15.2
+endif
+
+ifndef GIT_BRANCH
+  GIT_BRANCH=master
+endif
+
 HTTP_PROXY_CONFIG=
 ifdef HTTP_PROXY
   HTTP_PROXY_CONFIG=--build-arg http_proxy=${HTTP_PROXY}
@@ -59,59 +77,71 @@ endif
 
 
 ### BUILDING
-clean: clean-fledged clean-client
+clean: clean-fledged clean-client clean-operator
 
 clean-fledged:
 	-rm -f build/fledged
-	-rm -f build/fledged.tar.gz
-	-docker image rm $(FLEDGED_IMAGE_NAME)
+	-docker image rm $(FLEDGED_IMAGE_REPO):$(RELEASE_VERSION)
 	-docker image rm `docker image ls -f dangling=true -q`
 
 clean-client:
-	-rm -f build/fledged-docker-client.tar.gz
-	-docker image rm $(FLEDGED_DOCKER_CLIENT_IMAGE_NAME)
+	-docker image rm $(FLEDGED_DOCKER_CLIENT_IMAGE_REPO):$(RELEASE_VERSION)
+	-docker image rm `docker image ls -f dangling=true -q`
+
+clean-operator:
+	-docker image rm $(OPERATOR_IMAGE_REPO):$(RELEASE_VERSION)
 	-docker image rm `docker image ls -f dangling=true -q`
 
-fledged:
-	CGO_ENABLED=0 go build -o build/fledged \
-	  -ldflags '-s -w -extldflags "-static"' cmd/fledged.go
+fledged-dev: clean-fledged
+	CGO_ENABLED=0 go build -o build/fledged -ldflags '-s -w -extldflags "-static"' cmd/fledged.go && \
+	cd build && docker build -t $(FLEDGED_IMAGE_REPO):$(RELEASE_VERSION) -f Dockerfile.fledged_dev \
+	--build-arg ALPINE_VERSION=${ALPINE_VERSION} .
 
-fledged-image: clean-fledged fledged
-	cd build && docker build -t $(FLEDGED_IMAGE_NAME) . && \
-	docker save -o fledged.tar $(FLEDGED_IMAGE_NAME) && \
-	gzip fledged.tar
+fledged-image: clean-fledged
+	cd build && docker build -t $(FLEDGED_IMAGE_REPO):$(RELEASE_VERSION) -f Dockerfile.fledged \
+	${HTTP_PROXY_CONFIG} ${HTTPS_PROXY_CONFIG} --build-arg GIT_BRANCH=${GIT_BRANCH} \
+	--build-arg GOLANG_VERSION=${GOLANG_VERSION} --build-arg ALPINE_VERSION=${ALPINE_VERSION} .
 
 client-image: clean-client
-	cd build && docker build -t $(FLEDGED_DOCKER_CLIENT_IMAGE_NAME) \
+	cd build && docker build -t $(FLEDGED_DOCKER_CLIENT_IMAGE_REPO):$(RELEASE_VERSION) \
 	-f Dockerfile.docker_client  ${HTTP_PROXY_CONFIG} ${HTTPS_PROXY_CONFIG} \
-	--build-arg DOCKER_VERSION=${DOCKER_VERSION} --build-arg CRICTL_VERSION=${CRICTL_VERSION} . && 	\
-	docker save -o fledged-docker-client.tar $(FLEDGED_DOCKER_CLIENT_IMAGE_NAME) && \
-	gzip fledged-docker-client.tar 
+	--build-arg DOCKER_VERSION=${DOCKER_VERSION} --build-arg CRICTL_VERSION=${CRICTL_VERSION} \
+	--build-arg ALPINE_VERSION=${ALPINE_VERSION} .
+
+operator-image: clean-operator
+	cd deploy/kubefledged-operator && \
+	docker build -t $(OPERATOR_IMAGE_REPO):$(RELEASE_VERSION) -f ./build/Dockerfile \
+	--build-arg OPERATORSDK_VERSION=${OPERATORSDK_VERSION} .
+
+build-images: fledged-image client-image operator-image
+
+push-images:
+	-docker push $(FLEDGED_IMAGE_REPO):$(RELEASE_VERSION)
+	-docker push $(FLEDGED_DOCKER_CLIENT_IMAGE_REPO):$(RELEASE_VERSION)
+	-docker push $(OPERATOR_IMAGE_REPO):$(RELEASE_VERSION)
 
-push-image:
-	-docker push $(FLEDGED_IMAGE_NAME)
-	-docker push $(FLEDGED_DOCKER_CLIENT_IMAGE_NAME)
+release: build-images push-images
 
 test:
 	-rm -f coverage.out
 	bash hack/run-unit-tests.sh
 
 deploy:
-	kubectl apply -f deploy/fledged-crd.yaml && sleep 2 && \
-	kubectl apply -f deploy/fledged-namespace.yaml && sleep 2 && \
-	kubectl apply -f deploy/fledged-serviceaccount.yaml && \
-	kubectl apply -f deploy/fledged-clusterrole.yaml && \
-	kubectl apply -f deploy/fledged-clusterrolebinding.yaml && \
-	kubectl apply -f deploy/fledged-deployment.yaml
+	kubectl apply -f deploy/kubefledged-crd.yaml && sleep 2 && \
+	kubectl apply -f deploy/kubefledged-namespace.yaml && sleep 2 && \
+	kubectl apply -f deploy/kubefledged-serviceaccount.yaml && \
+	kubectl apply -f deploy/kubefledged-clusterrole.yaml && \
+	kubectl apply -f deploy/kubefledged-clusterrolebinding.yaml && \
+	kubectl apply -f deploy/kubefledged-deployment.yaml
 
 update:
-	kubectl scale deployment fledged --replicas=0 -n kube-fledged && sleep 5 && \
-	kubectl scale deployment fledged --replicas=1 -n kube-fledged && sleep 5 && \
-	kubectl get pods -l app=fledged -n kube-fledged
+	kubectl scale deployment kubefledged --replicas=0 -n kube-fledged && sleep 5 && \
+	kubectl scale deployment kubefledged --replicas=1 -n kube-fledged && sleep 5 && \
+	kubectl get pods -l app=kubefledged -n kube-fledged
 
 remove:
-	kubectl delete -f deploy/fledged-namespace.yaml && \
-	kubectl delete -f deploy/fledged-clusterrolebinding.yaml && \
-	kubectl delete -f deploy/fledged-clusterrole.yaml && \
-	kubectl delete -f deploy/fledged-crd.yaml
+	kubectl delete -f deploy/kubefledged-namespace.yaml && \
+	kubectl delete -f deploy/kubefledged-clusterrolebinding.yaml && \
+	kubectl delete -f deploy/kubefledged-clusterrole.yaml && \
+	kubectl delete -f deploy/kubefledged-crd.yaml
 

README.md

@@ -1,4 +1,6 @@
-# kube-fledged
+<img src="logo.png">
+
+# 
 
 [![Build Status](https://travis-ci.org/senthilrch/kube-fledged.svg?branch=master)](https://travis-ci.org/senthilrch/kube-fledged)
 [![Coverage Status](https://coveralls.io/repos/github/senthilrch/kube-fledged/badge.svg?branch=master)](https://coveralls.io/github/senthilrch/kube-fledged?branch=master)
@@ -11,6 +13,34 @@ of images and onto which worker nodes those images should be cached (i.e. pre-pu
 
 _kube-fledged_ provides CRUD APIs to manage the lifecycle of the image cache, and supports several configurable parameters to customize the functioning as per one's needs. 
 
+## Table of contents
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+
+- [Use cases](#use-cases)
+- [Prerequisites](#prerequisites)
+- [Quick Install using YAML manifests](#quick-install-using-yaml-manifests)
+- [Quick Install using Helm operator](#quick-install-using-helm-operator)
+- [Build and Deploy](#build-and-deploy)
+  - [Build](#build)
+  - [Deploy](#deploy)
+- [How to use](#how-to-use)
+  - [Create image cache](#create-image-cache)
+  - [View the status of image cache](#view-the-status-of-image-cache)
+  - [Add/remove images in image cache](#addremove-images-in-image-cache)
+  - [Refresh image cache](#refresh-image-cache)
+  - [Delete image cache](#delete-image-cache)
+  - [Remove kube-fledged](#remove-kube-fledged)
+- [How it works](#how-it-works)
+- [Configuration Flags](#configuration-flags)
+- [Supported Platforms](#supported-platforms)
+- [Built With](#built-with)
+- [Contributing](#contributing)
+- [License](#license)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 ## Use cases
 
 - Applications that require rapid start-up. For e.g. an application performing real-time data processing needs to scale rapidly due to a burst in data volume.
@@ -25,9 +55,9 @@ _kube-fledged_ provides CRUD APIs to manage the lifecycle of the image cache, an
 - Supported container runtimes: docker, containerd, cri-o
 - git, make, go, docker and kubectl installed on a local linux machine. kubectl configured properly to access the cluster.
 
-## Quick Install
+## Quick Install using YAML manifests
 
-These instructions install _kube-fledged_ using pre-built images of the latest stable release in [Docker Hub.](https://hub.docker.com/u/senthilrch)
+These instructions install _kube-fledged_ to a separate namespace called "kube-fledged", using YAML manifests and pre-built images in [Docker Hub.](https://hub.docker.com/u/senthilrch)
 
 - Clone the source code repository
 
@@ -46,14 +76,57 @@ These instructions install _kube-fledged_ using pre-built images of the latest s
 - Verify if _kube-fledged_ deployed successfully
 
   ```
-  $ kubectl get pods -n kube-fledged -l app=fledged
+  $ kubectl get pods -n kube-fledged -l app=kubefledged
+  $ kubectl logs -f <pod_name_obtained_from_above_command> -n kube-fledged
+  $ kubectl get imagecaches -n kube-fledged (Output should be: 'No resources found')
+  ```
+
+## Quick Install using Helm operator
+
+These instructions install _kube-fledged_ to a separate namespace called "kube-fledged", using Helm operator and pre-built images in [Docker Hub.](https://hub.docker.com/u/senthilrch)
+
+- Clone the source code repository
+
+  ```
+  $ mkdir -p $HOME/src/github.com/senthilrch
+  $ git clone https://github.com/senthilrch/kube-fledged.git $HOME/src/github.com/senthilrch/kube-fledged
+  $ cd $HOME/src/github.com/senthilrch/kube-fledged
+  ```
+
+- Deploy the operator to a separate namespace called "operators"
+
+  ```
+  $ sed -i "s|OPERATOR_NAMESPACE|operators|g" deploy/kubefledged-operator/deploy/service_account.yaml
+  $ sed -i "s|OPERATOR_NAMESPACE|operators|g" deploy/kubefledged-operator/deploy/clusterrole_binding.yaml
+  $ sed -i "s|OPERATOR_NAMESPACE|operators|g" deploy/kubefledged-operator/deploy/operator.yaml
+  $ kubectl create namespace operators
+  $ kubectl create -f deploy/kubefledged-operator/deploy/crds/charts.helm.k8s.io_kubefledgeds_crd.yaml
+  $ kubectl create -f deploy/kubefledged-operator/deploy/service_account.yaml
+  $ kubectl create -f deploy/kubefledged-operator/deploy/clusterrole.yaml
+  $ kubectl create -f deploy/kubefledged-operator/deploy/clusterrole_binding.yaml
+  $ kubectl create -f deploy/kubefledged-operator/deploy/operator.yaml
+  ```
+
+- Deploy _kube-fledged_ to a separate namespace called "kube-fledged"
+
+  ```
+  $ sed -i "s|OPERATOR_NAMESPACE|operators|g" deploy/kubefledged-operator/deploy/crds/charts.helm.k8s.io_v1alpha1_kubefledged_cr.yaml
+  $ sed -i "s|KUBEFLEDGED_NAMESPACE|kube-fledged|g" deploy/kubefledged-operator/deploy/crds/charts.helm.k8s.io_v1alpha1_kubefledged_cr.yaml
+  $ kubectl create namespace kube-fledged
+  $ kubectl create -f deploy/kubefledged-operator/deploy/crds/charts.helm.k8s.io_v1alpha1_kubefledged_cr.yaml
+  ```
+
+- Verify if _kube-fledged_ deployed successfully
+
+  ```
+  $ kubectl get pods -n kube-fledged -l app.kubernetes.io/name=kubefledged
   $ kubectl logs -f <pod_name_obtained_from_above_command> -n kube-fledged
   $ kubectl get imagecaches -n kube-fledged (Output should be: 'No resources found')
   ```
 
 ## Build and Deploy
 
-These instructions will help you build _kube-fledged_ from source and deploy it on a kubernetes cluster.
+These instructions will help you build _kube-fledged_ from source and deploy it to a separate namespace called "kube-fledged". If you need to deploy it to a different namespace, edit the namespace field of the manifests in "kube-fledged/deploy" accordingly.
 
 ### Build
 
@@ -75,29 +148,29 @@ These instructions will help you build _kube-fledged_ from source and deploy it
 - Build and push the docker images to registry (e.g. Docker hub)
 
   ```
-  $ export FLEDGED_IMAGE_NAME=<your_docker_hub_username>/fledged:<your_tag>
-  $ export FLEDGED_DOCKER_CLIENT_IMAGE_NAME=<your_docker_hub_username>/fledged-docker-client:<your_tag>
-  $ export DOCKER_VERSION=<docker_version_used_for_building_docker_client_image>
+  $ export RELEASE_VERSION=<your_tag>
+  $ export FLEDGED_IMAGE_REPO=<your_docker_hub_username>/fledged
+  $ export FLEDGED_DOCKER_CLIENT_IMAGE_REPO=<your_docker_hub_username>/fledged-docker-client
   $ docker login -u <username> -p <password>
-  $ make fledged-image && make client-image && make push-image
+  $ make fledged-image && make client-image && make push-images
   ```
 
 ### Deploy
 
 _Note:- You need to have 'cluster-admin' privileges to deploy_
 
-- All manifests required for deploying _kube-fledged_ are present inside 'kube-fledged/deploy'. These steps deploy _kube-fledged_ into a separate namespace called "kube-fledged" with default configuration flags. Edit "fledged-deployment.yaml".
+- All manifests required for deploying _kube-fledged_ are present in 'kube-fledged/deploy' directory. Edit "kubefledged-deployment.yaml".
 
   Set "image" to "<your_docker_hub_username>/fledged:<your_tag>"
 
   ```
   image: <your_docker_hub_username>/fledged:<your_tag>
   ```
 
-- If you pushed the image to a private repository, add 'imagePullSecrets' to the end of "fledged-deployment.yaml". Refer to kubernetes documentation on [Specifying ImagePullSecrets on a Pod](https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod). The secret <your_registry_key> should be created in "kube-fledged" namespace.
+- If you pushed the image to a private repository, add 'imagePullSecrets' to the end of "kubefledged-deployment.yaml". Refer to kubernetes documentation on [Specifying ImagePullSecrets on a Pod](https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod). The secret <your_registry_key> should be created in "kube-fledged" namespace.
 
   ```
-  serviceAccountName: fledged
+  serviceAccountName: kubefledged
   imagePullSecrets:
     - name: <your_registry_key>
   ```
@@ -111,7 +184,7 @@ _Note:- You need to have 'cluster-admin' privileges to deploy_
 - Verify if _kube-fledged_ deployed successfully
 
   ```
-  $ kubectl get pods -n kube-fledged -l app=fledged
+  $ kubectl get pods -n kube-fledged -l app=kubefledged
   $ kubectl logs -f <pod_name_obtained_from_above_command> -n kube-fledged
   $ kubectl get imagecaches -n kube-fledged (Output should be: 'No resources found')
   ```
@@ -122,7 +195,7 @@ _kube-fledged_ provides APIs to perform CRUD operations on image cache.  These A
 
 ### Create image cache
 
-Refer to sample image cache manifest in "deploy/fledged-imagecache.yaml". Edit it as per your needs before creating image cache. If images are in private repositories requiring credentials to pull, add "imagePullSecrets" to the end.
+Refer to sample image cache manifest in "deploy/kubefledged-imagecache.yaml". Edit it as per your needs before creating image cache. If images are in private repositories requiring credentials to pull, add "imagePullSecrets" to the end.
 
 ```
   imagePullSecrets:
@@ -132,7 +205,7 @@ Refer to sample image cache manifest in "deploy/fledged-imagecache.yaml". Edit i
 Create the image cache using kubectl. Verify successful creation
 
 ```
-$ kubectl create -f deploy/fledged-imagecache.yaml
+$ kubectl create -f deploy/kubefledged-imagecache.yaml
 $ kubectl get imagecaches -n kube-fledged
 ```
 

build/Dockerfile.docker_client

@@ -12,7 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-FROM alpine:3.10
+ARG ALPINE_VERSION
+FROM alpine:$ALPINE_VERSION
 
 RUN apk add --no-cache bash curl openssh-client