doc(common): make authentication docs easier to find #10110

coryan · 2022-10-27T19:26:09Z

I created a page for all the authentication components. I also moved some general overview stuff out of the Credentials class into the components overview.

This change is

google-cloud-cpp-bot · 2022-10-27T19:27:31Z

Google Cloud Build Logs
For commit: f86e23df04a8c5f51563ae463583b98c3e52e994

Public Access Build Logs
Cloud Build Console (requires auth)
Kokoro Logs (requires auth)

ℹ️ NOTE: Kokoro logs are linked from "Details" below.

I created a page for all the authentication components. I also moved some general overview stuff out of the `Credentials` class into the components overview.

google-cloud-cpp-bot · 2022-10-27T19:30:30Z

Google Cloud Build Logs
For commit: abe605af4f2a930a0aa5aa76fafd9091a80fe673

Public Access Build Logs
Cloud Build Console (requires auth)
Kokoro Logs (requires auth)

ℹ️ NOTE: Kokoro logs are linked from "Details" below.

coryan · 2022-10-27T19:38:28Z

This is a rendered version, because the source may be hard to grok:

pr-10110.pdf

codecov · 2022-10-27T20:17:01Z

Codecov Report

Base: 93.97% // Head: 93.97% // Increases project coverage by +0.00% 🎉

Coverage data is based on head (abe605a) compared to base (69561fe).
Patch has no changes to coverable lines.

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #10110   +/-   ##
=======================================
  Coverage   93.97%   93.97%           
=======================================
  Files        1513     1513           
  Lines      139964   139964           
=======================================
+ Hits       131534   131536    +2     
+ Misses       8430     8428    -2

Impacted Files	Coverage Δ
google/cloud/internal/async_connection_ready.cc	`89.36% <0.00%> (-4.26%)`	⬇️
...integration_tests/schema_admin_integration_test.cc	`98.88% <0.00%> (-1.12%)`	⬇️
google/cloud/storage/parallel_upload.cc	`98.28% <0.00%> (-0.35%)`	⬇️
...cloud/pubsub/internal/subscription_session_test.cc	`98.65% <0.00%> (ø)`
...le/cloud/storage/internal/curl_download_request.cc	`89.63% <0.00%> (+0.33%)`	⬆️
...te/integration_tests/publisher_integration_test.cc	`98.68% <0.00%> (+6.57%)`	⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

scotthart

Reviewed 3 of 3 files at r1, all commit messages.
Reviewable status: complete! all files reviewed, all discussions resolved (waiting on @coryan)

devbww · 2022-10-27T20:52:40Z

google/cloud/doc/guac.dox

+/*!
+@defgroup guac Authentication Components
+
+Most services in Google Cloud Platform requires the client to authenticate the


s/requires/require/

devbww · 2022-10-27T20:53:28Z

google/cloud/doc/guac.dox

+Most services in Google Cloud Platform requires the client to authenticate the
+requests. Notable exceptions include public buckets in GCS and public data
+sets in BigQuery. The C++ client libraries are automatically configured
+to use "Google Default Credentials", some applications may need to override this


s/some/but some/

devbww · 2022-10-27T20:54:03Z

google/cloud/doc/guac.dox

+requests. Notable exceptions include public buckets in GCS and public data
+sets in BigQuery. The C++ client libraries are automatically configured
+to use "Google Default Credentials", some applications may need to override this
+default. The functions and classes related to change the authentication


s/change/changing/

devbww · 2022-10-27T20:55:31Z

google/cloud/doc/guac.dox

+
+## General Concepts
+
+As mentioned complete overview of authentication and authorization for Google


s/mentioned /mentioned, /

devbww · 2022-10-27T20:56:43Z

google/cloud/doc/guac.dox

+
+Access tokens usually expire in about an hour. The client libraries
+automatically refresh these tokens when needed. The only exception is
+`MakeAccessTokenCredentials()` where the application provides the access token.


s/ where/, where/

devbww · 2022-10-27T20:58:05Z

google/cloud/doc/guac.dox

+
+## Development Workstations
+
+During development the most common configuration to use Application Default


s/configuration to/configurations that/

devbww · 2022-10-27T20:58:24Z

google/cloud/doc/guac.dox

+During development the most common configuration to use Application Default
+Credentials are:
+
+1. Use the `gcloud auth application-default` to authentication using the


s/authentication/authenticate/

devbww · 2022-10-27T20:59:07Z

google/cloud/doc/guac.dox

+
+1. Use the `gcloud auth application-default` to authentication using the
+   developer's account for authentication.
+1. Set `GOOGLE_APPLICATION_CREDENTIALS` environment variable to load a service


s/Set/Set the/

devbww · 2022-10-27T20:59:20Z

google/cloud/doc/guac.dox

+   developer's account for authentication.
+1. Set `GOOGLE_APPLICATION_CREDENTIALS` environment variable to load a service
+   account key. The value of this environment variable is the full path of a
+   file which contains the service account key.


s/which/that/

I think I fixed this and your other comments (thanks!) in #10111

doc(common): make authentication docs easier to find

abe605a

I created a page for all the authentication components. I also moved some general overview stuff out of the `Credentials` class into the components overview.

coryan force-pushed the doc-common-authentication-components branch from f86e23d to abe605a Compare October 27, 2022 19:28

coryan marked this pull request as ready for review October 27, 2022 20:21

coryan requested a review from a team as a code owner October 27, 2022 20:21

scotthart approved these changes Oct 27, 2022

View reviewed changes

coryan merged commit 74eb04b into googleapis:main Oct 27, 2022

coryan deleted the doc-common-authentication-components branch October 27, 2022 20:47

devbww reviewed Oct 27, 2022

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc(common): make authentication docs easier to find #10110

doc(common): make authentication docs easier to find #10110

coryan commented Oct 27, 2022 •

edited

google-cloud-cpp-bot commented Oct 27, 2022

google-cloud-cpp-bot commented Oct 27, 2022

coryan commented Oct 27, 2022

codecov bot commented Oct 27, 2022 •

edited

scotthart left a comment

devbww Oct 27, 2022

devbww Oct 27, 2022

devbww Oct 27, 2022

devbww Oct 27, 2022

devbww Oct 27, 2022

devbww Oct 27, 2022

devbww Oct 27, 2022

devbww Oct 27, 2022

devbww Oct 27, 2022

coryan Oct 27, 2022


		## General Concepts

		As mentioned complete overview of authentication and authorization for Google


		## Development Workstations

		During development the most common configuration to use Application Default

doc(common): make authentication docs easier to find #10110

doc(common): make authentication docs easier to find #10110

Conversation

coryan commented Oct 27, 2022 • edited

google-cloud-cpp-bot commented Oct 27, 2022

google-cloud-cpp-bot commented Oct 27, 2022

coryan commented Oct 27, 2022

codecov bot commented Oct 27, 2022 • edited

Codecov Report

scotthart left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

coryan commented Oct 27, 2022 •

edited

codecov bot commented Oct 27, 2022 •

edited