agent-starter-pack 0.3.3__py3-none-any.whl → 0.21.0__py3-none-any.whl

agent_starter_pack/deployment_targets/cloud_run/deployment/terraform/dev/service.tf

@@ -0,0 +1,243 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Get project information to access the project number
+data "google_project" "project" {
+  project_id = var.dev_project_id
+}
+
+
+{%- if cookiecutter.is_adk and cookiecutter.session_type == "cloud_sql" %}
+
+# Generate a random password for the database user
+resource "random_password" "db_password" {
+  length           = 16
+  special          = true
+  override_special = "!#$%&*()-_=+[]{}<>:?"
+}
+
+# Cloud SQL Instance
+resource "google_sql_database_instance" "session_db" {
+  project          = var.dev_project_id
+  name             = "${var.project_name}-db-dev"
+  database_version = "POSTGRES_15"
+  region           = var.region
+  deletion_protection = false
+
+  settings {
+    tier = "db-f1-micro"
+
+    backup_configuration {
+      enabled = false # No backups for dev
+    }
+    
+    # Enable IAM authentication
+    database_flags {
+      name  = "cloudsql.iam_authentication"
+      value = "on"
+    }
+  }
+
+  depends_on = [resource.google_project_service.services]
+}
+
+# Cloud SQL Database
+resource "google_sql_database" "database" {
+  project  = var.dev_project_id
+  name     = "${var.project_name}" # Use project name for DB to avoid conflict with default 'postgres'
+  instance = google_sql_database_instance.session_db.name
+}
+
+# Cloud SQL User
+resource "google_sql_user" "db_user" {
+  project  = var.dev_project_id
+  name     = "${var.project_name}" # Use project name for user to avoid conflict with default 'postgres'
+  instance = google_sql_database_instance.session_db.name
+  password = google_secret_manager_secret_version.db_password.secret_data
+}
+
+# Store the password in Secret Manager
+resource "google_secret_manager_secret" "db_password" {
+  project   = var.dev_project_id
+  secret_id = "${var.project_name}-db-password"
+
+  replication {
+    auto {}
+  }
+
+  depends_on = [resource.google_project_service.services]
+}
+
+resource "google_secret_manager_secret_version" "db_password" {
+  secret      = google_secret_manager_secret.db_password.id
+  secret_data = random_password.db_password.result
+}
+
+{%- endif %}
+
+
+resource "google_cloud_run_v2_service" "app" {
+  name                = var.project_name
+  location            = var.region
+  project             = var.dev_project_id
+  deletion_protection = false
+  ingress             = "INGRESS_TRAFFIC_ALL"
+  labels = {
+{%- if cookiecutter.is_adk %}
+    "created-by"                  = "adk"
+{%- endif %}
+{%- if cookiecutter.agent_garden %}
+    "deployed-with"               = "agent-garden"
+{%- if cookiecutter.agent_sample_id %}
+    "vertex-agent-sample-id"      = "{{cookiecutter.agent_sample_id}}"
+    "vertex-agent-sample-publisher" = "{{cookiecutter.agent_sample_publisher}}"
+{%- endif %}
+{%- endif %}
+  }
+
+  template {
+    containers {
+      image = "us-docker.pkg.dev/cloudrun/container/hello"
+
+{%- if cookiecutter.is_a2a %}
+      env {
+        name  = "APP_URL"
+        value = "https://${var.project_name}-${data.google_project.project.number}.${var.region}.run.app"
+      }
+
+{%- endif %}
+      resources {
+        limits = {
+          cpu    = "4"
+          memory = "8Gi"
+        }
+      }
+{%- if cookiecutter.data_ingestion %}
+{%- if cookiecutter.datastore_type == "vertex_ai_search" %}
+
+      env {
+        name  = "DATA_STORE_ID"
+        value = resource.google_discovery_engine_data_store.data_store_dev.data_store_id
+      }
+
+      env {
+        name  = "DATA_STORE_REGION"
+        value = var.data_store_region
+      }
+{%- elif cookiecutter.datastore_type == "vertex_ai_vector_search" %}
+      env {
+        name  = "VECTOR_SEARCH_INDEX"
+        value = resource.google_vertex_ai_index.vector_search_index.id
+      }
+
+      env {
+        name  = "VECTOR_SEARCH_INDEX_ENDPOINT"
+        value = resource.google_vertex_ai_index_endpoint.vector_search_index_endpoint.id
+      }
+
+      env {
+        name  = "VECTOR_SEARCH_BUCKET"
+        value = "gs://${resource.google_storage_bucket.data_ingestion_PIPELINE_GCS_ROOT.name}"
+      }
+{%- endif %}
+{%- endif %}
+
+{%- if cookiecutter.is_adk and cookiecutter.session_type == "cloud_sql" %}
+      # Mount the volume
+      volume_mounts {
+        name       = "cloudsql"
+        mount_path = "/cloudsql"
+      }
+
+      # Environment variables
+      env {
+        name  = "INSTANCE_CONNECTION_NAME"
+        value = google_sql_database_instance.session_db.connection_name
+      }
+
+      env {
+        name = "DB_PASS"
+        value_source {
+          secret_key_ref {
+            secret  = google_secret_manager_secret.db_password.secret_id
+            version = "latest"
+          }
+        }
+      }
+
+      env {
+        name  = "DB_NAME"
+        value = "${var.project_name}"
+      }
+
+      env {
+        name  = "DB_USER"
+        value = "${var.project_name}"
+      }
+{%- endif %}
+
+      env {
+        name  = "LOGS_BUCKET_NAME"
+        value = google_storage_bucket.logs_data_bucket.name
+      }
+
+      env {
+        name  = "OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT"
+        value = "NO_CONTENT"
+      }
+    }
+
+    service_account = google_service_account.app_sa.email
+    max_instance_request_concurrency = 40
+
+    scaling {
+      min_instance_count = 1
+      max_instance_count = 10
+    }
+
+    session_affinity = true
+
+{%- if cookiecutter.is_adk and cookiecutter.session_type == "cloud_sql" %}
+    # Cloud SQL volume
+    volumes {
+      name = "cloudsql"
+      cloud_sql_instance {
+        instances = [google_sql_database_instance.session_db.connection_name]
+      }
+    }
+{%- endif %}
+  }
+
+  traffic {
+    type    = "TRAFFIC_TARGET_ALLOCATION_TYPE_LATEST"
+    percent = 100
+  }
+
+  # This lifecycle block prevents Terraform from overwriting the container image when it's
+  # updated by Cloud Run deployments outside of Terraform (e.g., via CI/CD pipelines)
+  lifecycle {
+    ignore_changes = [
+      template[0].containers[0].image,
+    ]
+  }
+
+  # Make dependencies conditional to avoid errors.
+  depends_on = [
+    resource.google_project_service.services,
+{%- if cookiecutter.is_adk and cookiecutter.session_type == "cloud_sql" %}
+    google_sql_user.db_user,
+    google_secret_manager_secret_version.db_password,
+{%- endif %}
+  ]
+}

