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

shreyasiddhartha · 2023-02-09T10:10:41Z

Change type: Doc update; Topology support for Service Binding Label Selector Implementation
Doc JIRA: https://issues.redhat.com/browse/RHDEVDOCS-4826
Dev JIRA: https://issues.redhat.com/browse/ODC-7120
Fix Version: Openshift 4.13 Freeze

Doc Preview: https://55734--docspreview.netlify.app/openshift-enterprise/latest/applications/connecting_applications_to_services/odc-connecting-an-application-to-a-service-using-the-developer-perspective.html#odc-visualizing-the-binding-connections-to-resources_odc-connecting-an-application-to-a-service-using-the-developer-perspective

SME Review: @divyanshiGupta
QE Review: @sanketpathak
Peer Review: @Srivaralakshmi

ocpdocs-previewbot · 2023-02-09T10:18:25Z

🤖 Updated build preview is available at:
https://55734--docspreview.netlify.app

Build log: https://circleci.com/gh/ocpdocs-previewbot/openshift-docs/8965

sanketpathak · 2023-02-13T10:23:13Z

modules/odc-visualizing-the-binding-connections-to-resources.adoc

+To use *Label Selector* and to create one or more connections at once, you must import `ServiceBinding` resource yaml.
+====
+
+** After you click on the dangling arrow, the Service Binding connector *Details* side-panel appears. You can view the *Label Selector* associated with it here.


Will this be a dangling arrow as the connection is already established in the previous step? As seen in the doc dangling is used for the arrow appearing when the user hovers the mouse pointer on the application node i.e. before the connection is established

@sanketpathak I think this a drag and drop arrow. I'll make the correction.

invincibleJai · 2023-02-13T10:47:23Z

/cc @divyanshiGupta

divyanshiGupta · 2023-02-13T10:47:37Z

modules/odc-visualizing-the-binding-connections-to-resources.adoc

+[id="odc-visualizing-the-binding-connections-to-resources_{context}"]
+= Visualizing the binding connections to resources
+
+As a user, you can visualize a Service Binding through *Label Selector* in *Topology* view. Label selector is a feature added to Service Binding Operator that aims to simplify the process of binding applications to backing services. It does this by allowing developers to use specified labels to find and connect applications instead of using the name of the application. It aims to alleviate the confusing nature of one or many services to many application binds. This is done by specifying labels that will be consumed by the Service Binding Operator when creating `ServiceBinding` resources.


Suggested change

As a user, you can visualize a Service Binding through *Label Selector* in *Topology* view. Label selector is a feature added to Service Binding Operator that aims to simplify the process of binding applications to backing services. It does this by allowing developers to use specified labels to find and connect applications instead of using the name of the application. It aims to alleviate the confusing nature of one or many services to many application binds. This is done by specifying labels that will be consumed by the Service Binding Operator when creating `ServiceBinding` resources.

As a user, you can visualize a Service Binding through *Label Selector* in *Topology* view. Label selector is a feature added to Service Binding Operator that aims to simplify the process of binding applications to backing services. It does this by allowing developers to use specified labels to find and connect applications instead of using the name of the application. It aims to alleviate the confusing nature of one or many services to many application binds. This is done by specifying labels when creating `ServiceBinding` resources that will be consumed by the Service Binding Operator to find the applications to create a service binding with.

divyanshiGupta · 2023-02-13T10:49:51Z

modules/odc-visualizing-the-binding-connections-to-resources.adoc

+
+To view the *Label Selector*, consider the following approaches:
+
+** After you import yaml page, you can view the *Label Selector* associated with the Service Binding in the *ServiceBinding details* page.


Suggested change

** After you import yaml page, you can view the *Label Selector* associated with the Service Binding in the *ServiceBinding details* page.

** After you import a ServiceBinding resource, you can view the *Label Selector* associated with the Service Binding in the *ServiceBinding details* page.

Srivaralakshmi

@shreyasiddhartha PTAL at the suggestions. Thanks!

Srivaralakshmi · 2023-02-14T14:18:48Z

..._to_services/odc-connecting-an-application-to-a-service-using-the-developer-perspective.adoc

@@ -8,7 +8,7 @@ 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.
+In addition to grouping multiple components within an application, you can also use the *Topology* view to connect components with each other and to connect multiple resources to services with labels. You can either use a binding connector or a visual one to connect components.


Suggestion: Simplify this further for easy scanning of information. For example:

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 connector or a visual one to connect components.

Suggestion: Alternatively, you can also try this:

Use either a binding connector or a visual one in 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.

Note:

I am not clear what you mean by visual one. Ensure to check with the SMEs whether this is the appropriate term and use the correct one.

Check both my suggestions with the SMEs for technical accuracy. Pick the one that is more accurate. Thanks!

@divyanshiGupta WDYT?

