Skip to content

Commit 37867fa

Browse files
SBO 1.0.1 Release updates
1 parent ac487b6 commit 37867fa

23 files changed

+312
-236
lines changed

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

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

88
toc::[]
99

10+
[role="_abstract"]
1011
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.
1112

1213
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.
1314

1415
.Example of `ServiceBinding` CR
16+
[source,yaml]
1517
----
1618
apiVersion: binding.operators.coreos.com/v1alpha1
1719
kind: ServiceBinding
1820
metadata:
19-
name: spring-petclinic-rest
20-
namespace: my-postgresql
21+
name: spring-petclinic-pgcluster
22+
namespace: my-petclinic
2123
spec:
2224
services: <1>
2325
- group: postgres-operator.crunchydata.com
2426
version: v1beta1
2527
kind: PostgresCluster
2628
name: hippo
27-
- group: ""
28-
version: v1
29-
kind: Secret
30-
name: hippo-pguser-hippo
3129
application: <2>
32-
name: spring-petclinic-rest
30+
name: spring-petclinic
3331
group: apps
3432
version: v1
3533
resource: deployments
@@ -44,7 +42,6 @@ include::modules/sbo-advanced-binding-options.adoc[leveloffset=+1]
4442
include::modules/sbo-binding-workloads-that-are-not-compliant-with-PodSpec.adoc[leveloffset=+1]
4543
include::modules/sbo-unbinding-workloads-from-a-backing-service.adoc[leveloffset=+1]
4644

47-
[role="_additional-resources"]
4845
== Additional resources
4946
* xref:../../applications/connecting_applications_to_services/understanding-service-binding-operator.adoc#binding-a-workload-together-with-a-backing-service[Binding a workload together with a backing service].
50-
* xref:../../applications/connecting_applications_to_services/getting-started-with-service-binding.adoc#connecting-the-spring-petclinic-sample-application-to-the-postgresql-database-service[Connecting the Spring PetClinic sample application to the PostgreSQL database service].
47+
* xref:../../applications/connecting_applications_to_services/getting-started-with-service-binding.adoc#connecting-the-spring-petclinic-sample-application-to-the-postgresql-database-service[Connecting the Spring PetClinic sample application to the PostgreSQL database service].

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

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

88
toc::[]
99

10+
[role="_abstract"]
1011
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.
1112

1213
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.
@@ -16,8 +17,7 @@ include::modules/sbo-data-model.adoc[leveloffset=+1]
1617
include::modules/sbo-rbac-requirements.adoc[leveloffset=+1]
1718
include::modules/sbo-categories-of-exposable-binding-data.adoc[leveloffset=+1]
1819

19-
[role="_additional-resources"]
2020
== Additional resources
2121
* link:https://github.com/openshift/console/blob/master/frontend/packages/operator-lifecycle-manager/src/components/descriptors/reference/reference.md[OLM Descriptor Reference].
2222
* xref:../../operators/operator_sdk/osdk-generating-csvs.adoc#osdk-generating-csvs[Defining cluster service versions (CSVs)].
23-
* xref:../../applications/connecting_applications_to_services/projecting-binding-data.adoc#projecting-binding-data[Projecting binding data].
23+
* xref:../../applications/connecting_applications_to_services/projecting-binding-data.adoc#projecting-binding-data[Projecting binding data].

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

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

88
toc::[]
99

