operator-sdk/cmd: add up command #219

fanminshi · 2018-05-02T20:27:35Z

This pr adds a new command call up and its subcommand local.

Whenoperator-sdk up local is called, the operator is run locally on developer's machine with the access to a kubernetes cluster via the --kubeconfig flag.

ref: #142

cc/ @hasbro17 @spahl

fanminshi · 2018-05-02T20:28:20Z

depends on #218

fanminshi · 2018-05-02T23:26:41Z

manual test:

$ operator-sdk up -h
The operator-sdk up command launches the operator on the local machine
by building the operator binary with the ability to access a
kubernetes cluster using a Kubernete config file.

Usage:
  operator-sdk up [Flags] [flags]

Flags:
  -h, --help                help for up
      --kubeconfig string   The file path to kubernetes configuration file; defaults to $HOME/.kube/config


$ cat config/config.yaml
apiVersion: example.com/v1alpha1
kind: AppService
projectName: app-operator

$ pwd
/Users/fanminshi/work/src/github.com/operator-framework/app-operator
fanmins-MBP:app-operator fanminshi$ operator-sdk up
INFO[0000] Go Version: go1.10
INFO[0000] Go OS/Arch: darwin/amd64
INFO[0000] operator-sdk Version: 0.0.5+git
INFO[0000] starting appservices controller

fanminshi · 2018-05-03T16:04:45Z

In order to use up command, we need also need to create the CRD first. However, currently, the CRD and deployment manifests are tied together. Hence, I need to split that into two parts so that I can create CRD only.

ref: #76 #223

spahl · 2018-05-03T18:13:36Z

When I see a top level command called "up" I imagine that it is to deploy my operator to a running cluster. This seems to be for local development.

Is "up" the right command name here? Who is the user and what is his use case?

fanminshi · 2018-05-03T18:24:04Z

Is "up" the right command here?
I am not sure what's the best naming scheme here. To me, "up" means up and running, and the idea of "up" to run the operator locally on your machine like rails server.

Who is the user and what is his use case?
Serval users have complained that the build and push image to registry model is kinda tedious for local development and testing. I hope this "up" command can solve this issue by let the user test their operator code immediately.

Maybe we can name this command with a better name to illustrate the intended behavior.

spahl · 2018-05-03T18:24:57Z

Maybe "up --local" ? That way "up" can be to run it inside the cluster? For dev and test it's probably valuable to be able to do both?

fanminshi · 2018-05-03T18:50:01Z

Maybe "up --local" ? That way "up" can be to run it inside the cluster?

I am thinking about having separate sub commands for local and cluster deployment.
like up local [args] flags and up cluster [args] [flags] or r/up/deploy/ for better naming.

