Merge branch 'master' into incluster-test

Author: AlexNPavel

MAINTAINERS

@@ -1,13 +1,14 @@
 # This is the official list of operator-sdk maintainers.
 #
 # Names should be added to this file like so:
-#     Individual's name <submission email address> (@GITHUB_HANDLE) pkg:*
-#     Individual's name <submission email address> <email2> <emailN> (@GITHUB_HANDLE) pkg:*
-#
-# Please keep the list sorted.
+#     Individual's name <submission email address> (@GITHUB_HANDLE)
+#     Individual's name <submission email address> <email2> <emailN> (@GITHUB_HANDLE)
 
-Fanmin Shi <[email protected]> <[email protected]> (@fanminshi) pkg:*
-Haseeb Tariq <[email protected]> <[email protected]> (@hasbro17) pkg:*
-Sebastien Pahl <[email protected]> (@spahl) pkg:*
-Verónica López <[email protected]> (@Verolop) pkg:*
-Rithu Leena John <[email protected]> (@rithujohn191) pkg:*
+Fanmin Shi <[email protected]> (@fanminshi)
+Haseeb Tariq <[email protected]> (@hasbro17)
+Sebastien Pahl <[email protected]> (@spahl)
+Rithu Leena John <[email protected]> (@rithujohn191)
+Alexander Pavel <[email protected]> (@AlexNPavel)
+Eric Stroczynski <[email protected]> (@estroz)
+Shawn Hurley <[email protected]> (@shawn-hurley)
+Lili Cosic <[email protected]> (@LiliC)

README.md

@@ -57,6 +57,7 @@ Create and deploy an app-operator using the SDK CLI:
 
 ```sh
 # Create an app-operator project that defines the App CR.
+$ mkdir -p $GOPATH/src/github.com/example-inc/
 $ cd $GOPATH/src/github.com/example-inc/
 $ operator-sdk new app-operator --api-version=app.example.com/v1alpha1 --kind=App
 $ cd app-operator
@@ -69,6 +70,7 @@ $ docker push quay.io/example/app-operator
 $ sed -i 's|REPLACE_IMAGE|quay.io/example/app-operator|g' deploy/operator.yaml
 
 # Deploy the app-operator
+$ kubectl create -f deploy/sa.yaml
 $ kubectl create -f deploy/rbac.yaml
 $ kubectl create -f deploy/crd.yaml
 $ kubectl create -f deploy/operator.yaml
@@ -86,6 +88,7 @@ $ kubectl delete -f deploy/cr.yaml
 $ kubectl delete -f deploy/crd.yaml
 $ kubectl delete -f deploy/operator.yaml
 $ kubectl delete -f deploy/rbac.yaml
+$ kubectl delete -f deploy/sa.yaml
 ```
 
 ## User Guide

commands/operator-sdk/cmd/test/local.go

