add secret formats to readme

README.md

@@ -27,6 +27,7 @@ The SAP BTP service operator is based on the [Kubernetes Operator pattern](https
 * [Credentials Rotation](#credentials-rotation)
 * [Multitenancy](#multitenancy)
 * [Troubleshooting and Support](#troubleshooting-and-support)
+* [Formats of Secret Objects](#formats-of-secret-objects)
 * [Uninstalling the Operator](#uninstalling-the-operator)
 
 ## Architecture
@@ -258,20 +259,20 @@ Review the supported Kubernetes API versions for the following SAP BTP Service O
 
 ### Service Binding 
 #### Spec
-| Parameter             | Type       | Description                                                                                                   |
-|:-----------------|:---------|:-----------------------------------------------------------------------------------------------------------|
-| 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`  | The key inside the binding secret to store the credentials returned by the broker encoded as json to support complex data structures. |
-| secretRootKey | `string`  | The key inside the secret to store all binding data including credentials returned by the broker and additional info under single key.<br/>Convenient way to store whole binding data in single file when using `volumeMounts`. |
-| parameters       |  `[]object`  |  Some services support the provisioning of additional configuration parameters during the bind request.<br/>For the list of supported parameters, check the documentation of the particular service offering.|
-| parametersFrom | `[]object` | List of sources to populate parameters. |
-| userInfo | `object`  | Contains information about the user that last modified this service binding. |
-| credentialsRotationPolicy | `object`  | Holds automatic credentials rotation configuration. |
-| credentialsRotationPolicy.enabled | `boolean`  | Indicates whether automatic credentials rotation are enabled. |
-| credentialsRotationPolicy.rotationFrequency | `duration`  | Specifies the frequency at which the binding rotation is performed. |
-| credentialsRotationPolicy.rotatedBindingTTL | `duration`  | Specifies the time period for which to keep the rotated binding. |
+| Parameter             | Type       | Description                                                                                                                                                                                                                                                                                                                              |
+|:-----------------|:---------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| 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](#secret-formats)                                                                                                                                     |
+| secretRootKey | `string`  | The root key is a part of the Secret object, which stores service binding data (credentials) received from the broker, as well as additional information. When the root key is used, all data is stored under a single key. This makes it a convenient way to store data in one file when using volumeMounts. [Example](#secret-formats) |
+| parameters       |  `[]object`  | Some services support the provisioning of additional configuration parameters during the bind request.<br/>For the list of supported parameters, check the documentation of the particular service offering.                                                                                                                             |
+| parametersFrom | `[]object` | List of sources to populate parameters.                                                                                                                                                                                                                                                                                                  |
+| userInfo | `object`  | Contains information about the user that last modified this service binding.                                                                                                                                                                                                                                                             |
+| credentialsRotationPolicy | `object`  | Holds automatic credentials rotation configuration.                                                                                                                                                                                                                                                                                      |
+| credentialsRotationPolicy.enabled | `boolean`  | Indicates whether automatic credentials rotation are enabled.                                                                                                                                                                                                                                                                            |
+| credentialsRotationPolicy.rotationFrequency | `duration`  | Specifies the frequency at which the binding rotation is performed.                                                                                                                                                                                                                                                                      |
+| credentialsRotationPolicy.rotatedBindingTTL | `duration`  | Specifies the time period for which to keep the rotated binding.                                                                                                                                                                                                                                                                         |
 
 
 
@@ -517,6 +518,60 @@ The SAP BTP service operator project maintainers will respond to the best of the
 
 [Back to top](#sap-business-technology-platform-sap-btp-service-operator-for-kubernetes)
 
+## Formats of Secret Objects
+
+### Default
+```bash
+#Credentials section
+uri: https://feature-flags.cfapps.stagingaws.hanavlab.ondemand.com
+username: c2Jzc19sYmo4MG9sanczZm9hcTg3YnJqcnl6NmJxZStwd25kbmxyZWdoL3piZWR0bGFieGhpNWdmZXcxaGM1dGYrdWhjdzBnPQ==
+password: YWFfeXZZdjY4WWwxYnNyZ1VqUGNEMWk3anZWNWpNPQ==
+
+#Additional data added by the operator
+instance_guid: bd9bda65-1405-4ea0-a716-5afeb13eca5b
+instance_name: sample-instance    
+plan: lite                        
+type: feature-flags  // The service offering name
+```
+
+### SecretKey
+To use SecretKey, add 'secretKey: your-secret-value' to the spec.
+```bash
+#Credentials section
+your-secret-value:
+  {
+    password: aa_hM7glY8ARNF8hGWb5OjRIt1PPgo=
+    uri: https://feature-flags.cfapps.stagingaws.hanavlab.ondemand.com
+    username: <user_name>
+  }
+
+#Additional data added by the operator
+instance_guid: bd9bda65-1405-4ea0-a716-5afeb13eca5b
+instance_name: sample-instance  
+plan: lite
+type: feature-flags // The service offering name
+```
+
+### SecretRootKey
+To use SecretRootKey, add 'secretRootKey: your-secret-value' to the spec.
+```bash
+your-secret-value:
+  {
+    #Credentials section
+    password: aa_hM7glY8ARNF8hGWb5OjRIt1PPgo=
+    uri: https://feature-flags.cfapps.stagingaws.hanavlab.ondemand.com
+    username: <user_name>
+
+    #Additional data added by the operator
+    instance_guid: bd9bda65-1405-4ea0-a716-5afeb13eca5b
+    instance_name: sample-instance  
+    plan: lite
+    type: feature-flags // The service offering name
+  }
+```
+
+[Back to top](#sap-business-technology-platform-sap-btp-service-operator-for-kubernetes)
+
 ## Uninstalling the Operator
 
 Before you uninstall the operator, we recommend you manually delete all associated service instances and bindings. This way, you'll ensure all data stored with service instances and bindings are properly taken care of. Instances and bindings that were not manually deleted will be automatically deleted once you start the uninstallation process.