The reason for having separate command is that I suspect that up cluster might have a total of different flags and args than that of up local. If we combine the up cluster and the `up local into one command, I suspect most of the flags won't be apply to both and also may cause confusion to users.

fanminshi · 2018-05-03T18:50:51Z

let's keep the design discussion here #142

fanminshi · 2018-05-04T20:25:27Z

operator-sdk CLI interface :

$ operator-sdk -h
A sdk for building operator with ease

Usage:
  operator-sdk [command]

Available Commands:
  build       Compiles code and builds artifacts
  generate    Invokes specific generator
  help        Help about any command
  new         Creates a new operator application
  up          Launches the operator

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

Use "operator-sdk [command] --help" for more information about a command.

$ operator-sdk up -h
The up command has subcommands that can launch the operator in various ways.

Usage:
  operator-sdk up [command]

Available Commands:
  local       Launches the operator locally

Flags:
  -h, --help   help for up

Use "operator-sdk up [command] --help" for more information about a command.

$ operator-sdk up local -h
The operator-sdk up local command launches the operator on the local machine
by building the operator binary with the ability to access a
kubernetes cluster using a Kubernete config file.

Usage:
  operator-sdk up local [flags]

Flags:
  -h, --help                help for local
      --kubeconfig string   The file path to kubernetes configuration file; defaults to $HOME/.kube/config

$ pwd
/Users/fanminshi/work/src/github.com/operator-framework/app-operator

Local Test

$ kubectl get all
NAME             TYPE        CLUSTER-IP   EXTERNAL-IP   PORT(S)   AGE
svc/kubernetes   ClusterIP   10.96.0.1    <none>        443/TCP   43d

$ cat deploy/crd.yaml
apiVersion: apiextensions.k8s.io/v1beta1
kind: CustomResourceDefinition
metadata:
  name: apps.app.example.com
spec:
  group: app.example.com
  names:
    kind: App
    listKind: AppList
    plural: apps
    singular: app
  scope: Namespaced
  version: v1alpha1

$ kubectl create -f deploy/crd.yaml
customresourcedefinition "apps.app.example.com" created

$ operator-sdk up local
INFO[0000] Go Version: go1.10
INFO[0000] Go OS/Arch: darwin/amd64
INFO[0000] operator-sdk Version: 0.0.5+git
INFO[0000] starting apps controller

# In a different terminal
$ kubectl create -f deploy/cr.yaml
app "example" created
$ kubectl get po
NAME       READY     STATUS    RESTARTS   AGE
busy-box   1/1       Running   0          3s

fanminshi · 2018-05-04T20:26:38Z

Reflected the discussion from #142 in this pr.
PTAL cc/ @hasbro17 @spahl

hasbro17 · 2018-05-04T21:39:34Z

commands/operator-sdk/cmd/up/local.go

+		Short: "Launches the operator locally",
+		Long: `The operator-sdk up local command launches the operator on the local machine 
+by building the operator binary with the ability to access a 
+kubernetes cluster using a Kubernete config file.


using a Kubernete config file ==> using a kubeconfig file

hasbro17 · 2018-05-04T21:48:37Z

commands/operator-sdk/cmd/cmdutil/util.go

+
+	cmdError "github.com/operator-framework/operator-sdk/commands/operator-sdk/error"
+	"github.com/operator-framework/operator-sdk/pkg/generator"
+	yaml "gopkg.in/yaml.v2"


Leave a line break before this.

hasbro17 · 2018-05-04T21:59:08Z

commands/operator-sdk/cmd/up/local.go

