Kafka functions: user guide
- Dominant language
- Go
- Stars
- 365
- Forks
- 223
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 25
Description
Document how to create, configure, and deploy a Kafka function. Should cover:
- Creating a function with `func create -l go -t kafka`
- Configuring Kafka connection (env vars: `KAFKA_BROKERS`, `KAFKA_TOPICS`, `KAFKA_CONSUMER_GROUP`)
- Setting env vars via `func.yaml` (plain values, Secrets, ConfigMaps)
- Handler signature and return value semantics (nil = commit, error = skip)
- Optional lifecycle hooks (Start, Stop, Ready, Alive)
- Health check endpoints
- Deployment with `min-scale: 1` requirement
- Scaling considerations (no HTTP traffic, consumer must stay running)
Contributor guide
Research direction
Start by locating the user-guide structure and the Kafka function flow created by `func create -l go -t kafka`. Cover the listed Kafka environment variables, `func.yaml` values, handler and lifecycle semantics, health checks, deployment, and scaling guidance. Done means a complete guide that includes the `min-scale: 1` requirement and all requested examples.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go, kafka
- Domain
- documentation, stream-processing
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 72/100