Merge pull request #137 from triggermesh/task/rename-customize-to-spectoenvs

Move customize to spectoenvs

Author: Pablo Mercado

config/300-crdregistration.yaml

@@ -273,12 +273,22 @@ spec:
                           - name
                           type: object
                         type: array
-                      customize:
-                        description: Customize contains instructions to modify parameters
+                      global:
+                        description: Global defines the configuration to be applied
+                          to all generated parameters.
+                        properties:
+                          defaultPrefix:
+                            description: DefaultPrefix to be appeneded to keys by
+                              all generated parameters. This configuration does not
+                              affect parameter keys explicitly set by users.
+                            type: string
+                        type: object
+                      specToEnvs:
+                        description: SpecToEnvs contains instructions to modify parameters
                           generation from the instance's spec.
                         items:
-                          description: CustomizeParameters contains instructions to
-                            modify parameters generation for the controlled instance
+                          description: SpecToEnvsParameterConfiguration contains instructions
+                            to modify parameters generation for the controlled instance
                             spec.
                           properties:
                             path:
@@ -349,16 +359,6 @@ spec:
                           - path
                           type: object
                         type: array
-                      global:
-                        description: Global defines the configuration to be applied
-                          to all generated parameters.
-                        properties:
-                          defaultPrefix:
-                            description: DefaultPrefix to be appeneded to keys by
-                              all generated parameters. This configuration does not
-                              affect parameter keys explicitly set by users.
-                            type: string
-                        type: object
                     type: object
                   statusConfiguration:
                     description: StatusConfiguration contains rules to populate a

docs/primer.md

@@ -59,8 +59,6 @@ The CRD above defines a `kuard` resource with an schema that lets users define a
 kubectl apply -f https://raw.githubusercontent.com/triggermesh/scoby/main/docs/samples/00.primer/01.kuard-crd.yaml
 ```
 
-## Kuard ClusterRole
-
 Since the CRD has been created at the previous step, the `kuard` resource is available and we can run a command to list the instances at the cluster:
 
 ```console
@@ -69,7 +67,9 @@ $ kubectl get kuards
 No resources found in default namespace.
 ```
 
-Not all users can manage resources though, `ServiceAccount` that need it must be granted roles on the new resource. One of those `ServiceAccount` is the one that runs Scoby, that will need to watch any changes at `kuard` instances at every namespace of the cluster and update the status (when the CRD contains the status element).
+## Kuard ClusterRole
+
+Not all users can manage resources, each `ServiceAccount` that need it must be granted roles on the new resource. One of those `ServiceAccount` is the one that runs Scoby, that will need to watch any changes at `kuard` instances at every namespace of the cluster and update the status (when the CRD contains the status element).
 
 Scoby's `ServiceAccount` uses an aggregation pattern where any `ClusterRole` that contains the label `scoby.triggermesh.io/crdregistration: "true"` will be automatically granted.
 
@@ -150,7 +150,7 @@ Users can now create `kuards` like this one:
 apiVersion: extensions.triggermesh.io/v1
 kind: Kuard
 metadata:
-  name: kuard-primer-instance
+  name: primer-instance
 spec:
   primer: Hello World!
 ```
@@ -164,16 +164,16 @@ The instance will generate a deployment and a service.
 ```console
 $ kubectl get deployment,svc
 NAME                                    READY   UP-TO-DATE   AVAILABLE   AGE
-deployment.apps/kuard-primer-instance   1/1     1            1           1m00s
+deployment.apps/kuards-primer-instance   1/1     1            1           1m00s
 
 NAME                            TYPE        CLUSTER-IP     EXTERNAL-IP   PORT(S)   AGE
-service/kuard-primer-instance   ClusterIP   10.98.247.15   <none>        80/TCP    1m00s
+service/kuards-primer-instance   ClusterIP   10.98.247.15   <none>        80/TCP    1m00s
 ```
 
 The service can be forwarded to be able to reach `kuard` using `http://localhost:8888`.
 
 ```console
-kubectl port-forward svc/kuard-primer-instance  8888:80
+kubectl port-forward svc/kuards-primer-instance  8888:80
 ```
 
 Open the URL and navigate to `Server Env` option at the vertical menu. You should find that the `.spec.primer` element at the spec has been reflected as `PRIMER` environment variable at the running pod.
