Action Items

[fanminshi]

This tracks the action items needed for milestone 0.0.1.
Target Date: 03/12/18

Operator-SDK APIs:

• Initial design doc ref: https://docs.google.com/document/d/1GVvCc2UhCeK9T69hRRuOx8Pbz8CJNYZZviSbzWL1tMU/edit?ts=5a83c894
• Watch API interface and implementation ref: pkg/sdk: add watch API and informer implementation #9
• Handle API interface and implementation ref: pkg/sdk: implement sdk.Handle() API #11
• Update the Watch API to take in APIVersion and Kind and create the resource client for informer. Also update README. ref: *: simplify Watch API by using dynamic resource client #34
• Define and implement a minimum set of Actions such as KubeApplyFunc and KubeDeleteFunc required ref: *: add kube apply action #58 sdk/action: implement kube delete #61

Operator-SDK Generation:

• Initial Design Doc ref: https://docs.google.com/document/d/1xyNj2zDozGj38cXao0qmkQzzAsT9co5jtCtg5n0nn5E
• An detailed generated mock for review before starting development can save headache down the road ref: README: add create and deploy section #14
• define and implement operator-sdk new interface. ref: operator-sdk: add operator-sdk new command with descriptions #15 commands/operator-sdk: change defintion of operator-sdk new #23 commands/operator-sdk: pull deps after code generation #81
• define and implement operator-sdk build interface. ref: pkg/generator: implement operator-sdk build #70 cmd: add build subcommand #49 *: generate k8s manifest #72
• define and implement operator-sdk generate interface. ref: cmd: add generate and refactor structure #56 commands/operator-sdk: implement generate k8s #78
• operator-sdk generates project skeleton at project path github.com/example.com/play ref: *: operator-sdk new command generates project skeleton #21:

$GOPATH/github.com/example.com/play
├── cmd
│   └── play
├── deploy
│   └── play
├── config
├── tmp
│   ├── build
│   └── codegen
└── pkg
    ├── apis
    │   └── play
    │       └── v1alpha1
    ├── client
    └── stub  

• check operator-sdk new input args and flags ref: commands/operator-sdk: add flags check #106
• save sdk command inputs into config/config.yaml ref: pkg/generator: add code generation for config/config.yaml #71
• populate files for each dir in the order of following:
  • cmd/play ref: pkg/generator: add cmd/main.go generator #29
  • pkg/stub ref: pkg/generator: add stub/handler.go generator #32
  • deploy/play ref: *: generate k8s manifest #72
  • pkg/apis/play/v1alpha1 ref: pkg/generator: auto-gen for apis/../types.go #37
  • tmp/build ref: pkg/generator: add auto-gen for tmp/build.sh #46 pkg/generator: add generation for docker image building scripts #69
  • tmp/codegen ref: *: add auto-gen for codegen scripts #47
• generate Gopkg.lock Gopkg.toml ref: generator: pull dependency at last step of new #39 pkg/generator: render dep files #67

cc/ @hasbro17 @hongchaodeng @xiang90 for any modification.

[hongchaodeng]

@fanminshi
For generating scaffolding, can you work on the new command:

First of all, generate scaffolding code:

	operator-sdk new github.com/example.com/play --apigroup=play.example.com/v1

This will create the following directory layout:

	play/
	|	cmd/
	|		play/
	|			main.go
	|	pkg/
	|		apis/
	|			play/v1/
	|				doc.go
	|				register.go
	|				types.go
	|		stub/
	|			handler.go

[fanminshi]

@hongchaodeng yeah, but let me finish the doc design first. I think it is a good practice to do step by step. it should only take me a moment.

[hongchaodeng]

Just create the layout and files first. No need to write a design doc.

[fanminshi]

main action items for 0.0.1 milestone are finished. closing this.