Skip to content

README.md

Latest commit

 

History

History
75 lines (55 loc) · 2.54 KB

README.md

File metadata and controls

75 lines (55 loc) · 2.54 KB

Deployment

LLM provider configuration

DocsClaw supports three LLM providers. All configuration is carried in a single Kubernetes Secret named llm-secret, injected via envFrom.

Provider LLM_PROVIDER LLM_BASE_URL required? Example models
Anthropic anthropic No claude-sonnet-4-6, claude-opus-4-6, claude-haiku-4-5
OpenAI openai Yes (defaults to https://api.openai.com/v1) gpt-5.4, gpt-5.4-mini, gpt-5.4-nano
MaaS / LiteLLM litellm Yes qwen3-14b, deepseek-r1-distill-qwen-14b

Environment variables in the secret:

Variable Required Description
LLM_API_KEY Yes API key for the provider
LLM_PROVIDER Yes anthropic, openai, or litellm
LLM_MODEL No Model name (each provider has a default)
LLM_BASE_URL OpenAI/LiteLLM only API endpoint URL

To configure, copy the example for your provider and fill in the key:

# Pick one:
cp secrets/anthropic_example.yaml secrets/anthropic.yaml
cp secrets/openai_example.yaml    secrets/openai.yaml
cp secrets/maas_example.yaml      secrets/maas.yaml

# Edit to set LLM_API_KEY (and LLM_BASE_URL for MaaS), then:
oc apply -f secrets/<provider>.yaml

All three examples create the same llm-secret name, so only apply one. To switch providers, delete the old secret and apply the new one.

Local development

Source an environment file to set LLM provider variables:

cp environments/anthropic_example.env environments/anthropic.env
# Edit anthropic.env with your API key
source environments/anthropic.env

./bin/docsclaw serve --config-dir testdata/standalone

OpenShift / Kubernetes

  1. Create a namespace and the LLM secret (see above):
oc new-project docsclaw
oc apply -f secrets/anthropic.yaml   # or openai.yaml / maas.yaml
  1. Deploy the agent:
oc apply -f standalone-agent.yaml        # basic agent
oc apply -f agent-with-skills.yaml       # agent with skills

Files

Path Tracked Purpose
environments/*_example.env Yes Template env files for local dev
environments/*.env No Your local env files (gitignored)
secrets/*_example.yaml Yes Template K8s secrets
secrets/*.yaml No Your real secrets (gitignored)
standalone-agent.yaml Yes Basic agent (ConfigMap + Deployment + Service + Route)
agent-with-skills.yaml Yes Agent with skills (adds skill ConfigMaps)