Kafka functions: user guide
Maintainers usually reply within 5 days
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 72/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- go, kafka
- Domain
- documentation, stream-processing
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.
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: 1requirement - Scaling considerations (no HTTP traffic, consumer must stay running)
- Dominant language
- Go
- Stars
- 365
- Forks
- 223
- Avg merge
- 3d 7h
- Merged PRs (30d)
- 13
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from knative/func
-
KEDA deployer: default minReplicaCount prevents scale-to-zeroPossibly taken @Tushar-Khandelwal-2004 claimed this 96 days ago. Openlifecycle/stale
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
knative/func#3924 · 1 comment ·
Maintainers usually reply within 5 days
-
ImageNameWithDigest produces invalid OCI reference when Build.Image is emptyPossibly taken @Elvand-Lie claimed this 109 days ago. Openlifecycle/stale
Difficulty 1/5 Under an hour Newbie friendliness 88/100
knative/func#3902 · 1 comment ·
Maintainers usually reply within 5 days
-
setServiceOptions: %f format produces invalid autoscaling annotation values with trailing zerosPossibly taken @Elvand-Lie claimed this 109 days ago. Openlifecycle/stale
Difficulty 1/5 Under an hour Newbie friendliness 90/100
knative/func#3901 · 1 comment ·
Maintainers usually reply within 5 days
-
git/gitlab: default project webhooks to SSL verification when creating hooksPossibly taken @Vi-shub claimed this 143 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 5 days
-
mcp: config add/remove handlers bypass readonly guardPossibly taken @Elvand-Lie claimed this 145 days ago. Openkind/bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
knative/func#3704 · 1 comment ·
Maintainers usually reply within 5 days
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
prime-radiant-inc/evener#3726 ·
Maintainers usually reply within 1 day
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
temporalio/deputy#400 ·
Maintainers usually reply within 1 day
-
[BUG] Async engine endpoint-label relationship counts include pending relationships of every typeOpen
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
status/0-needs-triage
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day