Add memcached-operator demo

memcached-operator/.gitignore

@@ -0,0 +1,77 @@
+# Temporary Build Files
+build/_output
+build/_test
+# Created by https://www.gitignore.io/api/go,vim,emacs,visualstudiocode
+### Emacs ###
+# -*- mode: gitignore; -*-
+*~
+\#*\#
+/.emacs.desktop
+/.emacs.desktop.lock
+*.elc
+auto-save-list
+tramp
+.\#*
+# Org-mode
+.org-id-locations
+*_archive
+# flymake-mode
+*_flymake.*
+# eshell files
+/eshell/history
+/eshell/lastdir
+# elpa packages
+/elpa/
+# reftex files
+*.rel
+# AUCTeX auto folder
+/auto/
+# cask packages
+.cask/
+dist/
+# Flycheck
+flycheck_*.el
+# server auth directory
+/server/
+# projectiles files
+.projectile
+projectile-bookmarks.eld
+# directory configuration
+.dir-locals.el
+# saveplace
+places
+# url cache
+url/cache/
+# cedet
+ede-projects.el
+# smex
+smex-items
+# company-statistics
+company-statistics-cache.el
+# anaconda-mode
+anaconda-mode/
+### Go ###
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+# Test binary, build with 'go test -c'
+*.test
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+### Vim ###
+# swap
+.sw[a-p]
+.*.sw[a-p]
+# session
+Session.vim
+# temporary
+.netrwhist
+# auto-generated tag files
+tags
+### VisualStudioCode ###
+.vscode/*
+.history
+# End of https://www.gitignore.io/api/go,vim,emacs,visualstudiocode

memcached-operator/Makefile

@@ -0,0 +1,21 @@
+.PHONY: install image
+
+IMG ?= memcached-operator
+TAG ?= demo
+REPO_URL ?= https://github.com/99cloud/lab-openshift
+BRANCH ?= master
+COMMIT_REF ?= $(shell git show-ref --heads -s)
+OPERATOR_RELEASE_VERSION ?= v0.12.0
+
+export GO111MODULE=on
+export GOPROXY=https://goproxy.io
+
+install:
+	- curl -LO https://github.com/operator-framework/operator-sdk/releases/download/${OPERATOR_RELEASE_VERSION}/operator-sdk-${OPERATOR_RELEASE_VERSION}-x86_64-linux-gnu
+	- chmod +x operator-sdk-${OPERATOR_RELEASE_VERSION}-x86_64-linux-gnu 
+	- sudo mkdir -p /usr/local/bin/ 
+	- sudo cp operator-sdk-${OPERATOR_RELEASE_VERSION}-x86_64-linux-gnu /usr/local/bin/operator-sdk 
+	- rm operator-sdk-${OPERATOR_RELEASE_VERSION}-x86_64-linux-gnu
+
+image:
+	- operator-sdk build --image-build-args "--build-arg REPO_URL=$(REPO_URL) --build-arg  BRANCH=$(BRANCH) --build-arg COMMIT_REF=$(COMMIT_REF)" $(IMG):$(TAG)

memcached-operator/README.md

@@ -0,0 +1,85 @@
+# Memcached Operator
+
+## Prerequisites
+
+- git
+- go version v1.12+
+- docker version 17.03+
+
+## Build and run the Operator
+
+> Before running the operator, The CRD must be register with apiserver
+
+    oc create -f deploy/crds/cache.example.com_memcacheds_crd.yaml
+1. Clone repo and build image
+
+        $ git clone https://github.com/99cloud/lab-openshift.git
+        $ cd lab-openshift/memcached-operator
+        $ make install
+        $ make image
+1. Run as Deployment inside the cluster
+
+        $ oc create -f deploy/service_account.yaml
+        $ oc create -f deploy/cluster_role.yaml
+        $ oc create -f deploy/cluster_role_binding.yaml
+    **Note**: To apply the RBAC you need to logged in `system:admin`
+1. Verify that the `memcached-operator` Deployment is up and runing
+
+        oc get deployment memcached-operator
+        NAME                 DESIRED   CURRENT   UP-TO-DATE   AVAILABLE   AGE
+        memcached-operator   1         1         1            1           4h
+1. Verify that the `memcached-operator` pod is up and running:
+
+        oc get pod -l name=memcached-operator
+        NAME                                  READY     STATUS    RESTARTS   AGE
+        memcached-operator-8646699d79-6pnz2   1/1       Running   0          2h
+
+## Create a Memcached CR
+
+1. Create the example Memcached CR that was generated at `deploy/crds/cache.example.com_v1alpha1_memcached_cr.yaml`:
+
+        $ cat deploy/crds/cache.example.com_v1alpha1_memcached_cr.yaml
+        apiVersion: cache.example.com/v1alpha1
+        kind: Memcached
+        metadata:
+          name: example-memcached
+        spec:
+          # Add fields here
+          size: 3
+          image: memcached:1.4.36-alpine
+
+        $ oc apply -f deploy/crds/cache.example.com_v1alpha1_memcached_cr.yaml
+1. Ensure that the memcached-operator creates the deployment for the CR
+
+        $ oc get deployment
+        NAME                     DESIRED   CURRENT   UP-TO-DATE   AVAILABLE   AGE
+        memcached-operator       1         1         1            1           2m
+        example-memcached        3         3         3            3           1m
+1. Check the pods and CR status to confirm the status is updated with the memcached pod names:
+
+        $ oc get pods
+        NAME                                  READY     STATUS    RESTARTS   AGE
+        example-memcached-6fd7c98d8-7dqdr     1/1       Running   0          1m
+        example-memcached-6fd7c98d8-g5k7v     1/1       Running   0          1m
+        example-memcached-6fd7c98d8-m7vn7     1/1       Running   0          1m
+        memcached-operator-7cc7cfdf86-vvjqk   1/1       Running   0          2m
+
+        $ oc get memcached example-memcached -o yaml
+        apiVersion: cache.example.com/v1alpha1
+        kind: Memcached
+        metadata:
+          creationTimestamp: 2019-11-06T02:38:35Z
+          generation: 1
+          name: example-memcached
+          namespace: "123"
+          resourceVersion: "8303746"
+          selfLink: /apis/cache.example.com/v1alpha1/namespaces/123/memcacheds/example-memcached
+          uid: 88081d77-003e-11ea-b754-00163e10e25b
+        spec:
+          image: memcached:1.4.36-alpine
+          size: 3
+        status:
+          nodes:
+          - example-memcached-75cf67cd7b-45tf4
+          - example-memcached-75cf67cd7b-7z6sh
+          - example-memcached-75cf67cd7b-ppxx7

memcached-operator/build/Dockerfile

@@ -0,0 +1,19 @@
+FROM alpine:latest
+
+ARG REPO_URL
+ARG BRANCH
+ARG COMMIT_REF
+
+ENV OPERATOR=/usr/local/bin/memcached-operator \
+    USER_UID=1001 \
+    USER_NAME=memcached-operator
+
+# install operator binary
+COPY build/_output/bin/memcached-operator ${OPERATOR}
+
+COPY build/bin /usr/local/bin
+RUN  /usr/local/bin/user_setup
+
+ENTRYPOINT ["/usr/local/bin/entrypoint"]
+
+USER ${USER_UID}

memcached-operator/cmd/manager/main.go

@@ -0,0 +1,175 @@
+package main
+
+import (
+	"context"
+	"flag"
+	"fmt"
+	"os"
+	"runtime"
+
+	// Import all Kubernetes client auth plugins (e.g. Azure, GCP, OIDC, etc.)
+	_ "k8s.io/client-go/plugin/pkg/client/auth"
+	"k8s.io/client-go/rest"
+
+	"github.com/example-inc/memcached-operator/pkg/apis"
+	"github.com/example-inc/memcached-operator/pkg/controller"
+
+	"github.com/operator-framework/operator-sdk/pkg/k8sutil"
+	kubemetrics "github.com/operator-framework/operator-sdk/pkg/kube-metrics"
+	"github.com/operator-framework/operator-sdk/pkg/leader"
+	"github.com/operator-framework/operator-sdk/pkg/log/zap"
+	"github.com/operator-framework/operator-sdk/pkg/metrics"
+	"github.com/operator-framework/operator-sdk/pkg/restmapper"
+	sdkVersion "github.com/operator-framework/operator-sdk/version"
+	"github.com/spf13/pflag"
+	v1 "k8s.io/api/core/v1"
+	"k8s.io/apimachinery/pkg/util/intstr"
+	"sigs.k8s.io/controller-runtime/pkg/client/config"
+	logf "sigs.k8s.io/controller-runtime/pkg/log"
+	"sigs.k8s.io/controller-runtime/pkg/manager"
+	"sigs.k8s.io/controller-runtime/pkg/manager/signals"
+)
+
+// Change below variables to serve metrics on different host or port.
+var (
+	metricsHost               = "0.0.0.0"
+	metricsPort         int32 = 8383
+	operatorMetricsPort int32 = 8686
+)
+var log = logf.Log.WithName("cmd")
+
+func printVersion() {
+	log.Info(fmt.Sprintf("Go Version: %s", runtime.Version()))
+	log.Info(fmt.Sprintf("Go OS/Arch: %s/%s", runtime.GOOS, runtime.GOARCH))
+	log.Info(fmt.Sprintf("Version of operator-sdk: %v", sdkVersion.Version))
+}
+
+func main() {
+	// Add the zap logger flag set to the CLI. The flag set must
+	// be added before calling pflag.Parse().
+	pflag.CommandLine.AddFlagSet(zap.FlagSet())
+
+	// Add flags registered by imported packages (e.g. glog and
+	// controller-runtime)
+	pflag.CommandLine.AddGoFlagSet(flag.CommandLine)
+
+	pflag.Parse()
+
+	// Use a zap logr.Logger implementation. If none of the zap
+	// flags are configured (or if the zap flag set is not being
+	// used), this defaults to a production zap logger.
+	//
+	// The logger instantiated here can be changed to any logger
+	// implementing the logr.Logger interface. This logger will
+	// be propagated through the whole operator, generating
+	// uniform and structured logs.
+	logf.SetLogger(zap.Logger())
+
+	printVersion()
+
+	namespace, err := k8sutil.GetWatchNamespace()
+	if err != nil {
+		log.Error(err, "Failed to get watch namespace")
+		os.Exit(1)
+	}
+
+	// Get a config to talk to the apiserver
+	cfg, err := config.GetConfig()
+	if err != nil {
+		log.Error(err, "")
+		os.Exit(1)
+	}
+
+	ctx := context.TODO()
+	// Become the leader before proceeding
+	err = leader.Become(ctx, "memcached-operator-lock")
+	if err != nil {
+		log.Error(err, "")
+		os.Exit(1)
+	}
+
+	// Create a new Cmd to provide shared dependencies and start components
+	mgr, err := manager.New(cfg, manager.Options{
+		Namespace:          namespace,
+		MapperProvider:     restmapper.NewDynamicRESTMapper,
+		MetricsBindAddress: fmt.Sprintf("%s:%d", metricsHost, metricsPort),
+	})
+	if err != nil {
+		log.Error(err, "")
+		os.Exit(1)
+	}
+
+	log.Info("Registering Components.")
+
+	// Setup Scheme for all resources
+	if err := apis.AddToScheme(mgr.GetScheme()); err != nil {
+		log.Error(err, "")
+		os.Exit(1)
+	}
+
+	// Setup all Controllers
+	if err := controller.AddToManager(mgr); err != nil {
+		log.Error(err, "")
+		os.Exit(1)
+	}
+
+	if err = serveCRMetrics(cfg); err != nil {
+		log.Info("Could not generate and serve custom resource metrics", "error", err.Error())
+	}
+
+	// Add to the below struct any other metrics ports you want to expose.
+	servicePorts := []v1.ServicePort{
+		{Port: metricsPort, Name: metrics.OperatorPortName, Protocol: v1.ProtocolTCP, TargetPort: intstr.IntOrString{Type: intstr.Int, IntVal: metricsPort}},
+		{Port: operatorMetricsPort, Name: metrics.CRPortName, Protocol: v1.ProtocolTCP, TargetPort: intstr.IntOrString{Type: intstr.Int, IntVal: operatorMetricsPort}},
+	}
+	// Create Service object to expose the metrics port(s).
+	service, err := metrics.CreateMetricsService(ctx, cfg, servicePorts)
+	if err != nil {
+		log.Info("Could not create metrics Service", "error", err.Error())
+	}
+
+	// CreateServiceMonitors will automatically create the prometheus-operator ServiceMonitor resources
+	// necessary to configure Prometheus to scrape metrics from this operator.
+	services := []*v1.Service{service}
+	_, err = metrics.CreateServiceMonitors(cfg, namespace, services)
+	if err != nil {
+		log.Info("Could not create ServiceMonitor object", "error", err.Error())
+		// If this operator is deployed to a cluster without the prometheus-operator running, it will return
+		// ErrServiceMonitorNotPresent, which can be used to safely skip ServiceMonitor creation.
+		if err == metrics.ErrServiceMonitorNotPresent {
+			log.Info("Install prometheus-operator in your cluster to create ServiceMonitor objects", "error", err.Error())
+		}
+	}
+
+	log.Info("Starting the Cmd.")
+
+	// Start the Cmd
+	if err := mgr.Start(signals.SetupSignalHandler()); err != nil {
+		log.Error(err, "Manager exited non-zero")
+		os.Exit(1)
+	}
+}
+
+// serveCRMetrics gets the Operator/CustomResource GVKs and generates metrics based on those types.
+// It serves those metrics on "http://metricsHost:operatorMetricsPort".
+func serveCRMetrics(cfg *rest.Config) error {
+	// Below function returns filtered operator/CustomResource specific GVKs.
+	// For more control override the below GVK list with your own custom logic.
+	filteredGVK, err := k8sutil.GetGVKsFromAddToScheme(apis.AddToScheme)
+	if err != nil {
+		return err
+	}
+	// Get the namespace the operator is currently deployed in.
+	operatorNs, err := k8sutil.GetOperatorNamespace()
+	if err != nil {
+		return err
+	}
+	// To generate metrics in other namespaces, add the values below.
+	ns := []string{operatorNs}
+	// Generate and serve custom resource specific metrics.
+	err = kubemetrics.GenerateAndServeCRMetrics(cfg, ns, filteredGVK, metricsHost, operatorMetricsPort)
+	if err != nil {
+		return err
+	}
+	return nil
+}