Merge pull request #56 from rabbitmq/statusconditions

Add and set Status Conditions 'Ready' in all resources

api/v1alpha1/binding_types.go

@@ -39,9 +39,11 @@ type BindingSpec struct {
 
 // BindingStatus defines the observed state of Binding
 type BindingStatus struct {
+	Conditions []Condition `json:"conditions,omitempty"`
 }
 
 // +kubebuilder:object:root=true
+// +kubebuilder:subresource:status
 
 // Binding is the Schema for the bindings API
 type Binding struct {

api/v1alpha1/conditions.go

@@ -0,0 +1,44 @@
+package v1alpha1
+
+import (
+	corev1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+const ready ConditionType = "Ready"
+
+type ConditionType string
+
+type Condition struct {
+	// Type indicates the scope of RabbitmqCluster status addressed by the condition.
+	Type ConditionType `json:"type"`
+	// True, False, or Unknown
+	Status corev1.ConditionStatus `json:"status"`
+	// The last time this Condition type changed.
+	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`
+	// One word, camel-case reason for current status of the condition.
+	Reason string `json:"reason,omitempty"`
+	// Full text reason for current status of the condition.
+	Message string `json:"message,omitempty"`
+}
+
+// Ready indicates that the last Create/Update operator on the CR was successful.
+func Ready() Condition {
+	return Condition{
+		Type:               ready,
+		Status:             corev1.ConditionTrue,
+		LastTransitionTime: metav1.Now(),
+		Reason:             "SuccessfulCreateOrUpdate",
+	}
+}
+
+// NotReady indicates that the last Create/Update operator on the CR failed.
+func NotReady(msg string) Condition {
+	return Condition{
+		Type:               ready,
+		Status:             corev1.ConditionFalse,
+		LastTransitionTime: metav1.Now(),
+		Reason:             "FailedCreateOrUpdate",
+		Message:            msg,
+	}
+}

api/v1alpha1/conditions_test.go

@@ -0,0 +1,32 @@
+package v1alpha1
+
+import (
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+	corev1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+var _ = Describe("Conditions", func() {
+	Context("Ready", func() {
+		It("returns 'Ready' condition set to true", func() {
+			c := Ready()
+			Expect(string(c.Type)).To(Equal("Ready"))
+			Expect(c.Status).To(Equal(corev1.ConditionTrue))
+			Expect(c.Reason).To(Equal("SuccessfulCreateOrUpdate"))
+			Expect(c.LastTransitionTime).NotTo(Equal(metav1.Time{})) // has been set; not empty
+		})
+
+	})
+
+	Context("NotReady", func() {
+		It("returns 'Ready' condition set to false", func() {
+			c := NotReady("fail to declare queue")
+			Expect(string(c.Type)).To(Equal("Ready"))
+			Expect(c.Status).To(Equal(corev1.ConditionFalse))
+			Expect(c.Reason).To(Equal("FailedCreateOrUpdate"))
+			Expect(c.Message).To(Equal("fail to declare queue"))
+			Expect(c.LastTransitionTime).NotTo(Equal(metav1.Time{})) // has been set; not empty
+		})
+	})
+})

api/v1alpha1/exchange_types.go

@@ -37,11 +37,11 @@ type ExchangeSpec struct {
 
 // ExchangeStatus defines the observed state of Exchange
 type ExchangeStatus struct {
-	// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
-	// Important: Run "make" to regenerate code after modifying this file
+	Conditions []Condition `json:"conditions,omitempty"`
 }
 
 // +kubebuilder:object:root=true
+// +kubebuilder:subresource:status
 
 // Exchange is the Schema for the exchanges API
 type Exchange struct {

api/v1alpha1/policy_types.go

@@ -39,9 +39,11 @@ type PolicySpec struct {
 
 // PolicyStatus defines the observed state of Policy
 type PolicyStatus struct {
+	Conditions []Condition `json:"conditions,omitempty"`
 }
 
 // +kubebuilder:object:root=true
+// +kubebuilder:subresource:status
 
 // Policy is the Schema for the policies API
 type Policy struct {

api/v1alpha1/queue_types.go

@@ -50,9 +50,11 @@ type RabbitmqClusterReference struct {
 
 // QueueStatus defines the observed state of Queue
 type QueueStatus struct {
+	Conditions []Condition `json:"conditions,omitempty"`
 }
 
 // +kubebuilder:object:root=true
+// +kubebuilder:subresource:status
 
 // Queue is the Schema for the queues API
 type Queue struct {

api/v1alpha1/user_types.go

@@ -37,6 +37,7 @@ type UserSpec struct {
 
 // UserStatus defines the observed state of User.
 type UserStatus struct {
+	Conditions []Condition `json:"conditions,omitempty"`
 	// Provides a reference to a Secret object containing the user credentials.
 	Credentials *corev1.LocalObjectReference `json:"credentials,omitempty"`
 }
@@ -47,6 +48,7 @@ type UserStatus struct {
 type UserTag string
 
 // +kubebuilder:object:root=true
+// +kubebuilder:subresource:status
 
 // User is the Schema for the users API.
 // +kubebuilder:subresource:status

api/v1alpha1/vhost_types.go

@@ -27,9 +27,11 @@ type VhostSpec struct {
 
 // VhostStatus defines the observed state of Vhost
 type VhostStatus struct {
+	Conditions []Condition `json:"conditions,omitempty"`
 }
 
 // +kubebuilder:object:root=true
+// +kubebuilder:subresource:status
 
 // Vhost is the Schema for the vhosts API
 type Vhost struct {

config/crd/bases/rabbitmq.com_bindings.yaml

@@ -71,10 +71,39 @@ spec:
             type: object
           status:
             description: BindingStatus defines the observed state of Binding
+            properties:
+              conditions:
+                items:
+                  properties:
+                    lastTransitionTime:
+                      description: The last time this Condition type changed.
+                      format: date-time
+                      type: string
+                    message:
+                      description: Full text reason for current status of the condition.
+                      type: string
+                    reason:
+                      description: One word, camel-case reason for current status
+                        of the condition.
+                      type: string
+                    status:
+                      description: True, False, or Unknown
+                      type: string
+                    type:
+                      description: Type indicates the scope of RabbitmqCluster status
+                        addressed by the condition.
+                      type: string
+                  required:
+                  - status
+                  - type
+                  type: object
+                type: array
             type: object
         type: object
     served: true
     storage: true
+    subresources:
+      status: {}
 status:
   acceptedNames:
     kind: ""

config/crd/bases/rabbitmq.com_exchanges.yaml

@@ -75,10 +75,39 @@ spec:
             type: object
           status:
             description: ExchangeStatus defines the observed state of Exchange
+            properties:
+              conditions:
+                items:
+                  properties:
+                    lastTransitionTime:
+                      description: The last time this Condition type changed.
+                      format: date-time
+                      type: string
+                    message:
+                      description: Full text reason for current status of the condition.
+                      type: string
+                    reason:
+                      description: One word, camel-case reason for current status
+                        of the condition.
+                      type: string
+                    status:
+                      description: True, False, or Unknown
+                      type: string
+                    type:
+                      description: Type indicates the scope of RabbitmqCluster status
+                        addressed by the condition.
+                      type: string
+                  required:
+                  - status
+                  - type
+                  type: object
+                type: array
             type: object
         type: object
     served: true
     storage: true
+    subresources:
+      status: {}
 status:
   acceptedNames:
     kind: ""