ansible: introduce managedStatus flag

- Adds new bool flag to ansible operator `managedStatus`. When True
(expected default) the ansible operator manages the status. When false
the ansible operator does not touch the status of the CR.
- Adds new field to `watches.yaml`, for each GVK, you can now set
`managedStatus: bool` see https://golang.org/pkg/strconv/#ParseBool
- Update reconciler to only update the status of the CR when
`managedStatus`

Also move constants out of `status/utils.go` into `status/types.go` to
prevent confusion.

Author: djzager

commands/operator-sdk/cmd/up/local.go

@@ -148,7 +148,7 @@ func upLocalAnsible() {
 	}
 
 	// start the operator
-	go ansibleOperator.Run(done, mgr, "./"+ansibleScaffold.WatchesYamlFile, time.Minute)
+	go ansibleOperator.Run(done, mgr, "./"+ansibleScaffold.WatchesYamlFile, time.Minute, true)
 
 	// wait for either to finish
 	err = <-done

pkg/ansible/controller/controller.go

@@ -40,6 +40,7 @@ type Options struct {
 	Runner          runner.Runner
 	GVK             schema.GroupVersionKind
 	ReconcilePeriod time.Duration
+	ManagedStatus   bool
 }
 
 // Add - Creates a new ansible operator controller and adds it to the manager
@@ -56,6 +57,7 @@ func Add(mgr manager.Manager, options Options) {
 		Runner:          options.Runner,
 		EventHandlers:   eventHandlers,
 		ReconcilePeriod: options.ReconcilePeriod,
+		ManagedStatus:   options.ManagedStatus,
 	}
 
 	// Register the GVK with the schema

pkg/ansible/controller/reconcile.go

@@ -54,6 +54,7 @@ type AnsibleOperatorReconciler struct {
 	Client          client.Client
 	EventHandlers   []events.EventHandler
 	ReconcilePeriod time.Duration
+	ManagedStatus   bool
 }
 
 // Reconcile - handle the event.
@@ -113,28 +114,9 @@ func (r *AnsibleOperatorReconciler) Reconcile(request reconcile.Request) (reconc
 			return reconcileResult, err
 		}
 	}
-	statusInterface := u.Object["status"]
-	statusMap, _ := statusInterface.(map[string]interface{})
-	crStatus := ansiblestatus.CreateFromMap(statusMap)
-
-	// If there is no current status add that we are working on this resource.
-	errCond := ansiblestatus.GetCondition(crStatus, ansiblestatus.FailureConditionType)
-	succCond := ansiblestatus.GetCondition(crStatus, ansiblestatus.RunningConditionType)
 
-	// If the condition is currently running, making sure that the values are correct.
-	// If they are the same a no-op, if they are different then it is a good thing we
-	// are updating it.
-	if (errCond == nil && succCond == nil) || (succCond != nil && succCond.Reason != ansiblestatus.SuccessfulReason) {
-		c := ansiblestatus.NewCondition(
-			ansiblestatus.RunningConditionType,
-			v1.ConditionTrue,
-			nil,
-			ansiblestatus.RunningReason,
-			ansiblestatus.RunningMessage,
-		)
-		ansiblestatus.SetCondition(&crStatus, *c)
-		u.Object["status"] = crStatus
-		err = r.Client.Update(context.TODO(), u)
+	if r.ManagedStatus {
+		err = r.markRunning(u)
 		if err != nil {
 			return reconcileResult, err
 		}
@@ -207,6 +189,48 @@ func (r *AnsibleOperatorReconciler) Reconcile(request reconcile.Request) (reconc
 			return reconcileResult, err
 		}
 	}
+	if r.ManagedStatus {
+		err = r.markDone(u, statusEvent, failureMessages)
+	}
+	return reconcileResult, err
+}
+
+func (r *AnsibleOperatorReconciler) markRunning(u *unstructured.Unstructured) error {
+	statusInterface := u.Object["status"]
+	statusMap, _ := statusInterface.(map[string]interface{})
+	crStatus := ansiblestatus.CreateFromMap(statusMap)
+
+	// If there is no current status add that we are working on this resource.
+	errCond := ansiblestatus.GetCondition(crStatus, ansiblestatus.FailureConditionType)
+	succCond := ansiblestatus.GetCondition(crStatus, ansiblestatus.RunningConditionType)
+
+	// If the condition is currently running, making sure that the values are correct.
+	// If they are the same a no-op, if they are different then it is a good thing we
+	// are updating it.
+	if (errCond == nil && succCond == nil) || (succCond != nil && succCond.Reason != ansiblestatus.SuccessfulReason) {
+		c := ansiblestatus.NewCondition(
+			ansiblestatus.RunningConditionType,
+			v1.ConditionTrue,
+			nil,
+			ansiblestatus.RunningReason,
+			ansiblestatus.RunningMessage,
+		)
+		ansiblestatus.SetCondition(&crStatus, *c)
+		u.Object["status"] = crStatus
+		err := r.Client.Update(context.TODO(), u)
+		if err != nil {
+			return err
+		}
+	}
+	return nil
+}
+
+func (r *AnsibleOperatorReconciler) markDone(u *unstructured.Unstructured, statusEvent eventapi.StatusJobEvent, failureMessages eventapi.FailureMessages) error {
+	statusInterface := u.Object["status"]
+	statusMap, _ := statusInterface.(map[string]interface{})
+	crStatus := ansiblestatus.CreateFromMap(statusMap)
+
+	runSuccessful := len(failureMessages) == 0
 	ansibleStatus := ansiblestatus.NewAnsibleResultFromStatusJobEvent(statusEvent)
 
 	if !runSuccessful {
@@ -235,9 +259,8 @@ func (r *AnsibleOperatorReconciler) Reconcile(request reconcile.Request) (reconc
 	}
 	// This needs the status subresource to be enabled by default.
 	u.Object["status"] = crStatus
-	err = r.Client.Update(context.TODO(), u)
-	return reconcileResult, err
 
+	return r.Client.Update(context.TODO(), u)
 }
 
 func contains(l []string, s string) bool {

pkg/ansible/controller/status/types.go

@@ -79,6 +79,24 @@ func NewAnsibleResultFromMap(sm map[string]interface{}) *AnsibleResult {
 	return a
 }
 
+const (
+	// RunningReason - Condition is running
+	RunningReason = "Running"
+	// SuccessfulReason - Condition is running due to reconcile being successful
+	SuccessfulReason = "Successful"
+	// FailedReason - Condition is failed due to ansible failure
+	FailedReason = "Failed"
+	// UnknownFailedReason - Condition is unknown
+	UnknownFailedReason = "Unknown"
+)
+
+const (
+	// RunningMessage - message for running reason.
+	RunningMessage = "Running reconciliation"
+	// SuccessfulMessage - message for successful reason.
+	SuccessfulMessage = "Awaiting next reconciliation"
+)
+
 // ConditionType - type of condition
 type ConditionType string
 

pkg/ansible/controller/status/utils.go

@@ -19,24 +19,6 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
-const (
-	// RunningReason - Condition is running
-	RunningReason = "Running"
-	// SuccessfulReason - Condition is running due to reconcile being successful
-	SuccessfulReason = "Successful"
-	// FailedReason - Condition is failed due to ansible failure
-	FailedReason = "Failed"
-	// UnknownFailedReason - Condition is unknown
-	UnknownFailedReason = "Unknown"
-)
-
-const (
-	// RunningMessage - message for running reason.
-	RunningMessage = "Running reconciliation"
-	// SuccessfulMessage - message for successful reason.
-	SuccessfulMessage = "Awaiting next reconciliation"
-)
-
 // NewCondition -  condition
 func NewCondition(condType ConditionType, status v1.ConditionStatus, ansibleResult *AnsibleResult, reason, message string) *Condition {
 	return &Condition{

pkg/ansible/operator/operator.go

@@ -29,7 +29,7 @@ import (
 // Run - A blocking function which starts a controller-runtime manager
 // It starts an Operator by reading in the values in `./watches.yaml`, adds a controller
 // to the manager, and finally running the manager.
-func Run(done chan error, mgr manager.Manager, watchesPath string, reconcilePeriod time.Duration) {
+func Run(done chan error, mgr manager.Manager, watchesPath string, reconcilePeriod time.Duration, managedStatus bool) {
 	watches, err := runner.NewFromWatches(watchesPath)
 	if err != nil {
 		logrus.Error("Failed to get watches")
@@ -49,6 +49,10 @@ func Run(done chan error, mgr manager.Manager, watchesPath string, reconcilePeri
 		if ok {
 			o.ReconcilePeriod = d
 		}
+		s, ok := runner.GetManagedStatus()
+		if ok {
+			o.ManagedStatus = s
+		}
 		controller.Add(mgr, o)
 	}
 	done <- mgr.Start(c)

pkg/ansible/runner/runner.go

@@ -22,6 +22,7 @@ import (
 	"os"
 	"os/exec"
 	"path/filepath"
+	"strconv"
 	"strings"
 	"time"
 
@@ -40,6 +41,7 @@ type Runner interface {
 	Run(string, *unstructured.Unstructured, string) (*RunResult, error)
 	GetFinalizer() (string, bool)
 	GetReconcilePeriod() (time.Duration, bool)
+	GetManagedStatus() (bool, bool)
 }
 
 // watch holds data used to create a mapping of GVK to ansible playbook or role.
@@ -51,6 +53,7 @@ type watch struct {
 	Playbook        string     `yaml:"playbook"`
 	Role            string     `yaml:"role"`
 	ReconcilePeriod string     `yaml:"reconcilePeriod"`
+	ManagedStatus   string     `yaml:"managedStatus"`
 	Finalizer       *Finalizer `yaml:"finalizer"`
 }
 
@@ -91,20 +94,28 @@ func NewFromWatches(path string) (map[schema.GroupVersionKind]Runner, error) {
 			}
 			reconcilePeriod = &d
 		}
+		var managedStatus *bool
+		if w.ManagedStatus != "" {
+			stat, err := strconv.ParseBool(w.ManagedStatus)
+			if err != nil {
+				return nil, fmt.Errorf("unable to parse managedStatus: %v - %v, setting to default", w.ManagedStatus, err)
+			}
+			managedStatus = &stat
+		}
 
 		// Check if schema is a duplicate
 		if _, ok := m[s]; ok {
 			return nil, fmt.Errorf("duplicate GVK: %v", s.String())
 		}
 		switch {
 		case w.Playbook != "":
-			r, err := NewForPlaybook(w.Playbook, s, w.Finalizer, reconcilePeriod)
+			r, err := NewForPlaybook(w.Playbook, s, w.Finalizer, reconcilePeriod, managedStatus)
 			if err != nil {
 				return nil, err
 			}
 			m[s] = r
 		case w.Role != "":
-			r, err := NewForRole(w.Role, s, w.Finalizer, reconcilePeriod)
+			r, err := NewForRole(w.Role, s, w.Finalizer, reconcilePeriod, managedStatus)
 			if err != nil {
 				return nil, err
 			}
@@ -117,7 +128,7 @@ func NewFromWatches(path string) (map[schema.GroupVersionKind]Runner, error) {
 }
 
 // NewForPlaybook returns a new Runner based on the path to an ansible playbook.
-func NewForPlaybook(path string, gvk schema.GroupVersionKind, finalizer *Finalizer, reconcilePeriod *time.Duration) (Runner, error) {
+func NewForPlaybook(path string, gvk schema.GroupVersionKind, finalizer *Finalizer, reconcilePeriod *time.Duration, managedStatus *bool) (Runner, error) {
 	if !filepath.IsAbs(path) {
 		return nil, fmt.Errorf("playbook path must be absolute for %v", gvk)
 	}
@@ -131,6 +142,7 @@ func NewForPlaybook(path string, gvk schema.GroupVersionKind, finalizer *Finaliz
 			return exec.Command("ansible-runner", "-vv", "-p", path, "-i", ident, "run", inputDirPath)
 		},
 		reconcilePeriod: reconcilePeriod,
+		managedStatus:   managedStatus,
 	}
 	err := r.addFinalizer(finalizer)
 	if err != nil {
@@ -140,7 +152,7 @@ func NewForPlaybook(path string, gvk schema.GroupVersionKind, finalizer *Finaliz
 }
 
 // NewForRole returns a new Runner based on the path to an ansible role.
-func NewForRole(path string, gvk schema.GroupVersionKind, finalizer *Finalizer, reconcilePeriod *time.Duration) (Runner, error) {
+func NewForRole(path string, gvk schema.GroupVersionKind, finalizer *Finalizer, reconcilePeriod *time.Duration, managedStatus *bool) (Runner, error) {
 	if !filepath.IsAbs(path) {
 		return nil, fmt.Errorf("role path must be absolute for %v", gvk)
 	}
@@ -156,6 +168,7 @@ func NewForRole(path string, gvk schema.GroupVersionKind, finalizer *Finalizer,
 			return exec.Command("ansible-runner", "-vv", "--role", roleName, "--roles-path", rolePath, "--hosts", "localhost", "-i", ident, "run", inputDirPath)
 		},
 		reconcilePeriod: reconcilePeriod,
+		managedStatus:   managedStatus,
 	}
 	err := r.addFinalizer(finalizer)
 	if err != nil {
@@ -172,6 +185,7 @@ type runner struct {
 	cmdFunc          func(ident, inputDirPath string) *exec.Cmd // returns a Cmd that runs ansible-runner
 	finalizerCmdFunc func(ident, inputDirPath string) *exec.Cmd
 	reconcilePeriod  *time.Duration
+	managedStatus    *bool
 }
 
 func (r *runner) Run(ident string, u *unstructured.Unstructured, kubeconfig string) (*RunResult, error) {
@@ -254,6 +268,14 @@ func (r *runner) GetReconcilePeriod() (time.Duration, bool) {
 	return *r.reconcilePeriod, true
 }
 
+// GetManagedStatus - return runner's managedStatus if defined
+func (r *runner) GetManagedStatus() (bool, bool) {
+	if r.managedStatus == nil {
+		return false, false
+	}
+	return *r.managedStatus, true
+}
+
 func (r *runner) GetFinalizer() (string, bool) {
 	if r.Finalizer != nil {
 		return r.Finalizer.Name, true

pkg/ansible/runner/runner_test.go

@@ -55,6 +55,7 @@ func TestNewFromWatches(t *testing.T) {
 
 	zeroSeconds := time.Duration(0)
 	twoSeconds := time.Second * 2
+	noManagedStatus := false
 	testCases := []struct {
 		name        string
 		path        string
@@ -101,6 +102,11 @@ func TestNewFromWatches(t *testing.T) {
 			path:        "testdata/invalid_duration.yaml",
 			shouldError: true,
 		},
+		{
+			name:        "error invalid status",
+			path:        "testdata/invalid_status.yaml",
+			shouldError: true,
+		},
 		{
 			name: "valid watches file",
 			path: "testdata/valid.yaml",
@@ -148,6 +154,19 @@ func TestNewFromWatches(t *testing.T) {
 					Path:            validTemplate.ValidPlaybook,
 					reconcilePeriod: &zeroSeconds,
 				},
+				schema.GroupVersionKind{
+					Version: "v1alpha1",
+					Group:   "app.example.com",
+					Kind:    "DisableStatus",
+				}: runner{
+					GVK: schema.GroupVersionKind{
+						Version: "v1alpha1",
+						Group:   "app.example.com",
+						Kind:    "DisableStatus",
+					},
+					Path:          validTemplate.ValidPlaybook,
+					managedStatus: &noManagedStatus,
+				},
 				schema.GroupVersionKind{
 					Version: "v1alpha1",
 					Group:   "app.example.com",

pkg/ansible/runner/testdata/invalid_status.yaml

@@ -0,0 +1,6 @@
+---
+- version: v1alpha1
+  group: app.example.com
+  kind: Database
+  playbook: /opt/ansible/playbook.yaml
+  watches: invalid

pkg/ansible/runner/testdata/valid.yaml.tmpl

@@ -18,6 +18,11 @@
   kind: NoReconcile
   playbook: {{ .ValidPlaybook }}
   reconcilePeriod: 0s
+- version: v1alpha1
+  group: app.example.com
+  kind: DisableStatus
+  playbook: {{ .ValidPlaybook }}
+  managedStatus: False
 - version: v1alpha1
   group: app.example.com
   kind: Role

test/ansible-operator/cmd/ansible-operator/main.go

@@ -67,7 +67,7 @@ func main() {
 	}
 
 	// start the operator
-	go operator.Run(done, mgr, "/opt/ansible/watches.yaml", time.Minute)
+	go operator.Run(done, mgr, "/opt/ansible/watches.yaml", time.Minute, true)
 
 	// wait for either to finish
 	err = <-done