Skip to content

Docs: Add troubleshooting section to prebuilds docs for handling provisioner job saturation #19490

@ssncferreira

Description

@ssncferreira

Description

The prebuilds documentation currently does not explain how to recover when prebuild jobs saturate provisioner queues. This situation can occur for instance when a faulty template version is published and leaves admins needing to manually diagnose and clear jobs.

We should add a troubleshooting section to the prebuilds docs that gives admins clear recovery steps. This would include how to adjust reconciliation settings, pause the prebuild loop, and cancel provisioner jobs to restore normal operation.

Troubleshooting steps to document:

  • Adjust the CODER__PREBUILDS_RECONCILIATION_INTERVAL configuration value to decrease the reconciliation loop interval.
  • Run the coder prebuilds pause CLI command to pause the prebuilds reconciliation loop.
  • Use the coder provisioner job list and coder provisioner job cancel CLI commands to list and stop provisioner jobs by ID.

Related to: coder/internal#924

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions