Merge branch 'master' into refactor/controller-runtime-v0.2.0

Author: estroz

CHANGELOG.md

@@ -2,8 +2,14 @@
 
 ### Added
 
+- The `operator-sdk olm-catalog gen-csv` command now produces indented JSON for the `alm-examples` annotation. ([#1793](https://github.com/operator-framework/operator-sdk/pull/1793))
+- Added flag `--dep-manager` to command [`operator-sdk print-deps`](https://github.com/operator-framework/operator-sdk/blob/master/doc/sdk-cli-reference.md#print-deps) to specify the type of dependency manager file to print. The choice of dependency manager is inferred from top-level dependency manager files present if `--dep-manager` is not set. ([#1819](https://github.com/operator-framework/operator-sdk/pull/1819))
+
 ### Changed
 
+- The Helm operator now uses the CR name for the release name for newly created CRs. Existing CRs will continue to use their existing UID-based release name. When a release name collision occurs (when CRs of different types share the same name), the second CR will fail to install with an error about a duplicate name. ([#1818](https://github.com/operator-framework/operator-sdk/pull/1818))
+- Commands [`olm uninstall`](https://github.com/operator-framework/operator-sdk/blob/master/doc/sdk-cli-reference.md#uninstall) and [`olm status`](https://github.com/operator-framework/operator-sdk/blob/master/doc/sdk-cli-reference.md#status) no longer use a `--version` flag to specify OLM version. This information is now retrieved from the running cluster. ([#1634](https://github.com/operator-framework/operator-sdk/pull/1634))
+
 ### Breaking changes
 
 - CSV config field `role-path` is now `role-paths` and takes a list of strings. Users can now specify multiple `Role` and `ClusterRole` manifests using `role-paths`. ([#1704](https://github.com/operator-framework/operator-sdk/pull/1704))
@@ -35,9 +41,13 @@
 
 ### Removed
 
+- Removed flag `--as-file` from command [`operator-sdk print-deps`](https://github.com/operator-framework/operator-sdk/blob/master/doc/sdk-cli-reference.md#print-deps), which now only prints packages and versions in dependency manager file format. The choice of dependency manager type is set by `--dep-manager` or inferred from top-level dependency manager files present if `--dep-manager` is not set. ([#1819](https://github.com/operator-framework/operator-sdk/pull/1819))
+
 ### Bug Fixes
 
 - Configure the repo path correctly in `operator-sdk add crd` and prevent the command from running outside of an operator project. ([#1660](https://github.com/operator-framework/operator-sdk/pull/1660))
+- In the Helm operator, skip owner reference injection for cluster-scoped resources in release manifests. The Helm operator only supports namespace-scoped CRs, and namespaced resources cannot own cluster-scoped resources. ([#1817](https://github.com/operator-framework/operator-sdk/pull/1817))
+- Package manifests generated with [`gen-csv`](https://github.com/operator-framework/operator-sdk/blob/master/doc/sdk-cli-reference.md#gen-csv) respect the `--operator-name` flag, channel names are checked for duplicates before (re-)generation. ([#1693](https://github.com/operator-framework/operator-sdk/pull/1693))
 
 ## v0.10.0
 
@@ -70,6 +80,7 @@
 - New flags `--csv-channel` and `--default-channel` for subcommand [`gen-csv`](https://github.com/operator-framework/operator-sdk/blob/master/doc/sdk-cli-reference.md#gen-csv) that add channels to and update the [package manifest](https://github.com/operator-framework/operator-registry/#manifest-format) in `deploy/olm-catalog/<operator-name>` when generating a new CSV or updating an existing one. ([#1364](https://github.com/operator-framework/operator-sdk/pull/1364))
 - Adds `go.mod` and `go.sum` to switch from `dep` to [Go modules](https://github.com/golang/go/wiki/Modules) to manage dependencies for the SDK project itself. ([#1566](https://github.com/operator-framework/operator-sdk/pull/1566))
 - New flag `--operator-name` for [`operator-sdk olm-catalog gen-csv`](https://github.com/operator-framework/operator-sdk/blob/master/doc/sdk-cli-reference.md#gen-csv) to specify the operator name, ex. `memcached-operator`, to use in CSV generation. The project's name is used (old behavior) if `--operator-name` is not set. ([#1571](https://github.com/operator-framework/operator-sdk/pull/1571))
+- New flag `--local-operator-flags` for `operator-sdk test local --up-local` to specify flags to run a local operator with during a test. ([#1509](https://github.com/operator-framework/operator-sdk/pull/1509))
 
 ### Changed
 

ci/dockerfiles/ansible-e2e-hybrid.Dockerfile

@@ -20,7 +20,10 @@ ENV OPERATOR=/usr/local/bin/ansible-operator \
     HOME=/opt/ansible
 
 # Install python dependencies
-RUN (yum install -y https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm || true) \
+# Ensure fresh metadata rather than cached metadata in the base by running
+# yum clean all && rm -rf /var/yum/cache/* first
+RUN yum clean all && rm -rf /var/cache/yum/* \
+ && (yum install -y https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm || true) \
  && yum install -y python-devel gcc inotify-tools \
  && easy_install pip \
  && pip install -U --no-cache-dir setuptools pip \

ci/dockerfiles/ansible.Dockerfile

@@ -18,8 +18,10 @@ ENV OPERATOR=/usr/local/bin/ansible-operator \
     USER_NAME=ansible-operator\
     HOME=/opt/ansible
 
-# Install python dependencies
-RUN (yum install -y https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm || true) \
+# Ensure fresh metadata rather than cached metadata in the base by running
+# yum clean all && rm -rf /var/yum/cache/* first
+RUN yum clean all && rm -rf /var/cache/yum/* \
+ && (yum install -y https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm || true) \
  && yum install -y python-devel gcc inotify-tools \
  && easy_install pip \
  && pip install -U --no-cache-dir setuptools pip \

cmd/operator-sdk/alpha/olm/install.go

@@ -34,6 +34,7 @@ func NewInstallCmd() *cobra.Command {
 		},
 	}
 
+	cmd.Flags().StringVar(&mgr.Version, "version", olm.DefaultVersion, "version of OLM resources to install")
 	mgr.AddToFlagSet(cmd.Flags())
 	return cmd
 }

cmd/operator-sdk/alpha/olm/status.go

@@ -28,7 +28,7 @@ func NewStatusCmd() *cobra.Command {
 		Short: "Get the status of the Operator Lifecycle Manager installation in your cluster",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			if err := mgr.Status(); err != nil {
-				log.Fatalf("Failed to get OLM status for version %q: %s", mgr.Version, err)
+				log.Fatalf("Failed to get OLM status: %s", err)
 			}
 			return nil
 		},

cmd/operator-sdk/alpha/olm/uninstall.go

@@ -28,7 +28,7 @@ func NewUninstallCmd() *cobra.Command {
 		Short: "Uninstall Operator Lifecycle Manager from your cluster",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			if err := mgr.Uninstall(); err != nil {
-				log.Fatalf("Failed to uninstall OLM version %q: %s", mgr.Version, err)
+				log.Fatalf("Failed to uninstall OLM: %s", err)
 			}
 			return nil
 		},

cmd/operator-sdk/internal/genutil/genutil.go

@@ -23,7 +23,7 @@ import (
 	log "github.com/sirupsen/logrus"
 )
 
-// generateWithHeaderFile runs f with a header file path as an arguemnt.
+// generateWithHeaderFile runs f with a header file path as an argument.
 // If there is no project boilerplate.go.txt file, an empty header file is
 // created and its path passed as the argument.
 // generateWithHeaderFile is meant to be used with Kubernetes code generators.

cmd/operator-sdk/main.go

@@ -119,6 +119,7 @@ var commandsToSkip = map[string]struct{}{
 	"help":         struct{}{},
 	"completion":   struct{}{},
 	"version":      struct{}{},
+	"print-deps":   struct{}{}, // Does not require this logic
 }
 
 func skipCheckForCmd(cmd *cobra.Command) (skip bool) {

cmd/operator-sdk/olmcatalog/gen-csv.go

@@ -107,6 +107,7 @@ func genCSVFunc(cmd *cobra.Command, args []string) error {
 			CSVVersion:       csvVersion,
 			Channel:          csvChannel,
 			ChannelIsDefault: defaultChannel,
+			OperatorName:     operatorName,
 		},
 	)
 	if err != nil {

cmd/operator-sdk/printdeps/cmd.go

@@ -25,7 +25,7 @@ import (
 	"github.com/spf13/cobra"
 )
 
-var asFile bool
+var depManager string
 
 func NewCmd() *cobra.Command {
 	printDepsCmd := &cobra.Command{
@@ -35,14 +35,11 @@ func NewCmd() *cobra.Command {
 by this version of the Operator SDK. Versions for these packages should match
 those in an operators' go.mod or Gopkg.toml file, depending on the dependency
 manager chosen when initializing or migrating a project.
-
-print-deps prints in columnar format by default. Use the --as-file flag to
-print in go.mod or Gopkg.toml file format.
 `,
 		RunE: printDepsFunc,
 	}
 
-	printDepsCmd.Flags().BoolVar(&asFile, "as-file", false, "Print dependencies in go.mod or Gopkg.toml file format, depending on the dependency manager chosen when initializing or migrating a project")
+	printDepsCmd.Flags().StringVar(&depManager, "dep-manager", "", `Dependency manager file type to print (choices: "dep", "modules")`)
 
 	return printDepsCmd
 }
@@ -51,17 +48,23 @@ func printDepsFunc(cmd *cobra.Command, args []string) error {
 	if len(args) != 0 {
 		return fmt.Errorf("command %s doesn't accept any arguments", cmd.CommandPath())
 	}
+	projutil.MustInProjectRoot()
 
-	if err := printDeps(asFile); err != nil {
-		return fmt.Errorf("print deps failed: (%v)", err)
+	if err := printDeps(depManager); err != nil {
+		return fmt.Errorf("print deps failed: %v", err)
 	}
 	return nil
 }
 
-func printDeps(asFile bool) error {
-	// Make sure the project has a dep manager file.
-	mt, err := projutil.GetDepManagerType()
-	if err != nil {
+func printDeps(depManager string) (err error) {
+	// Use depManager if set. Fall back to the project's current dep manager
+	// type if unset.
+	mt := projutil.DepManagerType(depManager)
+	if mt != "" {
+		if mt != projutil.DepManagerDep && mt != projutil.DepManagerGoMod {
+			return projutil.ErrInvalidDepManager(mt)
+		}
+	} else if mt, err = projutil.GetDepManagerType(); err != nil {
 		return err
 	}
 	isDep := mt == projutil.DepManagerDep
@@ -71,19 +74,19 @@ func printDeps(asFile bool) error {
 	switch {
 	case projutil.IsOperatorAnsible():
 		if isDep {
-			return ansible.PrintDepGopkgTOML(asFile)
+			return ansible.PrintDepGopkgTOML()
 		}
-		return ansible.PrintGoMod(asFile)
+		return ansible.PrintGoMod()
 	case projutil.IsOperatorHelm():
 		if isDep {
-			return helm.PrintDepGopkgTOML(asFile)
+			return helm.PrintDepGopkgTOML()
 		}
-		return helm.PrintGoMod(asFile)
+		return helm.PrintGoMod()
 	case projutil.IsOperatorGo():
 		if isDep {
-			return scaffold.PrintDepGopkgTOML(asFile)
+			return scaffold.PrintDepGopkgTOML()
 		}
-		return scaffold.PrintGoMod(asFile)
+		return scaffold.PrintGoMod()
 	}
 
 	return projutil.ErrUnknownOperatorType{}

doc/sdk-cli-reference.md

@@ -91,14 +91,14 @@ Prints the most recent Golang packages and versions required by operators. Print
 
 ### Flags
 
-* `--as-file` - Print packages and versions in go.mod or Gopkg.toml format, depending on the dependency manager chosen when initializing or migrating a project.
+* `--dep-manager` string - Dependency manager file type to print (choices: "dep", "modules")
 
 ### Example
 
 With dependency manager `dep`:
 
 ```console
-$ operator-sdk print-deps --as-file
+$ operator-sdk print-deps
 required = [
   "k8s.io/code-generator/cmd/deepcopy-gen",
   "k8s.io/code-generator/cmd/conversion-gen",
@@ -115,10 +115,10 @@ required = [
 ...
 ```
 
-With dependency manager `modules`, i.e. go mod:
+With dependency manager Go `modules`:
 
 ```console
-$ operator-sdk print-deps --as-file
+$ operator-sdk print-deps
 module github.com/example-inc/memcached-operator
 
 require (
@@ -560,7 +560,6 @@ $ operator-sdk up local --namespace "testing"
 
 ### Flags
 
-* `--version` string - version of OLM resources to install, uninstall, or get status about (default: "latest")
 * `--timeout` duration - time to wait for the command to complete before failing (default: "2m")
 
 ### Available commands
@@ -577,42 +576,33 @@ then creating all of the necessary resources and waiting for them to become
 healthy. When the installation is complete, `olm install` outputs a status summary
 of all of the resources that were installed.
 
+##### Flags
+
+* `--version` string - version of OLM resources to install, uninstall, or get status about (default: "latest")
+
 #### uninstall - Uninstalls Operator Lifecycle Manager
 
 ##### Use
 
 The `operator-sdk alpha olm uninstall` command uninstalls OLM from a Kubernetes
 cluster based on the configured kubeconfig. It works by downloading OLM's
-release manifests at a specific version (default: `latest`), checking to see if
+release manifests at the version installed in the cluster, checking to see if
 any of those resources exist (if none exist, it aborts with an error since OLM
 is not installed), and then deletes each resource that is listed in the
 downloaded release manifests. It waits until all resources have been fully
 cleaned up before returning.
 
-**NOTE**: It is important to use `--version` with the version number that
-corresponds to the version that you installed with `olm install`. Not specifying
-the version (or using an incorrect version) may cause some resources not be
-cleaned up. This can occur if OLM changes its release manifest resources from
-one version of OLM to the next.
-
 #### status - Get status of the Operator Lifecycle Manager installation
 
 ##### Use
 
 The `operator-sdk alpha olm status` command gets the status of the OLM
 installation in a Kubernetes cluster based on the configured kubeconfig. It
-works by downloading OLM's release manifests at a specific version (default:
-`latest`), checking to see if any of those resources exist (if none exist, it
+works by downloading OLM's release manifests at the version installed in the
+cluster, checking to see if any of those resources exist (if none exist, it
 aborts with an error since OLM is not installed), and printing a summary of the
 status of each of those resources as they exist in the cluster.
 
-**NOTE**: It is important to use `--version` with the version number that
-corresponds to the version that you installed with `olm install`. Not specifying
-the version (or using an incorrect version) may cause some resources to be
-missing from the summary and others to be listed as "not found". This can occur
-if OLM changes its release manifest resources from one version of OLM to the
-next.
-
 [utility_link]: https://github.com/operator-framework/operator-sdk/blob/89bf021063d18b6769bdc551ed08fc37027939d5/pkg/util/k8sutil/k8sutil.go#L140
 [k8s-code-generator]: https://github.com/kubernetes/code-generator
 [openapi-code-generator]: https://github.com/kubernetes/kube-openapi

doc/user-guide.md

@@ -163,9 +163,20 @@ err := c.Watch(&source.Kind{Type: &appsv1.Deployment{}}, &handler.EnqueueRequest
   })
 ```
 
-**// TODO:** Doc on eventhandler, arbitrary mapping between watched and reconciled resource.
+#### Controller configurations
+
+There are a number of useful configurations that can be made when initialzing a controller and declaring the watch parameters. For more details on these configurations consult the upstream [controller godocs][controller_godocs]. 
+
+- Set the max number of concurrent Reconciles for the controller via the [`MaxConcurrentReconciles`][controller_options]  option. Defaults to 1.
+  ```Go
+  _, err := controller.New("memcached-controller", mgr, controller.Options{
+	  MaxConcurrentReconciles: 2,
+	  ...
+  })
+  ```
+- Filter watch events using [predicates][event_filtering]
+- Choose the type of [EventHandler][event_handler_godocs] to change how a watch event will translate to reconcile requests for the reconcile loop. For operator relationships that are more complex than primary and secondary resources, the [`EnqueueRequestsFromMapFunc`][enqueue_requests_from_map_func] handler can be used to transform a watch event into an arbitrary set of reconcile requests.
 
-**// TODO:** Doc on configuring a Controller: number of workers, predicates, watching channels,
 
 ### Reconcile loop
 
@@ -614,6 +625,11 @@ func main() {
 
 When the operator is not running in a cluster, the Manager will return an error on starting since it can't detect the operator's namespace in order to create the configmap for leader election. You can override this namespace by setting the Manager's `LeaderElectionNamespace` option.
 
+[enqueue_requests_from_map_func]: https://godoc.org/sigs.k8s.io/controller-runtime/pkg/handler#EnqueueRequestsFromMapFunc
+[event_handler_godocs]: https://godoc.org/sigs.k8s.io/controller-runtime/pkg/handler#hdr-EventHandlers
+[event_filtering]:./user/event-filtering.md
+[controller_options]: https://godoc.org/github.com/kubernetes-sigs/controller-runtime/pkg/controller#Options
+[controller_godocs]: https://godoc.org/github.com/kubernetes-sigs/controller-runtime/pkg/controller
 [operator_scope]:./operator-scope.md
 [install_guide]: ./user/install-operator-sdk.md
 [pod_eviction_timeout]: https://kubernetes.io/docs/reference/command-line-tools-reference/kube-controller-manager/#options

go.mod

@@ -6,7 +6,6 @@ require (
 	cloud.google.com/go v0.37.2 // indirect
 	contrib.go.opencensus.io/exporter/ocagent v0.4.11 // indirect
 	github.com/Azure/go-autorest v11.7.0+incompatible // indirect
-	github.com/BurntSushi/toml v0.3.1
 	github.com/DATA-DOG/go-sqlmock v1.3.3 // indirect
 	github.com/MakeNowJust/heredoc v0.0.0-20171113091838-e9091a26100e // indirect
 	github.com/Masterminds/goutils v1.1.0 // indirect

hack/tests/alpha-olm-subcommands.sh

@@ -5,36 +5,35 @@ set -ex
 
 test_version() {
     local version="$1"
+    # If version is "latest", run without --version flag
+    local ver_flag="--version=${version}"
+    if [[ "$version" == "latest" ]]; then
+      ver_flag=""
+    fi
 
     # Status should fail with OLM not installed
-    commandoutput=$(operator-sdk alpha olm status --version=${version} 2>&1 || true)
-    echo $commandoutput | grep -F "Failed to get OLM status for version \\\"${version}\\\": no existing installation found"
+    commandoutput=$(operator-sdk alpha olm status 2>&1 || true)
+    echo $commandoutput | grep -F "Failed to get OLM status: no existing installation found"
 
     # Uninstall should fail with OLM not installed
-    commandoutput=$(operator-sdk alpha olm uninstall --version=${version} 2>&1 || true)
-    echo $commandoutput | grep -F "Failed to uninstall OLM version \\\"${version}\\\": no existing installation found"
+    commandoutput=$(operator-sdk alpha olm uninstall 2>&1 || true)
+    echo $commandoutput | grep -F "Failed to uninstall OLM: no existing installation found"
 
     # Install should succeed with nothing installed
-    commandoutput=$(operator-sdk alpha olm install --version=${version} 2>&1)
+    commandoutput=$(operator-sdk alpha olm install $ver_flag 2>&1)
     echo $commandoutput | grep -F "Successfully installed OLM version \\\"${version}\\\""
 
     # Install should fail with OLM Installed
-    commandoutput=$(operator-sdk alpha olm install --version=${version} 2>&1 || true)
+    commandoutput=$(operator-sdk alpha olm install $ver_flag 2>&1 || true)
     echo $commandoutput | grep -F "Failed to install OLM version \\\"${version}\\\": detected existing OLM resources: OLM must be completely uninstalled before installation"
 
     # Status should succeed with OLM installed
-    # If version is "latest", also run without --version flag
-    if [[ "$version" == "latest" ]]; then
-        commandoutput=$(operator-sdk alpha olm status 2>&1)
-        echo $commandoutput | grep -F "Successfully got OLM status for version \\\"${version}\\\""
-    fi
-
-    commandoutput=$(operator-sdk alpha olm status --version=${version} 2>&1)
-    echo $commandoutput | grep -F "Successfully got OLM status for version \\\"${version}\\\""
+    commandoutput=$(operator-sdk alpha olm status 2>&1)
+    echo $commandoutput | grep -F "Successfully got OLM status"
 
     # Uninstall should succeed with OLM installed
-    commandoutput=$(operator-sdk alpha olm uninstall --version=${version} 2>&1)
-    echo $commandoutput | grep -F "Successfully uninstalled OLM version \\\"${version}\\\""
+    commandoutput=$(operator-sdk alpha olm uninstall 2>&1)
+    echo $commandoutput | grep -F "Successfully uninstalled OLM"
 }
 
 test_version "latest"