Merge branch 'master' into modularize-scorecard

Author: AlexNPavel

CHANGELOG.md

@@ -3,6 +3,8 @@
 ### Added
 
 - By default the controller-runtime metrics are exposed on port 8383. This is done as part of the scaffold in the main.go file, the port can be adjusted by modifying the `metricsPort` variable. [#786](https://github.com/operator-framework/operator-sdk/pull/786)
+- A new command [`operator-sdk olm-catalog`](https://github.com/operator-framework/operator-sdk/blob/master/doc/sdk-cli-reference.md#olm-catalog) to be used as a parent for SDK subcommands generating code related to Operator Lifecycle Manager (OLM) Catalog integration, and subcommand [`operator-sdk olm-catalog gen-csv`](https://github.com/operator-framework/operator-sdk/blob/master/doc/sdk-cli-reference.md#gen-csv) which generates a Cluster Service Version for an operator so the OLM can deploy the operator in a cluster. ([#673](https://github.com/operator-framework/operator-sdk/pull/673))
+- Helm-based operators have leader election turned on by default. When upgrading, add environment variable `POD_NAME` to your operator's Deployment using the Kubernetes downward API. To see an example, run `operator-sdk new --type=helm ...` and see file `deploy/operator.yaml`. [#1000](https://github.com/operator-framework/operator-sdk/pull/1000)
 
 ### Changed
 

Gopkg.lock

@@ -44,7 +44,7 @@
 
 [[constraint]]
   name = "github.com/operator-framework/operator-lifecycle-manager"
-  revision = "7ba3268c94bb247da0e5f3e1e625b5347ad9f1fb"
+  revision = "5eb7ae5bdb7ac36a26d6e34e5d0ec07be128927f"
 
 [[override]]
   name = "k8s.io/kube-aggregator"

Gopkg.toml

@@ -2,14 +2,6 @@
 
 [![Build Status](https://travis-ci.org/operator-framework/operator-sdk.svg?branch=master)](https://travis-ci.org/operator-framework/operator-sdk)
 
-### Project Status: alpha
-
-The project is currently alpha which means that there are still new features and APIs planned that will be added in the future. Due to this breaking changes may still happen.
-
-**Note:** The core APIs provided by the [controller-runtime][controller_runtime] will most likely stay unchanged however the expectation is that any breaking changes should be relatively minor and easier to handle than the changes from SDK `v0.0.7` to `v0.1.0`.
-
-See the [proposal docs][proposals_docs] and issues for ongoing or planned work.
-
 ## Overview
 
 This project is a component of the [Operator Framework][of-home], an open source toolkit to manage Kubernetes native applications, called Operators, in an effective, automated, and scalable way. Read more in the [introduction blog post][of-blog].
@@ -155,6 +147,8 @@ To explore any operator samples built using the operator-sdk, see the [operator-
 
 See [CONTRIBUTING][contrib] for details on submitting patches and the contribution workflow.
 
+See the [proposal docs][proposals_docs] and issues for ongoing or planned work.
+
 ## Reporting bugs
 
 See [reporting bugs][bug_guide] for details about reporting any issues.

README.md

@@ -17,7 +17,7 @@ package scorecard
 import (
 	"context"
 
-	olmAPI "github.com/operator-framework/operator-lifecycle-manager/pkg/api/apis/operators/v1alpha1"
+	olmapiv1alpha1 "github.com/operator-framework/operator-lifecycle-manager/pkg/api/apis/operators/v1alpha1"
 	"k8s.io/apimachinery/pkg/types"
 )
 
@@ -63,7 +63,7 @@ func statusDescriptors(test *Test, vars ScorecardVars) error {
 	}
 	statusBlock := vars.crObj.Object["status"].(map[string]interface{})
 	score.maximumPoints = len(statusBlock)
-	var crd *olmAPI.CRDDescription
+	var crd *olmapiv1alpha1.CRDDescription
 	for _, owned := range vars.csvObj.Spec.CustomResourceDefinitions.Owned {
 		if owned.Kind == vars.crObj.GetKind() {
 			crd = &owned
@@ -102,7 +102,7 @@ func specDescriptors(test *Test, vars ScorecardVars) error {
 	}
 	specBlock := vars.crObj.Object["spec"].(map[string]interface{})
 	score.maximumPoints = len(specBlock)
-	var crd *olmAPI.CRDDescription
+	var crd *olmapiv1alpha1.CRDDescription
 	for _, owned := range vars.csvObj.Spec.CustomResourceDefinitions.Owned {
 		if owned.Kind == vars.crObj.GetKind() {
 			crd = &owned

commands/operator-sdk/cmd/scorecard/olm_tests.go

@@ -23,7 +23,7 @@ import (
 	k8sInternal "github.com/operator-framework/operator-sdk/internal/util/k8sutil"
 	"github.com/operator-framework/operator-sdk/internal/util/yamlutil"
 
-	olmApi "github.com/operator-framework/operator-lifecycle-manager/pkg/api/apis/operators/v1alpha1"
+	olmapiv1alpha1 "github.com/operator-framework/operator-lifecycle-manager/pkg/api/apis/operators/v1alpha1"
 	log "github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 	v1 "k8s.io/api/core/v1"
@@ -80,8 +80,6 @@ var (
 const scorecardPodName = "operator-scorecard-test"
 
 func ScorecardTests(cmd *cobra.Command, args []string) error {
-	// in main.go, we catch and print errors, so we don't want cobra to print the error itself
-	cmd.SilenceErrors = true
 	if !SCConf.BasicTests && !SCConf.OLMTests {
 		return errors.New("at least one test type is required")
 	}
@@ -130,7 +128,7 @@ func ScorecardTests(cmd *cobra.Command, args []string) error {
 	var err error
 	kubeconfig, SCConf.Namespace, err = k8sInternal.GetKubeconfigAndNamespace(SCConf.KubeconfigPath)
 	if err != nil {
-		return err
+		return fmt.Errorf("failed to build the kubeconfig: %v", err)
 	}
 	scheme := runtime.NewScheme()
 	// scheme for client go
@@ -142,7 +140,7 @@ func ScorecardTests(cmd *cobra.Command, args []string) error {
 		return fmt.Errorf("failed to add failed to add extensions api scheme to client: (%v)", err)
 	}
 	// olm api (CS
-	if err := olmApi.AddToScheme(scheme); err != nil {
+	if err := olmapiv1alpha1.AddToScheme(scheme); err != nil {
 		return fmt.Errorf("failed to add failed to add oml api scheme (CSVs) to client: (%v)", err)
 	}
 	dynamicDecoder = serializer.NewCodecFactory(scheme).UniversalDeserializer()
@@ -196,9 +194,9 @@ func ScorecardTests(cmd *cobra.Command, args []string) error {
 		if err != nil {
 			return err
 		}
-		csv := &olmApi.ClusterServiceVersion{}
+		csv := &olmapiv1alpha1.ClusterServiceVersion{}
 		switch o := rawCSV.(type) {
-		case *olmApi.ClusterServiceVersion:
+		case *olmapiv1alpha1.ClusterServiceVersion:
 			csv = o
 		default:
 			return fmt.Errorf("provided yaml file not of ClusterServiceVersion type")

commands/operator-sdk/cmd/scorecard/scorecard.go

@@ -17,7 +17,7 @@ package scorecard
 import (
 	"fmt"
 
-	olmAPI "github.com/operator-framework/operator-lifecycle-manager/pkg/api/apis/operators/v1alpha1"
+	olmapiv1alpha1 "github.com/operator-framework/operator-lifecycle-manager/pkg/api/apis/operators/v1alpha1"
 	v1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	"sigs.k8s.io/controller-runtime/pkg/client"
@@ -29,7 +29,7 @@ import (
 type ScorecardVars struct {
 	client        *client.Client
 	crObj         *unstructured.Unstructured
-	csvObj        *olmAPI.ClusterServiceVersion
+	csvObj        *olmapiv1alpha1.ClusterServiceVersion
 	proxyPod      *v1.Pod
 	timeout       int
 	retryInterval int

commands/operator-sdk/cmd/scorecard/test_definitions.go

@@ -269,7 +269,7 @@ import (
 func (r *ReconcileApp) Reconcile(request reconcile.Request) (reconcile.Result, error) {
 	...
 
-	mem := &cachev1alpha.Memcached{}
+	mem := &cachev1alpha1.Memcached{}
 	err := r.client.Get(context.TODO(), request.NamespacedName, mem)
 
 	...

doc/user/client.md

@@ -15,6 +15,7 @@
 package helm
 
 import (
+	"context"
 	"fmt"
 	"os"
 	"runtime"
@@ -24,6 +25,7 @@ import (
 	hoflags "github.com/operator-framework/operator-sdk/pkg/helm/flags"
 	"github.com/operator-framework/operator-sdk/pkg/helm/release"
 	"github.com/operator-framework/operator-sdk/pkg/k8sutil"
+	"github.com/operator-framework/operator-sdk/pkg/leader"
 	sdkVersion "github.com/operator-framework/operator-sdk/version"
 
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
@@ -99,6 +101,18 @@ func Run(flags *hoflags.HelmOperatorFlags) error {
 		}
 	}
 
+	operatorName, err := k8sutil.GetOperatorName()
+	if err != nil {
+		log.Error(err, "Failed to get operator name")
+		return err
+	}
+	// Become the leader before proceeding
+	err = leader.Become(context.TODO(), operatorName+"-lock")
+	if err != nil {
+		log.Error(err, "Failed to become leader.")
+		return err
+	}
+
 	// Start the Cmd
 	if err = mgr.Start(signals.SetupSignalHandler()); err != nil {
 		log.Error(err, "Manager exited non-zero.")

pkg/helm/run.go

@@ -38,6 +38,7 @@ func (s *Cr) GetInput() (input.Input, error) {
 			s.Resource.LowerKind)
 		s.Path = filepath.Join(CrdsDir, fileName)
 	}
+	s.IfExistsAction = input.Skip
 	s.TemplateBody = crTemplate
 	return s.Input, nil
 }

pkg/scaffold/cr.go

@@ -38,6 +38,7 @@ func (s *Crd) GetInput() (input.Input, error) {
 			s.Resource.LowerKind)
 		s.Path = filepath.Join(CrdsDir, fileName)
 	}
+	s.IfExistsAction = input.Skip
 	s.TemplateBody = crdTemplate
 	return s.Input, nil
 }

pkg/scaffold/crd.go

@@ -69,6 +69,10 @@ spec:
                 fieldRef:
                   fieldPath: metadata.namespace
               {{- end}}
+            - name: POD_NAME
+              valueFrom:
+                fieldRef:
+                  fieldPath: metadata.name
             - name: OPERATOR_NAME
               value: "{{.ProjectName}}"
 `

pkg/scaffold/helm/operator.go

@@ -31,7 +31,7 @@ import (
 
 	"github.com/coreos/go-semver/semver"
 	"github.com/ghodss/yaml"
-	olmApi "github.com/operator-framework/operator-lifecycle-manager/pkg/api/apis/operators/v1alpha1"
+	olmapiv1alpha1 "github.com/operator-framework/operator-lifecycle-manager/pkg/api/apis/operators/v1alpha1"
 	log "github.com/sirupsen/logrus"
 )
 
@@ -68,15 +68,15 @@ func (s *CSV) GetInput() (input.Input, error) {
 }
 
 // CustomRender allows a CSV to be written by marshalling
-// olmApi.ClusterServiceVersion instead of writing to a template.
+// olmapiv1alpha1.ClusterServiceVersion instead of writing to a template.
 func (s *CSV) CustomRender() ([]byte, error) {
 	// Get current CSV to update.
 	csv, exists, err := getCurrentCSVIfExists(s.Path)
 	if err != nil {
 		return nil, err
 	}
 	if !exists {
-		csv = &olmApi.ClusterServiceVersion{}
+		csv = &olmapiv1alpha1.ClusterServiceVersion{}
 		s.initCSVFields(csv)
 	}
 
@@ -111,7 +111,7 @@ func (s *CSV) CustomRender() ([]byte, error) {
 	return yaml.Marshal(&cu)
 }
 
-func getCurrentCSVIfExists(csvPath string) (*olmApi.ClusterServiceVersion, bool, error) {
+func getCurrentCSVIfExists(csvPath string) (*olmapiv1alpha1.ClusterServiceVersion, bool, error) {
 	if _, err := os.Stat(csvPath); err != nil && os.IsNotExist(err) {
 		return nil, false, nil
 	}
@@ -124,7 +124,7 @@ func getCurrentCSVIfExists(csvPath string) (*olmApi.ClusterServiceVersion, bool,
 		return nil, false, nil
 	}
 
-	csv := &olmApi.ClusterServiceVersion{}
+	csv := &olmapiv1alpha1.ClusterServiceVersion{}
 	if err := yaml.Unmarshal(csvBytes, csv); err != nil {
 		return nil, false, err
 	}
@@ -173,10 +173,10 @@ func getDisplayName(name string) string {
 
 // initCSVFields initializes all csv fields that should be populated by a user
 // with sane defaults. initCSVFields should only be called for new csv's.
-func (s *CSV) initCSVFields(csv *olmApi.ClusterServiceVersion) {
+func (s *CSV) initCSVFields(csv *olmapiv1alpha1.ClusterServiceVersion) {
 	// Metadata
-	csv.TypeMeta.APIVersion = olmApi.ClusterServiceVersionAPIVersion
-	csv.TypeMeta.Kind = olmApi.ClusterServiceVersionKind
+	csv.TypeMeta.APIVersion = olmapiv1alpha1.ClusterServiceVersionAPIVersion
+	csv.TypeMeta.Kind = olmapiv1alpha1.ClusterServiceVersionKind
 	csv.SetName(getCSVName(strings.ToLower(s.ProjectName), s.CSVVersion))
 	csv.SetNamespace("placeholder")
 
@@ -185,21 +185,21 @@ func (s *CSV) initCSVFields(csv *olmApi.ClusterServiceVersion) {
 	csv.Spec.DisplayName = getDisplayName(s.ProjectName)
 	csv.Spec.Description = "Placeholder description"
 	csv.Spec.Maturity = "alpha"
-	csv.Spec.Provider = olmApi.AppLink{}
-	csv.Spec.Maintainers = make([]olmApi.Maintainer, 0)
-	csv.Spec.Links = make([]olmApi.AppLink, 0)
+	csv.Spec.Provider = olmapiv1alpha1.AppLink{}
+	csv.Spec.Maintainers = make([]olmapiv1alpha1.Maintainer, 0)
+	csv.Spec.Links = make([]olmapiv1alpha1.AppLink, 0)
 	csv.SetLabels(make(map[string]string))
 }
 
 // TODO: validate that all fields from files are populated as expected
 // ex. add `resources` to a CRD
 
-func getEmptyRequiredCSVFields(csv *olmApi.ClusterServiceVersion) (fields []string) {
+func getEmptyRequiredCSVFields(csv *olmapiv1alpha1.ClusterServiceVersion) (fields []string) {
 	// Metadata
-	if csv.TypeMeta.APIVersion != olmApi.ClusterServiceVersionAPIVersion {
+	if csv.TypeMeta.APIVersion != olmapiv1alpha1.ClusterServiceVersionAPIVersion {
 		fields = append(fields, "apiVersion")
 	}
-	if csv.TypeMeta.Kind != olmApi.ClusterServiceVersionKind {
+	if csv.TypeMeta.Kind != olmapiv1alpha1.ClusterServiceVersionKind {
 		fields = append(fields, "kind")
 	}
 	if csv.ObjectMeta.Name == "" {
@@ -221,7 +221,7 @@ func getEmptyRequiredCSVFields(csv *olmApi.ClusterServiceVersion) (fields []stri
 	if len(csv.Spec.Maintainers) == 0 {
 		fields = append(fields, "spec.maintainers")
 	}
-	if csv.Spec.Provider == (olmApi.AppLink{}) {
+	if csv.Spec.Provider == (olmapiv1alpha1.AppLink{}) {
 		fields = append(fields, "spec.provider")
 	}
 	if len(csv.Spec.Labels) == 0 {
@@ -242,7 +242,7 @@ func joinFields(fields []string) string {
 // updateCSVVersions updates csv's version and data involving the version,
 // ex. ObjectMeta.Name, and place the old version in the `replaces` object,
 // if there is an old version to replace.
-func (s *CSV) updateCSVVersions(csv *olmApi.ClusterServiceVersion) error {
+func (s *CSV) updateCSVVersions(csv *olmapiv1alpha1.ClusterServiceVersion) error {
 
 	// Old csv version to replace, and updated csv version.
 	oldVer, newVer := csv.Spec.Version.String(), s.CSVVersion
@@ -292,7 +292,7 @@ func replaceAllBytes(v interface{}, old, new []byte) error {
 
 // updateCSVFromManifestFiles gathers relevant data from generated and
 // user-defined manifests and updates csv.
-func (s *CSV) updateCSVFromManifestFiles(cfg *CSVConfig, csv *olmApi.ClusterServiceVersion) error {
+func (s *CSV) updateCSVFromManifestFiles(cfg *CSVConfig, csv *olmapiv1alpha1.ClusterServiceVersion) error {
 	store := NewUpdaterStore()
 	for _, f := range append(cfg.CRDCRPaths, cfg.OperatorPath, cfg.RolePath) {
 		yamlData, err := ioutil.ReadFile(f)

pkg/scaffold/olm-catalog/csv.go

@@ -28,8 +28,8 @@ import (
 
 	"github.com/coreos/go-semver/semver"
 	"github.com/ghodss/yaml"
-	olmApi "github.com/operator-framework/operator-lifecycle-manager/pkg/api/apis/operators/v1alpha1"
-	olmInstall "github.com/operator-framework/operator-lifecycle-manager/pkg/controller/install"
+	olmapiv1alpha1 "github.com/operator-framework/operator-lifecycle-manager/pkg/api/apis/operators/v1alpha1"
+	olminstall "github.com/operator-framework/operator-lifecycle-manager/pkg/controller/install"
 )
 
 const testDataDir = "testdata"
@@ -77,7 +77,7 @@ func TestUpdateVersion(t *testing.T) {
 	if err != nil {
 		t.Fatal(err)
 	}
-	csv := &olmApi.ClusterServiceVersion{}
+	csv := &olmapiv1alpha1.ClusterServiceVersion{}
 	if err := yaml.Unmarshal(csvExpBytes, csv); err != nil {
 		t.Fatal(err)
 	}
@@ -102,12 +102,12 @@ func TestUpdateVersion(t *testing.T) {
 		t.Errorf("Wanted csv name %s, got %s", wantedName, csv.ObjectMeta.Name)
 	}
 
-	var resolver *olmInstall.StrategyResolver
+	var resolver *olminstall.StrategyResolver
 	stratInterface, err := resolver.UnmarshalStrategy(csv.Spec.InstallStrategy)
 	if err != nil {
 		t.Fatal(err)
 	}
-	strat, ok := stratInterface.(*olmInstall.StrategyDetailsDeployment)
+	strat, ok := stratInterface.(*olminstall.StrategyDetailsDeployment)
 	if !ok {
 		t.Fatalf("Strategy of type %T was not StrategyDetailsDeployment", stratInterface)
 	}