agent-starter-pack 0.2.2__py3-none-any.whl → 0.3.0__py3-none-any.whl

agents/agentic_rag/notebooks/adk_app_testing.ipynb

@@ -0,0 +1,305 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# ADK Application Testing\n",
+    "\n",
+    "This notebook demonstrates how to test an ADK (Agent Development Kit) application.\n",
+    "It covers both local and remote testing, both with Agent Engine and Cloud Run.\n",
+    "\n",
+    "<img src=\"https://github.com/GoogleCloudPlatform/agent-starter-pack/blob/main/docs/images/adk_logo.png?raw=true\" width=\"400\">\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Import libraries"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import json\n",
+    "\n",
+    "import requests\n",
+    "import vertexai.agent_engines"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## If you are using Agent Engine\n",
+    "See more documentation at [Agent Engine Overview](https://cloud.google.com/vertex-ai/generative-ai/docs/agent-engine/overview)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Local Testing\n",
+    "\n",
+    "You can import directly the AgentEngineApp class within your environment. "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from app.agent import root_agent\n",
+    "from app.agent_engine_app import AgentEngineApp\n",
+    "\n",
+    "agent_engine = AgentEngineApp(agent=root_agent)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "for event in agent_engine.stream_query(message=\"hi!\", user_id=\"test\"):\n",
+    "    print(event)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Remote Testing"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Replace with your Agent Engine ID\n",
+    "AGENT_ENGINE_ID = \"projects/PROJECT_ID/locations/us-central1/reasoningEngines/ENGINE_ID\""
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "remote_agent_engine = vertexai.agent_engines.get(AGENT_ENGINE_ID)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "for event in remote_agent_engine.stream_query(message=\"hi!\", user_id=\"test\"):\n",
+    "    print(event)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## If you are using Cloud Run"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Local Testing\n",
+    "\n",
+    "> You can run the application locally via the `make backend` command."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Create a session\n",
+    " Create a new session with user preferences and state information\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "user_id = \"test_user_123\"\n",
+    "session_id = \"test_session_456\"\n",
+    "session_data = {\"state\": {\"preferred_language\": \"English\", \"visit_count\": 1}}\n",
+    "\n",
+    "session_url = f\"http://127.0.0.1:8000/apps/app/users/{user_id}/sessions/{session_id}\"\n",
+    "headers = {\"Content-Type\": \"application/json\"}\n",
+    "\n",
+    "session_response = requests.post(session_url, headers=headers, json=session_data)\n",
+    "print(f\"Session creation status code: {session_response.status_code}\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Send a message\n",
+    "Send a message to the backend service and receive a streaming response\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "message_data = {\n",
+    "    \"app_name\": \"app\",\n",
+    "    \"user_id\": user_id,\n",
+    "    \"session_id\": session_id,\n",
+    "    \"new_message\": {\"role\": \"user\", \"parts\": [{\"text\": \"Hello! Weather in New york?\"}]},\n",
+    "    \"streaming\": True,\n",
+    "}\n",
+    "\n",
+    "message_url = \"http://127.0.0.1:8000/run_sse\"\n",
+    "message_response = requests.post(\n",
+    "    message_url, headers=headers, json=message_data, stream=True\n",
+    ")\n",
+    "\n",
+    "print(f\"Message send status code: {message_response.status_code}\")\n",
+    "\n",
+    "# Print streamed response\n",
+    "for line in message_response.iter_lines():\n",
+    "    if line:\n",
+    "        line_str = line.decode(\"utf-8\")\n",
+    "        if line_str.startswith(\"data: \"):\n",
+    "            event_json = line_str[6:]\n",
+    "            event = json.loads(event_json)\n",
+    "            print(f\"Received event: {event}\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Remote Testing\n",
+    "\n",
+    "For more information about authenticating HTTPS requests to Cloud Run services, see:\n",
+    "[Cloud Run Authentication Documentation](https://cloud.google.com/run/docs/triggering/https-request)\n",
+    "\n",
+    "Remote testing involves using a deployed service URL instead of localhost.\n",
+    "\n",
+    "Authentication is handled using GCP identity tokens instead of local credentials."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 20,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "ID_TOKEN = get_ipython().getoutput(\"gcloud auth print-identity-token -q\")[0]"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "SERVICE_URL = \"YOUR_SERVICE_URL_HERE\"  # Replace with your Cloud Run service URL"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "You'll need to first create a Session"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "user_id = \"test_user_123\"\n",
+    "session_id = \"test_session_456\"\n",
+    "session_data = {\"state\": {\"preferred_language\": \"English\", \"visit_count\": 1}}\n",
+    "\n",
+    "session_url = f\"{SERVICE_URL}/apps/app/users/{user_id}/sessions/{session_id}\"\n",
+    "headers = {\"Content-Type\": \"application/json\", \"Authorization\": f\"Bearer {ID_TOKEN}\"}\n",
+    "\n",
+    "session_response = requests.post(session_url, headers=headers, json=session_data)\n",
+    "print(f\"Session creation status code: {session_response.status_code}\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Then you will be able to send a message"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "message_data = {\n",
+    "    \"app_name\": \"app\",\n",
+    "    \"user_id\": user_id,\n",
+    "    \"session_id\": session_id,\n",
+    "    \"new_message\": {\"role\": \"user\", \"parts\": [{\"text\": \"Hello! Weather in New york?\"}]},\n",
+    "    \"streaming\": True,\n",
+    "}\n",
+    "\n",
+    "message_url = f\"{SERVICE_URL}/run_sse\"\n",
+    "message_response = requests.post(\n",
+    "    message_url, headers=headers, json=message_data, stream=True\n",
+    ")\n",
+    "\n",
+    "print(f\"Message send status code: {message_response.status_code}\")\n",
+    "\n",
+    "# Print streamed response\n",
+    "for line in message_response.iter_lines():\n",
+    "    if line:\n",
+    "        line_str = line.decode(\"utf-8\")\n",
+    "        if line_str.startswith(\"data: \"):\n",
+    "            event_json = line_str[6:]\n",
+    "            event = json.loads(event_json)\n",
+    "            print(f\"Received event: {event}\")"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": ".venv",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.12.8"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

agents/agentic_rag/template/.templateconfig.yaml

@@ -17,10 +17,12 @@ settings:
   requires_data_ingestion: true
   deployment_targets: ["agent_engine", "cloud_run"]
   extra_dependencies: [
+    "google-adk~=0.1.0",
     "langchain-google-vertexai~=2.0.7",
     "langchain~=0.3.14",
-    "langgraph~=0.3.21",
     "langchain-community~=0.3.17",
     "langchain-openai~=0.3.5",
     "langchain-google-community[vertexaisearch]~=2.0.7",
   ]
+  tags: ["adk"]
+  frontend_type: "streamlit_adk"

agents/agentic_rag/tests/integration/test_agent.py

@@ -15,43 +15,50 @@
 # mypy: disable-error-code="union-attr"
 from unittest.mock import MagicMock, patch
 
-from app.agent import agent
+from google.adk.agents.run_config import RunConfig, StreamingMode
+from google.adk.runners import Runner
+from google.adk.sessions import InMemorySessionService
+from google.genai import types
+
+from app.agent import root_agent
 
 
 @patch(
-    "app.agent.retrieve_docs.func",
-    return_value=("dummy content", [{"page_content": "Test document content"}]),
+    "app.agent.retrieve_docs",
+    return_value="dummy content",
 )
 def test_agent_stream(mock_retrieve: MagicMock) -> None:
     """
     Integration test for the agent stream functionality.
     Tests that the agent returns valid streaming responses.
     """
-    input_dict = {
-        "messages": [
-            {"type": "human", "content": "Hi"},
-            {"type": "ai", "content": "Hi there!"},
-            {
-                "type": "human",
-                "content": "How to split a string with pattern 'alphabet/alphabet' and not split 'number/number' in same string",
-            },
-        ]
-    }
-
-    events = [
-        message for message, _ in agent.stream(input_dict, stream_mode="messages")
-    ]
-
-    # Verify we get a reasonable number of messages
-    assert len(events) > 0, "Expected at least one message"
 
-    # First message should be an AI message
-    assert events[0].type == "AIMessageChunk"
+    session_service = InMemorySessionService()
+
+    session = session_service.create_session(user_id="test_user", app_name="test")
+    runner = Runner(agent=root_agent, session_service=session_service, app_name="test")
+
+    message = types.Content(
+        role="user", parts=[types.Part.from_text(text="Why is the sky blue?")]
+    )
+
+    events = list(
+        runner.run(
+            new_message=message,
+            user_id="test_user",
+            session_id=session.id,
+            run_config=RunConfig(streaming_mode=StreamingMode.SSE),
+        )
+    )
+    assert len(events) > 0, "Expected at least one message"
 
-    # At least one message should have content
-    has_content = False
+    has_text_content = False
     for event in events:
-        if hasattr(event, "content") and event.content:
-            has_content = True
+        if (
+            event.content
+            and event.content.parts
+            and any(part.text for part in event.content.parts)
+        ):
+            has_text_content = True
             break
-    assert has_content, "Expected at least one message with content"
+    assert has_text_content, "Expected at least one message with text content"

agents/langgraph_base_react/README.md

@@ -1,6 +1,6 @@
 # LangGraph Base React Agent
 
-A minimal example demonstrating how to build a reactive agent using LangGraph. This agent serves as an excellent starting point for developers looking to implement LangGraph-based solutions.
+A minimal example demonstrating how to build a ReAct agent using LangGraph. This agent serves as an excellent starting point for developers looking to implement LangGraph-based solutions.
 
 ## Key Features
 

agents/langgraph_base_react/template/.templateconfig.yaml

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-description: "A agent implementing a base ReAct agent using LangGraph"
+description: "An agent implementing a base ReAct agent using LangGraph"
 settings:
   requires_data_ingestion: false
   deployment_targets: ["agent_engine", "cloud_run"]

src/base_template/Makefile

@@ -1,11 +1,19 @@
 install:
-	@command -v uv >/dev/null 2>&1 || { echo "uv is not installed. Installing uv..."; curl -LsSf https://astral.sh/uv/install.sh | sh; source ~/.bashrc; }
+	@command -v uv >/dev/null 2>&1 || { echo "uv is not installed. Installing uv..."; curl -LsSf https://astral.sh/uv/0.6.12/install.sh | sh; source ~/.bashrc; }
 	uv sync --dev {% if cookiecutter.agent_name != 'live_api' %}--extra streamlit{%- endif %} --extra jupyter --frozen{% if cookiecutter.agent_name == 'live_api' %} && npm --prefix frontend install{%- endif %}
 
 test:
 	uv run pytest tests/unit && uv run pytest tests/integration
 
 playground:
+{%- if "adk" in cookiecutter.tags %}
+	@echo "+-----------------------------------------------------------------------------+"
+	@echo "| Starting ADK Web Server via 'adk web' command.                              |"
+	@echo "|                                                                             |"
+	@echo "| Please select the app folder to start interacting with your agent.          |"
+	@echo "+-----------------------------------------------------------------------------+"
+	uv run adk web
+{%- else %}
 {%- if cookiecutter.deployment_target == 'cloud_run' %}
 	uv run uvicorn app.server:app --host 0.0.0.0 --port 8000 --reload &
 {%- endif %}
@@ -14,12 +22,15 @@ playground:
 {%- else %}
 	{% if cookiecutter.deployment_target == 'agent_engine' %}PYTHONPATH=. {% endif %}uv run streamlit run frontend/streamlit_app.py --browser.serverAddress=localhost --server.enableCORS=false --server.enableXsrfProtection=false
 {%- endif %}
+{%- endif %}
 
 backend:
 {%- if cookiecutter.deployment_target == 'cloud_run' %}
 	uv run uvicorn app.server:app --host 0.0.0.0 --port 8000 --reload
 {%- elif cookiecutter.deployment_target == 'agent_engine' %}
-	uv export --no-hashes --no-sources --no-header --no-emit-project --frozen > .requirements.txt && uv run app/agent_engine_app.py
+	# Export dependencies to requirements file using uv export (preferred method), otherwise fall back to uv pip freeze
+	uv export --no-hashes --no-sources --no-header --no-dev --no-emit-project --no-annotate --frozen > .requirements.txt 2>/dev/null || \
+	uv pip freeze --exclude-editable > .requirements.txt && uv run app/agent_engine_app.py
 {%- endif %}
 
 {% if cookiecutter.deployment_target == 'cloud_run' -%}
@@ -34,8 +45,7 @@ ui:
 setup-dev-env:
 	@if [ -z "$$PROJECT_ID" ]; then echo "Error: PROJECT_ID environment variable is not set"; exit 1; fi
 	(cd deployment/terraform/dev && terraform init && terraform apply --var-file vars/env.tfvars --var dev_project_id=$$PROJECT_ID --auto-approve)
-	
-{%- if cookiecutter.data_ingestion%}
+{% if cookiecutter.data_ingestion %}
 data-ingestion:
 	@if [ -z "$$PROJECT_ID" ]; then echo "Error: PROJECT_ID environment variable is not set"; exit 1; fi
 	$(MAKE) install
@@ -48,6 +58,7 @@ data-ingestion:
 {%- elif cookiecutter.datastore_type == "vertex_ai_vector_search" %}
 		--vector-search-index="{{cookiecutter.project_name}}-vector-search" \
 		--vector-search-index-endpoint="{{cookiecutter.project_name}}-vector-search-endpoint" \
+		--vector-search-data-bucket-name="$$PROJECT_ID-{{cookiecutter.project_name}}-vs" \
 {%- endif %}
 		--service-account="{{cookiecutter.project_name}}-rag@$$PROJECT_ID.iam.gserviceaccount.com" \
 		--pipeline-root="gs://$$PROJECT_ID-{{cookiecutter.project_name}}-rag" \

src/base_template/README.md

@@ -47,7 +47,7 @@ make install && make playground
 | -------------------- | ------------------------------------------------------------------------------------------- |
 | `make install`       | Install all required dependencies using uv                                                  |
 {%- if cookiecutter.deployment_target == 'cloud_run' %}
-| `make playground`    | Launch local development environment with backend and frontend |
+| `make playground`    | Launch local development environment with backend and frontend{%- if "adk" in cookiecutter.tags %} - leveraging `adk web` command. {%- endif %}|
 | `make backend`       | Start backend server only |
 | `make ui`            | Launch Streamlit frontend without local backend |
 {%- elif cookiecutter.deployment_target == 'agent_engine' %}
@@ -56,6 +56,10 @@ make install && make playground
 {%- endif %}
 | `make test`          | Run unit and integration tests                                                              |
 | `make lint`          | Run code quality checks (codespell, ruff, mypy)                                             |
+| `make setup-dev-env` | Set up development environment resources using Terraform                                    |
+{%- if cookiecutter.data_ingestion %}
+| `make data-ingestion`| Run data ingestion pipeline in the Dev environment                                           |
+{%- endif %}
 | `uv run jupyter lab` | Launch Jupyter notebook                                                                     |
 
 For full command options and usage, refer to the [Makefile](Makefile).
@@ -144,12 +148,14 @@ This template follows a "bring your own agent" approach - you focus on your busi
 1. **Prototype:** Build your Generative AI Agent using the intro notebooks in `notebooks/` for guidance. Use Vertex AI Evaluation to assess performance.
 2. **Integrate:** Import your agent into the app by editing `app/agent.py`.
 3. **Test:** Explore your agent functionality using the Streamlit playground with `make playground`. The playground offers features like chat history, user feedback, and various input types, and automatically reloads your agent on code changes.
-4. **Deploy:** Configure and trigger the CI/CD pipelines, editing tests if needed. See the [deployment section](#deployment) for details.
+4. **Deploy:** Set up and initiate the CI/CD pipelines, customizing tests as necessary. Refer to the [deployment section](#deployment) for comprehensive instructions. For streamlined infrastructure deployment, simply run `agent-starter-pack setup-cicd`. Check out the [`agent-starter-pack setup-cicd` CLI command](https://github.com/GoogleCloudPlatform/agent-starter-pack/blob/main/docs/cli/setup_cicd.md). Currently only supporting Github.
 5. **Monitor:** Track performance and gather insights using Cloud Logging, Tracing, and the Looker Studio dashboard to iterate on your application.
 {% endif %}
 
 ## Deployment
 
+> **Note:** For a streamlined one-command deployment of the entire CI/CD pipeline and infrastructure using Terraform, you can use the [`agent-starter-pack setup-cicd` CLI command](https://github.com/GoogleCloudPlatform/agent-starter-pack/blob/main/docs/cli/setup_cicd.md). Currently only supporting Github.
+
 ### Dev Environment
 
 {%- if cookiecutter.deployment_target == 'agent_engine' %}

src/base_template/app/__init__.py

@@ -0,0 +1,3 @@
+from app.agent import root_agent
+
+__all__ = ["root_agent"]

src/base_template/app/utils/tracing.py

@@ -86,8 +86,18 @@ class CloudTraceLoggingSpanExporter(CloudTraceSpanExporter):
                 print(span_dict)
 
             # Log the span data to Google Cloud Logging
+{%- if "adk" in cookiecutter.tags %}
+            self.logger.log_struct(
+                span_dict,
+                labels={
+                    "type": "agent_telemetry",
+                    "service_name": "{{cookiecutter.project_name}}",
+                },
+                severity="INFO",
+            )
+{%- else %}
             self.logger.log_struct(span_dict, severity="INFO")
-
+{%- endif %}
         # Export spans to Google Cloud Trace using the parent class method
         return super().export(spans)
 

src/base_template/app/utils/typing.py

@@ -12,6 +12,29 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+{%- if "adk" in cookiecutter.tags %}
+{%- if cookiecutter.deployment_target == 'cloud_run' %}
+import uuid
+from typing import (
+    Literal,
+)
+
+from google.adk.events.event import Event
+from google.genai.types import Content
+from pydantic import (
+    BaseModel,
+    Field,
+)
+{%- else %}
+from typing import (
+    Literal,
+)
+
+from pydantic import (
+    BaseModel,
+)
+{%- endif %}
+{%- else %}
 import json
 import uuid
 from typing import (
@@ -31,6 +54,24 @@ from pydantic import (
     BaseModel,
     Field,
 )
+{%- endif %}
+
+
+{%- if "adk" in cookiecutter.tags %}
+{%- if cookiecutter.deployment_target == 'cloud_run' %}
+
+
+class Request(BaseModel):
+    """Represents the input for a chat request with optional configuration."""
+
+    message: Content
+    events: list[Event]
+    user_id: str = Field(default_factory=lambda: str(uuid.uuid4()))
+    session_id: str = Field(default_factory=lambda: str(uuid.uuid4()))
+
+    model_config = {"extra": "allow"}
+{%- endif %}
+{%- else %}
 
 
 class InputChat(BaseModel):
@@ -42,7 +83,7 @@ class InputChat(BaseModel):
         ..., description="The chat messages representing the current conversation."
     )
 
-{% if cookiecutter.deployment_target == 'cloud_run' %}
+
 class Request(BaseModel):
     """Represents the input for a chat request with optional configuration.
 
@@ -54,16 +95,23 @@ class Request(BaseModel):
     input: InputChat
     config: RunnableConfig | None = None
 
-{% endif %}
+{%- endif %}
+
+
 class Feedback(BaseModel):
     """Represents feedback for a conversation."""
 
     score: int | float
     text: str | None = ""
+{%- if "adk" in cookiecutter.tags %}
+    invocation_id: str
+{%- else %}
     run_id: str
+{%- endif %}
     log_type: Literal["feedback"] = "feedback"
     service_name: Literal["{{cookiecutter.project_name}}"] = "{{cookiecutter.project_name}}"
-
+    user_id: str = ""
+{% if "adk" not in cookiecutter.tags %}
 
 def ensure_valid_config(config: RunnableConfig | None) -> RunnableConfig:
     """Ensures a valid RunnableConfig by setting defaults for missing fields."""
@@ -99,7 +147,8 @@ def dumps(obj: Any) -> str:
         JSON string representation of the object
     """
     return json.dumps(obj, default=default_serialization)
-{% if cookiecutter.deployment_target == 'agent_engine' %}
+{%- if cookiecutter.deployment_target == 'agent_engine' %}
+
 
 def dumpd(obj: Any) -> Any:
     """
@@ -113,4 +162,5 @@ def dumpd(obj: Any) -> Any:
         Dict/list representation of the object that can be JSON serialized
     """
     return json.loads(dumps(obj))
+{%- endif %}
 {% endif %}

src/base_template/deployment/README.md

@@ -29,6 +29,8 @@ The application leverages [**Terraform**](http://terraform.io) to define and pro
 
 ## Setup
 
+> **Note:** For a streamlined one-command deployment of the entire CI/CD pipeline and infrastructure using Terraform, you can use the [`agent-starter-pack setup-cicd` CLI command](https://github.com/GoogleCloudPlatform/agent-starter-pack/blob/main/docs/cli/setup_cicd.md). Currently only supporting Github.
+
 **Prerequisites:**
 
 1. A set of Google Cloud projects:
@@ -58,6 +60,7 @@ The application leverages [**Terraform**](http://terraform.io) to define and pro
 
    | Variable               | Description                                                     | Required |
    | ---------------------- | --------------------------------------------------------------- | :------: |
+   | project_name           | Project name used as a base for resource naming                 |   Yes    |
    | prod_project_id        | **Production** Google Cloud Project ID for resource deployment. |   Yes    |
    | staging_project_id     | **Staging** Google Cloud Project ID for resource deployment.    |   Yes    |
    | cicd_runner_project_id | Google Cloud Project ID where CI/CD pipelines will execute.     |   Yes    |
@@ -65,7 +68,7 @@ The application leverages [**Terraform**](http://terraform.io) to define and pro
    | host_connection_name   | Name of the host connection you created in Cloud Build          |   Yes    |
    | repository_name        | Name of the repository you added to Cloud Build                 |   Yes    |
 
-   Other optional variables include: telemetry and feedback BigQuery dataset IDs, log filters, sink names, service account names, bucket name suffixes, artifact registry repository name, and various role assignments.
+   Other optional variables may include: telemetry and feedback log filters, service account roles, and for projects requiring data ingestion: pipeline cron schedule, pipeline roles, and datastore-specific configurations.
 
 4. **Deploy Infrastructure with Terraform**