feat: allow kb layout works on operator-sdk run local command #2948
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -25,18 +25,19 @@ import ( | |
| "strings" | ||
| "syscall" | ||
|
|
||
| log "github.com/sirupsen/logrus" | ||
| "github.com/spf13/pflag" | ||
| logf "sigs.k8s.io/controller-runtime/pkg/log" | ||
|
|
||
| "github.com/operator-framework/operator-sdk/internal/scaffold" | ||
| kbutil "github.com/operator-framework/operator-sdk/internal/util/kubebuilder" | ||
| "github.com/operator-framework/operator-sdk/internal/util/projutil" | ||
| "github.com/operator-framework/operator-sdk/pkg/ansible" | ||
| aoflags "github.com/operator-framework/operator-sdk/pkg/ansible/flags" | ||
| "github.com/operator-framework/operator-sdk/pkg/helm" | ||
| hoflags "github.com/operator-framework/operator-sdk/pkg/helm/flags" | ||
| "github.com/operator-framework/operator-sdk/pkg/k8sutil" | ||
| "github.com/operator-framework/operator-sdk/pkg/log/zap" | ||
| ) | ||
|
|
||
| type runLocalArgs struct { | ||
|
|
@@ -52,9 +53,15 @@ type runLocalArgs struct { | |
| func (c *runLocalArgs) addToFlags(fs *pflag.FlagSet) { | ||
| prefix := "[local only] " | ||
|
|
||
| // The main.go and manager.yaml scaffolds in the new layout do not support the WATCH_NAMESPACE | ||
| // env var to configure the namespace that the operator watches. The default is all namespaces. | ||
| // So this flag is unsupported for the new layout. | ||
| if !kbutil.HasProjectFile() { | ||
| fs.StringVar(&c.watchNamespace, "watch-namespace", "", | ||
| prefix+"The namespace where the operator watches for changes. Set \"\" for AllNamespaces, "+ | ||
| "set \"ns1,ns2\" for MultiNamespace") | ||
|
Comment on lines
+60
to
+62
Member
Contributor
Author
There was a problem hiding this comment. For the first contidional here It will set watch-namepace == namespace if the flag is set. Since the flag does not exist when it is in the new layout all is fine. Anyway, we can be redundant and add a check as well to ensure case something change. However, for the second conditional here you are right we need set it for cluster-scoped. |
||
| } | ||
|
|
||
| fs.StringVar(&c.operatorFlags, "operator-flags", "", | ||
| prefix+"The flags that the operator needs. Example: \"--flag1 value1 --flag2=value2\"") | ||
| fs.StringVar(&c.ldFlags, "go-ldflags", "", prefix+"Set Go linker options") | ||
|
|
@@ -63,8 +70,12 @@ func (c *runLocalArgs) addToFlags(fs *pflag.FlagSet) { | |
| } | ||
|
|
||
| func (c runLocalArgs) run() error { | ||
| // The new layout will not have c.watchNamespace | ||
| if kbutil.HasProjectFile() { | ||
| log.Infof("Running the operator locally ...") | ||
| } else { | ||
| log.Infof("Running the operator locally; watching namespace %q", c.watchNamespace) | ||
| } | ||
| switch t := projutil.GetOperatorType(); t { | ||
| case projutil.OperatorTypeGo: | ||
| return c.runGo() | ||
|
|
@@ -76,65 +87,39 @@ func (c runLocalArgs) run() error { | |
| return projutil.ErrUnknownOperatorType{} | ||
| } | ||
|
|
||
| // runGo will run the project locally for the Go Type projects | ||
| func (c runLocalArgs) runGo() error { | ||
| // Build the project and generate binary that will be executed | ||
| binName, err := c.generateBinary() | ||
| if err != nil { | ||
| return err | ||
| } | ||
| // Get the args that will be used to exec the binary. | ||
| // Users are allowed to use the flag operator-flags to pass any value that they may wish | ||
| args := c.argsFromOperatorFlags() | ||
| // Build the command | ||
| var cmd *exec.Cmd | ||
| if c.enableDelve { | ||
| cmd = getExecCmdWithDebugger(binName, args) | ||
| } else { | ||
| cmd = exec.Command(binName, args...) | ||
| } | ||
| // Kill the command if an exit signal is received. | ||
| ch := make(chan os.Signal) | ||
| signal.Notify(ch, os.Interrupt, syscall.SIGTERM) | ||
| go func() { | ||
| <-ch | ||
| err := cmd.Process.Kill() | ||
| if err != nil { | ||
| log.Fatalf("Failed to terminate the operator: (%v)", err) | ||
| } | ||
| os.Exit(0) | ||
| }() | ||
| // Add default env vars and values informed via flags | ||
| c.addEnvVars(cmd) | ||
| if err := projutil.ExecCmd(cmd); err != nil { | ||
| return fmt.Errorf("failed to run operator locally: %v", err) | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
|
|
@@ -154,6 +139,7 @@ func (c runLocalArgs) runHelm() error { | |
| return helm.Run(c.helmOperatorFlags) | ||
| } | ||
|
|
||
| // setupOperatorEnv will add envvar for the kubeconfig and namespace informed | ||
| func setupOperatorEnv(kubeconfig, namespace string) error { | ||
| // Set the kubeconfig that the manager will be able to grab | ||
| // only set env var if user explicitly specified a kubeconfig path | ||
|
|
@@ -168,8 +154,6 @@ func setupOperatorEnv(kubeconfig, namespace string) error { | |
| return fmt.Errorf("failed to set %s environment variable: %v", k8sutil.WatchNamespaceEnvVar, err) | ||
| } | ||
| } | ||
| if _, err := k8sutil.GetOperatorName(); err != nil { | ||
| operatorName := filepath.Base(projutil.MustGetwd()) | ||
| if err := os.Setenv(k8sutil.OperatorNameEnvVar, operatorName); err != nil { | ||
|
|
@@ -179,18 +163,93 @@ func setupOperatorEnv(kubeconfig, namespace string) error { | |
| return nil | ||
| } | ||
|
|
||
| // getBuildRunLocalArgs returns go build args for -ldflags and -gcflags | ||
| func (c runLocalArgs) getBuildRunLocalArgs() []string { | ||
| var args []string | ||
| if c.ldFlags != "" { | ||
| args = []string{"-ldflags", c.ldFlags} | ||
| } | ||
| if c.enableDelve { | ||
| args = append(args, "-gcflags=\"all=-N -l\"") | ||
| } | ||
| return args | ||
| } | ||
|
|
||
| // generateBinary will build the Go project by running the command `go build -o bin/manager main.go` | ||
| func (c runLocalArgs) generateBinary() (string, error) { | ||
| // Define name of the bin and where is the main.go pkg for each layout | ||
| var outputBinName, packagePath string | ||
| if kbutil.HasProjectFile() { | ||
| outputBinName = filepath.Join(kbutil.BinBuildDir, getProjectName()+"-local") | ||
| packagePath = projutil.GetGoPkg() | ||
| } else { | ||
| // todo: remove the if, else when the legacy code is no longer supported | ||
| packagePath = path.Join(projutil.GetGoPkg(), filepath.ToSlash(scaffold.ManagerDir)) | ||
| outputBinName = filepath.Join(scaffold.BuildBinDir, getProjectName()+"-local") | ||
| } | ||
| // allow the command works in windows SO | ||
| if runtime.GOOS == "windows" { | ||
| outputBinName += ".exe" | ||
| } | ||
| opts := projutil.GoCmdOptions{ | ||
| BinName: outputBinName, | ||
| PackagePath: packagePath, | ||
| Args: c.getBuildRunLocalArgs(), | ||
| } | ||
| if err := projutil.GoBuild(opts); err != nil { | ||
| return "", err | ||
| } | ||
| return outputBinName, nil | ||
| } | ||
|
|
||
| // execCmdForBinWithDebugger will exec the command with the delve required args | ||
| // Note that delve is a debugger for the Go programming language. | ||
| // More info: https://github.com/go-delve/delve | ||
| func getExecCmdWithDebugger(binName string, args []string) *exec.Cmd { | ||
| delveArgs := []string{"--listen=:2345", "--headless=true", "--api-version=2", "exec", binName, "--"} | ||
| delveArgs = append(delveArgs, args...) | ||
| log.Infof("Delve debugger enabled with args %s", delveArgs) | ||
| return exec.Command("dlv", delveArgs...) | ||
| } | ||
|
|
||
| // addEnvVars will add the EnvVars to the command informed | ||
| func (c runLocalArgs) addEnvVars(cmd *exec.Cmd) { | ||
| cmd.Env = os.Environ() | ||
|
|
||
| // Set EnvVar to let the project knows that it is running outside of the cluster | ||
| cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", k8sutil.ForceRunModeEnv, k8sutil.LocalRunMode)) | ||
|
|
||
| // Only set env var if user explicitly specified a kubeconfig path | ||
| if c.kubeconfig != "" { | ||
| cmd.Env = append(cmd.Env, fmt.Sprintf("%v=%v", k8sutil.KubeConfigEnvVar, c.kubeconfig)) | ||
| } | ||
|
|
||
| // Set WATCH_NAMESPACE with the value informed via flag | ||
| cmd.Env = append(cmd.Env, fmt.Sprintf("%v=%v", k8sutil.WatchNamespaceEnvVar, c.watchNamespace)) | ||
|
|
||
| // todo: check if it should really be here. Shows that it should be part of AnsibleRun only. | ||
| // Set the ANSIBLE_ROLES_PATH | ||
| if c.ansibleOperatorFlags != nil && len(c.ansibleOperatorFlags.AnsibleRolesPath) > 0 { | ||
| log.Info(fmt.Sprintf("set the value %v for environment variable %v.", | ||
| c.ansibleOperatorFlags.AnsibleRolesPath, aoflags.AnsibleRolesPathEnvVar)) | ||
| cmd.Env = append(cmd.Env, fmt.Sprintf("%v=%v", aoflags.AnsibleRolesPathEnvVar, | ||
| c.ansibleOperatorFlags.AnsibleRolesPath)) | ||
| } | ||
| } | ||
|
|
||
| // argsFromOperatorFlags will return an array with all args used in the flags | ||
| func (c runLocalArgs) argsFromOperatorFlags() []string { | ||
| args := []string{} | ||
| if c.operatorFlags != "" { | ||
| extraArgs := strings.Split(c.operatorFlags, " ") | ||
| args = append(args, extraArgs...) | ||
| } | ||
| return args | ||
| } | ||
|
|
||
| // getProjectName will return the name of the project. This function only works if the current working directory | ||
| // is the project root. | ||
| func getProjectName() string { | ||
| absProjectPath := projutil.MustGetwd() | ||
| return filepath.Base(absProjectPath) | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| // Copyright 2020 The 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 kbutil | ||
|
|
||
| const ( | ||
| BinBuildDir = "bin" | ||
| ) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
just sort the imports and added the kbutils one.