I'm using the second suggestion provided by @Srivaralakshmi. Instead of using the "visual one", I'll use the term "visual connector" which is specified later in the document.

Srivaralakshmi · 2023-02-14T14:37:10Z

modules/odc-visualizing-the-binding-connections-to-resources.adoc

@@ -0,0 +1,41 @@
+// Module included in the following assemblies:
+//
+// * applications/connecting_applications_to_services/odc-connecting-an-application-to-a-service-using-the-developer-perspective.adoc


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

Srivaralakshmi · 2023-02-14T14:58:03Z

..._to_services/odc-connecting-an-application-to-a-service-using-the-developer-perspective.adoc

@@ -8,7 +8,7 @@ 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.
+In addition to grouping multiple components within an application, you can also use the *Topology* view to connect components with each other and to connect multiple resources to services with labels. 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.


Suggested change

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.

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.

Suggestion: Use the product title attributes. Global comment - check and fix all similar occurrences throughout this PR. Refer to point 4 here and info on Product title and Attribute files.

Srivaralakshmi · 2023-02-14T15:28:56Z

modules/odc-visualizing-the-binding-connections-to-resources.adoc

+[id="odc-visualizing-the-binding-connections-to-resources_{context}"]
+= Visualizing the binding connections to resources
+
+As a user, you can visualize a Service Binding through *Label Selector* in *Topology* view. Label selector is a feature added to Service Binding Operator that aims to simplify the process of binding applications to backing services. It does this by allowing developers to use specified labels to find and connect applications instead of using the name of the application. It aims to alleviate the confusing nature of one or many services to many application binds. This is done by specifying labels when creating  `ServiceBinding` resources that will be consumed by the Service Binding Operator to find the applications to create a Service Binding with.


Suggestion: Can we try this rewrite for simplicity? Consult my suggestion with SMEs and follow the one that is technically accurate, easy to scan, read, and understand.

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 {servicebinding-title} then consumes these ServiceBinding resources and specified labels to find the applications to create a service binding with.

Srivaralakshmi · 2023-02-14T15:35:23Z

modules/odc-visualizing-the-binding-connections-to-resources.adoc

+As a user, you can visualize a Service Binding through *Label Selector* in *Topology* view. Label selector is a feature added to Service Binding Operator that aims to simplify the process of binding applications to backing services. It does this by allowing developers to use specified labels to find and connect applications instead of using the name of the application. It aims to alleviate the confusing nature of one or many services to many application binds. This is done by specifying labels when creating  `ServiceBinding` resources that will be consumed by the Service Binding Operator to find the applications to create a Service Binding with.
+[TIP]
+====
+When you click on the label selector associated with the Service Binding, you can navigate to a list of all connected resources.


Suggested change

When you click on the label selector associated with the Service Binding, you can navigate to a list of all connected resources.

To navigate to a list of all connected resources, click the label selector associated with the service binding.

Also, refer to https://www.ibm.com/docs/en/ibm-style?topic=grammar-prepositions.

Question to the writer and SMEs: When you say "click the label selector that is associated with the service binding", do you mean ServiceBinding resource or just service binding? Please clarify.

IMO "ServiceBinding" resources would be a better approach for this labels are specified when creating ServiceBinding resources.

Srivaralakshmi · 2023-02-14T17:29:04Z

modules/odc-visualizing-the-binding-connections-to-resources.adoc

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


Suggested change

[NOTE]

+

[NOTE]

Srivaralakshmi · 2023-02-14T17:49:23Z

modules/odc-visualizing-the-binding-connections-to-resources.adoc

+
+[NOTE]
+====
+When you delete a single connection within *Topology* and delete the Service Binding, this will remove all connections that are tied to the deleted service binding. When you delete a Service Binding connector, the user should see a delete confirmation dialog which explains that all connectors will be deleted. This message will be different from deleting the initial implementation of `ServiceBinding` resource.


Suggested change

When you delete a single connection within *Topology* and delete the Service Binding, this will remove all connections that are tied to the deleted service binding. When you delete a Service Binding connector, the user should see a delete confirmation dialog which explains that all connectors will be deleted. This message will be different from deleting the initial implementation of `ServiceBinding` resource.

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.

Request: Review the suggestion write-up given here with the SMEs for technical accuracy and make adjustments as necessary.

Question to the SMEs and author: This sentence is unclear and ambiguous: "This message will be different from deleting the initial implementation of ServiceBinding resource."

Suggestion: Rewrite for clarity. How is it different? Explain and state the difference clearly.

Srivaralakshmi · 2023-02-14T17:54:05Z

modules/odc-visualizing-the-binding-connections-to-resources.adoc

+====
+When you delete a single connection within *Topology* and delete the Service Binding, this will remove all connections that are tied to the deleted service binding. When you delete a Service Binding connector, the user should see a delete confirmation dialog which explains that all connectors will be deleted. This message will be different from deleting the initial implementation of `ServiceBinding` resource.
+
+.Delete Service Binding


