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

Commit cef3d2c

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 ashokkumar.kannan@oracle.com Co-authored-by: Jayasheelan Kumar jayasheelan.kumar@oracle.com Co-authored-by: Naman Mehta naman.mehta@oracle.com
1 parent 12c76cd commit cef3d2c

File tree

20 files changed

+444
-150
lines changed

20 files changed

+444
-150
lines changed

charts/oci-service-broker/Chart.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@
55
apiVersion: v1
66
description: A Helm chart for installing OCI Service Broker into a Kubernetes cluster
77
name: oci-service-broker
8-
version: 1.1.1
8+
version: 1.2.0

charts/oci-service-broker/README.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,26 +42,32 @@
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)
4547
- [Service Binding](docs/object-storage.md#service-binding)
4648
- [Request Parameters](docs/object-storage.md#request-parameters)
4749
- [Response Credentials](docs/object-storage.md#response-credentials)
4850
- [Example](docs/object-storage.md#example)
4951
- [Kubernetes](docs/object-storage.md#kubernetes)
50-
- [Provisioning](docs/object-storage.md#provisioning)
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)
5154
- [Binding](docs/object-storage.md#binding)
5255
- [Autonomous Transaction Processing Service](docs/atp.md#autonomous-transaction-processing-service)
5356
- [Introduction](docs/atp.md#introduction)
5457
- [Plans](docs/atp.md#plans)
5558
- [OCI User Permission requirement](docs/atp.md#oci-user-permission-requirement)
5659
- [Service Provision Request Parameters](docs/atp.md#service-provision-request-parameters)
60+
- [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)
5762
- [Service Binding Request Parameters](docs/atp.md#service-binding-request-parameters)
5863
- [Service Binding Response Credentials](docs/atp.md#service-binding-response-credentials)
5964
- [Examples](docs/atp.md#examples)
6065
- [Prerequisite](docs/atp.md#prerequisite)
6166
- [OCI Service Broker](docs/atp.md#oci-service-broker)
6267
- [Sample files](docs/atp.md#sample-files)
6368
- [Provisioning](docs/atp.md#provisioning)
64-
- [Creating an ATP ServiceInstance](docs/atp.md#creating-an-atp-serviceinstance)
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)
6571
- [Get instance status](docs/atp.md#get-instance-status)
6672
- [Binding](docs/atp.md#binding)
6773
- [Creating an ATP ServiceBinding resource](docs/atp.md#creating-an-atp-servicebinding-resource)
@@ -78,14 +84,17 @@
7884
- [Plans](docs/adw.md#plans)
7985
- [OCI User Permission requirement](docs/adw.md#oci-user-permission-requirement)
8086
- [Service Provision Request Parameters](docs/adw.md#service-provision-request-parameters)
87+
- [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)
8189
- [Service Binding Request Parameters](docs/adw.md#service-binding-request-parameters)
8290
- [Service Binding Response Credentials](docs/adw.md#service-binding-response-credentials)
8391
- [Examples](docs/adw.md#examples)
8492
- [Prerequisite](docs/adw.md#prerequisite)
8593
- [OCI Service Broker](docs/adw.md#oci-service-broker)
8694
- [Sample files](docs/adw.md#sample-files)
8795
- [Provisioning](docs/adw.md#provisioning)
88-
- [Creating an ADW ServiceInstance](docs/adw.md#creating-an-adw-serviceinstance)
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)
8998
- [Get instance status](docs/adw.md#get-instance-status)
9099
- [Binding](docs/adw.md#binding)
91100
- [Creating an ADW ServiceBinding resource](docs/adw.md#creating-an-adw-servicebinding-resource)
@@ -101,12 +110,15 @@
101110
- [Introduction](docs/oss.md#introduction)
102111
- [Plans](docs/oss.md#plans)
103112
- [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)
104115
- [Service Binding](docs/oss.md#service-binding)
105116
- [Request Parameters](docs/oss.md#request-parameters)
106117
- [Response Credentials](docs/oss.md#response-credentials)
107118
- [Example](docs/oss.md#example)
108119
- [Kubernetes](docs/oss.md#kubernetes)
109-
- [Provisioning](docs/oss.md#provisioning)
120+
- [Creating a New Instance](docs/oss.md#creating-a-new-instance)
121+
- [Attaching an Existing Instance](docs/oss.md#attaching-an-existing-instance)
110122
- [Binding](docs/oss.md#binding)
111123

112124
## Introduction
@@ -116,4 +128,6 @@ The OCI Service Broker is an open source implementation of [Open service broker
116128
- Easy installation.
117129
- Easy extension.
118130
- Provide OOTB implementations for common OCI services.
119-
- OCI Service Broker Installation.
131+
- OCI Service Broker Installation.
132+
- [Attaching an Existing Service Instance](docs/services.md#attaching-an-existing-service-instance)
133+

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

Lines changed: 32 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +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-adw-service-instance)
8+
- [Attaching an Existing ADW Service Instance](#attaching-an-existing-adw-service-instance)
79
- [Service Binding Request Parameters](#service-binding-request-parameters)
810
- [Service Binding Response Credentials](#service-binding-response-credentials)
911
- [Examples](#examples)
1012
- [Prerequisite](#prerequisite)
1113
- [OCI Service Broker](#oci-service-broker)
1214
- [Sample files](#sample-files)
1315
- [Provisioning](#provisioning)
14-
- [Creating an ADW ServiceInstance](#creating-an-adw-serviceinstance)
16+
- [Creating a new ADW ServiceInstance](#creating-a-new-adw-serviceinstance)
17+
- [Attaching an Existing ADW ServiceInstance](#attaching-an-existing-adw-serviceinstance)
1518
- [Get instance status](#get-instance-status)
1619
- [Binding](#binding)
1720
- [Creating an ADW ServiceBinding resource](#creating-an-adw-servicebinding-resource)
@@ -42,7 +45,9 @@ The OCI user for OCI Service Broker should have permission `manage` for resource
4245
Allow group <SERVICE_BROKER_GROUP> to manage autonomous-data-warehouse in compartment <COMPARTMENT_NAME>
4346
```
4447

45-
## Service Provision Request Parameters
48+
### Service Provision Request Parameters
49+
50+
## Provisioning a new ADW Service Instance
4651

4752
To provision, an ADW service user needs to provide the following details:
4853

@@ -58,6 +63,20 @@ To provision, an ADW service user needs to provide the following details:
5863
| `freeFormTags` | free form tags that are to be used for tagging the ADW instance. | object | no |
5964
| `definedTags` | The defined tags that are to be used for tagging the ADW instance. | object | no |
6065

66+
## Attaching an Existing ADW Service Instance
67+
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).
69+
70+
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.
71+
72+
| Parameter | Description | Type | Mandatory |
73+
| ---------------- | ------------------------------------------------------------------- | ------- | --------- |
74+
| `name` | The display name for the ADW instance. | string | yes |
75+
| `ocid` | The OCID for existing ADW Instance. | string | yes |
76+
| `provisioning` | Set provisioning flag value as false. | boolean | yes |
77+
78+
79+
6180
## Service Binding Request Parameters
6281

6382
The user needs to pass the following parameters to get the binding details:
@@ -124,7 +143,7 @@ Providing password in plain text may not be an idle case. Alternatively, the use
124143

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

127-
#### Creating an ADW ServiceInstance
146+
#### Creating a new ADW ServiceInstance
128147

129148
**NOTE:**
130149
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.
@@ -133,6 +152,15 @@ The [`adw-instance-plain.yaml`](../samples/adw/adw-instance-plain.yaml) files co
133152
kubectl create -f charts/oci-service-broker/samples/adw/adw-instance-plain.yaml
134153
```
135154

155+
#### Attaching an existing ADW ServiceInstance
156+
157+
**NOTE:**
158+
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.
159+
160+
```bash
161+
kubectl create -f charts/oci-service-broker/samples/adw/adw-existing-instance.yaml
162+
```
163+
136164
#### Get instance status
137165

138166
```bash
@@ -350,7 +378,7 @@ NAME NAMESPACE CLASS PLAN STATUS
350378
adw-instance-1 catalog adw-service standard Deprovisioning
351379
```
352380

353-
It usually takes 5-10 minutes for an instance to get deprovisioned. On successful deprviosining the ServiceInstance will be removed and won't be listed.
381+
It usually takes 5-10 minutes for an instance to get deprovisioned. On successful deprviosining the ServiceInstance will be removed and won't be listed. In case of the existing instance actual instance won't be removed.
354382

355383
### Use Secret to pass passwords
356384

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

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +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)
79
- [Service Binding Request Parameters](#service-binding-request-parameters)
810
- [Service Binding Response Credentials](#service-binding-response-credentials)
911
- [Examples](#examples)
1012
- [Prerequisite](#prerequisite)
1113
- [OCI Service Broker](#oci-service-broker)
1214
- [Sample files](#sample-files)
1315
- [Provisioning](#provisioning)
14-
- [Creating an ATP ServiceInstance](#creating-an-atp-serviceinstance)
16+
- [Creating an ATP ServiceInstance](#creating-a-new-atp-serviceinstance)
17+
- [Attaching an Existing ATP ServiceInstance](#attaching-an-existing-atp-serviceinstance)
1518
- [Get instance status](#get-instance-status)
1619
- [Binding](#binding)
1720
- [Creating an ATP ServiceBinding resource](#creating-an-atp-servicebinding-resource)
@@ -42,7 +45,9 @@ The OCI user for OCI Service Broker should have permission `manage` for resource
4245
Allow group <SERVICE_BROKER_GROUP> to manage autonomous-database in compartment <COMPARTMENT_NAME>
4346
```
4447

45-
## Service Provision Request Parameters
48+
### Service Provision Request Parameters
49+
50+
## Provisioning a new ATP Service Instance
4651

4752
To provision, an ATP service user needs to provide the following details:
4853

@@ -58,6 +63,19 @@ To provision, an ATP service user needs to provide the following details:
5863
| `freeFormTags` | free form tags that are to be used for tagging the ATP instance. | object | no |
5964
| `definedTags` | The defined tags that are to be used for tagging the ATP instance. | object | no |
6065

66+
## Attaching an Existing ATP Service Instance
67+
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).
69+
70+
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.
71+
72+
| Parameter | Description | Type | Mandatory |
73+
| ---------------- | ------------------------------------------------------------------- | ------- | --------- |
74+
| `name` | The display name for the ATP instance. | string | yes |
75+
| `ocid` | The OCID for existing ATP Instance. | string | yes |
76+
| `provisioning` | Set provisioning flag value as false. | boolean | yes |
77+
78+
6179
## Service Binding Request Parameters
6280

6381
The user needs to pass the following parameters to get the binding details:
@@ -124,7 +142,7 @@ Providing password in plain text may not be an idle case. Alternatively, the use
124142

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

127-
#### Creating an ATP ServiceInstance
145+
#### Creating a New ATP ServiceInstance
128146

129147
**NOTE:**
130148
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.
@@ -133,6 +151,15 @@ The [`atp-instance-plain.yaml`](../samples/atp/atp-instance-plain.yaml) files c
133151
kubectl create -f charts/oci-service-broker/samples/atp/atp-instance-plain.yaml
134152
```
135153

154+
#### Attaching an existing ATP ServiceInstance
155+
156+
**NOTE:**
157+
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.
158+
159+
```bash
160+
kubectl create -f charts/oci-service-broker/samples/atp/atp-existing-instance.yaml
161+
```
162+
136163
#### Get instance status
137164

138165
```bash
@@ -349,7 +376,7 @@ NAME NAMESPACE CLASS PLAN STATUS
349376
atp-instance-1 catalog atp-service standard Deprovisioning
350377
```
351378

352-
It usually takes 5-10 minutes for an instance to get deprovisioned. On successful deprviosining the ServiceInstance will be removed and won't be listed.
379+
It usually takes 5-10 minutes for an instance to get deprovisioned. On successful deprviosining the ServiceInstance will be removed and won't be listed. In case of the existing instance the actual instance won't be removed.
353380

354381
### Use Secret to pass passwords
355382

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ brew update && brew install kubernetes-service-catalog-client
6969
The OCI Service Broker is packaged as Helm chart for making it easy to install in Kubernetes. The chart is available at [charts/oci-service-broker](../) directory.
7070

7171
```plain
72-
https://github.com/oracle/oci-service-broker/releases/download/v1.1.1/oci-service-broker-1.1.1.tgz
72+
https://github.com/oracle/oci-service-broker/releases/download/v1.2.0/oci-service-broker-1.2.0.tgz
7373
```
7474

7575
### OCI credentials
@@ -107,7 +107,7 @@ The value for `ociCredentials.secretName` should contain the name of the Kuberne
107107
For quickly testing out OCI Service Broker, TLS can be disabled and an embedded etcd container can be used. This can be used for quickly setting up the Broker but not recommended in PRODUCTION environments. Please refer to [Recommended Setup](#recommended-setup) for PRODUCTION environments
108108

109109
```bash
110-
helm install https://github.com/oracle/oci-service-broker/releases/download/v1.1.1/oci-service-broker-1.1.1.tgz --name oci-service-broker \
110+
helm install https://github.com/oracle/oci-service-broker/releases/download/v1.2.0/oci-service-broker-1.2.0.tgz --name oci-service-broker \
111111
--set ociCredentials.secretName=ocicredentials \
112112
--set storage.etcd.useEmbedded=true \
113113
--set tls.enabled=false
@@ -200,7 +200,7 @@ Please note that the names in keys i.e. keyStore.password and keyStore must not
200200

201201
Replace the values of --set arguments with your appropriate values to install the OCI Service Broker. User needs to point docker images either from OCIR or from their repository.
202202
```bash
203-
helm install https://github.com/oracle/oci-service-broker/releases/download/v1.1.1/oci-service-broker-1.1.1.tgz --name oci-service-broker \
203+
helm install https://github.com/oracle/oci-service-broker/releases/download/v1.2.0/oci-service-broker-1.2.0.tgz --name oci-service-broker \
204204
--set ociCredentials.secretName=ocicredentials \
205205
--set tls.secretName=certsecret \
206206
--set storage.etcd.servers=<comma separated list of etcd servers>
@@ -245,7 +245,7 @@ Refer [Restrict access to Service Catalog resources using RBAC](security.md#rest
245245
Sample files for various services are available under [`oci-service-broker/samples`](../samples) directory inside the charts. The below command extracts chart that contains the sample files.
246246

247247
```bash
248-
curl https://github.com/oracle/oci-service-broker/releases/download/v1.1.1/oci-service-broker-1.1.1.tgz | tar xz
248+
curl https://github.com/oracle/oci-service-broker/releases/download/v1.2.0/oci-service-broker-1.2.0.tgz | tar xz
249249
```
250250

251251
Create a `ClusterServiceBroker` resource with OCI Service Broker URL to register the broker. Use the below register yaml file after updating the namespace of the OCI Service Broker.

0 commit comments

Comments
 (0)