Merge branch 'master' into test-no-setup

Author: AlexNPavel

.travis.yml

@@ -32,7 +32,7 @@ jobs:
       install: true
       after_success: echo 'Markdown links are correct'
       after_failure: echo 'Incorrect markdown link detected'
-      script: ./hack/ci/marker
+      script: ./hack/ci/marker --root=./doc
 
 install:
 - curl -Lo dep https://github.com/golang/dep/releases/download/v0.5.0/dep-linux-amd64 && chmod +x dep && sudo mv dep /usr/local/bin/

CHANGELOG.md

@@ -1,3 +1,13 @@
+## Unreleased
+
+### Changed
+
+- The SDK now uses logr as the default logger to unify the logging output with the controller-runtime logs. Users can still use a logger of their own choice. See the [logging doc](https://github.com/operator-framework/operator-sdk/blob/master/doc/user/logging.md) on how the SDK initializes and uses logr.
+
+### Bug fixes
+
+- Make operator-sdk command work with composed GOPATH ([#676](https://github.com/operator-framework/operator-sdk/pull/676))
+
 ## v0.1.1
 
 ### Bug fixes

Gopkg.lock

@@ -0,0 +1,56 @@
+// Copyright 2018 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 cmd
+
+import (
+	"github.com/operator-framework/operator-sdk/pkg/scaffold"
+
+	log "github.com/sirupsen/logrus"
+	"github.com/spf13/cobra"
+)
+
+var asFile bool
+
+func NewPrintDepsCmd() *cobra.Command {
+	printDepsCmd := &cobra.Command{
+		Use:   "print-deps",
+		Short: "Print Golang packages and versions required to run the operator",
+		Long: `The operator-sdk print-deps command prints all Golang packages and versions expected
+by this version of the Operator SDK. Versions for these packages should match
+those in an operators' Gopkg.toml file.
+
+print-deps prints in columnar format by default. Use the --as-file flag to
+print in Gopkg.toml file format.
+`,
+		Run: printDepsFunc,
+	}
+
+	printDepsCmd.Flags().BoolVar(&asFile, "as-file", false, "Print dependencies in Gopkg.toml file format.")
+
+	return printDepsCmd
+}
+
+func printDepsFunc(cmd *cobra.Command, args []string) {
+	if len(args) != 0 {
+		log.Fatal("print-deps command does not take any arguments")
+	}
+	if asFile {
+		scaffold.PrintDepsAsFile()
+	} else {
+		if err := scaffold.PrintDeps(); err != nil {
+			log.Fatalf("print deps: (%v)", err)
+		}
+	}
+}

commands/operator-sdk/cmd/print_deps.go

@@ -34,6 +34,7 @@ func NewRootCmd() *cobra.Command {
 	cmd.AddCommand(NewUpCmd())
 	cmd.AddCommand(NewCompletionCmd())
 	cmd.AddCommand(NewTestCmd())
+	cmd.AddCommand(NewPrintDepsCmd())
 
 	return cmd
 }

commands/operator-sdk/cmd/root.go

@@ -88,9 +88,17 @@ operator-sdk completion bash
 # ex: ts=4 sw=4 et filetype=sh
 ```
 
+## print-deps
+
+Prints the most recent Golang packages and versions required by operators. Prints in columnar format by default.
+
+### Flags
+
+* `--as-file` Print packages and versions in Gopkg.toml format.
+
 ## generate
 
-### k8s 
+### k8s
 
 Runs the Kubernetes [code-generators][k8s-code-generator] for all Custom Resource Definitions (CRD) apis under `pkg/apis/...`.
 Currently only runs `deepcopy-gen` to generate the required `DeepCopy()` functions for all custom resource types.

doc/sdk-cli-reference.md

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package sdk
+package metrics
 
 import (
 	"context"

hack/ci/setup-minikube.sh

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package sdk
+package metrics
 
 import (
 	monitoringv1 "github.com/coreos/prometheus-operator/pkg/client/monitoring/v1"

pkg/sdk/metrics.go renamed to pkg/metrics/metrics.go

@@ -0,0 +1,58 @@
+// Copyright 2018 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 ready
+
+import (
+	"os"
+)
+
+const FileName = "/tmp/operator-sdk-ready"
+
+// Ready holds state about whether the operator is ready and communicates that
+// to a Kubernetes readiness probe.
+type Ready interface {
+	// Set ensures that future readiness probes will indicate that the operator
+	// is ready.
+	Set() error
+
+	// Unset ensures that future readiness probes will indicate that the
+	// operator is not ready.
+	Unset() error
+}
+
+// NewFileReady returns a Ready that uses the presence of a file on disk to
+// communicate whether the operator is ready. The operator's Pod definition
+// should include a readinessProbe of "exec" type that calls
+// "stat /tmp/operator-sdk-ready".
+func NewFileReady() Ready {
+	return fileReady{}
+}
+
+type fileReady struct{}
+
+// Set creates a file on disk whose presense can be used by a readiness probe
+// to determine that the operator is ready.
+func (r fileReady) Set() error {
+	f, err := os.Create(FileName)
+	if err != nil {
+		return err
+	}
+	return f.Close()
+}
+
+// Unset removes the file on disk that was created by Set().
+func (r fileReady) Unset() error {
+	return os.Remove(FileName)
+}

pkg/sdk/service-monitor.go renamed to pkg/metrics/service-monitor.go

@@ -0,0 +1,46 @@
+// Copyright 2018 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 ready
+
+import (
+	"os"
+	"testing"
+)
+
+func TestFileReady(t *testing.T) {
+	r := NewFileReady()
+	err := r.Set()
+	if err != nil {
+		t.Errorf("could not set ready file: %v", err)
+	}
+
+	_, err = os.Stat(FileName)
+	if err != nil {
+		t.Errorf("did not find expected file at %s: %v", FileName, err)
+	}
+
+	err = r.Unset()
+	if err != nil {
+		t.Errorf("could not unset ready file: %v", err)
+	}
+
+	_, err = os.Stat(FileName)
+	if err == nil {
+		t.Errorf("file still exists at %s", FileName)
+	}
+	if !os.IsNotExist(err) {
+		t.Errorf("error determining if file still exists at %s: %v", FileName, err)
+	}
+}

pkg/ready/ready.go

@@ -37,6 +37,7 @@ func (s *Cmd) GetInput() (input.Input, error) {
 const cmdTmpl = `package main
 
 import (
+	"context"
 	"flag"
 	"fmt"
 	"os"
@@ -46,6 +47,8 @@ import (
 	"{{ .Repo }}/pkg/controller"
 
 	"github.com/operator-framework/operator-sdk/pkg/k8sutil"
+	"github.com/operator-framework/operator-sdk/pkg/leader"
+	"github.com/operator-framework/operator-sdk/pkg/ready"
 	sdkVersion "github.com/operator-framework/operator-sdk/version"
 	_ "k8s.io/client-go/plugin/pkg/client/auth/gcp"
 	"sigs.k8s.io/controller-runtime/pkg/client/config"
@@ -86,6 +89,17 @@ func main() {
 		os.Exit(1)
 	}
 
+	// Become the leader before proceeding
+	leader.Become(context.TODO(), "{{ .ProjectName }}-lock")
+
+	r := ready.NewFileReady()
+	err = r.Set()
+	if err != nil {
+		log.Error(err, "")
+		os.Exit(1)
+	}
+	defer r.Unset()
+
 	// Create a new Cmd to provide shared dependencies and start components
 	mgr, err := manager.New(cfg, manager.Options{Namespace: namespace})
 	if err != nil {

pkg/ready/ready_test.go

@@ -36,6 +36,7 @@ func TestCmd(t *testing.T) {
 const cmdExp = `package main
 
 import (
+	"context"
 	"flag"
 	"fmt"
 	"os"
@@ -44,6 +45,8 @@ import (
 	"github.com/example-inc/app-operator/pkg/apis"
 	"github.com/example-inc/app-operator/pkg/controller"
 	"github.com/operator-framework/operator-sdk/pkg/k8sutil"
+	"github.com/operator-framework/operator-sdk/pkg/leader"
+	"github.com/operator-framework/operator-sdk/pkg/ready"
 	sdkVersion "github.com/operator-framework/operator-sdk/version"
 	_ "k8s.io/client-go/plugin/pkg/client/auth/gcp"
 	"sigs.k8s.io/controller-runtime/pkg/client/config"
@@ -84,6 +87,17 @@ func main() {
 		os.Exit(1)
 	}
 
+	// Become the leader before proceeding
+	leader.Become(context.TODO(), "app-operator-lock")
+
+	r := ready.NewFileReady()
+	err = r.Set()
+	if err != nil {
+		log.Error(err, "")
+		os.Exit(1)
+	}
+	defer r.Unset()
+
 	// Create a new Cmd to provide shared dependencies and start components
 	mgr, err := manager.New(cfg, manager.Options{Namespace: namespace})
 	if err != nil {