Suggested change

.Delete Service Binding

.Delete ServiceBinding confirmation dialog

Srivaralakshmi · 2023-02-14T17:56:35Z

modules/odc_customizing-a-developer-catalog-or-its-sub-catalogs-using-the-form-view.adoc

@@ -28,7 +28,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.


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

Srivaralakshmi · 2023-02-14T18:07:10Z

modules/odc_customizing-a-developer-catalog-or-its-sub-catalogs-using-the-form-view.adoc

@@ -28,7 +28,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.


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.

rolfedh · 2023-02-15T11:50:47Z

/cherry-pick enterprise-4.13

openshift-cherrypick-robot · 2023-02-15T11:52:12Z

@rolfedh: new pull request created: #55913

In response to this:

/cherry-pick enterprise-4.13

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

sanketpathak · 2023-02-15T13:38:40Z

LGTM

openshift-ci bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Feb 9, 2023

shreyasiddhartha changed the title ~~Spelling correction~~ RHDEVDOCS-4826-Topology support for Service Binding Label Selector Implementation Feb 9, 2023

sanketpathak reviewed Feb 13, 2023

View reviewed changes

openshift-ci bot requested a review from divyanshiGupta February 13, 2023 10:47

divyanshiGupta reviewed Feb 13, 2023

View reviewed changes

shreyasiddhartha force-pushed the RHDEVDOCS-4826 branch from 1df751f to 9eadde9 Compare February 14, 2023 10:59

Srivaralakshmi requested changes Feb 14, 2023

View reviewed changes

Changes for RHDEVDOCS-4826: after SME QE and peer Review

21345d5

shreyasiddhartha force-pushed the RHDEVDOCS-4826 branch from c884af4 to 21345d5 Compare February 15, 2023 11:30

rolfedh merged commit 07e5591 into openshift:main Feb 15, 2023

rolfedh added dev-tools Label for all Odo/Pipelines/Helm/Developer Console/Perspective PRs branch/enterprise-4.13 labels Feb 15, 2023

openshift-cherrypick-robot mentioned this pull request Feb 15, 2023

[enterprise-4.13] RHDEVDOCS-4826-Topology support for Service Binding Label Selector Implementation #55913

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

shreyasiddhartha commented Feb 9, 2023 •

edited

ocpdocs-previewbot commented Feb 9, 2023 •

edited

sanketpathak Feb 13, 2023 •

edited

shreyasiddhartha Feb 13, 2023

invincibleJai commented Feb 13, 2023

divyanshiGupta Feb 13, 2023 •

edited

divyanshiGupta Feb 13, 2023

Srivaralakshmi left a comment

Srivaralakshmi Feb 14, 2023

Srivaralakshmi Feb 14, 2023

shreyasiddhartha Feb 15, 2023

shreyasiddhartha Feb 15, 2023

Srivaralakshmi Feb 14, 2023

Srivaralakshmi Feb 14, 2023

Srivaralakshmi Feb 14, 2023

Srivaralakshmi Feb 14, 2023

shreyasiddhartha Feb 15, 2023

Srivaralakshmi Feb 14, 2023

Srivaralakshmi Feb 14, 2023

Srivaralakshmi Feb 14, 2023

Srivaralakshmi Feb 14, 2023

Srivaralakshmi Feb 14, 2023

rolfedh commented Feb 15, 2023

openshift-cherrypick-robot commented Feb 15, 2023

sanketpathak commented Feb 15, 2023


		To view the Label Selector, consider the following approaches:

		** After you import yaml page, you can view the Label Selector associated with the Service Binding in the ServiceBinding details page.

	** After you import yaml page, you can view the Label Selector associated with the Service Binding in the ServiceBinding details page.
	** After you import a ServiceBinding resource, you can view the Label Selector associated with the Service Binding in the ServiceBinding details page.

	When you click on the label selector associated with the Service Binding, you can navigate to a list of all connected resources.
	To navigate to a list of all connected resources, click the label selector associated with the service binding.

	.Delete Service Binding
	.Delete ServiceBinding confirmation dialog

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


		[NOTE]

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

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

Conversation

shreyasiddhartha commented Feb 9, 2023 • edited

ocpdocs-previewbot commented Feb 9, 2023 • edited

sanketpathak Feb 13, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

invincibleJai commented Feb 13, 2023

divyanshiGupta Feb 13, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Srivaralakshmi left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rolfedh commented Feb 15, 2023

openshift-cherrypick-robot commented Feb 15, 2023

sanketpathak commented Feb 15, 2023

shreyasiddhartha commented Feb 9, 2023 •

edited

ocpdocs-previewbot commented Feb 9, 2023 •

edited

sanketpathak Feb 13, 2023 •

edited

divyanshiGupta Feb 13, 2023 •

edited