Skip to content

Commit 15b18f1

Browse files
committed
docs: updated prereqs documentation for Agent deployment on GKE
updated iam permissions
1 parent 32b0be6 commit 15b18f1

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

docs/deploy/gke.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -315,15 +315,24 @@ Before you begin, ensure you have the following set up:
315315

316316
1. **A running GKE cluster:** You need an active Kubernetes cluster on Google Cloud.
317317

318-
2. **`gcloud` CLI:** The Google Cloud CLI must be installed, authenticated, and configured to use your target project. Run `gcloud auth login` and `gcloud config set project [YOUR_PROJECT_ID]`.
318+
2. **Required CLIs:**
319+
* **`gcloud` CLI:** The Google Cloud CLI must be installed, authenticated, and configured to use your target project. Run `gcloud auth login` and `gcloud config set project [YOUR_PROJECT_ID]`.
320+
* **kubectl:** The Kubernetes CLI must be installed to deploy the application to your cluster.
319321

320-
3. **Required IAM Permissions:** The user or service account running the command needs, at a minimum, the following roles:
322+
3. **Enabled Google Cloud APIs:** Make sure the following APIs are enabled in your Google Cloud project:
323+
* Kubernetes Engine API (`container.googleapis.com`)
324+
* Cloud Build API (`cloudbuild.googleapis.com`)
325+
* Container Registry API (`containerregistry.googleapis.com`)
326+
327+
4. **Required IAM Permissions:** The user or Compute Engine default service account running the command needs, at a minimum, the following roles:
321328

322329
* **Kubernetes Engine Developer** (`roles/container.developer`): To interact with the GKE cluster.
323330

324-
* **Artifact Registry Writer** (`roles/artifactregistry.writer`): To push the agent's container image.
331+
* **Storage Object Viewer** (`roles/storage.objectViewer`): To allow Cloud Build to download the source code from the Cloud Storage bucket where gcloud builds submit uploads it.
332+
333+
* **Artifact Registry Create on Push Writer** (`roles/artifactregistry.createOnPushWriter`): To allow Cloud Build to push the built container image to Artifact Registry. This role also permits the on-the-fly creation of the special gcr.io repository within Artifact Registry if needed on the first push.
325334

326-
4. **Docker:** The Docker daemon must be running on your local machine to build the container image.
335+
* **Logs Writer** (`roles/logging.logWriter`): To allow Cloud Build to write build logs to Cloud Logging.
327336

328337
### The `deploy gke` Command
329338

0 commit comments

Comments
 (0)