121 lines
4.8 KiB
Markdown
121 lines
4.8 KiB
Markdown
# Agent Gateway
|
|
|
|
The module facilitates the deployments of Agent Gateways.
|
|
|
|
<!-- BEGIN TOC -->
|
|
- [API](#api)
|
|
- [Minimal Gateway deployment](#minimal-gateway-deployment)
|
|
- [PSC-I: attach to an existing service attachment](#psc-i-attach-to-an-existing-service-attachment)
|
|
- [Connect to self-managed proxies](#connect-to-self-managed-proxies)
|
|
- [Context](#context)
|
|
- [Variables](#variables)
|
|
- [Outputs](#outputs)
|
|
<!-- END TOC -->
|
|
|
|
## API
|
|
|
|
In order to use this module you first need to enable the `networkservices.googleapis.com` API.
|
|
|
|
## Minimal Gateway deployment
|
|
|
|
In order to deploy a gateway, you need to specify a name, a region and the direction it needs to apply to.
|
|
|
|
```hcl
|
|
module "agent-gateway" {
|
|
source = "./fabric/modules/agent-gateway"
|
|
name = "my-gateway"
|
|
project_id = "my-project-id"
|
|
region = "europe-west1"
|
|
access_path = "CLIENT_TO_AGENT" # can be also: ingress, or egress (or AGENT_TO_ANYWHERE)
|
|
}
|
|
# tftest inventory=minimal.yaml
|
|
```
|
|
|
|
## PSC-I: attach to an existing service attachment
|
|
|
|
If it's a egress (or AGENT_TO_ANYWHERE) agent, you can attach with a PSC interface to an existing service attachment.
|
|
|
|
```hcl
|
|
module "agent-gateway" {
|
|
source = "./fabric/modules/agent-gateway"
|
|
name = "my-gateway"
|
|
project_id = "my-project-id"
|
|
region = "europe-west1"
|
|
access_path = "AGENT_TO_ANYWHERE"
|
|
networking_config = {
|
|
psc_i_network_attachment_id = "projects/my-project-id/regions/europe-west1/serviceAttachments/my-sa"
|
|
}
|
|
}
|
|
# tftest inventory=psc-i.yaml
|
|
```
|
|
|
|
## Connect to self-managed proxies
|
|
|
|
You can connect to compatible proxies you manage, by specifying the proxy uri.
|
|
|
|
```hcl
|
|
module "agent-gateway" {
|
|
source = "./fabric/modules/agent-gateway"
|
|
name = "my-gateway"
|
|
project_id = "my-project-id"
|
|
region = "europe-west1"
|
|
is_google_managed = false
|
|
proxy_uri = "my-proxy-uri"
|
|
}
|
|
# tftest inventory=proxy.yaml
|
|
```
|
|
|
|
## Context
|
|
|
|
The module supports the contexts interpolation. For example:
|
|
|
|
```hcl
|
|
module "agent-gateway" {
|
|
source = "./fabric/modules/agent-gateway"
|
|
name = "my-gateway"
|
|
project_id = "$project_ids:main"
|
|
region = "$locations:primary"
|
|
access_path = "AGENT_TO_ANYWHERE"
|
|
networking_config = {
|
|
psc_i_network_attachment_id = "$psc_network_attachments:my-sa"
|
|
}
|
|
context = {
|
|
locations = {
|
|
primary = "europe-west1"
|
|
}
|
|
project_ids = {
|
|
main = "my-prj-id"
|
|
}
|
|
psc_network_attachments = {
|
|
my-sa = "projects/my-project-id/regions/europe-west1/serviceAttachments/my-sa"
|
|
}
|
|
}
|
|
}
|
|
# tftest inventory=context.yaml
|
|
```
|
|
<!-- BEGIN TFDOC -->
|
|
## Variables
|
|
|
|
| name | description | type | required | default |
|
|
|---|---|:---:|:---:|:---:|
|
|
| [name](variables.tf#L77) | The name of the Agent Gateway. | <code>string</code> | ✓ | |
|
|
| [project_id](variables.tf#L93) | The ID of the project where the data stores and the agents will be created. | <code>string</code> | ✓ | |
|
|
| [region](variables.tf#L126) | The region where the agent gateway is created. | <code>string</code> | ✓ | |
|
|
| [access_path](variables.tf#L17) | The direction the gateway applies to: ingress (CLIENT_TO_AGENT) or egress (AGENT_TO_ANYWHERE) (if var.is_google_managed = false). | <code>string</code> | | <code>null</code> |
|
|
| [context](variables.tf#L47) | Context-specific interpolations. | <code>object({…})</code> | | <code>{}</code> |
|
|
| [description](variables.tf#L58) | The description of the Agent Gateway. | <code>string</code> | | <code>"Terraform managed."</code> |
|
|
| [is_google_managed](variables.tf#L64) | Whether the Agent Gateway is Google or self-managed. | <code>bool</code> | | <code>true</code> |
|
|
| [labels](variables.tf#L71) | Labels to associate to the Agent Gateway. | <code>map(string)</code> | | <code>null</code> |
|
|
| [networking_config](variables.tf#L84) | The Agent Gateway networking configuration. | <code>object({…})</code> | | <code>{}</code> |
|
|
| [protocols](variables.tf#L99) | The protocols managed by the Agent Gateway. | <code>list(string)</code> | | <code>["MCP"]</code> |
|
|
| [proxy_uri](variables.tf#L111) | The uri of a compatible self-managed proxy (if var.is_google_managed = false). | <code>string</code> | | <code>null</code> |
|
|
| [registries](variables.tf#L132) | A list of Agent Registries containing the agents, MCP servers and tools governed by the Agent Gateway. Note: Currently limited to project-scoped registries Must be of format //agentregistry.googleapis.com/{version}/projects/{{project}}/locations/{{location}}. | <code>list(string)</code> | | <code>null</code> |
|
|
|
|
## Outputs
|
|
|
|
| name | description | sensitive |
|
|
|---|---|:---:|
|
|
| [agent_gateway](outputs.tf#L17) | The Agent Gateway object. | |
|
|
| [id](outputs.tf#L22) | The Agent Gateway id. | |
|
|
<!-- END TFDOC -->
|