* feat(terraform): expose key type on virtual keys
* docs(terraform): remove in-tree key type docs
* fix(terraform): preserve server-derived key routes
* fix(terraform): keep unconfigured key routes plan-known and unsent
Two regressions from exposing key_type on litellm_key:
1. Marking allowed_routes Computed makes an omitted attribute unknown at
plan time ("known only after apply"), so any plan that consumes it
before the key exists fails, e.g.
for_each = toset(coalesce(litellm_key.x.allowed_routes, [])).
Computed is dropped again; server-derived routes still land in state
through reads, and a DiffSuppressFunc keyed on the raw config keeps a
config that never declares the attribute from showing a perpetual
removal diff against those routes (a config that shrinks the list or
sets it still diffs).
2. mapResourceDataToKey copies allowed_routes unconditionally and
UpdateKey sends it when non-empty, so once reads materialize the
server's routes into state, every update re-asserts them: an
alias-only rename POSTs allowed_routes (the pre-key_type provider
sent none), and with stale state (-refresh=false) it silently
overwrites routes managed outside Terraform. Updates now omit the
field whenever the raw config does not declare it.
The key_type flow is unchanged: create still sends key_type, the proxy
presets the routes, reads materialize them into state, and plans stay
drift-free.
* fix(terraform): reject allowed_routes alongside a presetting key_type
The proxy derives allowed_routes from the key_type preset and overwrites
whatever the request declared, so a config combining the two could never
match what gets stored: the key came back with the preset routes and
drifted against the declared list on every plan. A CustomizeDiff now
fails the plan with an actionable message when a presetting key_type
(llm_api, management, read_only) is combined with allowed_routes.
key_type "default" presets nothing and keeps declared routes.
* fix(terraform): scope key_type route rejection to create-shaped plans
/key/update stores an explicit allowed_routes verbatim and never reapplies
the key_type preset, so an existing or imported typed key can manage its
routes in place. Only plans that create a key (fresh, or a replacement
that changes key_type) still reject the combination, because there the
preset always overwrites the declared list. A replacement forced by
another ForceNew attribute converges on the next apply, which re-sends
the declared routes.
* fix(terraform): restore declared routes on typed key creation
/key/generate replaces a declared allowed_routes with the key_type
preset while /key/update stores the list verbatim, so any create that
carries both (a fresh key, or a replacement forced by key_type or
another ForceNew attribute) used to leave the key holding the preset
instead of the declared routes until a second apply. When the generate
response does not match the declared list, create now follows up with an
update that re-sends the full create payload against the new key hash,
so the first apply already stores the declared routes. This also
replaces the plan-time rejection of the combination: every config shape
now converges, and existing typed keys keep managing routes in place as
before.
* fix(terraform): delete the key when a route restore fails at create
If /key/generate succeeds but the restore update is rejected, the key
exists server-side while terraform holds no state for it: an active key
with the type preset would be orphaned and a retried apply would mint
another one. The restore failure path now deletes the created key, and a
delete that also fails names the key hash in the error so an operator
can remove it manually.
* fix(terraform): make the route restore surgical and keep supplied keys
Two sharp edges on the create-time route restore:
- Re-sending the full create payload rewrote fields the config never
declared: /key/update is a merge patch, so the empty metadata and
model_rpm_limit/model_tpm_limit maps the restored struct carried would
clear server-applied values such as team-inherited rate limits. The
restore now sends only the routes plus the two fields /key/update
requires non-null (permissions, model_max_budget); every other stored
value is kept.
- /key/generate upserts a config-supplied key value, so a restore
failure on such a key must not delete it: it may be an existing
credential that predates this apply. The compensating delete now runs
only for proxy-minted keys, and the error names the hash either way.
* fix(terraform): echo stored permissions and budgets in route restore
The surgical restore body carried empty permissions and model_max_budget
objects, and /key/update writes fields that are present: a key created
with declared permissions or model budgets next to a presetting key_type
and allowed_routes lost them on the first apply. The restore now echoes
the values /key/generate just stored (falling back to the configured
values when the response omits them), so the only field the restore ever
changes is allowed_routes.
* test(terraform): pin echoed budgets in the route restore
Adds the nonempty model_max_budget case Greptile asked for (the restore
must echo the stored map, never clear it) and drops a comment that
restated its own line.
* test(terraform): assert the declared budget reaches key generation
The budget echo case fed the raw config a malformed JSON string (a
template leftover), so nothing verified the declared budget actually
reached /key/generate. The config now carries the valid JSON and the
generate payload is asserted to match it.
* chore(terraform): trim the restore test preface to the proxy facts
---------
Co-authored-by: Roman Soletskyi <roman@mistral.ai>
|
||
|---|---|---|
| .. | ||
| docs | ||
| examples | ||
| litellm | ||
| tools | ||
| .gitignore | ||
| .goreleaser.yml | ||
| CHANGELOG.md | ||
| go.mod | ||
| go.sum | ||
| LICENSE | ||
| main.go | ||
| Makefile | ||
| README.md | ||
| RELEASING.md | ||
| terraform-registry-manifest.json | ||
LiteLLM Terraform Provider
This Terraform provider allows you to manage LiteLLM resources through Infrastructure as Code. It provides support for managing models, teams, team members, API keys, users, organizations, budgets, tags, projects, guardrails, prompts, agents, search tools, access groups, fallbacks, MCP servers, credentials and vector stores via the LiteLLM REST API, along with read-only data sources for each of them.
Source of truth
This directory (terraform/provider/ in BerriAI/litellm) is the source of truth for the provider. BerriAI/terraform-provider-litellm is a thin release mirror that the public Terraform Registry ingests from; do not open PRs there. Changes land here, where CI builds the provider, runs its tests, and statically audits every endpoint the provider calls against the proxy's generated OpenAPI schema (tools/endpointaudit/), so the provider cannot drift from the LiteLLM API silently. The same audit runs in reverse as a coverage gate: every management endpoint in the schema must be covered by a resource or data source, or carry a documented entry in tools/endpointaudit/coverage_allowlist.txt, and stale allowlist entries fail CI. Releases are published by mirroring this directory into the split repo and tagging it, which triggers the goreleaser workflow there (see RELEASING.md)
Versioning
The provider version is the LiteLLM version. Every LiteLLM release (dev, rc and stable) publishes the provider at the same version as the proxy, built from the same commit, so 1.99.0 of the provider is the one that shipped with 1.99.0 of the proxy and was audited against that proxy's API. Pin the provider to the line your proxy runs:
version = "~> 1.99.0"
Pre-release versions (1.99.0-rc.1, 1.99.0-dev.1) are published too; Terraform only selects one when it is pinned exactly.
Versions 0.1.0 through 0.4.0 predate this scheme and sit on their own line. They stay in the registry, but a ~> 0.4 constraint will never pick up another release: re-pin to the LiteLLM version to keep receiving updates.
Features
- Manage LiteLLM model configurations
- Associate models with specific teams
- Create and manage teams
- Configure team members and their permissions
- Set usage limits and budgets
- Control access to specific models
- Specify model modes (e.g., completion, embedding, image generation)
- Manage API keys with fine-grained controls
- Support for reasoning effort configuration in the model resource
Requirements
Using the Provider
To use the LiteLLM provider in your Terraform configuration, you need to declare it in the terraform block:
terraform {
required_providers {
litellm = {
source = "BerriAI/litellm"
version = "~> 1.99.0" # the LiteLLM version your proxy runs
}
}
}
provider "litellm" {
api_base = var.litellm_api_base
api_key = var.litellm_api_key
}
Then, you can use the provider to manage LiteLLM resources. Here's an example of creating a model configuration:
resource "litellm_model" "gpt4" {
model_name = "gpt-4-proxy"
custom_llm_provider = "openai"
model_api_key = var.openai_api_key
model_api_base = "https://api.openai.com/v1"
base_model = "gpt-4"
tier = "paid"
mode = "chat"
reasoning_effort = "medium" # Optional: "low", "medium", or "high"
input_cost_per_million_tokens = 30.0
output_cost_per_million_tokens = 60.0
}
For full details on the litellm_model resource, see the model resource documentation.
Here's an example of creating an API key with various options:
resource "litellm_key" "example_key" {
key_type = "llm_api"
models = ["gpt-4", "claude-3.5-sonnet"]
max_budget = 100.0
user_id = "user123"
team_id = "team456"
max_parallel_requests = 5
tpm_limit = 1000
rpm_limit = 60
budget_duration = "monthly"
key_alias = "prod-key-1"
duration = "30d"
metadata = {
environment = "production"
}
allowed_cache_controls = ["no-cache", "max-age=3600"]
soft_budget = 80.0
aliases = {
"gpt-4" = "gpt4"
}
config = {
default_model = "gpt-4"
}
permissions = {
can_create_keys = "true"
}
model_max_budget = jsonencode({
"gpt-4" = {
budget_limit = 50.0
time_period = "30d"
}
})
model_rpm_limit = {
"claude-3.5-sonnet" = 30
}
model_tpm_limit = {
"gpt-4" = 500
}
guardrails = ["content_filter", "token_limit"]
blocked = false
tags = ["production", "api"]
}
The litellm_key resource supports the following options:
key_type: Choose the key's default route accessmodels: List of allowed models for this keymax_budget: Maximum budget for the keyuser_idandteam_id: Associate the key with a user and teammax_parallel_requests: Limit concurrent requeststpm_limitandrpm_limit: Set tokens and requests per minute limitsbudget_duration: Specify budget duration (e.g., "monthly", "weekly")key_alias: Set a friendly name for the keyduration: Set the key's validity periodmetadata: Add custom metadata to the keyallowed_cache_controls: Specify allowed cache control directivessoft_budget: Set a soft budget limitaliases: Define model aliasesconfig: Set configuration optionspermissions: Specify key permissionsmodel_max_budget,model_rpm_limit,model_tpm_limit: Set per-model limitsguardrails: Apply specific guardrails to the keyblocked: Flag to block/unblock the keytags: Add tags for organization and filtering
For full details on the litellm_key resource, see the key resource documentation.
Available Resources
litellm_model: Manage model configurations. Documentationlitellm_team: Manage teams. Documentationlitellm_team_member: Manage team members. Documentationlitellm_team_member_add: Add multiple members to teams. Documentationlitellm_key: Manage API keys. Documentationlitellm_mcp_server: Manage MCP (Model Context Protocol) servers. Documentationlitellm_credential: Manage credentials for secure authentication. Documentationlitellm_vector_store: Manage vector stores for embeddings and RAG. Documentationlitellm_jwt_key_mapping: Map JWT claim values to virtual keys for per-client budgets and limits. Documentation
Available Data Sources
litellm_credential: Retrieve information about existing credentials. Documentationlitellm_vector_store: Retrieve information about existing vector stores. Documentation
Development
Project Structure
The project is organized as follows:
terraform-provider-litellm/
├── litellm/
│ ├── provider.go
│ ├── resource_model.go
│ ├── resource_model_crud.go
│ ├── resource_team.go
│ ├── resource_team_member.go
│ ├── resource_key.go
│ ├── resource_key_utils.go
│ ├── types.go
│ └── utils.go
├── main.go
├── go.mod
├── go.sum
├── Makefile
└── ...
Building the Provider
- Clone the repository:
git clone https://github.com/your-username/terraform-provider-litellm.git
- Enter the repository directory:
cd terraform-provider-litellm
- Build and install the provider:
make install
Development Commands
The Makefile provides several useful commands for development:
make build: Builds the providermake install: Builds and installs the providermake test: Runs the test suitemake fmt: Formats the codemake vet: Runs go vetmake lint: Runs golangci-lintmake clean: Removes build artifacts and installed provider
Testing
To run the tests:
make test
Contributing
Contributions are welcome! Please read our contributing guidelines first.
License
This project is licensed under the Apache License 2.0 - see the LICENSE file for details.
Notes
- Always use environment variables or secure secret management solutions to handle sensitive information like API keys and AWS credentials.
- Refer to the comprehensive documentation in the
docs/directory for detailed usage examples and configuration options. - Keep the provider version in step with the LiteLLM version your proxy runs; see Versioning.
- The provider now supports AWS cross-account access with
aws_session_nameandaws_role_nameparameters in the model resource. - All example configurations have been consolidated into the documentation for better organization and maintenance.