SDK skeleton #41

JohnStrunk · 2018-11-16T20:17:32Z

Describe what this PR does
This adds an initial operator executable based on the Operator SDK.

Is there anything that requires special attention?
There is a significant amount of code here, however it is almost all auto-generated by the operator-sdk tool.

None of the golang has been edited.
I added documentation to the README
I modified the pre-commit hook to match the checks in the CSI repo
I have not added anything to Travis because I haven't decided what a good approach to building would be.

Related issues:
Related to #30 - This partially satisfies #30, but it does not have the actual CRD contents defined, so it cannot be considered a fix.

Signed-off-by: John Strunk <jstrunk@redhat.com>

This adds the results of running: `operator-sdk new anthill --skip-git-init` and merging those files into the anthill repo unchanged. The initial `vendor` directory has not been committed. Signed-off-by: John Strunk <jstrunk@redhat.com>

Signed-off-by: John Strunk <jstrunk@redhat.com>

The operator-sdk produced yamls w/ poor indentation. This fixes the affected files so they pass yamllint Signed-off-by: John Strunk <jstrunk@redhat.com>

Results of running: `operator-sdk add api --api-version=operator.gluster.org/v1alpha1 --kind=GlusterCluster` Signed-off-by: John Strunk <jstrunk@redhat.com>

Signed-off-by: John Strunk <jstrunk@redhat.com>

This is the result of: `operator-sdk add controller --api-version=operator.gluster.org/v1alpha1 --kind=GlusterCluster` Signed-off-by: John Strunk <jstrunk@redhat.com>

Signed-off-by: John Strunk <jstrunk@redhat.com>

Results of running: `operator-sdk add api --api-version=operator.gluster.org/v1alpha1 --kind=GlusterNode` and fixing yaml formatting Signed-off-by: John Strunk <jstrunk@redhat.com>

Results of running: `operator-sdk add controller --api-version=operator.gluster.org/v1alpha1 --kind=GlusterNode` Signed-off-by: John Strunk <jstrunk@redhat.com>

phlogistonjohn

Code! :-)

Some small nits, but overall I'm liking what I'm seeing.

phlogistonjohn · 2018-11-16T21:30:52Z

cmd/manager/main.go

+	"runtime"
+
+	"github.com/gluster/anthill/pkg/apis"
+	"github.com/gluster/anthill/pkg/controller"


I understand that this is generated code, but it would be nice (in a followup commit) to order the import sections as:

std library

outside the repo/project

inside the repo/project

This is a standard more projects have been following. @Madhu-1 was just making similar fixes in heketi.

Yeah... Right now, I don't have a feel for what gets overwritten by the sdk and what doesn't. I suspect it's fair game for this file to get overwritten by the sdk.
I think we're supposed to stick to the *_types.go and *_controller.go files.

I believe that except the zz_generated files, the rest of the code is okay to be changed. zz_generated files are actually generated from other code. The rest of the code is really just skeleton code that we need to fill up.

I agree with @kshlm , rest is in our control and we should be able to correct it.

phlogistonjohn · 2018-11-16T21:59:27Z

README.md

