Skip to content

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

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.

Sign up for GitHub

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

Merged
merged 7 commits into from
Feb 8, 2024
Merged

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

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
455645c
docs: clarify ADC pre-auth in a non-interactive environment
shobsi Jan 25, 2024
b306446
Merge remote-tracking branch 'refs/remotes/github/main' into shobs-do…
shobsi Jan 25, 2024
0176476
fix typo
shobsi Jan 25, 2024
c29f905
Merge remote-tracking branch 'refs/remotes/github/main' into shobs-do…
shobsi Jan 27, 2024
60af6f5
include generic ADC link
shobsi Jan 27, 2024
0f24d9d
Merge remote-tracking branch 'refs/remotes/github/main' into shobs-do…
shobsi Jan 29, 2024
f702d93
Merge branch 'main' into shobs-doc-auth
shobsi Feb 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
docs: clarify ADC pre-auth in a non-interactive environment
  • Loading branch information
@shobsi
shobsi committed Jan 25, 2024
commit 455645cd2ad5143ab81f4dd3b50711ab3a048aa2
13 changes: 6 additions & 7 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,12 @@ Prerequisites

* Install the ``bigframes`` package.
* Create a Google Cloud project and billing account.
* When running locally, authenticate with application default credentials. See
the `gcloud auth application-default login
<https://cloud.google.com/sdk/gcloud/reference/auth/application-default/login>`_
reference.
* 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.

then generating the application default credentials by doing
`gcloud auth application-default login <https://cloud.google.com/sdk/gcloud/reference/auth/application-default/login>`_.

Code sample
^^^^^^^^^^^
Expand Down Expand Up @@ -284,9 +286,6 @@ created by BigQuery DataFrames are prefixed by ``bigframes``.

**Requirements**

BigQuery DataFrames uses the ``gcloud`` command-line interface internally,
so you must run ``gcloud auth login`` before using remote functions.

To use BigQuery DataFrames remote functions, you must enable the following APIs:

* The BigQuery API (bigquery.googleapis.com)
Expand Down