Merge branch 'master' into go-e2e-refactor

Author: AlexNPavel

CHANGELOG.md

@@ -10,6 +10,7 @@
 - Scaffold a `pkg/apis/<group>/group.go` package file to avoid `go/build` errors when running Kubernetes code generators. ([#1401](https://github.com/operator-framework/operator-sdk/pull/1401))
 - Adds a new extra variable containing the unmodified CR spec for ansible based operators. [#1563](https://github.com/operator-framework/operator-sdk/pull/1563)
 - New flag `--repo` for subcommands [`new`](https://github.com/operator-framework/operator-sdk/blob/master/doc/sdk-cli-reference.md#new) and [`migrate`](https://github.com/operator-framework/operator-sdk/blob/master/doc/sdk-cli-reference.md#migrate) specifies the repository path to be used in Go source files generated by the SDK. This flag can only be used with [Go modules](https://github.com/golang/go/wiki/Modules). ([#1475](https://github.com/operator-framework/operator-sdk/pull/1475))
+- Adds `--go-build-args` flag to `operator-sdk build` for providing additional Go build arguments. ([#1582](https://github.com/operator-framework/operator-sdk/pull/1582))
 
 ### Changed
 

Gopkg.lock

@@ -32,6 +32,7 @@ import (
 var (
 	imageBuildArgs string
 	imageBuilder   string
+	goBuildArgs    string
 )
 
 func NewCmd() *cobra.Command {
@@ -54,6 +55,7 @@ For example:
 	}
 	buildCmd.Flags().StringVar(&imageBuildArgs, "image-build-args", "", "Extra image build arguments as one string such as \"--build-arg https_proxy=$https_proxy\"")
 	buildCmd.Flags().StringVar(&imageBuilder, "image-builder", "docker", "Tool to build OCI images. One of: [docker, podman, buildah]")
+	buildCmd.Flags().StringVar(&goBuildArgs, "go-build-args", "", "Extra Go build arguments as one string such as \"-ldflags -X=main.xyz=abc\"")
 	return buildCmd
 }
 
@@ -99,10 +101,17 @@ func buildFunc(cmd *cobra.Command, args []string) error {
 	// Don't need to build Go code if a non-Go Operator.
 	if projutil.IsOperatorGo() {
 		trimPath := fmt.Sprintf("all=-trimpath=%s", filepath.Dir(absProjectPath))
+		args := []string{"-gcflags", trimPath, "-asmflags", trimPath}
+
+		if goBuildArgs != "" {
+			splitArgs := strings.Fields(goBuildArgs)
+			args = append(args, splitArgs...)
+		}
+
 		opts := projutil.GoCmdOptions{
 			BinName:     filepath.Join(absProjectPath, scaffold.BuildBinDir, projectName),
 			PackagePath: path.Join(projutil.GetGoPkg(), filepath.ToSlash(scaffold.ManagerDir)),
-			Args:        []string{"-gcflags", trimPath, "-asmflags", trimPath},
+			Args:        args,
 			Env:         goBuildEnv,
 			GoMod:       projutil.IsDepManagerGoMod(),
 		}

cmd/operator-sdk/build/cmd.go

@@ -4,22 +4,22 @@ This guide walks through an example of building a simple memcached-operator powe
 
 ## Prerequisites
 
-- [git][git_tool]
-- [docker][docker_tool] version 17.03+.
-- [kubectl][kubectl_tool] version v1.9.0+.
-- [ansible][ansible_tool] version v2.6.0+
-- [ansible-runner][ansible_runner_tool] version v1.1.0+
-- [ansible-runner-http][ansible_runner_http_plugin] version v1.0.0+
-- [dep][dep_tool] version v0.5.0+. (Optional if you aren't installing from source)
-- [go][go_tool] version v1.12+. (Optional if you aren't installing from source)
+- [git][git-tool]
+- [docker][docker-tool] version 17.03+.
+- [kubectl][kubectl-tool] version v1.9.0+.
+- [ansible][ansible-tool] version v2.6.0+
+- [ansible-runner][ansible-runner-tool] version v1.1.0+
+- [ansible-runner-http][ansible-runner-http-plugin] version v1.0.0+
+- [dep][dep-tool] version v0.5.0+. (Optional if you aren't installing from source)
+- [go][go-tool] version v1.12+. (Optional if you aren't installing from source)
 - Access to a Kubernetes v.1.9.0+ cluster.
 
-**Note**: This guide uses [minikube][minikube_tool] version v0.25.0+ as the
-local Kubernetes cluster and [quay.io][quay_link] for the public registry.
+**Note**: This guide uses [minikube][minikube-tool] version v0.25.0+ as the
+local Kubernetes cluster and [quay.io][quay-link] for the public registry.
 
 ## Install the Operator SDK CLI
 
-Follow the steps in the [installation guide][install_guide] to learn how to install the Operator SDK CLI tool.
+Follow the steps in the [installation guide][install-guide] to learn how to install the Operator SDK CLI tool.
 
 ## Create a new project
 
@@ -35,11 +35,11 @@ Memcached resource with APIVersion `cache.example.com/v1apha1` and Kind
 `Memcached`.
 
 To learn more about the project directory structure, see [project
-layout][layout_doc] doc.
+layout][layout-doc] doc.
 
 #### Operator scope
 
-Read the [operator scope][operator_scope] documentation on how to run your operator as namespace-scoped vs cluster-scoped.
+Read the [operator scope][operator-scope] documentation on how to run your operator as namespace-scoped vs cluster-scoped.
 
 ### Watches file
 
@@ -282,8 +282,8 @@ memcached-operator       1         1         1            1           1m
 
 This method is preferred during the development cycle to speed up deployment and testing.
 
-**Note**: Ensure that [Ansible Runner][ansible_runner_tool] and [Ansible Runner
-HTTP Plugin][ansible_runner_http_plugin] is installed or else you will see
+**Note**: Ensure that [Ansible Runner][ansible-runner-tool] and [Ansible Runner
+HTTP Plugin][ansible-runner-http-plugin] is installed or else you will see
 unexpected errors from Ansible Runner when a Custom Resource is created.
 
 It is also important that the `role` path referenced in `watches.yaml` exists
@@ -410,17 +410,17 @@ $ kubectl delete -f deploy/service_account.yaml
 $ kubectl delete -f deploy/crds/cache_v1alpha1_memcached_crd.yaml
 ```
 
-[operator_scope]:./../operator-scope.md
-[install_guide]: ../user/install-operator-sdk.md
-[layout_doc]:./project_layout.md
-[homebrew_tool]:https://brew.sh/
-[dep_tool]:https://golang.github.io/dep/docs/installation.html
-[git_tool]:https://git-scm.com/downloads
-[go_tool]:https://golang.org/dl/
-[docker_tool]:https://docs.docker.com/install/
-[kubectl_tool]:https://kubernetes.io/docs/tasks/tools/install-kubectl/
-[minikube_tool]:https://github.com/kubernetes/minikube#installation
-[ansible_tool]:https://docs.ansible.com/ansible/latest/index.html
-[ansible_runner_tool]:https://ansible-runner.readthedocs.io/en/latest/install.html
-[ansible_runner_http_plugin]:https://github.com/ansible/ansible-runner-http
-[quay_link]:https://quay.io
+[operator-scope]:./../operator-scope.md
+[install-guide]: ../user/install-operator-sdk.md
+[layout-doc]:./project_layout.md
+[homebrew-tool]:https://brew.sh/
+[dep-tool]:https://golang.github.io/dep/docs/installation.html
+[git-tool]:https://git-scm.com/downloads
+[go-tool]:https://golang.org/dl/
+[docker-tool]:https://docs.docker.com/install/
+[kubectl-tool]:https://kubernetes.io/docs/tasks/tools/install-kubectl/
+[minikube-tool]:https://github.com/kubernetes/minikube#installation
+[ansible-tool]:https://docs.ansible.com/ansible/latest/index.html
+[ansible-runner-tool]:https://ansible-runner.readthedocs.io/en/latest/install.html
+[ansible-runner-http-plugin]:https://github.com/ansible/ansible-runner-http
+[quay-link]:https://quay.io

doc/ansible/user-guide.md

@@ -3,13 +3,13 @@
 This document explains how to setup your dev environment.
 
 ## Prerequisites
-- [dep][dep_tool] version v0.5.0+
-- [git][git_tool]
-- [go][go_tool] version v1.12+
+- [dep][dep-tool] version v0.5.0+
+- [git][git-tool]
+- [go][go-tool] version v1.12+
 
 ## Download Operator SDK
 
-Go to the [Operator SDK repo][repo_sdk] and follow the [fork guide][fork_guide] to fork, clone, and setup the local operator-sdk repository.
+Go to the [Operator SDK repo][repo-sdk] and follow the [fork guide][fork-guide] to fork, clone, and setup the local operator-sdk repository.
 
 ## Vendor dependencies
 
@@ -47,14 +47,14 @@ $ make test
 For more information on running testing and correctly configuring your environment,
 refer to the [`Running the Tests Locally`][running-the-tests] document.
 
-See the project [README][sdk_readme] for more details.
+See the project [README][sdk-readme] for more details.
 
-[dep_tool]:https://golang.github.io/dep/docs/installation.html
-[git_tool]:https://git-scm.com/downloads
-[go_tool]:https://golang.org/dl/
-[repo_sdk]:https://github.com/operator-framework/operator-sdk
-[fork_guide]:https://help.github.com/en/articles/fork-a-repo
-[docker_tool]:https://docs.docker.com/install/
-[kubectl_tool]:https://kubernetes.io/docs/tasks/tools/install-kubectl/
-[sdk_readme]:../../README.md
+[dep-tool]:https://golang.github.io/dep/docs/installation.html
+[git-tool]:https://git-scm.com/downloads
+[go-tool]:https://golang.org/dl/
+[repo-sdk]:https://github.com/operator-framework/operator-sdk
+[fork-guide]:https://help.github.com/en/articles/fork-a-repo
+[docker-tool]:https://docs.docker.com/install/
+[kubectl-tool]:https://kubernetes.io/docs/tasks/tools/install-kubectl/
+[sdk-readme]:../../README.md
 [running-the-tests]: ./testing/running-the-tests.md

doc/dev/developer_guide.md

@@ -4,19 +4,19 @@ This guide walks through an example of building a simple nginx-operator powered
 
 ## Prerequisites
 
-- [git][git_tool]
-- [docker][docker_tool] version 17.03+.
-- [kubectl][kubectl_tool] version v1.11.3+.
-- [dep][dep_tool] version v0.5.0+. (Optional if you aren't installing from source)
-- [go][go_tool] version v1.12+. (Optional if you aren't installing from source)
+- [git][git-tool]
+- [docker][docker-tool] version 17.03+.
+- [kubectl][kubectl-tool] version v1.11.3+.
+- [dep][dep-tool] version v0.5.0+. (Optional if you aren't installing from source)
+- [go][go-tool] version v1.12+. (Optional if you aren't installing from source)
 - Access to a Kubernetes v1.11.3+ cluster.
 
-**Note**: This guide uses [minikube][minikube_tool] version v0.25.0+ as the
-local Kubernetes cluster and [quay.io][quay_link] for the public registry.
+**Note**: This guide uses [minikube][minikube-tool] version v0.25.0+ as the
+local Kubernetes cluster and [quay.io][quay-link] for the public registry.
 
 ## Install the Operator SDK CLI
 
-Follow the steps in the [installation guide][install_guide] to learn how to install the Operator SDK CLI tool.
+Follow the steps in the [installation guide][install-guide] to learn how to install the Operator SDK CLI tool.
 
 ## Create a new project
 
@@ -37,7 +37,7 @@ chart's default manifest. Be sure to double check that the rules generated
 in `deploy/role.yaml` meet the operator's permission requirements.
 
 To learn more about the project directory structure, see the
-[project layout][layout_doc] doc.
+[project layout][layout-doc] doc.
 
 ### Use an existing chart
 
@@ -66,7 +66,7 @@ If `--helm-chart-version` is not set, the SDK will fetch the latest available ve
 
 ### Operator scope
 
-Read the [operator scope][operator_scope] documentation on how to run your operator as namespace-scoped vs cluster-scoped.
+Read the [operator scope][operator-scope] documentation on how to run your operator as namespace-scoped vs cluster-scoped.
 
 
 ## Customize the operator logic
@@ -102,11 +102,11 @@ resources, along with a NOTES.txt template, which Helm chart developers use
 to convey helpful information about a release.
 
 If you aren't already familiar with Helm Charts, take a moment to review
-the [Helm Chart developer documentation][helm_charts].
+the [Helm Chart developer documentation][helm-charts].
 
 ### Understanding the Nginx CR spec
 
-Helm uses a concept called [values][helm_values] to provide customizations
+Helm uses a concept called [values][helm-values] to provide customizations
 to a Helm chart's defaults, which are defined in the Helm chart's `values.yaml`
 file.
 
@@ -329,16 +329,16 @@ kubectl delete -f deploy/service_account.yaml
 kubectl delete -f deploy/crds/example_v1alpha1_nginx_crd.yaml
 ```
 
-[operator_scope]:./../operator-scope.md
-[install_guide]: ../user/install-operator-sdk.md
-[layout_doc]:./project_layout.md
-[homebrew_tool]:https://brew.sh/
-[dep_tool]:https://golang.github.io/dep/docs/installation.html
-[git_tool]:https://git-scm.com/downloads
-[go_tool]:https://golang.org/dl/
-[docker_tool]:https://docs.docker.com/install/
-[kubectl_tool]:https://kubernetes.io/docs/tasks/tools/install-kubectl/
-[minikube_tool]:https://github.com/kubernetes/minikube#installation
-[helm_charts]:https://helm.sh/docs/developing_charts/
-[helm_values]:https://helm.sh/docs/using_helm/#customizing-the-chart-before-installing
-[quay_link]:https://quay.io
+[operator-scope]:./../operator-scope.md
+[install-guide]: ../user/install-operator-sdk.md
+[layout-doc]:./project_layout.md
+[homebrew-tool]:https://brew.sh/
+[dep-tool]:https://golang.github.io/dep/docs/installation.html
+[git-tool]:https://git-scm.com/downloads
+[go-tool]:https://golang.org/dl/
+[docker-tool]:https://docs.docker.com/install/
+[kubectl-tool]:https://kubernetes.io/docs/tasks/tools/install-kubectl/
+[minikube-tool]:https://github.com/kubernetes/minikube#installation
+[helm-charts]:https://helm.sh/docs/developing_charts/
+[helm-values]:https://helm.sh/docs/using_helm/#customizing-the-chart-before-installing
+[quay-link]:https://quay.io

doc/helm/user-guide.md

@@ -19,6 +19,7 @@ Usage:
 
 * `--image-build-args` string - extra, optional image build arguments as one string such as `"--build-arg https_proxy=$https_proxy"` (default "")
 * `--image-builder` string - tool to build OCI images. One of: `[docker, podman, buildah]` (default "docker")
+* `--go-build-args` string - extra Go build arguments as one string such as `"-ldflags -X=main.xyz=abc"`
 * `-h, --help` - help for build
 
 ### Use

doc/sdk-cli-reference.md

@@ -31,6 +31,7 @@ flags:
 - `--namespaced-manifest` - if set, this flag must point to a manifest file with all resources that run within a namespace. By default, the scorecard will combine `service_account.yaml`, `role.yaml`, `role_binding.yaml`, and `operator.yaml` from the `deploy` directory into a temporary manifest to use as the namespaced manifest.
 - `--global-manifest` - if set, this flag must point to all required resources that run globally (not namespaced). By default, the scorecard will combine all CRDs in the `deploy/crds` directory into a temporary manifest to use as the global manifest.
 - `--namespace` - if set, which namespace to run the scorecard tests in. If it is not set, the scorecard will use the default namespace of the current context set in the kubeconfig file.
+- `--olm-deployed` - indicates that the CSV and relevant CRD's have been deployed onto the cluster by the [Operator Lifecycle Manager (OLM)][olm]. This flag cannot be used in conjunction with `--namespaced-manifest` or `--global-manifest`. See the [CSV-only tests](#running-the-scorecard-with-a-deployed-csv) section below for more details.
 
 To run the tests, simply run the `scorecard` subcommand from your project root with the flags you want to
 use. For example:
@@ -324,8 +325,24 @@ Example of a valid JSON output:
 
 **NOTE:** The `ScorecardOutput.Log` field is only intended to be used to log the scorecard's output and the scorecard will ignore that field if a plugin provides it.
 
+## Running the scorecard with a deployed CSV
+
+The scorecard can be run using only a [Cluster Service Version (CSV)][olm-csv], providing a way to test cluster-ready and non-SDK operators.
+
+Running with a CSV alone requires both the `--csv-path=<CSV manifest path>` and `--olm-deployed` flags to be set. The scorecard assumes your CSV and relevant CRD's have been deployed onto the cluster using the OLM when using `--olm-deployed`. This [document][olm-deploy-operator] walks through bundling your CSV and CRD's, deploying the OLM on minikube or [OKD][okd], and deploying your operator. Once these steps have been completed, run the scorecard with both the `--csv-path=<CSV manifest path>` and `--olm-deployed` flags.
+
+A few notes:
+
+- As of now, using the scorecard with a CSV does not permit multiple CR manifests to be set through the CLI/config/CSV annotations. You will have to tear down your operator in the cluster, re-deploy, and re-run the scorecard for each CR being tested. In the future the scorecard will fully support testing multiple CR's without requiring users to teardown/standup each time.
+- You can either use `--cr-manifest` or your CSV's [`metadata.annotations['alm-examples']`][olm-csv-alm-examples] to provide CR's to the scorecard, but not both.
+
 [cli-reference]: ../sdk-cli-reference.md#scorecard
 [writing-tests]: ./writing-e2e-tests.md
 [owned-crds]: https://github.com/operator-framework/operator-lifecycle-manager/blob/master/Documentation/design/building-your-csv.md#owned-crds
 [alm-examples]: https://github.com/operator-framework/operator-lifecycle-manager/blob/master/Documentation/design/building-your-csv.md#crd-templates
 [viper]: https://github.com/spf13/viper/blob/master/README.md
+[olm-csv]:https://github.com/operator-framework/operator-lifecycle-manager/blob/master/Documentation/design/building-your-csv.md
+[olm-csv-alm-examples]:https://github.com/operator-framework/operator-lifecycle-manager/blob/master/Documentation/design/building-your-csv.md#crd-templates
+[olm]:https://github.com/operator-framework/operator-lifecycle-manager
+[olm-deploy-operator]:https://github.com/operator-framework/community-operators/blob/master/docs/testing-operators.md
+[okd]:https://www.okd.io/