+
+Once the SDK is installed, Anthill can be built via:
+
+```bash


I think you should mention you need to run dep ensure before building using operator-sdk build. If you naively follow the steps here, like I did the first time, it fails to find the dependency packages.

Good point. done.

Signed-off-by: John Strunk <jstrunk@redhat.com>

humblec · 2018-11-19T09:42:41Z

pkg/apis/operator/v1alpha1/glusternode_types.go

+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+// EDIT THIS FILE!  THIS IS SCAFFOLDING FOR YOU TO OWN!


Do we need this here ?

@shtripat will remove this when he posts his PR w/ the types.

humblec · 2018-11-19T09:43:45Z

pkg/controller/glustercluster/glustercluster_controller.go

+/**
+* USER ACTION REQUIRED: This is a scaffold file intended for the user to modify with their own Controller
+* business logic.  Delete these comments after modifying this file.*
+ */


Yes, we need to delete these comments :)

Just remove the commented lines or retain them till we add new logic here?

I say keep the comments until content is actually added.

humblec · 2018-11-19T09:44:29Z

pkg/controller/glusternode/glusternode_controller.go

+/**
+* USER ACTION REQUIRED: This is a scaffold file intended for the user to modify with their own Controller
+* business logic.  Delete these comments after modifying this file.*
+ */


Delete above line ?

Just remove the commented lines or retain them till we add new logic here?

humblec · 2018-11-19T09:46:28Z

@JohnStrunk As this is mostly auto generated, its fine to have initial skeleton. however we chould do some source code cleanup and some corrections. Please see my review comments.

humblec · 2018-11-19T09:47:42Z

I modified the pre-commit hook to match the chacks in the CSI repo

typo on 'chacks' :), please correct it.

humblec · 2018-11-19T09:49:02Z

README.md

+$ operator-sdk build docker.io/gluster/anthill
+INFO[0001] Building Docker image docker.io/gluster/anthill
+Sending build context to Docker daemon  114.7MB
+Step 1/4 : FROM alpine:3.8


Do we need to base our dockerimage on alphine ? I think its good to base on CentOS .. thougts are welome.

We should be ok customizing the Dockerfile. This is just what the SDK created. I think we can probably build FROM scratch, which would be awesome!

I just checked on FROM scratch, and that won't work because when you enable testing in the sdk, it injects a shell script into the container. Should be able to move to centos though.

Switched to CentOS

humblec · 2018-11-19T09:49:37Z

README.md

+role.rbac.authorization.k8s.io "anthill" created
+
+$ kubectl apply -f deploy/role_binding.yaml
+rolebinding.rbac.authorization.k8s.io "anthill" created


The roles can be combined in a single Yaml file.

JohnStrunk · 2018-11-19T19:47:29Z

Lots of the comments thus far have been related to reorganizing or modifying the autogenerated files. My reading of the SDK documentation suggests that modifications done to files other than *_types.go and *_controller.go files are done at our peril. Basically, the SDK generates the other stuff for us, and if we modify it, it will be very difficult to integrate SDK improvements into our code. Basically, for any file we modify we are volunteering to manually merge in SDK fixes and improvements.

As for the "remove me" type comments, yes we should remove them... once we actually put some code in there. 😄

Madhu-1 · 2018-11-20T14:00:29Z

cmd/manager/main.go

+)
+
+func printVersion() {
+	logf.Log.Info(fmt.Sprintf("Go Version: %s", runtime.Version()))


do we have logf.Log.Infof instead of logf.Log.Info to avoid use of Sprinf

There is no InfoF equivalent. See: https://godoc.org/github.com/go-logr/logr

I imagine the use of logr is part of the SDK? Looks kinda gross, but that might just be my unfamiliarity with it.

phlogistonjohn

My complaint about the docs were resolved and I don't think there's an immediate need to fix all the formatting, etc issues in the autogenerated files right away I'm good with merging this and then iterating on those files as needed.

Signed-off-by: John Strunk <jstrunk@redhat.com>

JohnStrunk · 2018-11-30T16:35:33Z

I believe I have addressed all comments.

JohnStrunk · 2018-11-30T16:46:29Z

BTW, upgrade discussion here: operator-framework/operator-sdk#773

humblec · 2018-12-03T05:10:00Z

@JohnStrunk I still think USER ACTION REQUIRED comments can be deleted as it wont look good on a merged PR/code :), but I dont want to insist on this though.

jarrpa

A few minor nits. Overall it's almost good enough that this could go through as-is. I'm in favor of leaving the boilerplate comments in so we have guideposts when actual development starts.

One thing I don't understand, why did we switch to a CentOS based VM? We don't require anything specific to the OS, and it results in a larger container image size. I'm personally in favor of sticking with alpine.

jarrpa · 2018-12-03T14:49:37Z

cmd/manager/main.go

+)
+
+func printVersion() {
+	logf.Log.Info(fmt.Sprintf("Go Version: %s", runtime.Version()))


I imagine the use of logr is part of the SDK? Looks kinda gross, but that might just be my unfamiliarity with it.

jarrpa · 2018-12-03T14:54:04Z

deploy/role.yaml

+      - '*'
+
+---
+


Remove whitespace

jarrpa · 2018-12-03T14:57:08Z

pkg/controller/glustercluster/glustercluster_controller.go

+/**
+* USER ACTION REQUIRED: This is a scaffold file intended for the user to modify with their own Controller
+* business logic.  Delete these comments after modifying this file.*
+ */


I say keep the comments until content is actually added.

Signed-off-by: John Strunk <jstrunk@redhat.com>

JohnStrunk · 2018-12-03T20:09:11Z

Re CentOS vs. Alpine: CentOS will make an easier transition to the product that will be RHEL-based. Also, CentOS is the base of all the other GCS images, so it should be common on all the nodes. But yes, in isolation, it's bigger.

There are docs about changing the logger, but also a warning that doing so will discard log messages from controller runtime. While the syntax is a bit ugly, I'd like to keep the controller runtime logs. Details here.

jarrpa

Re CentOS vs. Alpine: CentOS will make an easier transition to the product that will be RHEL-based.

Ah, legit.

Also, CentOS is the base of all the other GCS images, so it should be common on all the nodes. But yes, in isolation, it's bigger.

Also legit.

There are docs about changing the logger, but also a warning that doing so will discard log messages from controller runtime. While the syntax is a bit ugly, I'd like to keep the controller runtime logs. Details here.

I figured there was something like that.

LGTM!

humblec · 2018-12-05T15:39:15Z

LGTM .. @phlogistonjohn @shtripat If no other comments, I will merge this PR .

JohnStrunk added 10 commits November 16, 2018 14:00

Make pre-commit linter skip vendor directory

6087ba1

Signed-off-by: John Strunk <jstrunk@redhat.com>

Add operator-sdk skeleton

6bcaee9

This adds the results of running: `operator-sdk new anthill --skip-git-init` and merging those files into the anthill repo unchanged. The initial `vendor` directory has not been committed. Signed-off-by: John Strunk <jstrunk@redhat.com>

Add vendor directory to .gitignore

03fc0f3

Signed-off-by: John Strunk <jstrunk@redhat.com>

Fix errors in yaml formatting

825cfc8

The operator-sdk produced yamls w/ poor indentation. This fixes the affected files so they pass yamllint Signed-off-by: John Strunk <jstrunk@redhat.com>

Add GlusterCluster CRD

d545a31

Results of running: `operator-sdk add api --api-version=operator.gluster.org/v1alpha1 --kind=GlusterCluster` Signed-off-by: John Strunk <jstrunk@redhat.com>

Fix errors in yaml formatting

9421ebb

Signed-off-by: John Strunk <jstrunk@redhat.com>

Add the controller skeleton for GlusterCluster

25a97c0

This is the result of: `operator-sdk add controller --api-version=operator.gluster.org/v1alpha1 --kind=GlusterCluster` Signed-off-by: John Strunk <jstrunk@redhat.com>

Add instructions to build and run the operator

b2a3b78

Signed-off-by: John Strunk <jstrunk@redhat.com>

Add GlusterNode skeleton

6ae0671

Results of running: `operator-sdk add api --api-version=operator.gluster.org/v1alpha1 --kind=GlusterNode` and fixing yaml formatting Signed-off-by: John Strunk <jstrunk@redhat.com>

Add controller for GlusterNode

6a65c93

Results of running: `operator-sdk add controller --api-version=operator.gluster.org/v1alpha1 --kind=GlusterNode` Signed-off-by: John Strunk <jstrunk@redhat.com>

ghost assigned JohnStrunk Nov 16, 2018

ghost added the in progress label Nov 16, 2018

phlogistonjohn suggested changes Nov 16, 2018

View reviewed changes

Add note to run dep ensure

d14e508

Signed-off-by: John Strunk <jstrunk@redhat.com>

humblec reviewed Nov 19, 2018

View reviewed changes

Madhu-1 reviewed Nov 20, 2018

View reviewed changes

phlogistonjohn approved these changes Nov 30, 2018

View reviewed changes

JohnStrunk added 3 commits November 30, 2018 11:11

Switch container to use CentOS base image

b1ae847

Signed-off-by: John Strunk <jstrunk@redhat.com>

Merge operator role & rolebinding

dc62a9b

Signed-off-by: John Strunk <jstrunk@redhat.com>

Reorder imports for style

63b0ad7

Signed-off-by: John Strunk <jstrunk@redhat.com>

jarrpa suggested changes Dec 3, 2018

View reviewed changes

Remove whitespace in role yaml

ee8bcfe

Signed-off-by: John Strunk <jstrunk@redhat.com>

jarrpa approved these changes Dec 3, 2018

View reviewed changes

Madhu-1 approved these changes Dec 5, 2018

View reviewed changes

JohnStrunk merged commit f4df628 into gluster:master Dec 5, 2018

ghost removed the in progress label Dec 5, 2018

JohnStrunk deleted the sdk-skeleton branch December 19, 2018 14:56

		- '*'

		---

SDK skeleton #41

SDK skeleton #41

Conversation

JohnStrunk commented Nov 16, 2018 • edited Loading

phlogistonjohn left a comment

Choose a reason for hiding this comment

phlogistonjohn Nov 16, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

humblec commented Nov 19, 2018 • edited Loading

humblec commented Nov 19, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JohnStrunk commented Nov 19, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

phlogistonjohn left a comment

Choose a reason for hiding this comment

JohnStrunk commented Nov 30, 2018

JohnStrunk commented Nov 30, 2018

humblec commented Dec 3, 2018

jarrpa left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JohnStrunk commented Dec 3, 2018

jarrpa left a comment

Choose a reason for hiding this comment

humblec commented Dec 5, 2018 • edited Loading

JohnStrunk commented Nov 16, 2018 •

edited

Loading

phlogistonjohn Nov 16, 2018 •

edited

Loading

humblec commented Nov 19, 2018 •

edited

Loading

humblec commented Nov 19, 2018 •

edited

Loading

humblec commented Dec 5, 2018 •

edited

Loading