Skip to content

Commit 5bb86c0

Browse files
authored
Merge pull request #42305 from adellape/revert_sbo
Revert "Merge pull request #41809 from Srivaralakshmi/RefactorGetting…
2 parents 4159fc0 + 48a604a commit 5bb86c0

21 files changed

+207
-199
lines changed

applications/connecting_applications_to_services/binding-workloads-using-sbo.adoc

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,27 +7,29 @@ include::modules/servicebinding-document-attributes.adoc[]
77

88
toc::[]
99

10-
[role="_abstract"]
1110
Application developers must bind a workload to one or more backing services by using a binding secret. This secret is generated for the purpose of storing information to be consumed by the workload.
1211

1312
As an example, consider that the service you want to connect to is already exposing the binding data. In this case, you would also need a workload to be used along with the `ServiceBinding` custom resource (CR). By using this `ServiceBinding` CR, the workload sends a binding request with the details of the services to bind with.
1413

1514
.Example of `ServiceBinding` CR
16-
[source,yaml]
1715
----
1816
apiVersion: binding.operators.coreos.com/v1alpha1
1917
kind: ServiceBinding
2018
metadata:
21-
name: spring-petclinic-pgcluster
22-
namespace: my-petclinic
19+
name: spring-petclinic-rest
20+
namespace: my-postgresql
2321
spec:
2422
services: <1>
2523
- group: postgres-operator.crunchydata.com
2624
version: v1beta1
2725
kind: PostgresCluster
2826
name: hippo
27+
- group: ""
28+
version: v1
29+
kind: Secret
30+
name: hippo-pguser-hippo
2931
application: <2>
30-
name: spring-petclinic
32+
name: spring-petclinic-rest
3133
group: apps
3234
version: v1
3335
resource: deployments

applications/connecting_applications_to_services/exposing-binding-data-from-a-service.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ include::modules/servicebinding-document-attributes.adoc[]
77

88
toc::[]
99

10-
[role="_abstract"]
1110
Application developers need access to backing services to build and connect workloads. Connecting workloads to backing services is always a challenge because each service provider requires a different way to access their secrets and consume them in a workload.
1211

1312
The {servicebinding-title} enables application developers to easily bind workloads together with operator-managed backing services, without any manual procedures to configure the binding connection. For the {servicebinding-title} to provide the binding data, as an Operator provider or user who creates backing services, you must expose the binding data to be automatically detected by the {servicebinding-title}. Then, the {servicebinding-title} automatically collects the binding data from the backing service and shares it with a workload to provide a consistent and predictable experience.

applications/connecting_applications_to_services/getting-started-with-service-binding.adoc

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ include::modules/servicebinding-document-attributes.adoc[]
77

88
toc::[]
99

10-
[role="_abstract"]
1110
{servicebinding-title} manages the data plane for workloads and backing services. This guide provides instructions with examples to help you create a database instance, deploy an application, and use {servicebinding-title} to create a binding connection between the application and the database service.
1211

1312
// Prerequisites for getting started with Service Binding Operator
@@ -16,13 +15,9 @@ toc::[]
1615

1716
* You have access to an {product-title} cluster using an account with `cluster-admin` permissions.
1817
* You have installed the `oc` CLI.
18+
* You have installed PostgreSQL `psql` CLI.
1919
* You have installed {servicebinding-title} from OperatorHub.
20-
* You have installed the Crunchy Postgres for Kubernetes Operator from OperatorHub using the *v5* Update channel. The installed Operator is available in an appropriate namespace, such as the `my-petclinic` namespace.
21-
+
22-
[NOTE]
23-
====
24-
You can create the namespace using the `oc create namespace my-petclinic` command.
25-
====
20+
* You have installed the Crunchy Postgres for Kubernetes Operator from OperatorHub using the *v5* Update channel. The installed Operator is available in an appropriate namespace, such as the `my-postgresql` namespace.
2621

2722
//Creating a PostgreSQL database instance
2823
include::modules/sbo-creating-a-postgresql-database-instance.adoc[leveloffset=+1]

applications/connecting_applications_to_services/installing-sbo.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ include::modules/servicebinding-document-attributes.adoc[]
77

88
toc::[]
99

10-
[role="_abstract"]
1110
This guide walks cluster administrators through the process of installing the {servicebinding-title} to an {product-title} cluster.
1211

1312
You can install {servicebinding-title} on {product-title} 4.7 and later.

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

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ include::modules/common-attributes.adoc[]
55
include::modules/servicebinding-document-attributes.adoc[]
66
:context: odc-connecting-an-application-to-a-service-using-the-developer-perspective
77

8-
[role="_abstract"]
98
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.
109

1110
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 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.
@@ -19,8 +18,8 @@ This procedure walks you through an example of creating a visual connection betw
1918

2019
.Prerequisites
2120

22-
* You have created and deployed a Spring PetClinic sample application using the *Developer* perspective.
23-
* You have created and deployed a Crunchy PostgreSQL database instance using the *Developer* perspective. This instance has the following four components: `hippo-backup`, `hippo-instance`, `hippo-repo-host`, and `hippo-pgbouncer`.
21+
* Ensure that you have created and deployed a Spring PetClinic sample application using the *Developer* perspective.
22+
* Ensure that you have created and deployed a Crunchy PostgreSQL database instance using the *Developer* perspective. This instance has the following three components: `hippo-backup`, `hippo-instance`, and `hippo-pgbouncer`.
2423

2524
.Procedure
2625

@@ -29,7 +28,7 @@ This procedure walks you through an example of creating a visual connection betw
2928
.Visual connector
3029
image::odc_connector.png[]
3130
. Click and drag the arrow towards the `hippo-pgbouncer` deployment to connect the Spring PetClinic sample application with it.
32-
. Click the `spring-petclinic` deployment to see the *Overview* panel. Under the *Details* tab, click the edit icon in the *Annotations* section to see the *Key = `app.openshift.io/connects-to`* and *Value = `[{"apiVersion":"apps/v1","kind":"Deployment","name":"hippo-pgbouncer"}]`* annotation added to the deployment.
31+
. Click on the `spring-petclinic-rest` deployment to see the *Overview* panel. Under the *Details* tab, click the edit icon in the *Annotations* section to see the *Key = `app.openshift.io/connects-to`* and *Value = `[{"apiVersion":"apps/v1","kind":"Deployment","name":"hippo-pgbouncer"}]`* annotation added to the deployment.
3332

3433
Similarly you can create other applications and components and establish visual connections between them.
3534

@@ -43,13 +42,13 @@ This procedure walks through an example of creating a binding connection between
4342
The PostreSQL Database Operator then creates and manages the `Database` resource, which exposes the binding information in secrets, config maps, status, and spec attributes.
4443

4544
.Prerequisites
46-
* You have created and deployed a Spring PetClinic sample application using the *Developer* perspective.
47-
* You have installed the {servicebinding-title} from the OperatorHub.
48-
* You have installed the *Crunchy Postgres for Kubernetes* Operator from the OperatorHub using `v5` *Update* channel.
49-
* You have created and deployed a Crunchy PostgreSQL database instance using the *Developer* perspective. This instance has the following four components: `hippo-backup`, `hippo-instance`, `hippo-repo-host`, and `hippo-pgbouncer`.
45+
* Ensure that you have created and deployed a Spring PetClinic sample application using the *Developer* perspective.
46+
* Ensure that you have installed the {servicebinding-title} from the OperatorHub.
47+
* Ensure that you have installed the *Crunchy Postgres for Kubernetes* Operator from the OperatorHub using `v5` *Update* channel.
48+
* Ensure that you have created and deployed a Crunchy PostgreSQL database instance using the *Developer* perspective. This instance has the following three components: `hippo-backup`, `hippo-instance`, and `hippo-pgbouncer`.
5049

5150
.Procedure
52-
. Switch to the *Developer* perspective and ensure that you are in the appropriate project, for example, `my-petclinic`. In the *Topology* view, hover over the Spring PetClinic sample application to see a dangling arrow on the node.
51+
. Switch to the *Developer* perspective and ensure that you are in the appropriate project, for example, `my-postgresql`. In the *Topology* view, hover over the Spring PetClinic sample application to see a dangling arrow on the node.
5352
. Click and drag the arrow towards the *hippo* database Postgres Cluster to make a binding connection with the Spring PetClinic sample application.
5453
+
5554
Alternatively, in the *+Add* view, click the *YAML* option to see the *Import YAML* screen. Use the YAML editor and add the `ServiceBinding` resource:
@@ -60,16 +59,16 @@ Alternatively, in the *+Add* view, click the *YAML* option to see the *Import YA
6059
apiVersion: binding.operators.coreos.com/v1alpha1
6160
kind: ServiceBinding
6261
metadata:
63-
name: spring-petclinic-pgcluster
64-
namespace: my-petclinic
62+
name: spring-petclinic-rest
63+
namespace: my-postgresql
6564
spec:
6665
services:
6766
- group: postgres-operator.crunchydata.com
6867
version: v1beta1
6968
kind: PostgresCluster
7069
name: hippo
7170
application:
72-
name: spring-petclinic
71+
name: spring-petclinic-rest
7372
group: apps
7473
version: v1
7574
resource: deployments

applications/connecting_applications_to_services/projecting-binding-data.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ include::modules/servicebinding-document-attributes.adoc[]
77

88
toc::[]
99

10-
[role="_abstract"]
1110
This section provides information on how you can consume the binding data.
1211

1312
== Consumption of binding data

applications/connecting_applications_to_services/understanding-service-binding-operator.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ include::modules/servicebinding-document-attributes.adoc[]
88
toc::[]
99

1010

11-
[role="_abstract"]
1211
Application developers need access to backing services to build and connect workloads. Connecting workloads to backing services is always a challenge because each service provider suggests a different way to access their secrets and consume them in a workload. In addition, manual configuration and maintenance of this binding together of workloads and backing services make the process tedious, inefficient, and error-prone.
1312

1413
The {servicebinding-title} enables application developers to easily bind workloads together with Operator-managed backing services, without any manual procedures to configure the binding connection.

images/odc-binding-connector.png

93.9 KB
Loading
94.6 KB
Loading

images/odc_connector.png

73.3 KB
Loading

0 commit comments

Comments
 (0)