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.

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

[SAPBTPCFS-3288] CUSTOM TEMPLATES FOR SECRETS #408

Merged
merged 19 commits into from
Mar 27, 2024

Conversation

I065450
Copy link
Collaborator

@I065450 I065450 commented Mar 14, 2024

No description provided.

README.md Outdated Show resolved Hide resolved
README.md Outdated
@@ -286,31 +286,34 @@ SAP BTP service operator search for the credentials in the following order:

#### Service Binding

1. To get access credentials to your service instance and make it available in the cluster so that your applications can use it, create a `ServiceBinding` custom resource, and set the `serviceInstanceName` field to the name of the `ServiceInstance` resource you created.
To allow applications to access a service instance in your cluster, create a `ServiceBinding` custom resource. Set the `serviceInstanceName` field within the `ServiceBinding` to match the name of the `ServiceInstance` resource you previously created.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not access the service instance, but access/consume/communicate with the service (not instance).

the terminology of the previous version was better. it is actually 'get access credentials' to consume the service.

actually mentioning the term 'credentials' here is very important, as all the service binding chapter deals with credentials.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But is it a service in the cluster? Or an instance?
The rest was changed.

README.md Outdated

The credentials are stored in a secret created in your cluster.
This `ServiceBinding` is then exposed to users through a generated output: a `Secret` resource that contains securely-stored access credentials needed to connect to the `ServiceInstance`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the service binding is not exposed to users, but the credentials are exposed.

e.g., These access credentials are then available to consuming applications through a secret resource which is generated in your cluster.....

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@avilupu this was the official Kubernetes terminology. But I'll change.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated
name: sample-binding
spec:
serviceInstanceName: sample-instance
secretRootKey: your-secretRootKey-value
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use 'myBindingData'

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wouldn't this be myCredentialsAndInstanceData if already?? @avilupu

README.md Outdated Show resolved Hide resolved
README.md Outdated
spec:
serviceInstanceName: sample-instance
secretTemplate: your-Go-template
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what is "your-Go-template"?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@avilupu the applied Go template?
The used Go template?

README.md Outdated
password: {{ .credentials.client_secret }}
```
The sample-binding map on which your-Go-template operates is in the JSON format:

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure I understand...

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@avilupu I think we are still missing info here. Go template is applied to a data structure to generate an output. In this case, the generated output is the Secret format that we want. However, there is also a map. We need to explain more where this map comes from. @I065450

README.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@danielforsap danielforsap left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

3 issues still open.

README.md Outdated
@@ -286,31 +286,34 @@ SAP BTP service operator search for the credentials in the following order:

#### Service Binding

1. To get access credentials to your service instance and make it available in the cluster so that your applications can use it, create a `ServiceBinding` custom resource, and set the `serviceInstanceName` field to the name of the `ServiceInstance` resource you created.
To allow applications to access a service instance in your cluster, create a `ServiceBinding` custom resource. Set the `serviceInstanceName` field within the `ServiceBinding` to match the name of the `ServiceInstance` resource you previously created.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But is it a service in the cluster? Or an instance?
The rest was changed.

README.md Outdated

The credentials are stored in a secret created in your cluster.
This `ServiceBinding` is then exposed to users through a generated output: a `Secret` resource that contains securely-stored access credentials needed to connect to the `ServiceInstance`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@avilupu this was the official Kubernetes terminology. But I'll change.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@danielforsap danielforsap dismissed avilupu’s stale review March 19, 2024 21:50

Changes already implemented

@danielforsap danielforsap changed the title [SAPBTPCFS-3288] update readme [SAPBTPCFS-3288] CUSTOM TEMPLATES FOR SECRETS Mar 26, 2024
@danielforsap danielforsap merged commit b823ff8 into main Mar 27, 2024
6 checks passed
@danielforsap danielforsap deleted the secret_template_readme branch March 27, 2024 17:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants