Skip to content

Update the Service Catalog documentation to include namespaced resources #1102

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

Merged
merged 12 commits into from
Oct 5, 2018

Conversation

kazydek
Copy link

@kazydek kazydek commented Oct 3, 2018

Description

Changes proposed in this pull request:

  • Updated the Service Catalog documentation and the architecture diagram to include information on the newly-introduced namespaced resources.

Related issue(s)
Relates to #298

@crabtree crabtree added the area/documentation Issues or PRs related to documentation label Oct 4, 2018
@kazydek kazydek requested review from pkosiec and hudymi October 4, 2018 09:15
@kazydek kazydek added the area/service-management Issues or PRs related to service management label Oct 4, 2018
Copy link
Contributor

@pkosiec pkosiec left a comment

Choose a reason for hiding this comment

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

Please remove examples of (Cluster)ServiceBroker in the diagram. Everything else is fine 👍

@kazydek
Copy link
Author

kazydek commented Oct 4, 2018

Removed examples of (Cluster)ServiceBroker from the diagram ;)


* **ServiceInstance** is a provisioned instance of a ClusterServiceClass to use in one or more cluster applications.

* **ServiceBinding** is a link between a ServiceInstance and an application that cluster users create to obtain access credentials for their applications.
Copy link

Choose a reason for hiding this comment

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

not really or I just misunderstood, ServiceBinding requests credentials or configuration for a given instance and results in Secret creation


* **ServiceInstance** is a provisioned instance of a ClusterServiceClass to use in one or more cluster applications.

* **ServiceBinding** is a link between a ServiceInstance and an application that cluster users create to obtain access credentials for their applications.

* **Secret** is a basic resource to transfer logins and passwords to the Deployment. The service binding process leads to the creation of a Secret.
Copy link

Choose a reason for hiding this comment

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

I would say credentials/configuration because in many cases it is not login and password
transfer also sounds strange, it simply contains credentials that can be later used in your application to consume instance
Deployment narrows the possibilities, it is not necessary Deployment only

Copy link
Author

@kazydek kazydek Oct 5, 2018

Choose a reason for hiding this comment

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

I changed it. I also updated 012-details-provisioning-and-binding.md as it stated Deployment or Function instead of application.

* **Secret** is a basic resource to transfer logins and passwords to the Deployment. The service binding process leads to the creation of a Secret.

* **ServiceBindingUsage** is a Kyma custom resource that allows the ServiceBindingUsage controller to inject Secrets into a given application.

* **UsageKind** is a Kyma custom resource that allows you to bind a ServiceInstance to any resource.
Copy link

Choose a reason for hiding this comment

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

it actually allows you to specify what kind of resource is bindable to the instance through the SBU

Copy link
Author

Choose a reason for hiding this comment

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

Ok


![Service Catalog flow](assets/service-catalog-flow.png)
![Service Catalog flow](assets/service-catalog-flow.svg)
Copy link

Choose a reason for hiding this comment

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

Service Catalog frame should be more visible, more exposed and cover only service classes, brokers also should be excluded


3. The user gets a list of the available services in the Kyma web console or CLI.
3. In the Console UI or CLI, the Kyma user lists all exposed cluster-wide and Environment-specific services and requests to create their instances in the Environment (ServiceInstances).
Copy link

Choose a reason for hiding this comment

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

their instances in the Environment (ServiceInstances) ?

Copy link
Author

@kazydek kazydek Oct 5, 2018

Choose a reason for hiding this comment

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

What's unclear about that sentence? Is requests to create instances of those services in the Environment. better?

@lszymik lszymik added this to the Backlog_Wookiee milestone Oct 5, 2018

1. During the Kyma installation, the system registers the default Service Brokers in the Kyma cluster. The cluster administrator can manually register other Service Brokers in the Kyma cluster.
1. The Kyma installation results in the registration of the default Service Brokers in the Kyma cluster. The Kyma administrator can manually register other ClusterServiceBrokers in the Kyma cluster. The Kyma user can also register a Service Broker (ServiceBroker) in a given Environment.
Copy link
Contributor

Choose a reason for hiding this comment

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

"The Kyma user can also register a Service Broker (ServiceBroker) in a given Environment." -> Is there any need to double Service Broker here?

Copy link
Author

Choose a reason for hiding this comment

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

Ok, I will remove it.

@kazydek kazydek merged commit cf6eb34 into kyma-project:master Oct 5, 2018
@kazydek kazydek deleted the issue-298 branch October 5, 2018 13:06
grischperl pushed a commit to grischperl/kyma that referenced this pull request Nov 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Issues or PRs related to documentation area/service-management Issues or PRs related to service management
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants