Skip to content

Commit c35b65e

Browse files
committed
Updated readme
1 parent 1474880 commit c35b65e

File tree

1 file changed

+29
-32
lines changed

1 file changed

+29
-32
lines changed

ojdbc-provider-gcp/README.md

+29-32
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,6 @@ Provider</a></dt>
1111
<dd>Provides connection properties managed by the Object Storage service</dd>
1212
<dt><a href="#gcp-vault-secret-config-provider">GCP Vault Secret Config Provider</a></dt>
1313
<dd>Provides connection properties managed by the Secret Manager service</dd>
14-
<dt><a href="#common-parameters-for-centralized-config-providers">Common Parameters for Centralized Config Providers</a></dt>
15-
<dd>Common parameters supported by the config providers</dd>
1614
<dt><a href="#caching-configuration">Caching configuration</a></dt>
1715
<dd>Caching mechanism adopted by Centralized Config Providers</dd>
1816
</dl>
@@ -24,8 +22,6 @@ Provider</a></dt>
2422
<dd>Provides passwords managed by the Vault service</dd>
2523
<dt><a href="#vault-username-provider">Vault Username Provider</a></dt>
2624
<dd>Provides usernames managed by the Vault service</dd>
27-
<dt><a href="#common-parameters-for-resource-providers">Common Parameters for Resource Providers</a></dt>
28-
<dd>Common parameters supported by the resource providers</dd>
2925
</dl>
3026

3127
Visit any of the links above to find information and usage examples for a
@@ -44,6 +40,35 @@ JDK versions. The coordinates for the latest release are:
4440
</dependency>
4541
```
4642

43+
## Authentication
44+
45+
Providers use Google Cloud APIs which support
46+
[Application Default Credentials](https://cloud.google.com/docs/authentication/application-default-credentials);
47+
the libraries look for credentials in a set of defined locations and use those
48+
credentials to authenticate requests to the API.
49+
50+
ADC searches for credentials in the following locations:
51+
52+
1. GOOGLE_APPLICATION_CREDENTIALS environment variable
53+
2. User credentials set up by using the Google Cloud CLI
54+
3. The attached service account, returned by the metadata server
55+
56+
When your code is running in a local development environment, such as a development workstation, the best option is to use the credentials associated with your user
57+
account.
58+
59+
### Configure ADC with your Google Account
60+
To configure ADC with a Google Account, you use the Google Cloud CLI:
61+
62+
1. Install and initialize the gcloud CLI.
63+
64+
When you initialize the gcloud CLI, be sure to specify a Google Cloud project in which you have permission to access the resources your application needs.
65+
66+
2. Configure ADC:
67+
```
68+
gcloud auth application-default login
69+
```
70+
A sign-in screen appears. After you sign in, your credentials are stored in the local credential file used by ADC.
71+
4772
## GCP Object Storage Config Provider
4873
The Oracle DataSource uses a new prefix `jdbc:oracle:thin:@config-gcp-object:` to be able to identify that the configuration parameters should be loaded using GCP Object Storage. Users only need to indicate the project, bucket and object containing the JSON payload, with the following syntax:
4974

@@ -191,32 +216,4 @@ An example of a
191216
that configures this provider can be found in
192217
[example-vault.properties](example-vault.properties).
193218

194-
## Configuring Authentication
195-
196-
Providers use Google Cloud APIs which support
197-
[Application Default Credentials](https://cloud.google.com/docs/authentication/application-default-credentials);
198-
the libraries look for credentials in a set of defined locations and use those
199-
credentials to authenticate requests to the API.
200-
201-
ADC searches for credentials in the following locations:
202-
203-
1. GOOGLE_APPLICATION_CREDENTIALS environment variable
204-
2. User credentials set up by using the Google Cloud CLI
205-
3. The attached service account, returned by the metadata server
206-
207-
When your code is running in a local development environment, such as a development workstation, the best option is to use the credentials associated with your user
208-
account.
209-
210-
### Configure ADC with your Google Account
211-
To configure ADC with a Google Account, you use the Google Cloud CLI:
212-
213-
1. Install and initialize the gcloud CLI.
214-
215-
When you initialize the gcloud CLI, be sure to specify a Google Cloud project in which you have permission to access the resources your application needs.
216-
217-
2. Configure ADC:
218-
```
219-
gcloud auth application-default login
220-
```
221-
A sign-in screen appears. After you sign in, your credentials are stored in the local credential file used by ADC.
222219

0 commit comments

Comments
 (0)