Skip to content

chore: cleanup env vars and self hosting docs#4420

Open
mnafees wants to merge 12 commits into
mainfrom
nafees/docs+env-cleanup
Open

chore: cleanup env vars and self hosting docs#4420
mnafees wants to merge 12 commits into
mainfrom
nafees/docs+env-cleanup

Conversation

@mnafees

@mnafees mnafees commented Jul 14, 2026

Copy link
Copy Markdown
Member

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:

  1. SERVER_FLUSH_STRATEGY
  2. SERVER_LIMITS_DEFAULT_CRON_LIMIT
  3. SERVER_TLS_SERVER_NAME
  4. SERVER_LIMITS_DEFAULT_CRON_ALARM_LIMIT
  5. SERVER_TASK_OPERATION_LIMITS_TIMEOUT_LIMIT
  6. SERVER_LIMITS_DEFAULT_SCHEDULE_LIMIT
  7. SERVER_TASK_OPERATION_LIMITS_REASSIGN_LIMIT
  8. SERVER_LIMITS_DEFAULT_SCHEDULE_ALARM_LIMIT
  9. SERVER_TASK_OPERATION_LIMITS_RETRY_QUEUE_LIMIT
  10. SERVER_WAIT_FOR_FLUSH
  11. SERVER_TASK_OPERATION_LIMITS_DURABLE_SLEEP_LIMIT
  12. SERVER_MAX_CONCURRENT
  13. SERVER_DEFAULT_ENGINE_VERSION
  14. SERVER_FLUSH_PERIOD_MILLISECONDS
  15. SERVER_REQUEUE_LIMIT
  16. SERVER_FLUSH_ITEMS_THRESHOLD
  17. SERVER_UPDATE_HASH_FACTOR
  18. DATABASE_MAX_QUEUE_CONNS
  19. SERVER_UPDATE_CONCURRENT_FACTOR
  20. DATABASE_MIN_QUEUE_CONNS
  21. SEED_DEVELOPMENT

Type of change

  • Documentation change (pure documentation change)
  • Chore (changes which are not directly related to any business logic)

Checklist

Changes have been:

  • Tested (unit, integration, or manually with steps specified)
  • Linted and formatted
  • Documented (where applicable)

🤖 AI Disclosure
  • I acknowledge that an LLM was used in the creation of this Pull Request, in accordance with Hatchet's AI_POLICY.md.
  • Details: [e.g. generating tests, writing docs]

@mnafees mnafees self-assigned this Jul 14, 2026
@vercel

vercel Bot commented Jul 14, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
hatchet-docs Ready Ready Preview, Comment Jul 17, 2026 2:20pm

Request Review

@github-actions github-actions Bot added documentation Improvements or additions to documentation engine Related to the core Hatchet engine labels Jul 14, 2026
@mnafees
mnafees requested review from abelanger5 and Copilot July 14, 2026 16:37

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 BindEnv mappings from pkg/config/server and pkg/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.

Comment thread pkg/config/server/server.go
Comment thread frontend/docs/pages/self-hosting/configuration-options.mdx Outdated
@github-actions github-actions Bot added the github_actions Pull requests that update GitHub Actions code label Jul 14, 2026
@mnafees
mnafees requested a review from Copilot July 14, 2026 16:45
@github-actions

Copy link
Copy Markdown
Contributor

⚠️ Optional test failure: The load-deadlock job failed on this PR (optimistic-scheduling=true). This check is non-mandatory and does not block merging, but may be worth investigating. View logs

@github-actions

Copy link
Copy Markdown
Contributor

⚠️ Optional test failure: The load-deadlock job failed on this PR (optimistic-scheduling=false). This check is non-mandatory and does not block merging, but may be worth investigating. View logs

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 13 out of 13 changed files in this pull request and generated 4 comments.

Comment thread frontend/docs/pages/self-hosting/kubernetes-quickstart.mdx
Comment thread frontend/docs/pages/self-hosting/configuration-options.mdx Outdated
Comment thread frontend/docs/pages/self-hosting/configuration-options.mdx Outdated
Comment thread frontend/docs/pages/self-hosting/configuration-options.mdx Outdated
@github-actions

Copy link
Copy Markdown
Contributor

⚠️ Optional test failure: The load-deadlock job failed on this PR (optimistic-scheduling=false). This check is non-mandatory and does not block merging, but may be worth investigating. View logs

@github-actions

Copy link
Copy Markdown
Contributor

⚠️ Optional test failure: The load-deadlock job failed on this PR (optimistic-scheduling=false). This check is non-mandatory and does not block merging, but may be worth investigating. View logs

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two notes:

  1. It looks like we're missing the buffer configuration settings for the mq sub buffer / mq pub buffer
  2. 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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@mnafees mnafees Jul 16, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 🤷‍♂️

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup, tested this locally

Comment thread frontend/docs/pages/self-hosting/improving-performance.mdx Outdated
Comment thread frontend/docs/pages/self-hosting/improving-performance.mdx Outdated
Comment thread frontend/docs/pages/v1/migrating/migration-guide-engine.mdx Outdated
@github-actions

Copy link
Copy Markdown
Contributor

⚠️ Optional test failure: The load-deadlock job failed on this PR (optimistic-scheduling=false). This check is non-mandatory and does not block merging, but may be worth investigating. View logs

@github-actions

Copy link
Copy Markdown
Contributor

⚠️ Optional test failure: The load-deadlock job failed on this PR (optimistic-scheduling=true). This check is non-mandatory and does not block merging, but may be worth investigating. View logs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation engine Related to the core Hatchet engine github_actions Pull requests that update GitHub Actions code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants