add secret formats to readme #326
Conversation
…to add_to_readme_secret_formats
…to add_to_readme_secret_formats
…to add_to_readme_secret_formats
…to add_to_readme_secret_formats
…to add_to_readme_secret_formats
…to add_to_readme_secret_formats
…to add_to_readme_secret_formats
…to add_to_readme_secret_formats
…to add_to_readme_secret_formats
…to add_to_readme_secret_formats
…to add_to_readme_secret_formats
…to add_to_readme_secret_formats
…to add_to_readme_secret_formats
…to add_to_readme_secret_formats
…to add_to_readme_secret_formats
…to add_to_readme_secret_formats
…to add_to_readme_secret_formats
…to add_to_readme_secret_formats
…to add_to_readme_secret_formats
…to add_to_readme_secret_formats
…to add_to_readme_secret_formats
…to add_to_readme_secret_formats
…to add_to_readme_secret_formats
…to add_to_readme_secret_formats
…to add_to_readme_secret_formats
…to add_to_readme_secret_formats
…to add_to_readme_secret_formats
…to add_to_readme_secret_formats
…to add_to_readme_secret_formats # Conflicts: # README.md
Changed the credentials format descriptions
…to add_to_readme_secret_formats # Conflicts: # README.md
…to add_to_readme_secret_formats # Conflicts: # README.md
…to add_to_readme_secret_formats # Conflicts: # README.md
…to add_to_readme_secret_formats # Conflicts: # README.md
UA changes
README.md
Outdated
| | serviceInstanceName`*` | `string` | The Kubernetes name of the service instance to bind, should be in the namespace of the binding. | | ||
| | externalName | `string` | The name for the service binding in SAP BTP, defaults to the binding `metadata.name` if not specified. | | ||
| | secretName | `string` | The name of the secret where the credentials are stored, defaults to the binding `metadata.name` if not specified. | | ||
| | secretKey | `string` | Property of the Secret object that stores service binding data (credentials) returned from the broker. It is encoded as a JSON object to support complex data structures. [Example](#formats-of-secret-objects) | |
There was a problem hiding this comment.
In rootKey you use 'property' while in secretRootKey we use 'key'. key is also baked in the attributes' name. And you also use it below in the format title ("Key- Value Pairs") and the description.
"...defines a name of a key in the secret object in which the service binding data (credentials) returned from the broker will be stored..."
There was a problem hiding this comment.
@TalShorSap
Part of the Secret object that stores service binding data (credentials) received from the broker. When secretKey is used, credentials are stored in the JSON format.
There was a problem hiding this comment.
@danielforsap
The root key... -> The secretRootKey is the key in the secret object in which... (value is json)
README.md
Outdated
| ``` | ||
|
|
||
| ### Credentials as JSON Object | ||
| To show credentials returned from the broker as a JSON object, add 'secretKey: your-secret-value' to the binding spec. |
There was a problem hiding this comment.
it shoud be clearer that 'your-secret-value' is a sample value.
"add 'secretKey: your-secret-value' to the binding spec" seems like straight forward instruction to follow.
"...specify your desired key name in add 'secretKey' attribute in the binding spec"
There was a problem hiding this comment.
To show credentials returned from the broker as a JSON object, specify your desired key name for 'secretKey' attribute in the binding spec. 'secretKey: your-desired-key-name'
There was a problem hiding this comment.
@danielforsap need to add reason and take care for Avi's comment
add secret formats to readme