@@ -189,7 +189,7 @@ This primer example does not contain status management though, which means that
 Remove assets created, preferably in reverse creation order to avoid getting error logs at Scoby controller.
 
 ```console
-kubectl delete kuards kuard-primer-instance
+kubectl delete kuards primer-instance
 kubectl delete crdregistrations.scoby.triggermesh.io kuards
 kubectl delete clusterroles crd-registrations-scoby-kuard
 kubectl delete crd kuards.extensions.triggermesh.io

docs/reference/registration.md

@@ -158,7 +158,7 @@ The default behavior is to create parameters from each spec element (arrays will
 
 ```yaml
     parameterConfiguration:
-      customize:
+      specToEnvs:
       - path: spec.bar
         render:
           skip: true
@@ -168,7 +168,7 @@ The default behavior is to create parameters from each spec element (arrays will
 
 ```yaml
     parameterConfiguration:
-      customize:
+      specToEnvs:
       - path: spec.bar
         render:
           name: FOO_BAR
@@ -178,7 +178,7 @@ The default behavior is to create parameters from each spec element (arrays will
 
 ```yaml
     parameterConfiguration:
-      customize:
+      specToEnvs:
       - path: spec.bar
         render:
           defaultValue: hello scoby
@@ -188,7 +188,7 @@ The default behavior is to create parameters from each spec element (arrays will
 
 ```yaml
     parameterConfiguration:
-      customize:
+      specToEnvs:
       - path: spec.credentials
         render:
           name: FOO_CREDENTIALS
@@ -201,7 +201,7 @@ The default behavior is to create parameters from each spec element (arrays will
 
 ```yaml
     parameterConfiguration:
-      customize:
+      specToEnvs:
       - path: spec.preferences
         render:
           valueFromConfigmap:
@@ -213,7 +213,7 @@ The default behavior is to create parameters from each spec element (arrays will
 
 ```yaml
     parameterConfiguration:
-      customize:
+      specToEnvs:
       - path: spec.destination
         render:
           name: K_SINK
@@ -227,7 +227,7 @@ The default behavior is to create parameters from each spec element (arrays will
 
 ```yaml
     parameterConfiguration:
-      customize:
+      specToEnvs:
       - path: spec.destination
         render:
           name: K_SINK

docs/samples/00.primer/04.kuard-instance.yaml

@@ -1,6 +1,6 @@
 apiVersion: extensions.triggermesh.io/v1
 kind: Kuard
 metadata:
-  name: kuard-primer-instance
+  name: primer-instance
 spec:
   primer: Hello World!

docs/samples/01.kuard/03.param.skip/01.kuard-registration.yaml

@@ -15,7 +15,7 @@ spec:
       repo: gcr.io/kuar-demo/kuard-amd64:blue
 
     parameterConfiguration:
-      customize:
+      specToEnvs:
       # Skip variable2 from generating a parameter for the workload
       - path: spec.variable2
         render:

docs/samples/01.kuard/04.param.rename/01.kuard-registration.yaml

@@ -15,7 +15,7 @@ spec:
       repo: gcr.io/kuar-demo/kuard-amd64:blue
 
     parameterConfiguration:
-      customize:
+      specToEnvs:
       # Use a specific env var key for variable2
       - path: spec.variable2
         render:

docs/samples/01.kuard/05.param.value/01.kuard-registration.yaml

@@ -15,7 +15,7 @@ spec:
       repo: gcr.io/kuar-demo/kuard-amd64:blue
 
     parameterConfiguration:
-      customize:
+      specToEnvs:
       # Set a default value for variable2
       - path: spec.variable2
         render:

docs/samples/01.kuard/06.param.secret/01.kuard-registration.yaml

@@ -16,7 +16,7 @@ spec:
       repo: gcr.io/kuar-demo/kuard-amd64:blue
 
     parameterConfiguration:
-      customize:
+      specToEnvs:
       # Reference a secret
       - path: spec.refToSecret
         render:

docs/samples/01.kuard/07.param.configmap/01.kuard-registration.yaml

@@ -16,7 +16,7 @@ spec:
       repo: gcr.io/kuar-demo/kuard-amd64:blue
 
     parameterConfiguration:
-      customize:
+      specToEnvs:
       # Reference a ConfigMap
       - path: spec.refToConfigMap
         render:

docs/samples/01.kuard/08.param.addressable/01.kuard-registration.yaml

@@ -16,7 +16,7 @@ spec:
       repo: gcr.io/kuar-demo/kuard-amd64:blue
 
     parameterConfiguration:
-      customize:
+      specToEnvs:
       # Resolve an address
       - path: spec.refToAddress
         render: