From d87eef8dc1c5c42fbf14cf7bc2689222f641c8ad Mon Sep 17 00:00:00 2001 From: Shobhit Singh Date: Tue, 5 Mar 2024 23:29:14 +0000 Subject: [PATCH] docs: Document minimum IAM requirement --- README.rst | 49 +++++++++++++++++++++++++++++++------------------ 1 file changed, 31 insertions(+), 18 deletions(-) diff --git a/README.rst b/README.rst index f6d6f93e36..ad96382df8 100644 --- a/README.rst +++ b/README.rst @@ -34,6 +34,11 @@ Prerequisites `install and initialize the gcloud CLI `_, and then generate the application default credentials by doing `gcloud auth application-default login `_. +* The user must have + `BigQuery Job User `_ and + `BigQuery Read Session User `_ + roles for the minimum usage. Additional IAM requirements apply for using remote + functions and ML. Code sample ^^^^^^^^^^^ @@ -215,6 +220,30 @@ steps and an estimator together. to create a pipeline of transforms with a final estimator. +ML remote models +---------------- + +**Requirements** + +To use BigQuery DataFrames ML remote models (`bigframes.ml.remote` or `bigframes.ml.llm`), +you must enable the following APIs: + +* The BigQuery API (bigquery.googleapis.com) +* The BigQuery Connection API (bigqueryconnection.googleapis.com) +* The Vertex AI API (aiplatform.googleapis.com) + +and you must be granted the following IAM roles: + +* BigQuery Data Editor (roles/bigquery.dataEditor) +* BigQuery Connection Admin (roles/bigquery.connectionAdmin) +* Service Account User (roles/iam.serviceAccountUser) on the + `service account `__ + ``PROJECT_NUMBER-compute@developer.gserviceaccount.com`` +* Vertex AI User (roles/aiplatform.user) +* Project IAM Admin (roles/resourcemanager.projectIamAdmin) if using default + BigQuery connection, or Browser (roles/browser) if using a pre-created connection + + ML locations ------------ @@ -311,24 +340,8 @@ following IAM roles: `service account `__ ``PROJECT_NUMBER-compute@developer.gserviceaccount.com`` * Storage Object Viewer (roles/storage.objectViewer) -* Project IAM Admin (roles/resourcemanager.projectIamAdmin) - -To use BigQuery DataFrames ML remote models(bigframes.ml.remote or bigframes.ml.llm), you must enable the following APIs: - -* The BigQuery API (bigquery.googleapis.com) -* The BigQuery Connection API (bigqueryconnection.googleapis.com) -* The Vertex AI API (aiplatform.googleapis.com) - -To use BigQuery DataFrames ML remote models(bigframes.ml.remote or bigframes.ml.llm), you must be granted the -following IAM roles: - -* BigQuery Data Editor (roles/bigquery.dataEditor) -* BigQuery Connection Admin (roles/bigquery.connectionAdmin) -* Service Account User (roles/iam.serviceAccountUser) on the - `service account `__ - ``PROJECT_NUMBER-compute@developer.gserviceaccount.com`` -* Vertex AI User (roles/aiplatform.user) -* Project IAM Admin (roles/resourcemanager.projectIamAdmin) +* Project IAM Admin (roles/resourcemanager.projectIamAdmin) if using default + BigQuery connection, or Browser (roles/browser) if using a pre-created connection **Limitations**