You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Nov 2, 2023. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,7 +38,9 @@ Samples for creating Service Instances and Bindings using `oci-service-broker`,
38
38
39
39
## Troubleshooting
40
40
41
-
See [Troubleshooting](charts/oci-service-broker/docs/troubleshoot.md#troubleshooting-guide-for-oci-service-broker) document for details on debugging common and known issues.
41
+
You can use the [diagnostics tool](charts/oci-service-broker/tools/diagnostics_tool.sh) to help identify the common issues in the installation.
42
+
43
+
Also see [Troubleshooting](charts/oci-service-broker/docs/troubleshoot.md#troubleshooting-guide-for-oci-service-broker) document for details on debugging common and known issues.
-[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)
20
20
-[Register OCI Service Broker](docs/installation.md#register-oci-service-broker)
21
21
-[Monitoring OCI Service Broker](docs/installation.md#monitoring-oci-service-broker)
22
22
-[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)
24
24
-[Restrict access to Service Catalog resources using RBAC](docs/security.md#restrict-access-to-service-catalog-resources-using-rbac)
-[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)
29
29
-[OCI User Capabilities](docs/security.md#oci-user-capabilities)
30
30
-[Policies to allow access to Services](docs/security.md#policies-to-allow-access-to-services)
31
31
-[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)
33
33
-[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)
34
34
-[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)
35
35
-[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,33 +42,39 @@
42
42
-[Plans](docs/object-storage.md#plans)
43
43
-[OCI User Permission requirement](docs/object-storage.md#oci-user-permission-requirement)
-[Creating an ADW ServiceInstance](#creating-an-adw-serviceinstance)
16
+
-[Creating a new ADW Instance](#creating-a-new-adw-instance)
17
+
-[Using an Existing ADW Instance](#using-an-existing-adw-instance)
15
18
-[Get instance status](#get-instance-status)
16
19
-[Binding](#binding)
17
20
-[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
42
45
Allow group <SERVICE_BROKER_GROUP> to manage autonomous-data-warehouse in compartment <COMPARTMENT_NAME>
43
46
```
44
47
45
-
## Service Provision Request Parameters
48
+
### Service Provision Request Parameters
49
+
50
+
## Provisioning a new ADW Service Instance
46
51
47
52
To provision, an ADW service user needs to provide the following details:
48
53
@@ -58,6 +63,20 @@ To provision, an ADW service user needs to provide the following details:
58
63
|`freeFormTags`| free form tags that are to be used for tagging the ADW instance. | object | no |
59
64
|`definedTags`| The defined tags that are to be used for tagging the ADW instance. | object | no |
60
65
66
+
## Using an Existing ADW Service Instance
67
+
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).
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.
|`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
+
61
80
## Service Binding Request Parameters
62
81
63
82
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
124
143
125
144
Please refer [Use Secret to pass passwords](#use-secret-to-pass-passwords) section for passing the password from secrets.
126
145
127
-
#### Creating an ADW ServiceInstance
146
+
#### Creating a new ADW Instance
128
147
129
148
**NOTE:**
130
149
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
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.
@@ -350,7 +378,7 @@ NAME NAMESPACE CLASS PLAN STATUS
350
378
adw-instance-1 catalog adw-service standard Deprovisioning
351
379
```
352
380
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.
-[Creating an ATP ServiceInstance](#creating-an-atp-serviceinstance)
16
+
-[Creating an ATP Instance](#creating-a-new-atp-instance)
17
+
-[Using an Existing ATP Instance](#using-an-existing-atp-instance)
15
18
-[Get instance status](#get-instance-status)
16
19
-[Binding](#binding)
17
20
-[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
42
45
Allow group <SERVICE_BROKER_GROUP> to manage autonomous-database in compartment <COMPARTMENT_NAME>
43
46
```
44
47
45
-
## Service Provision Request Parameters
48
+
### Service Provision Request Parameters
49
+
50
+
## Provisioning a new ATP Service Instance
46
51
47
52
To provision, an ATP service user needs to provide the following details:
48
53
@@ -58,6 +63,19 @@ To provision, an ATP service user needs to provide the following details:
58
63
|`freeFormTags`| free form tags that are to be used for tagging the ATP instance. | object | no |
59
64
|`definedTags`| The defined tags that are to be used for tagging the ATP instance. | object | no |
60
65
66
+
## Using an Existing ATP Service Instance
67
+
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).
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.
|`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
+
61
79
## Service Binding Request Parameters
62
80
63
81
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
124
142
125
143
Please refer [Use Secret to pass passwords](#use-secret-to-pass-passwords) section for passing the password from secrets.
126
144
127
-
#### Creating an ATP ServiceInstance
145
+
#### Creating a New ATP Instance
128
146
129
147
**NOTE:**
130
148
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
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.
@@ -349,7 +376,7 @@ NAME NAMESPACE CLASS PLAN STATUS
349
376
atp-instance-1 catalog atp-service standard Deprovisioning
350
377
```
351
378
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.
0 commit comments