mirror of
https://github.com/coder/coder.git
synced 2025-07-12 00:14:10 +00:00
f4da5d4f3a
This PR adds a package lifecycle and an Executor implementation that attempts to schedule a build of workspaces with autostart configured. - lifecycle.Executor takes a chan time.Time in its constructor (e.g. time.Tick(time.Minute)) - Whenever a value is received from this channel, it executes one iteration of looping through the workspaces and triggering lifecycle operations. - When the context passed to the executor is Done, it exits. - Only workspaces that meet the following criteria will have a lifecycle operation applied to them: - Workspace has a valid and non-empty autostart or autostop schedule (either) - Workspace's last build was successful - The following transitions will be applied depending on the current workspace state: - If the workspace is currently running, it will be stopped. - If the workspace is currently stopped, it will be started. - Otherwise, nothing will be done. - Workspace builds will be created with the same parameters and template version as the last successful build (for example, template version)
121 lines
3.4 KiB
Go
121 lines
3.4 KiB
Go
package cli
|
|
|
|
import (
|
|
"fmt"
|
|
"os"
|
|
"time"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
"github.com/coder/coder/coderd/autobuild/schedule"
|
|
"github.com/coder/coder/codersdk"
|
|
)
|
|
|
|
const autostartDescriptionLong = `To have your workspace build automatically at a regular time you can enable autostart.
|
|
When enabling autostart, provide the minute, hour, and day(s) of week.
|
|
The default schedule is at 09:00 in your local timezone (TZ env, UTC by default).
|
|
`
|
|
|
|
func autostart() *cobra.Command {
|
|
autostartCmd := &cobra.Command{
|
|
Annotations: workspaceCommand,
|
|
Use: "autostart enable <workspace>",
|
|
Short: "schedule a workspace to automatically start at a regular time",
|
|
Long: autostartDescriptionLong,
|
|
Example: "coder autostart enable my-workspace --minute 30 --hour 9 --days 1-5 --tz Europe/Dublin",
|
|
Hidden: true,
|
|
}
|
|
|
|
autostartCmd.AddCommand(autostartEnable())
|
|
autostartCmd.AddCommand(autostartDisable())
|
|
|
|
return autostartCmd
|
|
}
|
|
|
|
func autostartEnable() *cobra.Command {
|
|
// yes some of these are technically numbers but the cron library will do that work
|
|
var autostartMinute string
|
|
var autostartHour string
|
|
var autostartDayOfWeek string
|
|
var autostartTimezone string
|
|
cmd := &cobra.Command{
|
|
Use: "enable <workspace_name> <schedule>",
|
|
Args: cobra.ExactArgs(1),
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
|
client, err := createClient(cmd)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
organization, err := currentOrganization(cmd, client)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
spec := fmt.Sprintf("CRON_TZ=%s %s %s * * %s", autostartTimezone, autostartMinute, autostartHour, autostartDayOfWeek)
|
|
validSchedule, err := schedule.Weekly(spec)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
workspace, err := client.WorkspaceByOwnerAndName(cmd.Context(), organization.ID, codersdk.Me, args[0])
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
err = client.UpdateWorkspaceAutostart(cmd.Context(), workspace.ID, codersdk.UpdateWorkspaceAutostartRequest{
|
|
Schedule: validSchedule.String(),
|
|
})
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
_, _ = fmt.Fprintf(cmd.OutOrStdout(), "\nThe %s workspace will automatically start at %s.\n\n", workspace.Name, validSchedule.Next(time.Now()))
|
|
|
|
return nil
|
|
},
|
|
}
|
|
|
|
cmd.Flags().StringVar(&autostartMinute, "minute", "0", "autostart minute")
|
|
cmd.Flags().StringVar(&autostartHour, "hour", "9", "autostart hour")
|
|
cmd.Flags().StringVar(&autostartDayOfWeek, "days", "1-5", "autostart day(s) of week")
|
|
tzEnv := os.Getenv("TZ")
|
|
if tzEnv == "" {
|
|
tzEnv = "UTC"
|
|
}
|
|
cmd.Flags().StringVar(&autostartTimezone, "tz", tzEnv, "autostart timezone")
|
|
return cmd
|
|
}
|
|
|
|
func autostartDisable() *cobra.Command {
|
|
return &cobra.Command{
|
|
Use: "disable <workspace_name>",
|
|
Args: cobra.ExactArgs(1),
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
|
client, err := createClient(cmd)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
organization, err := currentOrganization(cmd, client)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
workspace, err := client.WorkspaceByOwnerAndName(cmd.Context(), organization.ID, codersdk.Me, args[0])
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
err = client.UpdateWorkspaceAutostart(cmd.Context(), workspace.ID, codersdk.UpdateWorkspaceAutostartRequest{
|
|
Schedule: "",
|
|
})
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
_, _ = fmt.Fprintf(cmd.OutOrStdout(), "\nThe %s workspace will no longer automatically start.\n\n", workspace.Name)
|
|
|
|
return nil
|
|
},
|
|
}
|
|
}
|