Merge remote-tracking branch 'kb-plugin/main'

Author: jmrodri

.gitignore

@@ -0,0 +1,15 @@
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Dependency directories (remove the comment below to include it)
+# vendor/

LICENSE

@@ -198,4 +198,4 @@
    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.
+   limitations under the License.

Makefile

@@ -0,0 +1,7 @@
+lint:
+	@go fmt ./...
+
+test:
+	@ginkgo ./...
+
+.PHONY: test lint

README.md

@@ -24,3 +24,81 @@ Operator SDK is under Apache 2.0 license. See the [LICENSE][license_file] file f
 [of-home]: https://github.com/operator-framework
 [of-blog]: https://coreos.com/blog/introducing-operator-framework
 [operator-link]: https://coreos.com/operators/
+
+# Enable kubebuilder-plugin for operator-sdk
+
+
+To use kubebuilder-plugin for java operators we need to clone the operator-sdk repo. 
+
+### Updates in Operator-SDK go.mod
+
+- Add the kubebuilder plugin to `go.mod`
+
+```
+github.com/java-operator-sdk/kubebuilder-plugin v0.0.0-20210225171707-e42ea87455e3
+```
+
+- Replace the kubebuilder-plugin path in go-mod pointing to the local dir of your kube-builder repo. Example.
+
+```
+github.com/java-operator-sdk/kubebuilder-plugin => /Users/sushah/go/src/github.com/sujil02/kubebuilder-plugin
+```
+
+### Updates in Operator-SDK `internal/cmd/operator-sdk/cli/cli.go`
+
+- Add the java-operator-sdk import
+
+```
+javav1 "github.com/java-operator-sdk/kubebuilder-plugin/pkg/quarkus/v1"
+```
+
+- Introduce the java bundle in `GetPluginsCLIAndRoot()` method. 
+```
+javaBundle, _ := plugin.NewBundle("quarkus"+plugins.DefaultNameQualifier, plugin.Version{Number: 1},
+		&javav1.Plugin{},
+	)
+```
+
+- Add the created javaBundle to the `cli.New`
+
+```
+    cli.WithPlugins(
+			ansibleBundle,
+			gov2Bundle,
+			gov3Bundle,
+			helmBundle,
+			javaBundle,
+		),
+```
+
+
+### Build and Install the Operator-SDK
+```
+go mod tidy
+make install
+```
+
+Now that the plugin is integrated with the `operator-sdk` you can run the `init` command to generate the sample java operator
+
+- Use the quarkus plugin flag
+- Pick the domain and project name as prefered.
+
+```
+operator-sdk init --plugins quarkus --domain xyz.com --project-name java-op
+```
+
+Once the operator is scaffolded check for the following files
+
+```
+├── PROJECT
+├── pom.xml
+└── src
+    └── main
+        ├── java
+        │   └── com
+        │       └── xyz
+        │           └── JavaOpOperator.java
+        └── resources
+            └── application.properties
+
+```

go.mod

@@ -0,0 +1,12 @@
+module github.com/java-operator-sdk/kubebuilder-plugin
+
+go 1.15
+
+require github.com/spf13/pflag v1.0.5
+
+require (
+	github.com/onsi/ginkgo v1.15.2
+	github.com/onsi/gomega v1.11.0
+	k8s.io/apimachinery v0.20.2
+	sigs.k8s.io/kubebuilder/v3 v3.0.0-beta.1
+)

go.sum

@@ -0,0 +1,124 @@
+/*
+ * Copyright 2021 The Java Operator SDK 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 v1
+
+import (
+	"errors"
+	"fmt"
+
+	"github.com/spf13/pflag"
+	"sigs.k8s.io/kubebuilder/v3/pkg/config"
+	"sigs.k8s.io/kubebuilder/v3/pkg/machinery"
+	"sigs.k8s.io/kubebuilder/v3/pkg/model/resource"
+	"sigs.k8s.io/kubebuilder/v3/pkg/plugin"
+	pluginutil "sigs.k8s.io/kubebuilder/v3/pkg/plugin/util"
+
+	"github.com/java-operator-sdk/kubebuilder-plugin/pkg/quarkus/v1/scaffolds"
+)
+
+type createAPIOptions struct {
+	CRDVersion string
+}
+
+type createAPISubcommand struct {
+	config   config.Config
+	resource *resource.Resource
+	options  createAPIOptions
+}
+
+func (opts createAPIOptions) UpdateResource(res *resource.Resource) {
+	fmt.Println("UpdateResource called")
+
+	res.API = &resource.API{
+		CRDVersion: opts.CRDVersion,
+		Namespaced: true,
+	}
+
+	// Ensure that Path is empty and Controller false as this is not a Go project
+	res.Path = ""
+	res.Controller = false
+}
+
+var (
+	_ plugin.CreateAPISubcommand = &createAPISubcommand{}
+)
+
+func (p *createAPISubcommand) BindFlags(fs *pflag.FlagSet) {
+	fs.SortFlags = false
+	fs.StringVar(&p.options.CRDVersion, "crd-version", "v1", "crd version to generate")
+}
+
+func (p *createAPISubcommand) InjectConfig(c config.Config) error {
+	p.config = c
+
+	return nil
+}
+
+func (p *createAPISubcommand) Run(fs machinery.Filesystem) error {
+	fmt.Println("Run called")
+	return nil
+}
+
+func (p *createAPISubcommand) Validate() error {
+	fmt.Println("Validate called")
+	return nil
+}
+
+func (p *createAPISubcommand) PostScaffold() error {
+	fmt.Println("PostScaffold called")
+	return nil
+}
+
+func (p *createAPISubcommand) Scaffold(fs machinery.Filesystem) error {
+	fmt.Println("Scaffold called")
+	scaffolder := scaffolds.NewCreateAPIScaffolder(p.config, *p.resource)
+	scaffolder.InjectFS(fs)
+	if err := scaffolder.Scaffold(); err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func (p *createAPISubcommand) InjectResource(res *resource.Resource) error {
+	fmt.Println("InjectResource called")
+	p.resource = res
+
+	// RESOURCE: &{{cache zeusville.com v1 Joke} jokes  0xc00082a640 false 0xc00082a680}
+	p.options.UpdateResource(p.resource)
+
+	if err := p.resource.Validate(); err != nil {
+		return err
+	}
+
+	// Check that resource doesn't have the API scaffolded
+	if res, err := p.config.GetResource(p.resource.GVK); err == nil && res.HasAPI() {
+		return errors.New("the API resource already exists")
+	}
+
+	// Check that the provided group can be added to the project
+	if !p.config.IsMultiGroup() && p.config.ResourcesLength() != 0 && !p.config.HasGroup(p.resource.Group) {
+		return fmt.Errorf("multiple groups are not allowed by default, to enable multi-group set 'multigroup: true' in your PROJECT file")
+	}
+
+	// Selected CRD version must match existing CRD versions.
+	if pluginutil.HasDifferentCRDVersion(p.config, p.resource.API.CRDVersion) {
+		return fmt.Errorf("only one CRD version can be used for all resources, cannot add %q", p.resource.API.CRDVersion)
+	}
+
+	return nil
+}

pkg/quarkus/v1/api.go

@@ -0,0 +1,125 @@
+/*
+ * Copyright 2021 The Java Operator SDK 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 v1
+
+import (
+	"fmt"
+	"os"
+	"path/filepath"
+	"strings"
+
+	"github.com/java-operator-sdk/kubebuilder-plugin/pkg/quarkus/v1/scaffolds"
+	"github.com/spf13/pflag"
+	"k8s.io/apimachinery/pkg/util/validation"
+
+	"sigs.k8s.io/kubebuilder/v3/pkg/config"
+	"sigs.k8s.io/kubebuilder/v3/pkg/machinery"
+	"sigs.k8s.io/kubebuilder/v3/pkg/plugin"
+)
+
+// This file represents the CLI for this plugin.
+
+const (
+	groupFlag   = "group"
+	versionFlag = "version"
+	kindFlag    = "kind"
+)
+
+type initSubcommand struct {
+	apiSubcommand createAPISubcommand
+
+	config config.Config
+
+	// For help text.
+	commandName string
+
+	// Flags
+	group       string
+	domain      string
+	version     string
+	kind        string
+	projectName string
+}
+
+var (
+	_ plugin.InitSubcommand = &initSubcommand{}
+)
+
+func (p *initSubcommand) UpdateMetadata(cliMeta plugin.CLIMetadata, subcmdMeta *plugin.SubcommandMetadata) {
+	subcmdMeta.Description = `Initialize a new project based on the java-operator-sdk project.
+
+Writes the following files:
+- a basic, Quarkus-based operator set-up
+- a pom.xml file to build the project with Maven
+`
+	p.commandName = cliMeta.CommandName
+}
+
+func (p *initSubcommand) BindFlags(fs *pflag.FlagSet) {
+	//// TODO: include flags required for this plugin
+
+	fs.SortFlags = false
+	fs.StringVar(&p.domain, "domain", "my.domain", "domain for groups")
+	fs.StringVar(&p.projectName, "project-name", "", "name of this project, the default being directory name")
+
+	fs.StringVar(&p.group, groupFlag, "", "resource Group")
+	fs.StringVar(&p.version, versionFlag, "", "resource Version")
+	fs.StringVar(&p.kind, kindFlag, "", "resource Kind")
+	p.apiSubcommand.BindFlags(fs)
+}
+
+func (p *initSubcommand) InjectConfig(c config.Config) error {
+	p.config = c
+
+	if err := p.config.SetDomain(p.domain); err != nil {
+		return err
+	}
+
+	// Assign a default project name
+	if p.projectName == "" {
+		dir, err := os.Getwd()
+		if err != nil {
+			return fmt.Errorf("error getting current directory: %v", err)
+		}
+		p.projectName = strings.ToLower(filepath.Base(dir))
+	}
+	// Check if the project name is a valid k8s namespace (DNS 1123 label).
+	if err := validation.IsDNS1123Label(p.projectName); err != nil {
+		return fmt.Errorf("project name (%s) is invalid: %v", p.projectName, err)
+	}
+	if err := p.config.SetProjectName(p.projectName); err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func (p *initSubcommand) Validate() error {
+	// TODO: validate the conditions you expect before running the plugin
+	return nil
+}
+
+func (p *initSubcommand) PostScaffold() error {
+	// TODO: add anything you want to do AFTER the scaffolding has happened.
+	return nil
+}
+
+func (p *initSubcommand) Scaffold(fs machinery.Filesystem) error {
+	scaffolder := scaffolds.NewInitScaffolder(p.config)
+	scaffolder.InjectFS(fs)
+	return scaffolder.Scaffold()
+}