@@ -58,10 +58,14 @@ func testLocalFunc(cmd *cobra.Command, args []string) {
 	if len(args) != 1 {
 		cmdError.ExitWithError(cmdError.ExitBadArgs, fmt.Errorf("operator-sdk test local requires exactly 1 argument"))
 	}
-	// if no namespaced manifest path is given, combine deploy/rbac.yaml and deploy/operator.yaml
+	// if no namespaced manifest path is given, combine deploy/sa.yaml, deploy/rbac.yaml and deploy/operator.yaml
 	if namespacedManifestPath == "" {
 		os.Mkdir("deploy/test", os.FileMode(int(0775)))
 		namespacedManifestPath = "deploy/test/namespace-manifests.yaml"
+		sa, err := ioutil.ReadFile("deploy/sa.yaml")
+		if err != nil {
+			log.Fatalf("could not find sa manifest: %v", err)
+		}
 		rbac, err := ioutil.ReadFile("deploy/rbac.yaml")
 		if err != nil {
 			log.Fatalf("could not find rbac manifest: %v", err)
@@ -70,7 +74,9 @@ func testLocalFunc(cmd *cobra.Command, args []string) {
 		if err != nil {
 			log.Fatalf("could not find operator manifest: %v", err)
 		}
-		combined := append(rbac, []byte("\n---\n")...)
+		combined := append(sa, []byte("\n---\n")...)
+		combined = append(combined, rbac...)
+		combined = append(combined, []byte("\n---\n")...)
 		combined = append(combined, operator...)
 		err = ioutil.WriteFile(namespacedManifestPath, combined, os.FileMode(int(0664)))
 		if err != nil {

doc/user-guide.md

@@ -140,6 +140,7 @@ Kubernetes deployment manifests are generated in `deploy/operator.yaml`. The dep
 Deploy the memcached-operator:
 
 ```sh
+$ kubectl create -f deploy/sa.yaml
 $ kubectl create -f deploy/rbac.yaml
 $ kubectl create -f deploy/operator.yaml
 ```
@@ -265,6 +266,44 @@ $ kubectl delete -f deploy/cr.yaml
 $ kubectl delete -f deploy/operator.yaml
 ```
 
+
+## Advanced Topics
+### Adding 3rd Party Resources To Your Operator
+To add a resource to an operator, you must add it to a scheme. By creating an `AddToScheme` method or reusing one you can easily add a resource to your scheme. An [example][deployments_register] shows that you define a function and then use the [runtime][runtime_package] package to create a `SchemeBuilder`
+
+#### Current Operator-SDK
+You then need to tell the operators to use these functions to add the resources to its scheme. In operator-sdk you use [AddToSDKScheme][osdk_add_to_scheme] to add this.
+Example of you main.go:
+```go
+import (
+    ....
+    appsv1 "k8s.io/api/apps/v1"
+)
+
+func main() {
+    k8sutil.AddToSDKScheme(appsv1.AddToScheme)`
+    sdk.Watch(appsv1.SchemeGroupVersion.String(), "Deployments", <namespace>, <resyncPeriod>)
+}
+```
+
+#### Future with Controller Runtime
+When using controller runtime, you will also need to tell its scheme about your resourece. In controller runtime to add to the scheme, you can get the managers [scheme][manager_scheme].  If you would like to see what kubebuilder generates to add the resoureces to the [scheme][simple_resource].
+Example:
+```go
+import (
+    ....
+    appsv1 "k8s.io/api/apps/v1"
+)
+
+func main() {
+    ....
+    if err := appsv1.AddToScheme(mgr.GetScheme()); err != nil {
+        log.Fatal(err)
+    }
+    ....
+}
+```
+
 [memcached_handler]: ../example/memcached-operator/handler.go.tmpl
 [layout_doc]:./project_layout.md
 [dep_tool]:https://golang.github.io/dep/docs/installation.html
@@ -273,3 +312,8 @@ $ kubectl delete -f deploy/operator.yaml
 [docker_tool]:https://docs.docker.com/install/
 [kubectl_tool]:https://kubernetes.io/docs/tasks/tools/install-kubectl/
 [minikube_tool]:https://github.com/kubernetes/minikube#installation
+[manager_scheme]: https://github.com/kubernetes-sigs/controller-runtime/blob/master/pkg/manager/manager.go#L61
+[simple_resource]: https://book.kubebuilder.io/basics/simple_resource.html
+[deployments_register]: https://github.com/kubernetes/api/blob/master/apps/v1/register.go#L41
+[runtime_package]: https://godoc.org/k8s.io/apimachinery/pkg/runtime
+[osdk_add_to_scheme]: https://github.com/operator-framework/operator-sdk/blob/4179b6ac459b2b0cb04ab3a1b438c280bd28d1a5/pkg/util/k8sutil/k8sutil.go#L67

pkg/generator/generator.go

@@ -63,6 +63,7 @@ const (
 	config             = "config.yaml"
 	rbacYaml           = "rbac.yaml"
 	crYaml             = "cr.yaml"
+	saYaml             = "sa.yaml"
 	catalogPackageYaml = "package.yaml"
 	catalogCSVYaml     = "csv.yaml"
 	crdYaml            = "crd.yaml"
@@ -80,6 +81,7 @@ const (
 	rbacTmplName       = "deploy/rbac.yaml"
 	crTmplName         = "deploy/cr.yaml"
 	testYamlName       = "deploy/test-pod.yaml"
+	saTmplName         = "deploy/sa.yaml"
 	pluralSuffix       = "s"
 )
 
@@ -240,6 +242,13 @@ func renderDeployFiles(deployDir, projectName, apiVersion, kind string) error {
 		return err
 	}
 
+	saTd := tmplData{
+		ProjectName: projectName,
+	}
+	if err := renderWriteFile(filepath.Join(deployDir, saYaml), saTmplName, saYamlTmpl, saTd); err != nil {
+		return err
+	}
+
 	opTd := tmplData{
 		ProjectName:     projectName,
 		Image:           "REPLACE_IMAGE",

pkg/generator/generator_test.go

@@ -199,6 +199,7 @@ spec:
       labels:
         name: app-operator
     spec:
+      serviceAccountName: app-operator
       containers:
         - name: app-operator
           image: quay.io/example-inc/app-operator:0.0.1
@@ -255,16 +256,22 @@ rules:
 kind: RoleBinding
 apiVersion: rbac.authorization.k8s.io/v1beta1
 metadata:
-  name: default-account-app-operator
+  name: app-operator
 subjects:
 - kind: ServiceAccount
-  name: default
+  name: app-operator
 roleRef:
   kind: Role
   name: app-operator
   apiGroup: rbac.authorization.k8s.io
 `
 
+const saYamlExp = `apiVersion: v1
+kind: ServiceAccount
+metadata:
+  name: app-operator
+`
+
 func TestGenDeploy(t *testing.T) {
 	buf := &bytes.Buffer{}
 	crdTd := tmplData{
@@ -309,6 +316,16 @@ func TestGenDeploy(t *testing.T) {
 		diffs := dmp.DiffMain(rbacYamlExp, buf.String(), false)
 		t.Errorf("\nTest failed. Below is the diff of the expected vs actual results.\nRed text is missing and green text is extra.\n\n" + dmp.DiffPrettyText(diffs))
 	}
+
+	buf = &bytes.Buffer{}
+	if err := renderFile(buf, saTmplName, saYamlTmpl, tmplData{ProjectName: appProjectName}); err != nil {
+		t.Error(err)
+	}
+	if saYamlExp != buf.String() {
+		dmp := diffmatchpatch.New()
+		diffs := dmp.DiffMain(saYamlExp, buf.String(), false)
+		t.Errorf("\nTest failed. Below is the diff of the expected vs actual results.\nRed text is missing and green text is extra.\n\n" + dmp.DiffPrettyText(diffs))
+	}
 }
 
 const registerExp = `package v1alpha1

pkg/generator/templates.go

@@ -459,6 +459,7 @@ spec:
       labels:
         name: {{.ProjectName}}
     spec:
+      serviceAccountName: {{.ProjectName}}
       containers:
         - name: {{.ProjectName}}
           image: {{.Image}}
@@ -515,16 +516,22 @@ rules:
 kind: RoleBinding
 apiVersion: rbac.authorization.k8s.io/v1beta1
 metadata:
-  name: default-account-{{.ProjectName}}
+  name: {{.ProjectName}}
 subjects:
 - kind: ServiceAccount
-  name: default
+  name: {{.ProjectName}}
 roleRef:
   kind: Role
   name: {{.ProjectName}}
   apiGroup: rbac.authorization.k8s.io
 `
 
+const saYamlTmpl = `apiVersion: v1
+kind: ServiceAccount
+metadata:
+  name: {{.ProjectName}}
+`
+
 const crYamlTmpl = `apiVersion: "{{.APIVersion}}"
 kind: "{{.Kind}}"
 metadata:

test/e2e/memcached_test.go

@@ -273,6 +273,17 @@ func MemcachedCluster(t *testing.T) {
 		}
 	}
 
+	// create sa
+	saYAML, err := ioutil.ReadFile("deploy/sa.yaml")
+	if err != nil {
+		t.Fatal(err)
+	}
+	err = ctx.CreateFromYAML(saYAML)
+	if err != nil {
+		t.Fatal(err)
+	}
+	t.Log("Created sa")
+
 	// create rbac
 	rbacYAML, err := ioutil.ReadFile("deploy/rbac.yaml")
 	rbacYAMLSplit := bytes.Split(rbacYAML, []byte("\n---\n"))

test/test-framework/deploy/namespace-init.yaml

@@ -1,3 +1,10 @@
+apiVersion: v1
+kind: ServiceAccount
+metadata:
+  name: memcached-operator
+
+---
+
 kind: Role
 apiVersion: rbac.authorization.k8s.io/v1beta1
 metadata:
@@ -36,10 +43,10 @@ rules:
 kind: RoleBinding
 apiVersion: rbac.authorization.k8s.io/v1beta1
 metadata:
-  name: default-account-memcached-operator
+  name: memcached-operator
 subjects:
 - kind: ServiceAccount
-  name: default
+  name: memcached-operator
 roleRef:
   kind: Role
   name: memcached-operator
@@ -61,6 +68,7 @@ spec:
       labels:
         name: memcached-operator
     spec:
+      serviceAccountName: memcached-operator
       containers:
         - name: memcached-operator
           image: quay.io/coreos/operator-sdk-dev:test-framework-operator

test/test-framework/deploy/operator.yaml

@@ -12,6 +12,7 @@ spec:
       labels:
         name: memcached-operator
     spec:
+      serviceAccountName: memcached-operator
       containers:
         - name: memcached-operator
           image: quay.io/coreos/operator-sdk-dev:test-framework-operator

test/test-framework/deploy/rbac.yaml

@@ -36,10 +36,10 @@ rules:
 kind: RoleBinding
 apiVersion: rbac.authorization.k8s.io/v1beta1
 metadata:
-  name: default-account-memcached-operator
+  name: memcached-operator
 subjects:
 - kind: ServiceAccount
-  name: default
+  name: memcached-operator
 roleRef:
   kind: Role
   name: memcached-operator

test/test-framework/deploy/sa.yaml

@@ -0,0 +1,4 @@
+kind: ServiceAccount
+apiVersion: v1
+metadata:
+  name: memcached-operator