Skip to content

Commit

Permalink
Merge pull request #9 from application-stacks/discovery
Browse files Browse the repository at this point in the history
Adding annotation to help discovery
  • Loading branch information
arthurdm committed Apr 24, 2020
2 parents 5871b7a + 93a66a1 commit cb4062a
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Specification for binding services to runtime applications running in Kubernetes

## Proposal

Main section of the doc. Has sub-sections that outline the design.
The following sections outline the details of the specification.

### Making a service bindable

Expand All @@ -30,6 +30,10 @@ A bindable service **MUST** comply with one-of:
* a `dataMapping` element illustrating how each of its `status`, `spec` or `data` properties map to the corresponding [binding data](#service-binding-schema).
* a `detectBindingResources: true` element which will automatically populate the resulting Secret from the `ServiceBinding` with information from any Route, Ingress, Service, ConfigMap or Secret resources that are owned by the backing service CR.

<kbd>EXPERIMENTAL</kbd>The service **MUST** also make itself discoverable by complying with one-of:
* In the case of an OLM-based Operator, add `Bindable` to the CSV's `metadata.annotations.categories`.
* In the case of a Helm chart service, add bindable to the Chart.yaml's keyword list.
* In all other cases, add the `servicebinding/bindable: "true"` annotation to your CRD or any CR (Secret, Service, etc).

#### Pointer to binding data

Expand Down

0 comments on commit cb4062a

Please sign in to comment.