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

docs: clarify ADC pre-auth in a non-interactive environment #348

Merged
merged 7 commits into from
Feb 8, 2024

Conversation

shobsi
Copy link
Contributor

@shobsi shobsi commented Jan 25, 2024

Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:

  • Make sure to open an issue as a bug/issue before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
  • Ensure the tests and linter pass
  • Code coverage does not decrease (if any source code was changed)
  • Appropriate docs were updated (if necessary)

Fixes internal issue 321859738 🦕

@shobsi shobsi requested review from a team as code owners January 25, 2024 00:21
@shobsi shobsi requested a review from Genesis929 January 25, 2024 00:21
@product-auto-label product-auto-label bot added size: s Pull request size is small. api: bigquery Issues related to the googleapis/python-bigquery-dataframes API. labels Jan 25, 2024
@shobsi shobsi requested review from tswast and jiaxunwu and removed request for Genesis929 January 25, 2024 00:43
README.rst Outdated
* In an interactive environment (like Notebook, Python REPL or command line),
``bigframes`` will do the authentication on-the-fly if needed. Otherwise,
pre-authenticate by
`Installing and initializing the gcloud CLI <https://cloud.google.com/sdk/docs/install>`_,
Copy link
Collaborator

Choose a reason for hiding this comment

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

I would actually recommend linking to our Application Default Credentials docs for instructions. https://cloud.google.com/docs/authentication/provide-credentials-adc

Steps will vary depending on their environment. For example, if running on a GCE VM they won't have to do anything, either.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for the suggestion, done, PTAL.

@shobsi shobsi added the automerge Merge the pull request once unit tests and other checks pass. label Feb 8, 2024
@gcf-merge-on-green gcf-merge-on-green bot merged commit 99a9e6e into main Feb 8, 2024
14 of 15 checks passed
@gcf-merge-on-green gcf-merge-on-green bot deleted the shobs-doc-auth branch February 8, 2024 21:24
@gcf-merge-on-green gcf-merge-on-green bot removed the automerge Merge the pull request once unit tests and other checks pass. label Feb 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: bigquery Issues related to the googleapis/python-bigquery-dataframes API. size: s Pull request size is small.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants