doc: Add explanation for service binding options #35
Conversation
README.md
Outdated
| There are multiple options to register the service binding: | ||
| * Regular service binding in SAP BTP Cloud Foundry (resulting in `VCAP_SERVICES` env var entry). | ||
| * Set an environment variable explicitly: `AICORE_SERVICE_KEY` | ||
| * Define and use a _Destination_ in _BTP Destination Service_. | ||
| * Leveraging `"user-provided"` service binding (currently not recommended). | ||
| * Define and use a custom `ServiceBinding` or `ServiceBindingAccessor` declaration in application (not recommended). |
There was a problem hiding this comment.
Mention that option 1 and 4 are Cloud only, not local. The other are both local and Cloud
There was a problem hiding this comment.
I've seen devs use VCAP_SERVICES locally. Therefore I would rather not make this distinction explicit here.
|
|
||
| </details> | ||
|
|
||
| ### Set credentials as dedicated environment variable |
There was a problem hiding this comment.
Mention that this is recommended if you need to access an external AI Core service instance or for local use
There was a problem hiding this comment.
Currently the README is already almost unreadable with all the details and sample code. I don't want to explain and motivate reasons for the options to resolve a service binding.
Not only because of complexity and readability, but also any documented "reasoning" is subject to change over time. I'm certain we will see changes to best-practices, once the project gains traction.
Context
AI/ai-sdk-java-backlog#56.
Explain options:
VCAP_SERVICESenv var entry).AICORE_SERVICE_KEYLeveraging"user-provided"service binding (currently not recommended).Define and use a customServiceBindingorServiceBindingAccessordeclaration in application (not recommended).I chose to enhance the
README.md(instead of starting a newdocs/document).