+
+	_, err := os.Stat(kubeConfig)
+	if err != nil && os.IsNotExist(err) {
+		cmdError.ExitWithError(cmdError.ExitError, fmt.Errorf("failed to fine the Kubernetes config file (%v): %v", kubeConfig, err))


failed to fine the Kubernetes config file ==> failed to find the kubeconfig file

hasbro17 · 2018-05-04T22:03:46Z

commands/operator-sdk/cmd/up/local.go

+	dc := exec.Command(gocmd, run, filepath.Join(cmd, projectName, main))
+	dc.Stdout = os.Stdout
+	dc.Stderr = os.Stderr
+	dc.Env = append(os.Environ(), fmt.Sprintf("KUBERNETES_CONFIG=%v", kubeConfig))


Make the string KUBERNETES_CONFIG a constant because it's common to pkg/k8sclient/client.go and here.

hasbro17 · 2018-05-04T22:10:15Z

commands/operator-sdk/cmd/up/local.go

+	}
+}
+
+func up(projectName string) {


Can you rename this to upLocal(). Because we'll be adding an up cluster command in the same package later on.

fanminshi · 2018-05-04T22:41:05Z

all fixed PTAL cc/ @hasbro17

hasbro17 · 2018-05-04T23:47:20Z

LGTM

fanminshi force-pushed the better_local_workflow branch from 09bc729 to 5f5cd3c Compare May 2, 2018 20:37

fanminshi closed this May 2, 2018

fanminshi reopened this May 2, 2018

fanminshi force-pushed the better_local_workflow branch 2 times, most recently from 52f101b to 6d50689 Compare May 2, 2018 23:23

fanminshi changed the title ~~[WIP] operator-sdk/cmd: add up command~~ operator-sdk/cmd: add up command May 2, 2018

fanminshi changed the title ~~operator-sdk/cmd: add up command~~ [WIP] operator-sdk/cmd: add up command May 3, 2018

fanminshi force-pushed the better_local_workflow branch from 6d50689 to 53ddd96 Compare May 4, 2018 20:12

fanminshi changed the title ~~[WIP] operator-sdk/cmd: add up command~~ operator-sdk/cmd: add up command May 4, 2018

fanminshi force-pushed the better_local_workflow branch from 53ddd96 to 81d13dd Compare May 4, 2018 20:24

hasbro17 reviewed May 4, 2018

View reviewed changes

fanminshi force-pushed the better_local_workflow branch from 81d13dd to d9babea Compare May 4, 2018 21:40

hasbro17 reviewed May 4, 2018

View reviewed changes

fanminshi force-pushed the better_local_workflow branch 2 times, most recently from 96c24bc to 32b397e Compare May 4, 2018 22:36

fanminshi force-pushed the better_local_workflow branch from 65b9a18 to 7904407 Compare May 4, 2018 22:42

fanminshi force-pushed the better_local_workflow branch from 7904407 to ebc09c0 Compare May 4, 2018 22:42

fanminshi added 2 commits May 4, 2018 15:56

operator-sdk/cmd: add up command

3515196

dep: update dep

f1ca75d

fanminshi force-pushed the better_local_workflow branch from ebc09c0 to f1ca75d Compare May 4, 2018 22:56

fanminshi merged commit 3359d42 into operator-framework:master May 4, 2018

fanminshi mentioned this pull request May 4, 2018

Better local deployment workflow #142

Closed

2 tasks

This was referenced May 16, 2018

Document operator-sdk up local #253

Closed

commands/operator-sdk/cmd/local: add namespace flag #274

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

operator-sdk/cmd: add up command #219

operator-sdk/cmd: add up command #219

fanminshi commented May 2, 2018 •

edited

Loading

fanminshi commented May 2, 2018

fanminshi commented May 2, 2018 •

edited

Loading

fanminshi commented May 3, 2018 •

edited

Loading

spahl commented May 3, 2018 •

edited

Loading

fanminshi commented May 3, 2018

spahl commented May 3, 2018

fanminshi commented May 3, 2018

fanminshi commented May 3, 2018

fanminshi commented May 4, 2018 •

edited

Loading

fanminshi commented May 4, 2018

hasbro17 May 4, 2018

fanminshi May 4, 2018

hasbro17 May 4, 2018

hasbro17 May 4, 2018

hasbro17 May 4, 2018

hasbro17 May 4, 2018

fanminshi May 4, 2018

fanminshi commented May 4, 2018

hasbro17 commented May 4, 2018

operator-sdk/cmd: add up command #219

operator-sdk/cmd: add up command #219

Conversation

fanminshi commented May 2, 2018 • edited Loading

fanminshi commented May 2, 2018

fanminshi commented May 2, 2018 • edited Loading

fanminshi commented May 3, 2018 • edited Loading

spahl commented May 3, 2018 • edited Loading

fanminshi commented May 3, 2018

spahl commented May 3, 2018

fanminshi commented May 3, 2018

fanminshi commented May 3, 2018

fanminshi commented May 4, 2018 • edited Loading

operator-sdk CLI interface :

Local Test

fanminshi commented May 4, 2018

hasbro17 May 4, 2018

Choose a reason for hiding this comment

fanminshi May 4, 2018

Choose a reason for hiding this comment

hasbro17 May 4, 2018

Choose a reason for hiding this comment

hasbro17 May 4, 2018

Choose a reason for hiding this comment

hasbro17 May 4, 2018

Choose a reason for hiding this comment

hasbro17 May 4, 2018

Choose a reason for hiding this comment

fanminshi May 4, 2018

Choose a reason for hiding this comment

fanminshi commented May 4, 2018

hasbro17 commented May 4, 2018

fanminshi commented May 2, 2018 •

edited

Loading

fanminshi commented May 2, 2018 •

edited

Loading

fanminshi commented May 3, 2018 •

edited

Loading

spahl commented May 3, 2018 •

edited

Loading

fanminshi commented May 4, 2018 •

edited

Loading