Skip to content

Commit 36173b0

Browse files
authored
docs: Document minimum IAM requirement (#416)
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](https://togithub.com/googleapis/python-bigquery-dataframes/issues/new/choose) 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) - [x] Appropriate docs were updated (if necessary) - https://screenshot.googleplex.com/BPPQ6YVWYykCSus - https://screenshot.googleplex.com/8v3JYwcJJemSKRd Fixes internal issue #328086566 🦕
1 parent 38bd2ba commit 36173b0

File tree

1 file changed

+31
-18
lines changed

1 file changed

+31
-18
lines changed

README.rst

Lines changed: 31 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,11 @@ Prerequisites
3434
`install and initialize the gcloud CLI <https://cloud.google.com/sdk/docs/install>`_,
3535
and then generate the application default credentials by doing
3636
`gcloud auth application-default login <https://cloud.google.com/sdk/gcloud/reference/auth/application-default/login>`_.
37+
* The user must have
38+
`BigQuery Job User <https://cloud.google.com/bigquery/docs/access-control#bigquery.jobUser>`_ and
39+
`BigQuery Read Session User <https://cloud.google.com/bigquery/docs/access-control#bigquery.readSessionUser>`_
40+
roles for the minimum usage. Additional IAM requirements apply for using remote
41+
functions and ML.
3742

3843
Code sample
3944
^^^^^^^^^^^
@@ -215,6 +220,30 @@ steps and an estimator together.
215220
to create a pipeline of transforms with a final estimator.
216221

217222

223+
ML remote models
224+
----------------
225+
226+
**Requirements**
227+
228+
To use BigQuery DataFrames ML remote models (`bigframes.ml.remote` or `bigframes.ml.llm`),
229+
you must enable the following APIs:
230+
231+
* The BigQuery API (bigquery.googleapis.com)
232+
* The BigQuery Connection API (bigqueryconnection.googleapis.com)
233+
* The Vertex AI API (aiplatform.googleapis.com)
234+
235+
and you must be granted the following IAM roles:
236+
237+
* BigQuery Data Editor (roles/bigquery.dataEditor)
238+
* BigQuery Connection Admin (roles/bigquery.connectionAdmin)
239+
* Service Account User (roles/iam.serviceAccountUser) on the
240+
`service account <https://cloud.google.com/functions/docs/reference/iam/roles#additional-configuration>`__
241+
242+
* Vertex AI User (roles/aiplatform.user)
243+
* Project IAM Admin (roles/resourcemanager.projectIamAdmin) if using default
244+
BigQuery connection, or Browser (roles/browser) if using a pre-created connection
245+
246+
218247
ML locations
219248
------------
220249

@@ -311,24 +340,8 @@ following IAM roles:
311340
`service account <https://cloud.google.com/functions/docs/reference/iam/roles#additional-configuration>`__
312341
313342
* Storage Object Viewer (roles/storage.objectViewer)
314-
* Project IAM Admin (roles/resourcemanager.projectIamAdmin)
315-
316-
To use BigQuery DataFrames ML remote models(bigframes.ml.remote or bigframes.ml.llm), you must enable the following APIs:
317-
318-
* The BigQuery API (bigquery.googleapis.com)
319-
* The BigQuery Connection API (bigqueryconnection.googleapis.com)
320-
* The Vertex AI API (aiplatform.googleapis.com)
321-
322-
To use BigQuery DataFrames ML remote models(bigframes.ml.remote or bigframes.ml.llm), you must be granted the
323-
following IAM roles:
324-
325-
* BigQuery Data Editor (roles/bigquery.dataEditor)
326-
* BigQuery Connection Admin (roles/bigquery.connectionAdmin)
327-
* Service Account User (roles/iam.serviceAccountUser) on the
328-
`service account <https://cloud.google.com/functions/docs/reference/iam/roles#additional-configuration>`__
329-
330-
* Vertex AI User (roles/aiplatform.user)
331-
* Project IAM Admin (roles/resourcemanager.projectIamAdmin)
343+
* Project IAM Admin (roles/resourcemanager.projectIamAdmin) if using default
344+
BigQuery connection, or Browser (roles/browser) if using a pre-created connection
332345

333346
**Limitations**
334347

0 commit comments

Comments
 (0)