operator-sdk: add operator-sdk new command with descriptions by fanminshi · Pull Request #15 · operator-framework/operator-sdk

fanminshi · 2018-02-15T23:56:33Z

add initial command file structure and defines the interface for the operator-sdk new command.

fanminshi · 2018-02-15T23:58:24Z

Manual test:

operator-sdk top view:

$ ./operator-sdk
A framework for building operator with ease

Usage:
  operator-sdk [command]

Available Commands:
  help        Help about any command
  new         Creates a new operator application

Flags:
  -h, --help   help for operator-sdk

operator-sdk new with no arguments:

$ ./operator-sdk new
Error: new command needs 2 arguments.

help operator-sdk new:

$ ./operator-sdk new -h
The operator-sdk new command creates a new operator application and
	generates a default directory layout based on the input <project-name>.

	If none of options are specified, the operator-sdk defaults
	Kubernetes api group to <project-name>.example.com/v1
	and Kubernetes kind to <project-name>Service.

	For example,
	$ mkdir $GOPATH/src/github.com/example.com/play
	$ cd $GOPATH/src/github.com/example.com/play
	$ operator-sdk new play
	generates a skeletal play application in $GOPATH/src/github.com/example.com/play.

Usage:
  operator-sdk new [options] <project-name> [flags]

Flags:
      --api-group string   Kubernetes API group. e.g play.example.com/v1
  -h, --help               help for new
      --kind string        Kubernetes CRD kind. e.g PlayService

cc/ @hongchaodeng @hasbro17 for code review.

hongchaodeng · 2018-02-16T03:46:47Z

@@ -0,0 +1,38 @@
+
+# Gopkg.toml example


Remove these comments

will remove!

hongchaodeng · 2018-02-16T03:47:02Z

+	ExitBadArgs = 128
+)
+
+func ExitWithError(code int, err error) {


hongchaodeng · 2018-02-16T03:47:05Z

+)
+
+const (
+	ExitBadArgs = 128


hongchaodeng · 2018-02-16T03:49:46Z

+	"github.com/coreos/operator-sdk/cmd"
+)
+
+func main() {


Put this into cmd/operator-sdk/?

the cobra way seen from https://github.com/spf13/cobra is:

▾ appName/ ▾ cmd/ add.go your.go commands.go here.go main.go

We can also do operator-sdk/operator-sdk/cmd, but that look a bit weird.

Just cmd/operator-sdk/.

The cobra way is one repo for one thing. We aren't following that. For more package stuff, put them into pkg/cmd/operator-sdk/.

how about this?

cmd/operator-sdk/ ▾ cmd/ add.go your.go commands.go here.go main.go

or

The following allows us to add additionally command under the commands pkg which seems an intuitive approach.

commands/operator-sdk/ ▾ cmd/ add.go your.go commands.go here.go main.go

the etcd benchmark tool is has a good file structure for defining commands. https://github.com/coreos/etcd/tree/master/tools/benchmark

Sounds good!

hongchaodeng · 2018-02-16T03:51:29Z

+	"github.com/spf13/cobra"
+)
+
+// newCmd represents the new command


Put this into cmd/operator-sdk/new.go

xiang90 · 2018-02-16T19:57:00Z

+func init() {
+	RootCmd.AddCommand(newCmd)
+	newCmd.Flags().StringVar(&apiGroup, "api-group", "", "Kubernetes API group. e.g play.example.com/v1")
+	newCmd.Flags().StringVar(&kind, "kind", "", "Kubernetes CRD kind. e.g PlayService")


Kubernetes Resource Kind. (we might add aggregated API server support so that the resource will not be a CRD )

xiang90 · 2018-02-16T19:58:15Z

+// This represents the base command when called without any subcommands
+var RootCmd = &cobra.Command{
+	Use:   "operator-sdk",
+	Short: "A framework for building operator with ease",


we should always call sdk sdk rather than framework. the less terminologies we use the better

sounds good!

fanminshi · 2018-02-16T21:13:28Z

all fixed PTAL! cc/ @hongchaodeng @xiang90

hongchaodeng · 2018-02-16T21:22:46Z

lgtm

fanminshi mentioned this pull request Feb 15, 2018

Action Items #10

Closed

21 tasks

hongchaodeng reviewed Feb 16, 2018

View reviewed changes

xiang90 reviewed Feb 16, 2018

View reviewed changes

fanminshi added 2 commits February 16, 2018 13:16

operator-sdk: add operator-sdk new command with descriptions

76fc164

dep: dep init files

ba87161

hongchaodeng merged commit c247f13 into operator-framework:master Feb 16, 2018

hongchaodeng deleted the add_operatorSDK_commands_interface branch February 16, 2018 21:22

Conversation

fanminshi commented Feb 15, 2018

Uh oh!

fanminshi commented Feb 15, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hongchaodeng Feb 16, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fanminshi Feb 16, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fanminshi Feb 16, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fanminshi commented Feb 16, 2018

Uh oh!

hongchaodeng commented Feb 16, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

fanminshi commented Feb 15, 2018 •

edited

Loading

hongchaodeng Feb 16, 2018 •

edited

Loading

fanminshi Feb 16, 2018 •

edited

Loading

fanminshi Feb 16, 2018 •

edited

Loading