10-
{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.
10+
[role="_abstract"]
11+
The {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 the {servicebinding-title} to create a binding connection between the application and the database service.
1112

1213
// Prerequisites for getting started with Service Binding Operator
1314
[discrete]
1415
== Prerequisites
1516

1617
* You have access to an {product-title} cluster using an account with `cluster-admin` permissions.
1718
* 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-postgresql` namespace.
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+
====
2126

2227
//Creating a PostgreSQL database instance
2328
include::modules/sbo-creating-a-postgresql-database-instance.adoc[leveloffset=+1]
@@ -28,9 +33,8 @@ include::modules/sbo-deploying-the-spring-petclinic-sample-application.adoc[leve
2833
//Connecting the Spring PetClinic sample application to the PostgreSQL database service
2934
include::modules/sbo-connecting-spring-petclinic-sample-app-to-postgresql-database-service.adoc[leveloffset=+1]
3035

31-
[role="_additional-resources"]
32-
== Additional resources
36+
== Additional Resources
3337
* xref:../../applications/connecting_applications_to_services/installing-sbo.adoc#installing-sbo[Installing Service Binding Operator].
3438
* xref:../../applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc#odc-creating-applications-using-developer-perspective[Creating applications using the Developer perspective].
3539
* xref:../../operators/understanding/crds/crd-managing-resources-from-crds.adoc[Managing resources from custom resource definitions].
36-
* link:https://github.com/redhat-developer/service-binding-operator#known-bindable-operators[Known bindable Operators].
40+
* link:https://github.com/redhat-developer/service-binding-operator#known-bindable-operators[Known bindable Operators].

applications/connecting_applications_to_services/installing-sbo.adoc

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

88
toc::[]
99

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

1213
You can install {servicebinding-title} on {product-title} 4.7 and later.
@@ -23,6 +24,5 @@ You can install {servicebinding-title} on {product-title} 4.7 and later.
2324
include::modules/op-installing-sbo-operator-using-the-web-console.adoc[leveloffset=+1]
2425

2526

26-
[role="_additional-resources"]
27-
== Additional resources
28-
* xref:../../applications/connecting_applications_to_services/getting-started-with-service-binding.adoc#getting-started-with-service-binding[Getting started with service binding].
27+
== Additional Resources
28+
* xref:../../applications/connecting_applications_to_services/getting-started-with-service-binding.adoc#getting-started-with-service-binding[Getting started with service binding].

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

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ 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"]
89
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.
910

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

1920
.Prerequisites
2021

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`.
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`.
2324

2425
.Procedure
2526

@@ -28,7 +29,7 @@ This procedure walks you through an example of creating a visual connection betw
2829
.Visual connector
2930
image::odc_connector.png[]
3031
. Click and drag the arrow towards the `hippo-pgbouncer` deployment to connect the Spring PetClinic sample application with it.
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.
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.
3233

3334
Similarly you can create other applications and components and establish visual connections between them.
3435

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

4445
.Prerequisites
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`.
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`.
4950

5051
.Procedure
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.
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.
5253
. Click and drag the arrow towards the *hippo* database Postgres Cluster to make a binding connection with the Spring PetClinic sample application.
5354
+
5455
Alternatively, in the *+Add* view, click the *YAML* option to see the *Import YAML* screen. Use the YAML editor and add the `ServiceBinding` resource:
@@ -59,16 +60,16 @@ Alternatively, in the *+Add* view, click the *YAML* option to see the *Import YA
5960
apiVersion: binding.operators.coreos.com/v1alpha1
6061
kind: ServiceBinding
6162
metadata:
62-
name: spring-petclinic-rest
63-
namespace: my-postgresql
63+
name: spring-petclinic-pgcluster
64+
namespace: my-petclinic
6465
spec:
6566
services:
6667
- group: postgres-operator.crunchydata.com
6768
version: v1beta1
6869
kind: PostgresCluster
6970
name: hippo
7071
application:
71-
name: spring-petclinic-rest
72+
name: spring-petclinic
7273
group: apps
7374
version: v1
7475
resource: deployments
@@ -87,7 +88,6 @@ You can also use the context menu by dragging the dangling arrow to add and crea
8788
image::odc_context_operator.png[]
8889
====
8990

90-
[role="_additional-resources"]
9191
== Additional resources
9292
* xref:../../applications/connecting_applications_to_services/getting-started-with-service-binding.adoc#getting-started-with-service-binding[Getting started with service binding].
93-
* link:https://github.com/redhat-developer/service-binding-operator#known-bindable-operators[Known bindable Operators].
93+
* link:https://github.com/redhat-developer/service-binding-operator#known-bindable-operators[Known bindable Operators].

applications/connecting_applications_to_services/projecting-binding-data.adoc

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

88
toc::[]
99

10+
[role="_abstract"]
1011
This section provides information on how you can consume the binding data.
1112

1213
== Consumption of binding data
@@ -18,7 +19,6 @@ After the backing service exposes the binding data, for a workload to access and
1819
include::modules/sbo-configuration-of-directory-path-to-project-binding-data.adoc[leveloffset=+1]
1920
include::modules/sbo-projecting-the-binding-data.adoc[leveloffset=+1]
2021

21-
[role="_additional-resources"]
2222
== Additional resources
2323
* xref:../../applications/connecting_applications_to_services/exposing-binding-data-from-a-service.adoc#exposing-binding-data-from-a-service[Exposing binding data from a service].
24-
* link:https://redhat-developer.github.io/service-binding-operator/userguide/using-projected-bindings/using-projected-bindings.html[Using the projected binding data in the source code of the application].
24+
* link:https://redhat-developer.github.io/service-binding-operator/userguide/using-projected-bindings/using-projected-bindings.html[Using the projected binding data in the source code of the application].

applications/connecting_applications_to_services/sbo-release-notes.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
//OpenShift Service Binding Release Notes
22
:_content-type: ASSEMBLY
33
[id="servicebinding-release-notes"]
4-
= {servicebinding-title} release notes
4+
= Release notes for {servicebinding-title}
55
:context: servicebinding-release-notes
66
include::modules/common-attributes.adoc[]
77
include::modules/servicebinding-document-attributes.adoc[]
@@ -24,7 +24,9 @@ With {servicebinding-title}, you can:
2424
Red Hat is committed to replacing problematic language in our code, documentation, and web properties. We are beginning with these four terms: master, slave, blacklist, and whitelist. Because of the enormity of this endeavor, these changes will be implemented gradually over several upcoming releases. For more details, see link:https://www.redhat.com/en/blog/making-open-source-more-inclusive-eradicating-problematic-language[Red Hat CTO Chris Wright's message].
2525

2626
// Modules included, most to least recent
27+
include::modules/sbo-release-notes-1-0-1.adoc[leveloffset=+1]
2728
include::modules/sbo-release-notes-1-0.adoc[leveloffset=+1]
2829

30+
2931
== Additional resources
30-
* xref:../../applications/connecting_applications_to_services/understanding-service-binding-operator.adoc#understanding-service-binding-operator[Understanding Service Binding Operator].
32+
* xref:../../applications/connecting_applications_to_services/understanding-service-binding-operator.adoc#understanding-service-binding-operator[Understanding Service Binding Operator].

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

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

1010

11+
[role="_abstract"]
1112
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.
1213

1314
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.
@@ -78,6 +79,5 @@ With {servicebinding-title}, you can:
7879
** Support for role-based access control (RBAC).
7980

8081

81-
[role="_additional-resources"]
8282
== Additional resources
83-
* xref:../../applications/connecting_applications_to_services/getting-started-with-service-binding.adoc#getting-started-with-service-binding[Getting started with service binding].
83+
* xref:../../applications/connecting_applications_to_services/getting-started-with-service-binding.adoc#getting-started-with-service-binding[Getting started with service binding].

images/odc-binding-connector.png

-93.9 KB
Loading
-94.6 KB
Loading

0 commit comments

Comments
 (0)