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

Commit a19c281

Browse files
chore(docs): add Authorization section to Java README template (#1161) (#514)
as a part of the PR 582 for java-logging an authorization section is added to the Java README template. Fixing googleapis/java-logging#570. Source-Link: googleapis/synthtool@3d32990 Post-Processor: gcr.io/repo-automation-bots/owlbot-java:latest@sha256:2904b9ad921ecc1343d1cf815bfaafbcc1115c1f39593aef9f8e333ffda552f7
1 parent 88c77a5 commit a19c281

File tree

2 files changed

+16
-1
lines changed

2 files changed

+16
-1
lines changed

.github/.OwlBot.lock.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
docker:
22
image: gcr.io/repo-automation-bots/owlbot-java:latest
3-
digest: sha256:b3f8a219abf58ed4a775da5b90934b34f477b74f6f4e5d15781694dcc67b6f41
3+
digest: sha256:2904b9ad921ecc1343d1cf815bfaafbcc1115c1f39593aef9f8e333ffda552f7

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,11 @@ Java idiomatic client for [Kubernetes Engine][product-docs].
88
- [Product Documentation][product-docs]
99
- [Client Library Documentation][javadocs]
1010

11+
1112
## Quickstart
1213

1314
If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file
15+
1416
```xml
1517
<dependencyManagement>
1618
<dependencies>
@@ -34,6 +36,7 @@ If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file
3436

3537
If you are using Maven without BOM, add this to your dependencies:
3638

39+
3740
```xml
3841
<dependency>
3942
<groupId>com.google.cloud</groupId>
@@ -44,17 +47,20 @@ If you are using Maven without BOM, add this to your dependencies:
4447
```
4548

4649
If you are using Gradle 5.x or later, add this to your dependencies
50+
4751
```Groovy
4852
implementation platform('com.google.cloud:libraries-bom:20.9.0')
4953
5054
compile 'com.google.cloud:google-cloud-container'
5155
```
5256
If you are using Gradle without BOM, add this to your dependencies
57+
5358
```Groovy
5459
compile 'com.google.cloud:google-cloud-container:1.5.0'
5560
```
5661

5762
If you are using SBT, add this to your dependencies
63+
5864
```Scala
5965
libraryDependencies += "com.google.cloud" % "google-cloud-container" % "1.5.0"
6066
```
@@ -63,6 +69,10 @@ libraryDependencies += "com.google.cloud" % "google-cloud-container" % "1.5.0"
6369

6470
See the [Authentication][authentication] section in the base directory's README.
6571

72+
## Authorization
73+
74+
The client application making API calls must be granted [authorization scopes][auth-scopes] required for the desired Kubernetes Engine APIs, and the authenticated principal must have the [IAM role(s)][predefined-iam-roles] required to access GCP resources using the Kubernetes Engine API calls.
75+
6676
## Getting Started
6777

6878
### Prerequisites
@@ -149,6 +159,7 @@ and on [google-cloud-java][g-c-j].
149159
This library follows [Semantic Versioning](http://semver.org/).
150160

151161

162+
152163
## Contributing
153164

154165

@@ -160,6 +171,7 @@ Please note that this project is released with a Contributor Code of Conduct. By
160171
this project you agree to abide by its terms. See [Code of Conduct][code-of-conduct] for more
161172
information.
162173

174+
163175
## License
164176

165177
Apache 2.0 - See [LICENSE][license] for more information.
@@ -192,6 +204,9 @@ Java is a registered trademark of Oracle and/or its affiliates.
192204
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-container.svg
193205
[maven-version-link]: https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-container&core=gav
194206
[authentication]: https://github.com/googleapis/google-cloud-java#authentication
207+
[auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes
208+
[predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles
209+
[iam-policy]: https://cloud.google.com/iam/docs/overview#cloud-iam-policy
195210
[developer-console]: https://console.developers.google.com/
196211
[create-project]: https://cloud.google.com/resource-manager/docs/creating-managing-projects
197212
[cloud-sdk]: https://cloud.google.com/sdk/

0 commit comments

Comments
 (0)