First pass at Authentication summary in docs. #830

jgeewax · 2015-04-15T16:12:33Z

Took a crack at this, related to #805

coveralls · 2015-04-15T16:15:14Z

Coverage remained the same at 100.0% when pulling 8b60160 on jgeewax:authentication into 6283ab9 on GoogleCloudPlatform:master.

jgeewax · 2015-04-15T16:27:21Z

@tmatsuo : FYI, feedback welcome.

docs/gcloud-auth.rst

+Order of evaluation
+-------------------
+
+``gcloud`` will look in a bunch of different places


docs/gcloud-auth.rst

+Summary
+=======
+
+For the majority of cases,


coveralls · 2015-04-15T16:40:20Z

Coverage remained the same at 100.0% when pulling 4d6fc98 on jgeewax:authentication into 6283ab9 on GoogleCloudPlatform:master.

docs/gcloud-auth.rst

+authentication should "just work"
+as credentials can be loaded implicitly
+based on the environment you're application is running in
+and therefore there is no extra code required to authenticate.


coveralls · 2015-04-16T12:58:20Z

Changes Unknown when pulling 5a88b2f on jgeewax:authentication into * on GoogleCloudPlatform:master*.

jgeewax · 2015-04-16T14:43:57Z

@dhermes can you take a look?

docs/gcloud-auth.rst

+   from gcloud import pubsub
+
+   # Create the credentials from the keyfile and set the default connection.
+   credentials = get_for_service_account_json('/path/to/key.json')


coveralls · 2015-04-17T19:39:49Z

Coverage remained the same at 100.0% when pulling 0c9c31f on jgeewax:authentication into 286207b on GoogleCloudPlatform:master.

docs/gcloud-auth.rst

+the easiest way to authenticate is using the Cloud SDK.
+
+**If you're running your application elsewhere**,
+you should download the service account JSON keyfile


docs/gcloud-auth.rst

+(and add the answer to your question here).
+
+.. _Google Developers Console: https://console.developers.google.com/project
+.. _Credentials: https://pantheon.corp.google.com/project/_/apiui/credential


tmatsuo · 2015-04-23T23:35:19Z

I came up with a little concern about thread safety and multiprocessing safety.

Is the implicit method thread safe?
Also, trickier thing is that, even if your client object is thread safe, it could break with multiprocessing.

For example, when I did the following, the apiary client object breaks:

create a client
issue an API call in the main process
fork sharing the client
issue an API with the shared client in the child process

BTW the document looks great now :)

dhermes · 2015-04-27T20:27:04Z

@tmatsuo Thanks for pointing this out. I've also worried about how our implicit code would work in a multithreaded environment. (Easy becomes hard very quickly.)

Are you referring to our library or google-api-python-client? Also, can you send sample code and stacktraces if it is us breaking.

tmatsuo · 2015-04-27T21:22:35Z

@dhermes That's the apiary client, so yes, it was google-api-python-client. However, if you're using httplib2.Http object, it could happen to anyone I guess.

Unfortunately I lost the stacktraces now, I tried to reproduce it, but now I'm failing to repro.
Basically what I did was

store the apiary client object in a thread local variable
use that client in the main process
fork with multiprocessing (thus the client object is copied to the child)
use the client in the child process

Then it threw some kind of SSL handshake error.

I will update here once I can reproduce it.

dhermes · 2015-04-27T21:36:36Z

Thanks. That's "good news" for us since we don't do config with httplib2 (we use raw httplib / http.client to check compute engine for config).

The flipside is that this could be a larger issue in a threaded environment. I thought I filed an issue about enabling a "bring your own http" but couldn't track it down. (We don't necessarily need to pigeonhole people into using httplib2.)

docs/gcloud-auth.rst

+This means that you can set your credentials a bunch of different ways.
+We recommend using some form of implicitly discovered credentials
+(ie, set in an environment variable or auto-discovered in GCE/GAE)
+so that youre code can be


dhermes · 2015-04-29T17:20:31Z

FYI @jgeewax @tseaver et al I just discovered a quick way to expand all outdated comments:

$(".outdated-diff-comment-container").addClass("open")

from the JS console

coveralls · 2015-04-29T20:45:56Z

Coverage remained the same at 100.0% when pulling b18bcff on jgeewax:authentication into 286207b on GoogleCloudPlatform:master.

coveralls · 2015-05-06T14:32:59Z

Coverage remained the same at 100.0% when pulling ac9479f on jgeewax:authentication into 73a341c on GoogleCloudPlatform:master.

coveralls · 2015-05-06T14:59:27Z

Coverage remained the same at 100.0% when pulling 4d6d9f2 on jgeewax:authentication into 73a341c on GoogleCloudPlatform:master.

dhermes · 2015-06-26T00:47:44Z

@jgeewax I just tried to revisit this and #805, but realized it's not worth moving forward on until the client pattern is fully in.

When I do move forward on it, I'm going to start with a tiny document (i.e. one paragraph) and then "launch and iterate" so we don't have so many comments to address in a single PR.

dhermes · 2015-06-26T00:48:20Z

Though you may notice that this little review spawned #950 and #951.

googlebot added the cla: yes This human has signed the Contributor License Agreement. label Apr 15, 2015

jgeewax added docs auth and removed cla: yes This human has signed the Contributor License Agreement. labels Apr 15, 2015

jgeewax added this to the Core Stable milestone Apr 15, 2015

jgeewax added the cla: yes This human has signed the Contributor License Agreement. label Apr 15, 2015

tmatsuo reviewed Apr 15, 2015
View reviewed changes

docs/gcloud-auth.rst

Order of evaluation

-------------------

``gcloud`` will look in a bunch of different places

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

jgeewax force-pushed the authentication branch from 8b60160 to 4d6fc98 Compare April 15, 2015 16:37

tmatsuo reviewed Apr 15, 2015
View reviewed changes

jgeewax force-pushed the authentication branch from 4d6fc98 to 5a88b2f Compare April 16, 2015 12:56

jgeewax assigned dhermes Apr 16, 2015

dhermes mentioned this pull request Apr 16, 2015

Impossible to set non-default storage project since 0.5.0 #832

Closed

jgeewax reviewed Apr 17, 2015
View reviewed changes

jgeewax force-pushed the authentication branch from 5a88b2f to 0c9c31f Compare April 17, 2015 18:50

dhermes reviewed Apr 19, 2015
View reviewed changes

docs/gcloud-auth.rst

the easiest way to authenticate is using the Cloud SDK.

**If you're running your application elsewhere**,

you should download the service account JSON keyfile

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

dhermes reviewed Apr 19, 2015
View reviewed changes

jgeewax force-pushed the authentication branch from 0c9c31f to abff368 Compare April 29, 2015 13:13

dhermes reviewed Apr 29, 2015
View reviewed changes

jgeewax force-pushed the authentication branch from abff368 to b18bcff Compare April 29, 2015 16:34

dhermes mentioned this pull request Apr 29, 2015

Get distinctive CSS for <h4> #846

Closed

jgeewax force-pushed the authentication branch from b18bcff to ac9479f Compare May 6, 2015 14:26

First pass at Authentication summary in docs.

4d6d9f2

jgeewax force-pushed the authentication branch from ac9479f to 4d6d9f2 Compare May 6, 2015 14:37

dhermes mentioned this pull request Jun 25, 2015

Adding Pylint plugin to check Sphinx docstrings. #948

Merged

This was referenced Aug 25, 2015

Basic beginning of authentication module. #1084

Merged

Add basic discussion of clients to auth doc. #1087

Merged

Adding section about order used for app. default creds. #1088

Merged

Describing how to create credentials explicitly in auth doc. #1090

Merged

dhermes closed this Aug 27, 2015

theacodes unassigned dhermes Sep 28, 2018

First pass at Authentication summary in docs. #830

First pass at Authentication summary in docs. #830

Uh oh!

Conversation

jgeewax commented Apr 15, 2015

Uh oh!

coveralls commented Apr 15, 2015

Uh oh!

jgeewax commented Apr 15, 2015

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

coveralls commented Apr 15, 2015

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

coveralls commented Apr 16, 2015

Uh oh!

jgeewax commented Apr 16, 2015

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

coveralls commented Apr 17, 2015

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

tmatsuo commented Apr 23, 2015

Uh oh!

dhermes commented Apr 27, 2015

Uh oh!

tmatsuo commented Apr 27, 2015

Uh oh!

dhermes commented Apr 27, 2015

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

dhermes commented Apr 29, 2015

Uh oh!

coveralls commented Apr 29, 2015

Uh oh!

coveralls commented May 6, 2015

Uh oh!

coveralls commented May 6, 2015

Uh oh!

dhermes commented Jun 26, 2015

Uh oh!

dhermes commented Jun 26, 2015

Uh oh!

Uh oh!