mirror of
https://github.com/coder/coder.git
synced 2026-06-03 04:58:23 +00:00
Spike Curtis
bddb808b25
Fixes all our Go file imports to match the preferred spec that we've _mostly_ been using. For example: ``` import ( "context" "time" "github.com/prometheus/client_golang/prometheus" "golang.org/x/xerrors" "gopkg.in/natefinch/lumberjack.v2" "cdr.dev/slog/v3" "github.com/coder/coder/v2/codersdk/agentsdk" "github.com/coder/serpent" ) ``` 3 groups: standard library, 3rd partly libs, Coder libs. This PR makes the change across the codebase. The PR in the stack above modifies our formatting to maintain this state of affairs, and is a separate PR so it's possible to review that one in detail.
312 lines
12 KiB
Go
312 lines
12 KiB
Go
package cli
|
|
|
|
import (
|
|
"fmt"
|
|
"net/http"
|
|
"time"
|
|
|
|
"golang.org/x/xerrors"
|
|
|
|
"github.com/coder/coder/v2/cli/cliui"
|
|
"github.com/coder/coder/v2/codersdk"
|
|
"github.com/coder/pretty"
|
|
"github.com/coder/serpent"
|
|
)
|
|
|
|
func (r *RootCmd) templateEdit() *serpent.Command {
|
|
const deprecatedFlagName = "deprecated"
|
|
var (
|
|
name string
|
|
displayName string
|
|
description string
|
|
icon string
|
|
defaultTTL time.Duration
|
|
activityBump time.Duration
|
|
autostopRequirementDaysOfWeek []string
|
|
autostopRequirementWeeks int64
|
|
autostartRequirementDaysOfWeek []string
|
|
failureTTL time.Duration
|
|
dormancyThreshold time.Duration
|
|
dormancyAutoDeletion time.Duration
|
|
allowUserCancelWorkspaceJobs bool
|
|
allowUserAutostart bool
|
|
allowUserAutostop bool
|
|
requireActiveVersion bool
|
|
deprecationMessage string
|
|
disableEveryone bool
|
|
orgContext = NewOrganizationContext()
|
|
)
|
|
|
|
cmd := &serpent.Command{
|
|
Use: "edit <template>",
|
|
Middleware: serpent.Chain(
|
|
serpent.RequireNArgs(1),
|
|
),
|
|
Short: "Edit the metadata of a template by name.",
|
|
Handler: func(inv *serpent.Invocation) error {
|
|
client, err := r.InitClient(inv)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
unsetAutostopRequirementDaysOfWeek := len(autostopRequirementDaysOfWeek) == 1 && autostopRequirementDaysOfWeek[0] == "none"
|
|
requiresScheduling := (len(autostopRequirementDaysOfWeek) > 0 && !unsetAutostopRequirementDaysOfWeek) ||
|
|
autostopRequirementWeeks > 0 ||
|
|
!allowUserAutostart ||
|
|
!allowUserAutostop ||
|
|
failureTTL != 0 ||
|
|
dormancyThreshold != 0 ||
|
|
dormancyAutoDeletion != 0 ||
|
|
len(autostartRequirementDaysOfWeek) > 0
|
|
|
|
requiresEntitlement := requiresScheduling || requireActiveVersion
|
|
if requiresEntitlement {
|
|
entitlements, err := client.Entitlements(inv.Context())
|
|
if cerr, ok := codersdk.AsError(err); ok && cerr.StatusCode() == http.StatusNotFound {
|
|
return xerrors.Errorf("your deployment appears to be an AGPL deployment, so you cannot set enterprise-only flags")
|
|
} else if err != nil {
|
|
return xerrors.Errorf("get entitlements: %w", err)
|
|
}
|
|
|
|
if requiresScheduling && !entitlements.Features[codersdk.FeatureAdvancedTemplateScheduling].Enabled {
|
|
return xerrors.Errorf("your license is not entitled to use advanced template scheduling, so you cannot set --failure-ttl, --inactivityTTL, --allow-user-autostart=false or --allow-user-autostop=false")
|
|
}
|
|
|
|
if requireActiveVersion {
|
|
if !entitlements.Features[codersdk.FeatureAccessControl].Enabled {
|
|
return xerrors.Errorf("your license is not entitled to use enterprise access control, so you cannot set --require-active-version")
|
|
}
|
|
}
|
|
}
|
|
|
|
organization, err := orgContext.Selected(inv, client)
|
|
if err != nil {
|
|
return xerrors.Errorf("get current organization: %w", err)
|
|
}
|
|
template, err := client.TemplateByName(inv.Context(), organization.ID, inv.Args[0])
|
|
if err != nil {
|
|
return xerrors.Errorf("get workspace template: %w", err)
|
|
}
|
|
|
|
// Default values
|
|
if !userSetOption(inv, "description") {
|
|
description = template.Description
|
|
}
|
|
|
|
if !userSetOption(inv, "icon") {
|
|
icon = template.Icon
|
|
}
|
|
|
|
if !userSetOption(inv, "display-name") {
|
|
displayName = template.DisplayName
|
|
}
|
|
|
|
if !userSetOption(inv, "default-ttl") {
|
|
defaultTTL = time.Duration(template.DefaultTTLMillis) * time.Millisecond
|
|
}
|
|
|
|
if !userSetOption(inv, "activity-bump") {
|
|
activityBump = time.Duration(template.ActivityBumpMillis) * time.Millisecond
|
|
}
|
|
|
|
if !userSetOption(inv, "allow-user-autostop") {
|
|
allowUserAutostop = template.AllowUserAutostop
|
|
}
|
|
|
|
if !userSetOption(inv, "allow-user-autostart") {
|
|
allowUserAutostart = template.AllowUserAutostart
|
|
}
|
|
|
|
if !userSetOption(inv, "allow-user-cancel-workspace-jobs") {
|
|
allowUserCancelWorkspaceJobs = template.AllowUserCancelWorkspaceJobs
|
|
}
|
|
|
|
if !userSetOption(inv, "failure-ttl") {
|
|
failureTTL = time.Duration(template.FailureTTLMillis) * time.Millisecond
|
|
}
|
|
|
|
if !userSetOption(inv, "dormancy-threshold") {
|
|
dormancyThreshold = time.Duration(template.TimeTilDormantMillis) * time.Millisecond
|
|
}
|
|
|
|
if !userSetOption(inv, "dormancy-auto-deletion") {
|
|
dormancyAutoDeletion = time.Duration(template.TimeTilDormantAutoDeleteMillis) * time.Millisecond
|
|
}
|
|
|
|
if !userSetOption(inv, "require-active-version") {
|
|
requireActiveVersion = template.RequireActiveVersion
|
|
}
|
|
|
|
if !userSetOption(inv, "autostop-requirement-weekdays") {
|
|
autostopRequirementDaysOfWeek = template.AutostopRequirement.DaysOfWeek
|
|
}
|
|
|
|
if unsetAutostopRequirementDaysOfWeek {
|
|
autostopRequirementDaysOfWeek = []string{}
|
|
}
|
|
|
|
if !userSetOption(inv, "autostop-requirement-weeks") {
|
|
autostopRequirementWeeks = template.AutostopRequirement.Weeks
|
|
}
|
|
|
|
switch {
|
|
case len(autostartRequirementDaysOfWeek) == 1 && autostartRequirementDaysOfWeek[0] == "all":
|
|
// Set it to every day of the week
|
|
autostartRequirementDaysOfWeek = []string{"monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday"}
|
|
case !userSetOption(inv, "autostart-requirement-weekdays"):
|
|
autostartRequirementDaysOfWeek = template.AutostartRequirement.DaysOfWeek
|
|
case len(autostartRequirementDaysOfWeek) == 0:
|
|
autostartRequirementDaysOfWeek = []string{}
|
|
}
|
|
|
|
var deprecated *string
|
|
if userSetOption(inv, "deprecated") {
|
|
deprecated = &deprecationMessage
|
|
}
|
|
|
|
var disableEveryoneGroup bool
|
|
if userSetOption(inv, "private") {
|
|
disableEveryoneGroup = disableEveryone
|
|
}
|
|
|
|
req := codersdk.UpdateTemplateMeta{
|
|
Name: name,
|
|
DisplayName: &displayName,
|
|
Description: &description,
|
|
Icon: &icon,
|
|
DefaultTTLMillis: defaultTTL.Milliseconds(),
|
|
ActivityBumpMillis: activityBump.Milliseconds(),
|
|
AutostopRequirement: &codersdk.TemplateAutostopRequirement{
|
|
DaysOfWeek: autostopRequirementDaysOfWeek,
|
|
Weeks: autostopRequirementWeeks,
|
|
},
|
|
AutostartRequirement: &codersdk.TemplateAutostartRequirement{
|
|
DaysOfWeek: autostartRequirementDaysOfWeek,
|
|
},
|
|
FailureTTLMillis: failureTTL.Milliseconds(),
|
|
TimeTilDormantMillis: dormancyThreshold.Milliseconds(),
|
|
TimeTilDormantAutoDeleteMillis: dormancyAutoDeletion.Milliseconds(),
|
|
AllowUserCancelWorkspaceJobs: allowUserCancelWorkspaceJobs,
|
|
AllowUserAutostart: allowUserAutostart,
|
|
AllowUserAutostop: allowUserAutostop,
|
|
RequireActiveVersion: requireActiveVersion,
|
|
DeprecationMessage: deprecated,
|
|
DisableEveryoneGroupAccess: disableEveryoneGroup,
|
|
}
|
|
|
|
_, err = client.UpdateTemplateMeta(inv.Context(), template.ID, req)
|
|
if err != nil {
|
|
return xerrors.Errorf("update template metadata: %w", err)
|
|
}
|
|
_, _ = fmt.Fprintf(inv.Stdout, "Updated template metadata at %s!\n", pretty.Sprint(cliui.DefaultStyles.DateTimeStamp, time.Now().Format(time.Stamp)))
|
|
return nil
|
|
},
|
|
}
|
|
|
|
cmd.Options = serpent.OptionSet{
|
|
{
|
|
Flag: "name",
|
|
Description: "Edit the template name.",
|
|
Value: serpent.StringOf(&name),
|
|
},
|
|
{
|
|
Flag: "display-name",
|
|
Description: "Edit the template display name.",
|
|
Value: serpent.StringOf(&displayName),
|
|
},
|
|
{
|
|
Flag: "description",
|
|
Description: "Edit the template description.",
|
|
Value: serpent.StringOf(&description),
|
|
},
|
|
{
|
|
Name: deprecatedFlagName,
|
|
Flag: "deprecated",
|
|
Description: "Sets the template as deprecated. Must be a message explaining why the template is deprecated.",
|
|
Value: serpent.StringOf(&deprecationMessage),
|
|
},
|
|
{
|
|
Flag: "icon",
|
|
Description: "Edit the template icon path.",
|
|
Value: serpent.StringOf(&icon),
|
|
},
|
|
{
|
|
Flag: "default-ttl",
|
|
Description: "Edit the template default time before shutdown - workspaces created from this template default to this value. Maps to \"Default autostop\" in the UI.",
|
|
Value: serpent.DurationOf(&defaultTTL),
|
|
},
|
|
{
|
|
Flag: "activity-bump",
|
|
Description: "Edit the template activity bump - workspaces created from this template will have their shutdown time bumped by this value when activity is detected. Maps to \"Activity bump\" in the UI.",
|
|
Value: serpent.DurationOf(&activityBump),
|
|
},
|
|
{
|
|
Flag: "autostart-requirement-weekdays",
|
|
Description: "Edit the template autostart requirement weekdays - workspaces created from this template can only autostart on the given weekdays. To unset this value for the template (and allow autostart on all days), pass 'all'.",
|
|
Value: serpent.EnumArrayOf(&autostartRequirementDaysOfWeek, append(codersdk.AllDaysOfWeek, "all")...),
|
|
},
|
|
{
|
|
Flag: "autostop-requirement-weekdays",
|
|
Description: "Edit the template autostop requirement weekdays - workspaces created from this template must be restarted on the given weekdays. To unset this value for the template (and disable the autostop requirement for the template), pass 'none'.",
|
|
Value: serpent.EnumArrayOf(&autostopRequirementDaysOfWeek, append(codersdk.AllDaysOfWeek, "none")...),
|
|
},
|
|
{
|
|
Flag: "autostop-requirement-weeks",
|
|
Description: "Edit the template autostop requirement weeks - workspaces created from this template must be restarted on an n-weekly basis.",
|
|
Value: serpent.Int64Of(&autostopRequirementWeeks),
|
|
},
|
|
{
|
|
Flag: "failure-ttl",
|
|
Description: "Specify a failure TTL for workspaces created from this template. It is the amount of time after a failed \"start\" build before coder automatically schedules a \"stop\" build to cleanup.This licensed feature's default is 0h (off). Maps to \"Failure cleanup\" in the UI.",
|
|
Default: "0h",
|
|
Value: serpent.DurationOf(&failureTTL),
|
|
},
|
|
{
|
|
Flag: "dormancy-threshold",
|
|
Description: "Specify a duration workspaces may be inactive prior to being moved to the dormant state. This licensed feature's default is 0h (off). Maps to \"Dormancy threshold\" in the UI.",
|
|
Default: "0h",
|
|
Value: serpent.DurationOf(&dormancyThreshold),
|
|
},
|
|
{
|
|
Flag: "dormancy-auto-deletion",
|
|
Description: "Specify a duration workspaces may be in the dormant state prior to being deleted. This licensed feature's default is 0h (off). Maps to \"Dormancy Auto-Deletion\" in the UI.",
|
|
Default: "0h",
|
|
Value: serpent.DurationOf(&dormancyAutoDeletion),
|
|
},
|
|
{
|
|
Flag: "allow-user-cancel-workspace-jobs",
|
|
Description: "Allow users to cancel in-progress workspace jobs.",
|
|
Default: "true",
|
|
Value: serpent.BoolOf(&allowUserCancelWorkspaceJobs),
|
|
},
|
|
{
|
|
Flag: "allow-user-autostart",
|
|
Description: "Allow users to configure autostart for workspaces on this template. This can only be disabled in enterprise.",
|
|
Default: "true",
|
|
Value: serpent.BoolOf(&allowUserAutostart),
|
|
},
|
|
{
|
|
Flag: "allow-user-autostop",
|
|
Description: "Allow users to customize the autostop TTL for workspaces on this template. This can only be disabled in enterprise.",
|
|
Default: "true",
|
|
Value: serpent.BoolOf(&allowUserAutostop),
|
|
},
|
|
{
|
|
Flag: "require-active-version",
|
|
Description: "Requires workspace builds to use the active template version. This setting does not apply to template admins. This is an enterprise-only feature. See https://coder.com/docs/admin/templates/managing-templates#require-automatic-updates-enterprise for more details.",
|
|
Value: serpent.BoolOf(&requireActiveVersion),
|
|
Default: "false",
|
|
},
|
|
{
|
|
Flag: "private",
|
|
Description: "Disable the default behavior of granting template access to the 'everyone' group. " +
|
|
"The template permissions must be updated to allow non-admin users to use this template.",
|
|
Value: serpent.BoolOf(&disableEveryone),
|
|
Default: "false",
|
|
},
|
|
cliui.SkipPromptOption(),
|
|
}
|
|
orgContext.AttachOptions(cmd)
|
|
|
|
return cmd
|
|
}
|