Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adding annotation to help discovery #9

Merged
merged 5 commits into from
Apr 24, 2020
Merged

Adding annotation to help discovery #9

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
845f3b7
Adding annotation to help discovery
arthurdm Mar 25, 2020
7efd4d6
Simplifying discoverability
arthurdm Apr 13, 2020
a41611d
Merge branch 'master' into discovery
arthurdm Apr 13, 2020
25ed20f
Merge branch 'master' into discovery
arthurdm Apr 21, 2020
93a66a1
Update README.md
arthurdm Apr 24, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion README.md
View file
Open in desktop
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