Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PubSub: Document how to choose the PubSub auth method #8429

Merged
merged 3 commits into from
Jun 24, 2019

Conversation

plamut
Copy link
Contributor

@plamut plamut commented Jun 19, 2019

Closes #8137.

Describes a possible workaround for #7387, however, it does not close it, the PR just fulfills a GA requirement (documenting a possible workaround).

How to test

Steps to perform:

  • Generate the pubsub docs locally (from inside the pubsub/ directory):
    $ nox -f noxfile.py -s docs
    
  • Open the generated docs for authentication:
    $ google-chrome "file://$GOOG_CLOUD_PYTHON_DIR/pubsub/docs/_build/html/index.html#authentication"
    

Expected result:
The example is understandable and correct, the links point to correct locations.

Background

The issue itself is hard to reproduce in practice, but it was discovered in other PubSub clients that using JWT-based authentication avoids the issue. The goal of this PR is to document how different auth methods can be used with the Python client.

@plamut plamut added api: pubsub Issues related to the Pub/Sub API. type: docs Improvement to the documentation for an API. labels Jun 19, 2019
@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Jun 19, 2019
Copy link

@xrmx xrmx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @plamut! I've added a small comment as to me the key is the google-auth documentation and not the Credentials reference.

pubsub/README.rst Outdated Show resolved Hide resolved
@plamut
Copy link
Contributor Author

plamut commented Jun 21, 2019

I marked the PR to close #8137 based on the issue reporter's feedback (thanks again, @xrmx ).

The link to the library is moved to the first paragraph of the
Authentication section for better visibility.
Copy link
Contributor

@anguillanneuf anguillanneuf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@sduskis sduskis merged commit ad405a7 into googleapis:master Jun 24, 2019
@plamut plamut deleted the iss-7387-workaround branch June 24, 2019 17:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: pubsub Issues related to the Pub/Sub API. cla: yes This human has signed the Contributor License Agreement. type: docs Improvement to the documentation for an API.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Pubsub: add 'PublisherClient.from_service_account_dict'
5 participants