chore: cleanup env vars and self hosting docs#4420
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull request overview
This PR removes several legacy server/database/limits configuration fields and their environment variable bindings, and updates self-hosting documentation to reflect the current configuration surface (Kubernetes Helm and Docker Compose guidance, plus the configuration options reference).
Changes:
- Removed unused config fields and
BindEnvmappings frompkg/config/serverandpkg/config/database. - Removed obsolete limits fields from
pkg/config/limits. - Updated self-hosting docs (Helm quickstart/config, Docker Compose networking note, and the env-var reference page).
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| pkg/config/server/server.go | Removes legacy runtime fields and env var bindings from server config. |
| pkg/config/limits/limits.go | Removes unused limits fields from the limits config struct. |
| pkg/config/database/config.go | Removes legacy DB pool/seed env config fields and bindings. |
| frontend/docs/pages/self-hosting/kubernetes-quickstart.mdx | Updates Helm install command and quickstart job explanation. |
| frontend/docs/pages/self-hosting/kubernetes-helm-configuration.mdx | Updates Helm values example for seeding and shared config. |
| frontend/docs/pages/self-hosting/docker-compose.mdx | Updates guidance for gRPC broadcast address port inside the Docker network. |
| frontend/docs/pages/self-hosting/configuration-options.mdx | Updates and trims the env-var reference list and examples. |
|
|
|
|
|
|
|
|
There was a problem hiding this comment.
Two notes:
- It looks like we're missing the buffer configuration settings for the mq sub buffer / mq pub buffer
- It looks like we don't have the dual writes environment variables here either, and importantly we should probably be disabling the dual writes by default (will need to check with @mrkaye97 on that)
This is just on first glance, but I suspect we haven't caught other cases if I caught this with just a quick look.
There was a problem hiding this comment.
If we're disabling dual writes by default, can we just remove those code paths instead? It's effectively the same at this point, and I suspect nobody is manually enabling them because they don't know to do so, and it's been a long time of running with support for that at this point
There was a problem hiding this comment.
I am open to removing those code paths but that may severely bloat the PR and its intended outcome. Happy to open a followup PR later though.
cc @abelanger5
There was a problem hiding this comment.
That’s fine, follow up PR works for me if we’re good with going that route
|
|
||
| ```yaml | ||
| SERVER_GRPC_BROADCAST_ADDRESS: "hatchet-engine:7077" | ||
| SERVER_GRPC_BROADCAST_ADDRESS: "hatchet-engine:7070" |
There was a problem hiding this comment.
We've tested this? I remember some back and forth on this somewhere, I wonder if it has to do with the networking mode of the docker instance, or perhaps it's just incorrect 🤷♂️
There was a problem hiding this comment.
Yup, tested this locally
|
|
|
|
Description
Gets rid of older env vars that are no longer references anywhere. Updates self hosting docs accordingly for errors.
Specifically these vars have been removed across all references:
SERVER_FLUSH_STRATEGYSERVER_LIMITS_DEFAULT_CRON_LIMITSERVER_TLS_SERVER_NAMESERVER_LIMITS_DEFAULT_CRON_ALARM_LIMITSERVER_TASK_OPERATION_LIMITS_TIMEOUT_LIMITSERVER_LIMITS_DEFAULT_SCHEDULE_LIMITSERVER_TASK_OPERATION_LIMITS_REASSIGN_LIMITSERVER_LIMITS_DEFAULT_SCHEDULE_ALARM_LIMITSERVER_TASK_OPERATION_LIMITS_RETRY_QUEUE_LIMITSERVER_WAIT_FOR_FLUSHSERVER_TASK_OPERATION_LIMITS_DURABLE_SLEEP_LIMITSERVER_MAX_CONCURRENTSERVER_DEFAULT_ENGINE_VERSIONSERVER_FLUSH_PERIOD_MILLISECONDSSERVER_REQUEUE_LIMITSERVER_FLUSH_ITEMS_THRESHOLDSERVER_UPDATE_HASH_FACTORDATABASE_MAX_QUEUE_CONNSSERVER_UPDATE_CONCURRENT_FACTORDATABASE_MIN_QUEUE_CONNSSEED_DEVELOPMENTType of change
Checklist
Changes have been:
🤖 AI Disclosure