Skip to content
This repository was archived by the owner on Nov 2, 2023. It is now read-only.

Commit 42d3686

Browse files
committed
New Release v1.2.0 for OCI Service Broker
- Added Support for Binding Existing Service Instance - CNP-228. - Documentation Changes Co-authored-by: Ashokkumar Kannan [email protected] Co-authored-by: Jayasheelan Kumar [email protected] Co-authored-by: Naman Mehta [email protected]
1 parent f994082 commit 42d3686

File tree

11 files changed

+123
-62
lines changed

11 files changed

+123
-62
lines changed

charts/oci-service-broker/README.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -16,20 +16,20 @@
1616
- [Recommended Setup Command](docs/installation.md#recommended-setup-command)
1717
- [RBAC](docs/installation.md#rbac)
1818
- [RBAC required for OCI Service Broker](docs/installation.md#rbac-required-for-oci-service-broker)
19-
- [RBAC Permissions for registering OCI Service Broker and creating services](docs/installation.md#rbac-permissions-for-registering-service-broker-and-creating-services)
19+
- [RBAC Permissions for registering OCI Service Broker](docs/installation.md#rbac-permissions-for-registering-oci-service-broker)
2020
- [Register OCI Service Broker](docs/installation.md#register-oci-service-broker)
2121
- [Monitoring OCI Service Broker](docs/installation.md#monitoring-oci-service-broker)
2222
- [JMX](docs/installation.md#jmx)
23-
- [Guidelines for Securing OCI Service Broker](docs/security.md#guidelines-for-securing-service-broker)
23+
- [Guidelines for Securing OCI Service Broker](docs/security.md#guidelines-for-securing-oci-service-broker)
2424
- [Restrict access to Service Catalog resources using RBAC](docs/security.md#restrict-access-to-service-catalog-resources-using-rbac)
2525
- [Read-only access](docs/security.md#read-only-access)
26-
- [Full acccess](docs/security.md#full-acccess)
26+
- [Full access](docs/security.md#full-acccess)
2727
- [TLS enable endpoint](docs/security.md#tls-enable-endpoint)
28-
- [Restrict access of the OCI User used by OCI Service Broker](docs/security.md#restrict-access-of-the-oci-user-used-by-service-broker)
28+
- [Restrict access of the OCI User used by OCI Service Broker](docs/security.md#restrict-access-of-the-oci-user-used-by-oci-service-broker)
2929
- [OCI User Capabilities](docs/security.md#oci-user-capabilities)
3030
- [Policies to allow access to Services](docs/security.md#policies-to-allow-access-to-services)
3131
- [Restrict the permissions only to the required Compartments](docs/security.md#restrict-the-permissions-only-to-the-required-compartments)
32-
- [Limit access to OCI Service Broker endpoint using Networkpolicy](docs/security.md#limit-access-to-service-broker-endpoint-using-networkpolicy)
32+
- [Limit access to OCI Service Broker endpoint using Networkpolicy](docs/security.md#limit-access-to-oci-service-broker-endpoint-using-networkpolicy)
3333
- [Strategy 1-Allow access only for Service Catalog running in the same namespace](docs/security.md#strategy-1-allow-access-only-for-service-catalog-running-in-the-same-namespace)
3434
- [Strategy 2-Allow access only for Service Catalog from any namespace](docs/security.md#strategy-2-allow-access-only-for-service-catalog-from-any-namespace)
3535
- [Strategy 3-Allow access for any pods running in a certain namespace](docs/security.md#strategy-3-allow-access-for-any-pods-running-in-a-certain-namespace)
@@ -42,39 +42,39 @@
4242
- [Plans](docs/object-storage.md#plans)
4343
- [OCI User Permission requirement](docs/object-storage.md#oci-user-permission-requirement)
4444
- [Service Provision Request Parameters](docs/object-storage.md#service-provision-request-parameters)
45-
- [Provisioning a new Service Instance](docs/object-storage.md#provisioning-a-new-service-instance)
46-
- [Attaching an Existing Service Instance](docs/object-storage.md#attaching-an-existing-service-instance)
45+
- [Provisioning a new Object Storage Service Instance](docs/object-storage.md#provisioning-a-new-object-storage-service-instance)
46+
- [Using Existing Object Storage Service Instance](docs/object-storage.md#using-an-existing-object-storage-service-instance)
4747
- [Service Binding](docs/object-storage.md#service-binding)
4848
- [Request Parameters](docs/object-storage.md#request-parameters)
4949
- [Response Credentials](docs/object-storage.md#response-credentials)
5050
- [Example](docs/object-storage.md#example)
5151
- [Kubernetes](docs/object-storage.md#kubernetes)
52-
- [Creating a New Instance](docs/object-storage.md#creating-a-new-instance)
53-
- [Attaching an Existing Instance](docs/object-storage.md#attaching-an-existing-instance)
52+
- [Creating a New Object Storage Instance](docs/object-storage.md#creating-a-new-object-storage-instance)
53+
- [Using Existing Object Storage Service Instance](docs/object-storage.md#using-an-existing-object-storage-instance)
5454
- [Binding](docs/object-storage.md#binding)
5555
- [Autonomous Transaction Processing Service](docs/atp.md#autonomous-transaction-processing-service)
5656
- [Introduction](docs/atp.md#introduction)
5757
- [Plans](docs/atp.md#plans)
5858
- [OCI User Permission requirement](docs/atp.md#oci-user-permission-requirement)
5959
- [Service Provision Request Parameters](docs/atp.md#service-provision-request-parameters)
6060
- [Provisioning a new ADW Service Instance](docs/atp.md#provisioning-a-new-atp-service-instance)
61-
- [Attaching an Existing ADW Service Instance](docs/atp.md#attaching-an-existing-atp-service-instance)
61+
- [Using Existing ADW Service Instance](docs/atp.md#using-an-existing-atp-service-instance)
6262
- [Service Binding Request Parameters](docs/atp.md#service-binding-request-parameters)
6363
- [Service Binding Response Credentials](docs/atp.md#service-binding-response-credentials)
6464
- [Examples](docs/atp.md#examples)
6565
- [Prerequisite](docs/atp.md#prerequisite)
6666
- [OCI Service Broker](docs/atp.md#oci-service-broker)
6767
- [Sample files](docs/atp.md#sample-files)
6868
- [Provisioning](docs/atp.md#provisioning)
69-
- [Creating an ATP ServiceInstance](docs/atp.m#creating-a-new-atp-serviceinstance)
70-
- [Attaching an Existing ATP ServiceInstance](docs/atp.m#attaching-an-existing-atp-serviceinstance)
69+
- [Creating an ATP Instance](docs/atp.md#creating-a-new-atp-instance)
70+
- [Using Existing ATP Instance](docs/atp.md#using-an-existing-atp-instance)
7171
- [Get instance status](docs/atp.md#get-instance-status)
7272
- [Binding](docs/atp.md#binding)
7373
- [Creating an ATP ServiceBinding resource](docs/atp.md#creating-an-atp-servicebinding-resource)
7474
- [Get Binding status](docs/atp.md#get-instance-status)
75-
- [Sample program to Connect to ATP](docs/atp.md#sample-program-to-connect-to-atp)
75+
- [Connecting to a provisioned ATP instance](docs/atp.md#connecting-to-a-provisioned-atp-instance)
7676
- [Create a Kubernetes Secret with passwords](docs/atp.md#create-a-kubernetes-secret-with-passwords)
77-
- [Deploy sample application](docs/atp.md#deploy-sample-application)
77+
- [Injecting credentials and configurations](docs/atp.md#injecting-credentials-and-configurations)
7878
- [Deprovision](docs/atp.md#deprovision)
7979
- [Delete Service Binding](docs/atp.md#delete-service-binding)
8080
- [Delete Service Instance](docs/atp.md#delete-service-instance)
@@ -85,23 +85,23 @@
8585
- [OCI User Permission requirement](docs/adw.md#oci-user-permission-requirement)
8686
- [Service Provision Request Parameters](docs/adw.md#service-provision-request-parameters)
8787
- [Provisioning a new ADW Service Instance](docs/adw.md#provisioning-a-new-adw-service-instance)
88-
- [Attaching an Existing ADW Service Instance](docs/adw.md#attaching-an-existing-adw-service-instance)
88+
- [Using Existing ADW Service Instance](docs/adw.md#using-an-existing-adw-service-instance)
8989
- [Service Binding Request Parameters](docs/adw.md#service-binding-request-parameters)
9090
- [Service Binding Response Credentials](docs/adw.md#service-binding-response-credentials)
9191
- [Examples](docs/adw.md#examples)
9292
- [Prerequisite](docs/adw.md#prerequisite)
9393
- [OCI Service Broker](docs/adw.md#oci-service-broker)
9494
- [Sample files](docs/adw.md#sample-files)
9595
- [Provisioning](docs/adw.md#provisioning)
96-
- [Creating a new ADW ServiceInstance](docs/adw.md#creating-a-new-adw-serviceinstance)
97-
- [Attaching an Existing ADW ServiceInstance](docs/adw.md#attaching-an-existing-adw-serviceinstance)
96+
- [Creating a new ADW Instance](docs/adw.md#creating-a-new-adw-instance)
97+
- [Using Existing ADW Instance](docs/adw.md#using-an-existing-adw-instance)
9898
- [Get instance status](docs/adw.md#get-instance-status)
9999
- [Binding](docs/adw.md#binding)
100100
- [Creating an ADW ServiceBinding resource](docs/adw.md#creating-an-adw-servicebinding-resource)
101101
- [Get Binding status](docs/adw.md#get-instance-status)
102-
- [Sample program to Connect to ADW](docs/adw.md#sample-program-to-connect-to-adw)
102+
- [Connecting to a provisioned ADW instance](docs/adw.md#connecting-to-a-provisioned-adw-instance)
103103
- [Create a Kubernetes Secret with passwords](docs/adw.md#create-a-kubernetes-secret-with-passwords)
104-
- [Deploy sample application](docs/adw.md#deploy-sample-application)
104+
- [Injecting credentials and configurations](docs/adw.md#injecting-credentials-and-configurations)
105105
- [Deprovision](docs/adw.md#deprovision)
106106
- [Delete Service Binding](docs/adw.md#delete-service-binding)
107107
- [Delete Service Instance](docs/adw.md#delete-service-instance)
@@ -110,15 +110,15 @@
110110
- [Introduction](docs/oss.md#introduction)
111111
- [Plans](docs/oss.md#plans)
112112
- [Service Provision Request Parameters](docs/oss.md#service-provision-request-parameters)
113-
- [Provisioning a new Service Instance](docs/oss.md#provisioning-a-new-service-instance)
114-
- [Attaching an Existing Service Instance](docs/oss.md#attaching-an-existing-service-instance)
113+
- [Creating a OSS Service Instance](docs/oss.md#creating-a-new-oss-instance)
114+
- [Using Existing OSS Service Instance](docs/oss.md#using-an-existing-oss-service-instance)
115115
- [Service Binding](docs/oss.md#service-binding)
116116
- [Request Parameters](docs/oss.md#request-parameters)
117117
- [Response Credentials](docs/oss.md#response-credentials)
118118
- [Example](docs/oss.md#example)
119119
- [Kubernetes](docs/oss.md#kubernetes)
120-
- [Creating a New Instance](docs/oss.md#creating-a-new-instance)
121-
- [Attaching an Existing Instance](docs/oss.md#attaching-an-existing-instance)
120+
- [Creating a New OSS Instance](docs/oss.md#creating-a-new-oss-instance)
121+
- [Using Existing OSS Service Instance](docs/oss.md#using-an-existing-oss-instance)
122122
- [Binding](docs/oss.md#binding)
123123

124124
## Introduction
@@ -129,5 +129,5 @@ The OCI Service Broker is an open source implementation of [Open service broker
129129
- Easy extension.
130130
- Provide OOTB implementations for common OCI services.
131131
- OCI Service Broker Installation.
132-
- [Attaching an Existing Service Instance](docs/services.md#attaching-an-existing-service-instance)
132+
- [Using an Existing Service Instance](docs/services.md#using-an-existing-service-instance)
133133

charts/oci-service-broker/docs/adw.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,16 @@
55
- [OCI User Permission requirement](#oci-user-permission-requirement)
66
- [Service Provision Request Parameters](#service-provision-request-parameters)
77
- [Provisioning a new ADW Service Instance](#provisioning-a-new-adw-service-instance)
8-
- [Attaching an Existing ADW Service Instance](#attaching-an-existing-adw-service-instance)
8+
- [Using an Existing ADW Service Instance](#using-an-existing-adw-service-instance)
99
- [Service Binding Request Parameters](#service-binding-request-parameters)
1010
- [Service Binding Response Credentials](#service-binding-response-credentials)
1111
- [Examples](#examples)
1212
- [Prerequisite](#prerequisite)
1313
- [OCI Service Broker](#oci-service-broker)
1414
- [Sample files](#sample-files)
1515
- [Provisioning](#provisioning)
16-
- [Creating a new ADW ServiceInstance](#creating-a-new-adw-serviceinstance)
17-
- [Attaching an Existing ADW ServiceInstance](#attaching-an-existing-adw-serviceinstance)
16+
- [Creating a new ADW Instance](#creating-a-new-adw-instance)
17+
- [Using an Existing ADW Instance](#using-an-existing-adw-instance)
1818
- [Get instance status](#get-instance-status)
1919
- [Binding](#binding)
2020
- [Creating an ADW ServiceBinding resource](#creating-an-adw-servicebinding-resource)
@@ -63,9 +63,9 @@ To provision, an ADW service user needs to provide the following details:
6363
| `freeFormTags` | free form tags that are to be used for tagging the ADW instance. | object | no |
6464
| `definedTags` | The defined tags that are to be used for tagging the ADW instance. | object | no |
6565

66-
## Attaching an Existing ADW Service Instance
66+
## Using an Existing ADW Service Instance
6767

68-
For more information about binding to an existing ADW service instance, see [Attaching an Existing Service Instance](services.md#attaching-an-existing-service-instance).
68+
For more information about binding to an existing ADW service instance, see [Using an Existing Service Instance](services.md#using-an-existing-service-instance).
6969

7070
To attach to an existing ADW service, the user needs to provide the following details. In this case, OCI Service broker will neither provision a new instance nor update/change the existing instance.
7171

@@ -143,7 +143,7 @@ Providing password in plain text may not be an idle case. Alternatively, the use
143143

144144
Please refer [Use Secret to pass passwords](#use-secret-to-pass-passwords) section for passing the password from secrets.
145145

146-
#### Creating a new ADW ServiceInstance
146+
#### Creating a new ADW Instance
147147

148148
**NOTE:**
149149
The [`adw-instance-plain.yaml`](../samples/adw/adw-instance-plain.yaml) files contain the compartment OCID in which the user wants to provision the ADW instance. The user needs to update it with their compartment OCID.
@@ -152,7 +152,7 @@ The [`adw-instance-plain.yaml`](../samples/adw/adw-instance-plain.yaml) files co
152152
kubectl create -f charts/oci-service-broker/samples/adw/adw-instance-plain.yaml
153153
```
154154

155-
#### Attaching an existing ADW ServiceInstance
155+
#### Using an existing ADW Instance
156156

157157
**NOTE:**
158158
The [`adw-existing-instance.yaml`](../samples/adw/adw-existing-instance.yaml) files contain the instance OCID and compartment OCID which the user wants to provision as existing ADW instance. The user needs to update it with their instance OCID and compartment OCID.

charts/oci-service-broker/docs/atp.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@
44
- [Plans](#plans)
55
- [OCI User Permission requirement](#oci-user-permission-requirement)
66
- [Service Provision Request Parameters](#service-provision-request-parameters)
7-
- [Provisioning a new ADW Service Instance](#provisioning-a-new-atp-service-instance)
8-
- [Attaching an Existing ADW Service Instance](#attaching-an-existing-atp-service-instance)
7+
- [Provisioning a new ATP Service Instance](#provisioning-a-new-atp-service-instance)
8+
- [Using an Existing ATP Service Instance](#using-an-existing-atp-service-instance)
99
- [Service Binding Request Parameters](#service-binding-request-parameters)
1010
- [Service Binding Response Credentials](#service-binding-response-credentials)
1111
- [Examples](#examples)
1212
- [Prerequisite](#prerequisite)
1313
- [OCI Service Broker](#oci-service-broker)
1414
- [Sample files](#sample-files)
1515
- [Provisioning](#provisioning)
16-
- [Creating an ATP ServiceInstance](#creating-a-new-atp-serviceinstance)
17-
- [Attaching an Existing ATP ServiceInstance](#attaching-an-existing-atp-serviceinstance)
16+
- [Creating an ATP Instance](#creating-a-new-atp-instance)
17+
- [Using an Existing ATP Instance](#using-an-existing-atp-instance)
1818
- [Get instance status](#get-instance-status)
1919
- [Binding](#binding)
2020
- [Creating an ATP ServiceBinding resource](#creating-an-atp-servicebinding-resource)
@@ -63,9 +63,9 @@ To provision, an ATP service user needs to provide the following details:
6363
| `freeFormTags` | free form tags that are to be used for tagging the ATP instance. | object | no |
6464
| `definedTags` | The defined tags that are to be used for tagging the ATP instance. | object | no |
6565

66-
## Attaching an Existing ATP Service Instance
66+
## Using an Existing ATP Service Instance
6767

68-
For more information about binding to an existing ATP service instance, see [Attaching an Existing Service Instance](services.md#attaching-an-existing-service-instance).
68+
For more information about binding to an existing ATP service instance, see [Using an Existing Service Instance](services.md#using-an-existing-service-instance).
6969

7070
To attach to an existing ATP service, the user needs to provide the following details. In this case, OCI Service broker will neither provision a new instance nor update/change the existing instance.
7171

@@ -142,7 +142,7 @@ Providing password in plain text may not be an idle case. Alternatively, the use
142142

143143
Please refer [Use Secret to pass passwords](#use-secret-to-pass-passwords) section for passing the password from secrets.
144144

145-
#### Creating a New ATP ServiceInstance
145+
#### Creating a New ATP Instance
146146

147147
**NOTE:**
148148
The [`atp-instance-plain.yaml`](../samples/atp/atp-instance-plain.yaml) files contain the compartment OCID in which the user wants to provision the ATP instance. The user needs to update it with their compartment OCID.
@@ -151,7 +151,7 @@ The [`atp-instance-plain.yaml`](../samples/atp/atp-instance-plain.yaml) files c
151151
kubectl create -f charts/oci-service-broker/samples/atp/atp-instance-plain.yaml
152152
```
153153

154-
#### Attaching an existing ATP ServiceInstance
154+
#### Using an existing ATP Instance
155155

156156
**NOTE:**
157157
The [`atp-existing-instance.yaml`](../samples/atp/atp-existing-instance.yaml) files contain the instance OCID and compartment OCID which the user wants to provision as existing ATP instance. The user needs to update it with their instance OCID and compartment OCID.

charts/oci-service-broker/docs/object-storage.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,15 @@
44
- [Plans](#plans)
55
- [OCI User Permission requirement](#oci-user-permission-requirement)
66
- [Service Provision Request Parameters](#service-provision-request-parameters)
7-
- [Provisioning a new Service Instance](#provisioning-a-new-service-instance)
8-
- [Attaching an Existing Service Instance](#attaching-an-existing-service-instance)
9-
- [Service Provision Request Parameters for Existing Instance](#service-provision-request-parameters-for-existing-service-instance)
7+
- [Provisioning a new Object Storage Service Instance](#provisioning-a-new-object-storage-service-instance)
8+
- [Using an Existing Object Storage Service Instance](#using-an-existing-object-storage-instance)
109
- [Service Binding](#service-binding)
1110
- [Request Parameters](#request-parameters)
1211
- [Response Credentials](#response-credentials)
1312
- [Example](#example)
1413
- [Kubernetes](#kubernetes)
15-
- [Creating a New Instance](#creating-a-new-instance)
16-
- [Attaching an Existing Instance](#attaching-an-existing-instance)
14+
- [Creating a New Object Storage Instance](#creating-a-new-object-storage-instance)
15+
- [Using an Existing Object Storage Instance](#using-an-existing-object-storage-instance)
1716
- [Binding](#binding)
1817

1918
## Introduction
@@ -41,7 +40,7 @@ Allow group <SERVICE_BROKER_GROUP> to manage buckets in compartment <COMPARTMENT
4140

4241
### Service Provision Request Parameters
4342

44-
## Provisioning a new Service Instance
43+
## Provisioning a new Object Storage Service Instance
4544

4645
The request parameters for Service provisioning are:
4746

@@ -55,9 +54,9 @@ The request parameters for Service provisioning are:
5554
| metadata | The metadata of the bucket | object | No |
5655
| publicAccessType | The public access type of the bucket. Valid values are NoPublicAccess, ObjectRead and ObjectReadWithoutList. Default is NoPublicAccess | string | No |
5756

58-
## Attaching an Existing Service Instance
57+
## Using an Existing Object Storage Service Instance
5958

60-
For more information about binding to an existing Object Storage service instance, see [Attaching an Existing Service Instance](services.md#attaching-an-existing-service-instance).
59+
For more information about binding to an existing Object Storage service instance, see [Using an Existing Service Instance](services.md#using-an-existing-service-instance).
6160

6261
The request parameters for the existing Service provisioning are:
6362

@@ -90,7 +89,7 @@ Service Binding is optional in case of this service. OCI User credentials can be
9089

9190
### Kubernetes
9291

93-
#### Creating a New Instance
92+
#### Creating a New Object Storage Instance
9493

9594
Create a bucket
9695

@@ -146,7 +145,7 @@ spec:
146145
publicAccessType: "ObjectRead"
147146
```
148147
149-
#### Attaching an Existing Instance
148+
#### Using an Existing Object Storage Instance
150149
151150
Provision Existing bucket
152151

0 commit comments

Comments
 (0)