New Annotations/descriptors for all use-cases #25
Conversation
There was a problem hiding this comment.
awesome job @sbose78, thanks. I think this is simple yet flexible enough to cater for complex cases as well.
I put some minor comments for more clarity. Another thing if you wanted to do a global search/replace is there were a few instances of configmap vs ConfigMap and secret vs Secret - just for the syntax police out there. :)
Let me know when it's ready to merge. 👍
|
All Secret and |
|
|
||
| During a binding operation, annotations from relevant Kubernetes resources are extracted to gather information about what is interesting for binding. This information is eventually used to bind the application with the backing service by populating the binding Secret. | ||
|
|
||
| ### Requirements for specifying binding information in a backing service CRD / Kubernetes resource |
There was a problem hiding this comment.
Just trying to see if any of these scenarios can extract binding info from Kafka CR e.g.
status:
listeners:
- type: plain
addresses:
- host: my-cluster-kafka-bootstrap.service-binding-demo.svc
port: 9092
- host: my-cluster-kafka-bootstrap.service-binding-demo.svc
port: 9093
- type: tls
addresses:
- host: my-cluster-kafka-bootstrap.service-binding-demo.svc
port: 9094I'm wondering if supporting templating would cover cases we haven't thought of. Maybe something like:
- path: listeners
x-descriptors:
- servicebinding:prefix:elementType=template:source:{{ GO_TEMPLATE }}:bindAs=volumeAnd the Go templates generates the following:
plain_0=my-cluster-kafka-bootstrap.service-binding-demo.svc:9092
plain_1=my-cluster-kafka-bootstrap.service-binding-demo.svc:9093
tls_0=my-cluster-kafka-bootstrap.service-binding-demo.svc:9094
After adding the prefix, the secret would look like this:
PREFIX_PLAIN_0: my-cluster-kafka-bootstrap.service-binding-demo.svc:9092
...
There was a problem hiding this comment.
Escape hatch! :) Let me think.
There was a problem hiding this comment.
ya - I think that's a great point @navidsh. This essentially allows the Operator author to define these complex mappings without changing their controller code and without requiring each consumer to have to deal with that complexity in the dataMappings portion of their ServiceBinding.
@sbose78 - I believe if we introduced Navid's proposal then we could close this issue.
There was a problem hiding this comment.
@navidsh could you help me with a complete example please? I will work on introducing this in a separate PR today.
|
On a second look, this does look like a very complex structure - we can realistically support only top-level items in a slice of maps and slice of strings. Therefore, we need a "customEnvVar"-styled thing which you've suggested - and it's a good escape hatch. |
annotations.md
Outdated
| * `sourceValue`: Specifies the key in the slice of maps whose value would be used as the value, corresponding to the value of the `sourceKey` which is added as the key, in the binding Secret. Mandatory only if `elementType` is `sliceOfMaps`. | ||
|
|
||
|
|
||
| ### A Sample CR : The Kubernetes resource that the appliaction would bind to |
annotations.md
Outdated
| - path: data.dbConfiguration | ||
| x-descriptors: | ||
| - urn:alm:descriptor:io.kubernetes:ConfigMap | ||
| - servicebinding:certificate:bindAs=volume |
There was a problem hiding this comment.
probably meant bindAs=envVar or omit it?
annotations.md
Outdated
| ``` | ||
| - path: data.uri | ||
| x-descriptors: | ||
| - servicebinding:connectionURL |
There was a problem hiding this comment.
perhaps this is reversed? should be data.connectionURL and servicebinding:uri
| - servicebinding:timeout:sourceKey=db_timeout | ||
| ``` | ||
|
|
||
| 6. #### Use the attribute “status.data.url” |
There was a problem hiding this comment.
we used both url and uri in this example. I think you meant to use uri in all cases.
|
Comments addressed in 6942689 . Thank you for the excellent review. |
|
.. and 0eae110 |
Based on extensive discussions in #21 , I've drafted how the annotations and descriptors need to look like.