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

RHDEVDOCS-4826-Topology support for Service Binding Label Selector Implementation #55734

Merged
merged 1 commit into from
Feb 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,27 @@ include::_attributes/servicebinding-document-attributes.adoc[]
toc::[]

[role="_abstract"]
In addition to grouping multiple components within an application, you can also use the *Topology* view to connect components with each other. You can either use a binding connector or a visual one to connect components.

A binding connection between the components can be established only if the target node is an Operator-backed service. This is indicated by the *Create a binding connector* tool-tip which appears when you drag an arrow to such a target node. When an application is connected to a service by using a binding connector a `ServiceBinding` resource is created. Then, the Service Binding Operator controller projects the necessary binding data into the application deployment. After the request is successful, the application is redeployed establishing an interaction between the connected components.
Use the *Topology* view for the following purposes:

** Group multiple components within an application.

** Connect components with each other.

** Connect multiple resources to services with labels.

You can either use a binding or a visual connector to connect components.


A binding connection between the components can be established only if the target node is an Operator-backed service. This is indicated by the *Create a binding connector* tool-tip which appears when you drag an arrow to such a target node. When an application is connected to a service by using a binding connector a `ServiceBinding` resource is created. Then, the {servicebinding-title} controller projects the necessary binding data into the application deployment. After the request is successful, the application is redeployed establishing an interaction between the connected components.

A visual connector establishes only a visual connection between the components, depicting an intent to connect. No interaction between the components is established. If the target node is not an Operator-backed service the *Create a visual connector* tool-tip is displayed when you drag an arrow to a target node.

include::modules/odc-discovering-and-identifying-operator-backed-bindable-services.adoc[leveloffset=+1]
include::modules/odc-creating-a-visual-connection-between-components.adoc[leveloffset=+1]
include::modules/odc-creating-a-binding-connection-between-components.adoc[leveloffset=+1]
include::modules/odc-verifying-the-status-of-your-service-binding-from-the-topology-view.adoc[leveloffset=+1]
include::modules/odc-visualizing-the-binding-connections-to-resources.adoc[leveloffset=+1]

[role="_additional-resources"]
[id="additional-resources-odc-connecting-an-application-to-a-service-using-the-developer-perspective"]
Expand Down
Binary file added images/odc-delete-service-binding.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/odc-label-selector-sb-details.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
44 changes: 44 additions & 0 deletions modules/odc-visualizing-the-binding-connections-to-resources.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
// Module included in the following assemblies:
//
// * applications/connecting_applications_to_services/odc-connecting-an-application-to-a-service-using-the-developer-perspective.adoc
Copy link
Member

Choose a reason for hiding this comment

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

Suggestion: Insert a blank line after L3. Refer to the guideline and examples given here.


:_content-type: PROCEDURE
[id="odc-visualizing-the-binding-connections-to-resources_{context}"]
= Visualizing the binding connections to resources

As a user, use *Label Selector* in the *Topology* view to visualize a service binding and simplify the process of binding applications to backing services. When creating `ServiceBinding` resources, specify labels by using *Label Selector* to find and connect applications instead of using the name of the application. The Service Binding Operator then consumes these `ServiceBinding` resources and specified labels to find the applications to create a service binding with.


[TIP]
====
To navigate to a list of all connected resources, click the label selector associated with the `ServiceBinding` resource.
====

To view the *Label Selector*, consider the following approaches:

** After you import a `ServiceBinding` resource, view the *Label Selector* associated with the service binding on the *ServiceBinding details* page.

+
.ServiceBinding details page
image::odc-label-selector-sb-details.png[]

[NOTE]
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
[NOTE]
+
[NOTE]

Suggestion: The note is specific to the previous bullet point. Hence must indent the Note to the right. Apply this comment to all similar occurrences in this file.

====
To use *Label Selector* and to create one or more connections at once, you must import the YAML file of the `ServiceBinding` resource.
====

** After the connection is established and when you click the binding connector, the service binding connector *Details* side panel appears. You can view the *Label Selector* associated with the service binding on this panel.

+
.Topology label selector side panel
image::odc-label-selector-topology-side-panel.png[]

+
[NOTE]
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
[NOTE]
+
[NOTE]

====
When you delete a binding connector (a single connection within *Topology* along with a service binding), the action removes all connections that are tied to the deleted service binding. While deleting a binding connector, a confirmation dialog appears, which informs that all connectors will be deleted.

.Delete ServiceBinding confirmation dialog
image::odc-delete-service-binding.png[]

====
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
// * web_console/customizing-the-web-console.adoc

:_content-type: PROCEDURE

[id="odc_customizing-a-developer-catalog-or-its-sub-catalogs-using-the-form-view_{context}"]
= Customizing a developer catalog or its sub-catalogs using the form view

Expand All @@ -28,7 +27,7 @@ image::odc_customizing_developer_catalog.png[]

[NOTE]
====
As an administrator, you can define the navigation items that appeaer by default for all users. You can also reorder the navigation items.
As an administrator, you can define the navigation items that appear by default for all users. You can also reorder the navigation items.
Copy link
Member

Choose a reason for hiding this comment

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

Suggestion for L6: Delete L6. Refer to the guideline and example here.

Copy link
Member

Choose a reason for hiding this comment

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

Suggestion: Use admonitions sparingly so that they do not lose their effectiveness. Refer to this guideline here.

  • Move the Note section up, so that it appears immediately after the step 4 instruction and just before the Verification section.

====

[TIP]
Expand Down