Template Readiness Checks (#15)

These last two fields (name & namespace) use the old accessor and string
types, by making them plain strings (that may be templated) then we can
thrown away yet more legacy code.

Author: spjmurray

crds/servicebroker.couchbase.com_servicebrokerconfigs.yaml

@@ -83,37 +83,11 @@ spec:
                                   type: string
                                 name:
                                   description: Name is the resource name to poll.
-                                  properties:
-                                    parameter:
-                                      description: Parameter, if set, uses the corresponding
-                                        request parameter for the parameter source.
-                                      type: string
-                                    registry:
-                                      description: Registry , if set, uses the corresponding
-                                        registry value for the parameter source.
-                                      pattern: ^[a-zA-Z0-9-]+$
-                                      type: string
-                                    string:
-                                      description: String is a literal string value.
-                                      type: string
-                                  type: object
+                                  type: string
                                 namespace:
                                   description: Namespace is the namespace the resource
                                     resides in.
-                                  properties:
-                                    parameter:
-                                      description: Parameter, if set, uses the corresponding
-                                        request parameter for the parameter source.
-                                      type: string
-                                    registry:
-                                      description: Registry , if set, uses the corresponding
-                                        registry value for the parameter source.
-                                      pattern: ^[a-zA-Z0-9-]+$
-                                      type: string
-                                    string:
-                                      description: String is a literal string value.
-                                      type: string
-                                  type: object
+                                  type: string
                                 status:
                                   description: Status is the status of the condition
                                     that must match e.g. "True"
@@ -193,37 +167,11 @@ spec:
                                   type: string
                                 name:
                                   description: Name is the resource name to poll.
-                                  properties:
-                                    parameter:
-                                      description: Parameter, if set, uses the corresponding
-                                        request parameter for the parameter source.
-                                      type: string
-                                    registry:
-                                      description: Registry , if set, uses the corresponding
-                                        registry value for the parameter source.
-                                      pattern: ^[a-zA-Z0-9-]+$
-                                      type: string
-                                    string:
-                                      description: String is a literal string value.
-                                      type: string
-                                  type: object
+                                  type: string
                                 namespace:
                                   description: Namespace is the namespace the resource
                                     resides in.
-                                  properties:
-                                    parameter:
-                                      description: Parameter, if set, uses the corresponding
-                                        request parameter for the parameter source.
-                                      type: string
-                                    registry:
-                                      description: Registry , if set, uses the corresponding
-                                        registry value for the parameter source.
-                                      pattern: ^[a-zA-Z0-9-]+$
-                                      type: string
-                                    string:
-                                      description: String is a literal string value.
-                                      type: string
-                                  type: object
+                                  type: string
                                 status:
                                   description: Status is the status of the condition
                                     that must match e.g. "True"

documentation/modules/ROOT/pages/concepts/dynamic-attributes.adoc

@@ -65,7 +65,6 @@ Service Broker defined functions are divided into categories based on their beha
 * Generators--these generate data items.
 * Assertions--these perform error checking.
 
-[#accessors]
 === Accessors
 
 Accessors do a simple lookup of a value from available data sources.
@@ -167,7 +166,7 @@ metadata:
 
 === Mutators
 
-Mutators build upon accessors and allow data to be modified.
+Mutators allow data to be modified.
 
 ==== Default
 

documentation/modules/ROOT/pages/reference/servicebrokerconfigs.adoc

@@ -499,8 +499,8 @@ readinessChecks:
 - condition:
     apiVersion: apps/v1
     kind: Deployment
-    namespace: {}
-    name: {}
+    namespace: '{{ registry "namespace" | json }}'
+    name: '{{ registry "instance-name" | json }}'
     type: Available
     status: "True"
 ----
@@ -521,16 +521,16 @@ This attribute defines the resource kind of the desired resource.
 ==== readinessChecks.condition.namespace
 
 This attribute defines the namespace the desired resource exists in.
+This attribute may be templated as per dynamic attributes.
 
-* This attribute is required and must be an object.
-* This attribute is described in more detail in the <<string,string>> reference.
+* This attribute is required and must be a string.
 
 ==== readinessChecks.condition.name
 
 This attribute defines the name the desired resource has.
+This attribute may be templated as per dynamic attributes.
 
-* This attribute is required and must be an object.
-* This attribute is described in more detail in the <<string,string>> reference.
+* This attribute is required and must be a string.
 
 ==== readinessChecks.condition.type
 
@@ -543,59 +543,3 @@ This attribute defines the condition type to match.
 This attribute defines the condition status to match.
 
 * This attribute is required and must be a string.
-
-[#accessor]
-=== Accessor
-
-This object is used by parameter sources to read configuration data dynamically from one of the available data sources.
-Only one of `registry` or `parameter` should be specified, the result is undefined otherwise.
-
-[source,yaml]
-----
-registry: my-key
-parameter: /path/to/my/value
-----
-
-==== registry
-
-This attribute causes the Service Broker to source a value from the registry associated with the service instance or service binding.
-
-* This attribute is optional and must be a string.
-
-==== parameter
-
-This attribute causes the Service Broker to source a value from the user-specified service instance or service binding request parameters.
-
-* This attribute is optional and must be a string.
-
-[#string]
-=== String
-
-This object is a specialization of the <<accessor,accessor>> type that enforces type.
-It also allows a literal string value to be specified.
-Only one of `registry`, `parameter` or `string` can be specified, the result is undefined otherwise.
-
-[source,yaml]
-----
-registry: my-key
-parameter: /path/to/my/value
-string: my-string
-----
-
-==== registry
-
-This attribute causes the Service Broker to source a value from the registry associated with the service instance or service binding.
-
-* This attribute is optional and must be a string.
-
-==== parameter
-
-This attribute causes the Service Broker to source a value from the user-specified service instance or service binding request parameters.
-
-* This attribute is optional and must be a string.
-
-==== string
-
-This attribute provides a literal string value.
-
-* This attribute is optional and must be a string.

examples/configurations/couchbase-server/broker.yaml

@@ -453,10 +453,8 @@ spec:
         condition:
           apiVersion: couchbase.com/v2
           kind: CouchbaseCluster
-          namespace:
-            registry: namespace
-          name:
-            registry: instance-name
+          namespace: '{{ registry "namespace" | json }}'
+          name: '{{ registry "instance-name" | json }}'
           type: Available
           status: "True"
     serviceBinding:

pkg/apis/servicebroker/v1alpha1/types.go

@@ -308,10 +308,10 @@ type ConfigurationReadinessCheckCondition struct {
 	Kind string `json:"kind"`
 
 	// Namespace is the namespace the resource resides in.
-	Namespace String `json:"namespace"`
+	Namespace string `json:"namespace"`
 
 	// Name is the resource name to poll.
-	Name String `json:"name"`
+	Name string `json:"name"`
 
 	// Type is the type of the condition to look for e.g. "Available"
 	Type string `json:"type"`
@@ -320,29 +320,6 @@ type ConfigurationReadinessCheckCondition struct {
 	Status string `json:"status"`
 }
 
-// Accessor is an argument that references data from either parameters or
-// the registry.
-type Accessor struct {
-	// Registry , if set, uses the corresponding registry value for the
-	// parameter source.
-	// +kubebuilder:validation:Pattern="^[a-zA-Z0-9-]+$"
-	Registry *string `json:"registry,omitempty"`
-
-	// Parameter, if set, uses the corresponding request parameter for the
-	// parameter source.
-	Parameter *string `json:"parameter,omitempty"`
-}
-
-// String allows the specification of a string value from either a literal source
-// or an accessor.
-type String struct {
-	// Accessor allows the string to be read from the registry or parameters.
-	Accessor `json:",inline"`
-
-	// String is a literal string value.
-	String *string `json:"string,omitempty"`
-}
-
 // ServiceBrokerConfigStatus records status information about a configuration
 // as the Service Broker processes it.
 type ServiceBrokerConfigStatus struct {

pkg/apis/servicebroker/v1alpha1/zz_generated.deepcopy.go

@@ -19,6 +19,7 @@ import (
 
 	v1 "github.com/couchbase/service-broker/pkg/apis/servicebroker/v1alpha1"
 	"github.com/couchbase/service-broker/pkg/config"
+	"github.com/couchbase/service-broker/pkg/errors"
 	"github.com/couchbase/service-broker/pkg/operation"
 	"github.com/couchbase/service-broker/pkg/registry"
 
@@ -55,16 +56,26 @@ func (e *conditionUnreadyError) Error() string {
 // conditionReady waits for a condition on a resource to report as ready.  Returns nil on success and
 // an error otherwise.
 func conditionReady(entry *registry.Entry, condition *v1.ConfigurationReadinessCheckCondition) error {
-	namespace, err := resolveString(&condition.Namespace, entry)
+	namespaceRaw, err := renderTemplateString(condition.Namespace, entry)
 	if err != nil {
 		return err
 	}
 
-	name, err := resolveString(&condition.Name, entry)
+	namespace, ok := namespaceRaw.(string)
+	if !ok {
+		return errors.NewConfigurationError("condition resource namespace not a string %v", namespaceRaw)
+	}
+
+	nameRaw, err := renderTemplateString(condition.Name, entry)
 	if err != nil {
 		return err
 	}
 
+	name, ok := nameRaw.(string)
+	if !ok {
+		return errors.NewConfigurationError("condition resource name not a string %v", nameRaw)
+	}
+
 	gv, err := schema.ParseGroupVersion(condition.APIVersion)
 	if err != nil {
 		return err