Change API group/version to kubeflow.org/v1alpha1 and version operator correspondingly (#176)

- Change API group to "kubeflow.org" and API version to "v1alpha1"
- Move operator to "v1alpha1" versioned directories
- Update image building to adapt to the changes
- Improve update-codegen script and add verify-codegen script

Author: xyhuang

build/images/kubebench-operator/Dockerfile

@@ -1,3 +1,3 @@
 FROM golang:1.8 AS build
-COPY kubebench-operator /app/kubebench-operator
-ENTRYPOINT /app/kubebench-operator
+COPY kubebench-operator-v1alpha1 /app/kubebench-operator-v1alpha1
+ENTRYPOINT /app/kubebench-operator-v1alpha1

build/images/kubebench-operator/build_image.sh

@@ -30,7 +30,7 @@ echo "Change working directory to ${BUILD_DIR}"
 cd ${BUILD_DIR}
 
 echo "Build go binaries"
-GOOS=linux CGO_ENABLED=0 go build github.com/kubeflow/kubebench/controller/cmd/kubebench-operator
+GOOS=linux CGO_ENABLED=0 go build github.com/kubeflow/kubebench/controller/cmd/operator/kubebench-operator-v1alpha1
 
 echo "Authenticate gcloud account"
 gcloud auth activate-service-account --key-file=${GOOGLE_APPLICATION_CREDENTIALS}

controller/cmd/kubebench-operator/main.go …ator/kubebench-operator-v1alpha1/main.gocontroller/cmd/kubebench-operator/main.go renamed to controller/cmd/operator/kubebench-operator-v1alpha1/main.go controller/cmd/kubebench-operator/main.go renamed to controller/cmd/operator/kubebench-operator-v1alpha1/main.go

@@ -6,10 +6,9 @@ import (
 	"syscall"
 
 	kubeclient "github.com/kubeflow/kubebench/controller/pkg/client"
-	controllers "github.com/kubeflow/kubebench/controller/pkg/controller"
+	controllerv1alpha1 "github.com/kubeflow/kubebench/controller/pkg/controller/kubebenchjob/v1alpha1"
 	log "github.com/sirupsen/logrus"
 
-	// "github.com/kubeflow/kubebench/controller/pkg/handler"
 	"github.com/kubeflow/kubebench/controller/pkg/util"
 )
 
@@ -22,12 +21,11 @@ func main() {
 
 	argoClient := kubeclient.GetArgoClient()
 
-	controller := controllers.KubebenchJobController{
+	controller := controllerv1alpha1.KubebenchJobController{
 		Logger:    log.NewEntry(log.New()),
 		Clientset: client,
 		Informer:  teaminformer,
 		Queue:     queue,
-		// Handler:   handler.KubebenchJobHandler{},
 
 		//pass correct namespace here
 		Workflows: argoClient.Workflows("default"),

controller/hack/update-codegen.sh

@@ -0,0 +1,21 @@
+// Copyright 2019 The Kubeflow Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+// +k8s:deepcopy-gen=package,register
+// +k8s:defaulter-gen=TypeMeta
+// +k8s:openapi-gen=true
+
+// Package v1alpha1 is the v1alpha1 version of the API.
+// +groupName=kubeflow.org
+package v1alpha1

controller/pkg/apis/kubebenchjob/register.go

@@ -0,0 +1,60 @@
+// Copyright 2019 The Kubeflow Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package v1alpha1
+
+import (
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/runtime"
+	"k8s.io/apimachinery/pkg/runtime/schema"
+)
+
+const (
+	// GroupName is the group name use in this package.
+	GroupName = "kubeflow.org"
+	// GroupVersion is the version.
+	GroupVersion = "v1alpha1"
+)
+
+// SchemeGroupVersion is group version used to register these objects
+var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: GroupVersion}
+
+// Resource takes an unqualified resource and returns a Group qualified GroupResource
+func Resource(resource string) schema.GroupResource {
+	return SchemeGroupVersion.WithResource(resource).GroupResource()
+}
+
+var (
+	// localSchemeBuilder and AddToScheme will stay in k8s.io/kubernetes.
+	SchemeBuilder      runtime.SchemeBuilder
+	localSchemeBuilder = &SchemeBuilder
+	AddToScheme        = localSchemeBuilder.AddToScheme
+)
+
+func init() {
+	// We only register manually written functions here. The registration of the
+	// generated functions takes place in the generated files. The separation
+	// makes the code compile even when the generated files are missing.
+	localSchemeBuilder.Register(addKnownTypes)
+}
+
+// Adds the list of known types to api.Scheme.
+func addKnownTypes(scheme *runtime.Scheme) error {
+	scheme.AddKnownTypes(SchemeGroupVersion,
+		&KubebenchJob{},
+		&KubebenchJobList{},
+	)
+	metav1.AddToGroupVersion(scheme, SchemeGroupVersion)
+	return nil
+}

controller/pkg/apis/kubebenchjob/v1/doc.go

@@ -1,4 +1,18 @@
-package v1
+// Copyright 2019 The Kubeflow Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package v1alpha1
 
 import (
 	apiv1 "k8s.io/api/core/v1"
@@ -7,10 +21,9 @@ import (
 
 // +genclient
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+// +resource:path=kubebenchjob
 
-// KubebenchJob
-// +k8s:openapi-gen=true
-// +kubebuilder:resource:path=kubebenchjobs
+// KubebenchJob is the configuration of a Kubebench job
 type KubebenchJob struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
@@ -20,7 +33,6 @@ type KubebenchJob struct {
 }
 
 // KubebenchJobSpec defines the desired state of KubebenchJob
-
 type KubebenchJobSpec struct {
 	ServiceAccount string      `json:"serviceAccount,omitempty"`
 	Volumes        VolumeSpecs `json:"volumeSpecs"`