rebase and review comments

kudobuilder · Dec 16, 2019 · ab675c1 · ab675c1
1 parent 2971291
commit ab675c1
Show file tree

Hide file tree

Showing 6 changed files with 25 additions and 24 deletions.
diff --git a/config/crds/kudo_v1beta1_operatorversion.yaml b/config/crds/kudo_v1beta1_operatorversion.yaml
@@ -78,8 +78,8 @@ spec:
                 type: object
               type: array
             templates:
-              description: Yaml captures a templated yaml list of elements that define
-                the application operator instance.
+              description: Templates is a list of references to YAML templates located
+                in the templates folder and later referenced from tasks.
               type: object
             upgradableFrom:
               description: UpgradableFrom lists all OperatorVersions that can upgrade

diff --git a/pkg/kudoctl/cmd/testdata/deploy-kudo-ns.yaml.golden b/pkg/kudoctl/cmd/testdata/deploy-kudo-ns.yaml.golden
@@ -135,8 +135,8 @@ spec:
                 type: object
               type: array
             templates:
-              description: Yaml captures a templated yaml list of elements that define
-                the application operator instance.
+              description: Templates is a list of references to YAML templates located
+                in the templates folder and later referenced from tasks.
               type: object
             upgradableFrom:
               description: UpgradableFrom lists all OperatorVersions that can upgrade

diff --git a/pkg/kudoctl/cmd/testdata/deploy-kudo-sa.yaml.golden b/pkg/kudoctl/cmd/testdata/deploy-kudo-sa.yaml.golden
@@ -135,8 +135,8 @@ spec:
                 type: object
               type: array
             templates:
-              description: Yaml captures a templated yaml list of elements that define
-                the application operator instance.
+              description: Templates is a list of references to YAML templates located
+                in the templates folder and later referenced from tasks.
               type: object
             upgradableFrom:
               description: UpgradableFrom lists all OperatorVersions that can upgrade

diff --git a/pkg/kudoctl/cmd/testdata/deploy-kudo-webhook.yaml.golden b/pkg/kudoctl/cmd/testdata/deploy-kudo-webhook.yaml.golden
@@ -82,8 +82,8 @@ spec:
         spec:
           properties:
             connectionString:
-              description: ConnectionString defines a mustached string that can be
-                used to connect to an instance of the Operator
+              description: ConnectionString defines a templated string that can be
+                used to connect to an instance of the Operator.
               type: string
             crdVersion:
               type: string
@@ -94,35 +94,36 @@ spec:
                 properties:
                   default:
                     description: Default is a default value if no parameter is provided
-                      by the instance
+                      by the instance.
                     type: string
                   description:
                     description: Description captures a longer description of how
-                      the variable will be used
+                      the parameter will be used.
                     type: string
                   displayName:
-                    description: Human friendly crdVersion of the parameter name
+                    description: DisplayName can be used by UIs.
                     type: string
                   name:
-                    description: 'Name is the string that should be used in the template
-                      file for example, if `name: COUNT` then using the variable `.Params.COUNT`'
+                    description: "Name is the string that should be used in the template
+                      file for example, if `name: COUNT` then using the variable in
+                      a spec like: \n spec:   replicas:  {{ .Params.COUNT }}"
                     type: string
                   required:
                     description: Required specifies if the parameter is required to
-                      be provided by all instances, or whether a default can suffice
+                      be provided by all instances, or whether a default can suffice.
                     type: boolean
                   trigger:
                     description: Trigger identifies the plan that gets executed when
                       this parameter changes in the Instance object. Default is `update`
-                      if present, or `deploy` if not present
+                      if a plan with that name exists, otherwise it's `deploy`.
                     type: string
                 type: object
               type: array
             plans:
-              description: Plans specify a map a plans that specify how to
+              description: Plans maps a plan name to a plan.
               type: object
             tasks:
-              description: List of all tasks available in this OperatorVersions
+              description: List of all tasks available in this OperatorVersion.
               items:
                 properties:
                   kind:
@@ -134,12 +135,12 @@ spec:
                 type: object
               type: array
             templates:
-              description: List of go templates YAML files that define the application
-                operator instance
+              description: Templates is a list of references to YAML templates located
+                in the templates folder and later referenced from tasks.
               type: object
             upgradableFrom:
               description: UpgradableFrom lists all OperatorVersions that can upgrade
-                to this OperatorVersion
+                to this OperatorVersion.
               items:
                 type: object
               type: array
@@ -186,7 +187,7 @@ spec:
           properties:
             OperatorVersion:
               description: OperatorVersion specifies a reference to a specific OperatorVersion
-                object
+                object.
               type: object
             parameters:
               type: object

diff --git a/pkg/kudoctl/cmd/testdata/deploy-kudo.yaml.golden b/pkg/kudoctl/cmd/testdata/deploy-kudo.yaml.golden
@@ -135,8 +135,8 @@ spec:
                 type: object
               type: array
             templates:
-              description: Yaml captures a templated yaml list of elements that define
-                the application operator instance.
+              description: Templates is a list of references to YAML templates located
+                in the templates folder and later referenced from tasks.
               type: object
             upgradableFrom:
               description: UpgradableFrom lists all OperatorVersions that can upgrade

diff --git a/pkg/kudoctl/kudoinit/crd/crds.go b/pkg/kudoctl/kudoinit/crd/crds.go
@@ -184,7 +184,7 @@ func operatorVersionCrd() *apiextv1beta1.CustomResourceDefinition {
 				Properties: taskProps,
 			}, JSONSchemas: []apiextv1beta1.JSONSchemaProps{}},
 		},
-		"templates": {Type: "object", Description: "Yaml captures a templated yaml list of elements that define the application operator instance."},
+		"templates": {Type: "object", Description: "Templates is a list of references to YAML templates located in the templates folder and later referenced from tasks."},
 		"upgradableFrom": {
 			Type:        "array",
 			Description: "UpgradableFrom lists all OperatorVersions that can upgrade to this OperatorVersion.",