agent_starter_pack/deployment_targets/cloud_run/deployment/terraform/service.tf

@@ -0,0 +1,417 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Get project information to access the project number
+data "google_project" "project" {
+  for_each = local.deploy_project_ids
+
+  project_id = local.deploy_project_ids[each.key]
+}
+
+
+
+{%- if cookiecutter.is_adk and cookiecutter.session_type == "cloud_sql" %}
+
+# Generate a random password for the database user
+resource "random_password" "db_password" {
+  for_each = local.deploy_project_ids
+
+  length           = 16
+  special          = true
+  override_special = "!#$%&*()-_=+[]{}<>:?"
+}
+
+# Cloud SQL Instance
+resource "google_sql_database_instance" "session_db" {
+  for_each = local.deploy_project_ids
+
+  project          = local.deploy_project_ids[each.key]
+  name             = "${var.project_name}-db-${each.key}"
+  database_version = "POSTGRES_15"
+  region           = var.region
+  deletion_protection = false # For easier teardown in starter packs
+
+  settings {
+    tier = each.key == "prod" ? "db-custom-1-3840" : "db-f1-micro" # Use a custom machine type for prod to avoid tier restrictions
+
+    backup_configuration {
+      enabled = true
+      start_time = "03:00"
+    }
+    
+    # Enable IAM authentication
+    database_flags {
+      name  = "cloudsql.iam_authentication"
+      value = "on"
+    }
+  }
+
+  depends_on = [google_project_service.deploy_project_services]
+}
+
+# Cloud SQL Database
+resource "google_sql_database" "database" {
+  for_each = local.deploy_project_ids
+
+  project  = local.deploy_project_ids[each.key]
+  name     = "${var.project_name}" # Use project name for DB to avoid conflict with default 'postgres'
+  instance = google_sql_database_instance.session_db[each.key].name
+}
+
+# Cloud SQL User
+resource "google_sql_user" "db_user" {
+  for_each = local.deploy_project_ids
+
+  project  = local.deploy_project_ids[each.key]
+  name     = "${var.project_name}" # Use project name for user to avoid conflict with default 'postgres'
+  instance = google_sql_database_instance.session_db[each.key].name
+  password = random_password.db_password[each.key].result
+}
+
+# Store the password in Secret Manager
+resource "google_secret_manager_secret" "db_password" {
+  for_each = local.deploy_project_ids
+  
+  project   = local.deploy_project_ids[each.key]
+  secret_id = "${var.project_name}-db-password"
+
+  replication {
+    auto {}
+  }
+
+  depends_on = [google_project_service.deploy_project_services]
+}
+
+resource "google_secret_manager_secret_version" "db_password" {
+  for_each = local.deploy_project_ids
+  
+  secret      = google_secret_manager_secret.db_password[each.key].id
+  secret_data = random_password.db_password[each.key].result
+}
+
+{%- endif %}
+
+resource "google_cloud_run_v2_service" "app_staging" {
+  name                = var.project_name
+  location            = var.region
+  project             = var.staging_project_id
+  deletion_protection = false
+  ingress             = "INGRESS_TRAFFIC_ALL"
+  labels = {
+{%- if cookiecutter.is_adk %}
+    "created-by"                  = "adk"
+{%- endif %}
+{%- if cookiecutter.agent_garden %}
+    "deployed-with"               = "agent-garden"
+{%- if cookiecutter.agent_sample_id %}
+    "vertex-agent-sample-id"      = "{{cookiecutter.agent_sample_id}}"
+    "vertex-agent-sample-publisher" = "{{cookiecutter.agent_sample_publisher}}"
+{%- endif %}
+{%- endif %}
+  }
+
+  template {
+    containers {
+      # Placeholder, will be replaced by the CI/CD pipeline
+      image = "us-docker.pkg.dev/cloudrun/container/hello"
+
+{%- if cookiecutter.is_a2a %}
+      env {
+        name  = "APP_URL"
+        value = "https://${var.project_name}-${data.google_project.project["staging"].number}.${var.region}.run.app"
+      }
+
+{%- endif %}
+      resources {
+        limits = {
+          cpu    = "4"
+          memory = "8Gi"
+        }
+        cpu_idle = false
+      }
+{%- if cookiecutter.data_ingestion %}
+{%- if cookiecutter.datastore_type == "vertex_ai_search" %}
+
+      env {
+        name  = "DATA_STORE_ID"
+        value = resource.google_discovery_engine_data_store.data_store_staging.data_store_id
+      }
+
+      env {
+        name  = "DATA_STORE_REGION"
+        value = var.data_store_region
+      }
+{%- elif cookiecutter.datastore_type == "vertex_ai_vector_search" %}
+      env {
+        name  = "VECTOR_SEARCH_INDEX"
+        value = resource.google_vertex_ai_index.vector_search_index_staging.id
+      }
+
+      env {
+        name  = "VECTOR_SEARCH_INDEX_ENDPOINT"
+        value = resource.google_vertex_ai_index_endpoint.vector_search_index_endpoint_staging.id
+      }
+
+      env {
+        name  = "VECTOR_SEARCH_BUCKET"
+        value = resource.google_storage_bucket.vector_search_data_bucket["staging"].url
+      }
+{%- endif %}
+{%- endif %}
+
+{%- if cookiecutter.is_adk and cookiecutter.session_type == "cloud_sql" %}
+      # Mount the volume
+      volume_mounts {
+        name       = "cloudsql"
+        mount_path = "/cloudsql"
+      }
+
+      # Environment variables
+      env {
+        name  = "INSTANCE_CONNECTION_NAME"
+        value = google_sql_database_instance.session_db["staging"].connection_name
+      }
+
+      env {
+        name = "DB_PASS"
+        value_source {
+          secret_key_ref {
+            secret  = google_secret_manager_secret.db_password["staging"].secret_id
+            version = "latest"
+          }
+        }
+      }
+
+      env {
+        name  = "DB_NAME"
+        value = "${var.project_name}"
+      }
+
+      env {
+        name  = "DB_USER"
+        value = "${var.project_name}"
+      }
+{%- endif %}
+
+      env {
+        name  = "LOGS_BUCKET_NAME"
+        value = google_storage_bucket.logs_data_bucket[var.staging_project_id].name
+      }
+
+      env {
+        name  = "OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT"
+        value = "NO_CONTENT"
+      }
+    }
+
+    service_account                = google_service_account.app_sa["staging"].email
+    max_instance_request_concurrency = 40
+
+    scaling {
+      min_instance_count = 1
+      max_instance_count = 10
+    }
+
+    session_affinity = true
+
+{%- if cookiecutter.is_adk and cookiecutter.session_type == "cloud_sql" %}
+    # Cloud SQL volume
+    volumes {
+      name = "cloudsql"
+      cloud_sql_instance {
+        instances = [google_sql_database_instance.session_db["staging"].connection_name]
+      }
+    }
+{%- endif %}
+  }
+
+  traffic {
+    type    = "TRAFFIC_TARGET_ALLOCATION_TYPE_LATEST"
+    percent = 100
+  }
+
+  # This lifecycle block prevents Terraform from overwriting the container image when it's
+  # updated by Cloud Run deployments outside of Terraform (e.g., via CI/CD pipelines)
+  lifecycle {
+    ignore_changes = [
+      template[0].containers[0].image,
+    ]
+  }
+
+  # Make dependencies conditional to avoid errors.
+  depends_on = [
+    google_project_service.deploy_project_services,
+{%- if cookiecutter.is_adk and cookiecutter.session_type == "cloud_sql" %}
+    google_sql_user.db_user,
+    google_secret_manager_secret_version.db_password,
+{%- endif %}
+  ]
+}
+
+resource "google_cloud_run_v2_service" "app_prod" {
+  name                = var.project_name
+  location            = var.region
+  project             = var.prod_project_id
+  deletion_protection = false
+  ingress             = "INGRESS_TRAFFIC_ALL"
+  labels = {
+{%- if cookiecutter.is_adk %}
+    "created-by"                  = "adk"
+{%- endif %}
+{%- if cookiecutter.agent_garden %}
+    "deployed-with"               = "agent-garden"
+{%- if cookiecutter.agent_sample_id %}
+    "vertex-agent-sample-id"      = "{{cookiecutter.agent_sample_id}}"
+    "vertex-agent-sample-publisher" = "{{cookiecutter.agent_sample_publisher}}"
+{%- endif %}
+{%- endif %}
+  }
+
+  template {
+    containers {
+      # Placeholder, will be replaced by the CI/CD pipeline
+      image = "us-docker.pkg.dev/cloudrun/container/hello"
+
+{%- if cookiecutter.is_a2a %}
+      env {
+        name  = "APP_URL"
+        value = "https://${var.project_name}-${data.google_project.project["prod"].number}.${var.region}.run.app"
+      }
+
+{%- endif %}
+      resources {
+        limits = {
+          cpu    = "4"
+          memory = "8Gi"
+        }
+        cpu_idle = false
+      }
+{%- if cookiecutter.data_ingestion %}
+{%- if cookiecutter.datastore_type == "vertex_ai_search" %}
+
+      env {
+        name  = "DATA_STORE_ID"
+        value = resource.google_discovery_engine_data_store.data_store_prod.data_store_id
+      }
+
+      env {
+        name  = "DATA_STORE_REGION"
+        value = var.data_store_region
+      }
+{%- elif cookiecutter.datastore_type == "vertex_ai_vector_search" %}
+      env {
+        name  = "VECTOR_SEARCH_INDEX"
+        value = resource.google_vertex_ai_index.vector_search_index_prod.id
+      }
+
+      env {
+        name  = "VECTOR_SEARCH_INDEX_ENDPOINT"
+        value = resource.google_vertex_ai_index_endpoint.vector_search_index_endpoint_prod.id
+      }
+
+      env {
+        name  = "VECTOR_SEARCH_BUCKET"
+        value = resource.google_storage_bucket.vector_search_data_bucket["prod"].url
+      }
+{%- endif %}
+{%- endif %}
+
+{%- if cookiecutter.is_adk and cookiecutter.session_type == "cloud_sql" %}
+      # Mount the volume
+      volume_mounts {
+        name       = "cloudsql"
+        mount_path = "/cloudsql"
+      }
+
+      # Environment variables
+      env {
+        name  = "INSTANCE_CONNECTION_NAME"
+        value = google_sql_database_instance.session_db["prod"].connection_name
+      }
+
+      env {
+        name = "DB_PASS"
+        value_source {
+          secret_key_ref {
+            secret  = google_secret_manager_secret.db_password["prod"].secret_id
+            version = "latest"
+          }
+        }
+      }
+
+      env {
+        name  = "DB_NAME"
+        value = "${var.project_name}"
+      }
+
+      env {
+        name  = "DB_USER"
+        value = "${var.project_name}"
+      }
+{%- endif %}
+
+      env {
+        name  = "LOGS_BUCKET_NAME"
+        value = google_storage_bucket.logs_data_bucket[var.prod_project_id].name
+      }
+
+      env {
+        name  = "OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT"
+        value = "NO_CONTENT"
+      }
+    }
+
+    service_account                = google_service_account.app_sa["prod"].email
+    max_instance_request_concurrency = 40
+
+    scaling {
+      min_instance_count = 1
+      max_instance_count = 10
+    }
+
+    session_affinity = true
+
+{%- if cookiecutter.is_adk and cookiecutter.session_type == "cloud_sql" %}
+    # Cloud SQL volume
+    volumes {
+      name = "cloudsql"
+      cloud_sql_instance {
+        instances = [google_sql_database_instance.session_db["prod"].connection_name]
+      }
+    }
+{%- endif %}
+  }
+
+  traffic {
+    type    = "TRAFFIC_TARGET_ALLOCATION_TYPE_LATEST"
+    percent = 100
+  }
+
+  # This lifecycle block prevents Terraform from overwriting the container image when it's
+  # updated by Cloud Run deployments outside of Terraform (e.g., via CI/CD pipelines)
+  lifecycle {
+    ignore_changes = [
+      template[0].containers[0].image,
+    ]
+  }
+
+  # Make dependencies conditional to avoid errors.
+  depends_on = [
+    google_project_service.deploy_project_services,
+{%- if cookiecutter.is_adk and cookiecutter.session_type == "cloud_sql" %}
+    google_sql_user.db_user,
+    google_secret_manager_secret_version.db_password,
+{%- endif %}
+  ]
+}