synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-12 00:14:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(cli): add --provisioner-log-debug option (#14558)

Browse Source 
Allows starting a build in debug mode from the CLI without needing
to have the build fail first by adding `--provisioner-log-debug`.
This commit is contained in:
Cian Johnston
2024-09-04 14:39:35 +01:00
committed by GitHub
parent bd90740166
commit bcf9bc3c90
8 changed files with 77 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
cli/delete.go
View File

@ -11,7 +11,10 @@ import (
// nolint // nolint
func (r *RootCmd) deleteWorkspace() *serpent.Command { func (r *RootCmd) deleteWorkspace() *serpent.Command {
var orphan bool var (
orphan bool
prov buildFlags
)
client := new(codersdk.Client) client := new(codersdk.Client)
cmd := &serpent.Command{ cmd := &serpent.Command{
Annotations: workspaceCommand, Annotations: workspaceCommand,
@ -40,11 +43,15 @@ func (r *RootCmd) deleteWorkspace() *serpent.Command {
} }
var state []byte var state []byte
build, err := client.CreateWorkspaceBuild(inv.Context(), workspace.ID, codersdk.CreateWorkspaceBuildRequest{ req := codersdk.CreateWorkspaceBuildRequest{
Transition: codersdk.WorkspaceTransitionDelete, Transition: codersdk.WorkspaceTransitionDelete,
ProvisionerState: state, ProvisionerState: state,
Orphan: orphan, Orphan: orphan,
}) }
if prov.provisionerLogDebug {
req.LogLevel = codersdk.ProvisionerLogLevelDebug
}
build, err := client.CreateWorkspaceBuild(inv.Context(), workspace.ID, req)
if err != nil { if err != nil {
return err return err
} }
@ -71,5 +78,6 @@ func (r *RootCmd) deleteWorkspace() *serpent.Command {
}, },
cliui.SkipPromptOption(), cliui.SkipPromptOption(),
} }
cmd.Options = append(cmd.Options, prov.cliOptions()...)
return cmd return cmd
} }

18
cli/parameter.go
View File

@ -127,3 +127,21 @@ func parseParameterMapFile(parameterFile string) (map[string]string, error) {
} }
return parameterMap, nil return parameterMap, nil
} }
// buildFlags contains options relating to troubleshooting provisioner jobs.
type buildFlags struct {
provisionerLogDebug bool
}
func (bf *buildFlags) cliOptions() []serpent.Option {
return []serpent.Option{
{
Flag: "provisioner-log-debug",
Description: `Sets the provisioner log level to debug.
This will print additional information about the build process.
This is useful for troubleshooting build issues.`,
Value: serpent.BoolOf(&bf.provisionerLogDebug),
Hidden: true,
},
}
}

18
cli/restart.go
View File

@ -14,7 +14,10 @@ import (
) )
func (r *RootCmd) restart() *serpent.Command { func (r *RootCmd) restart() *serpent.Command {
var parameterFlags workspaceParameterFlags var (
parameterFlags workspaceParameterFlags
bflags buildFlags
)
client := new(codersdk.Client) client := new(codersdk.Client)
cmd := &serpent.Command{ cmd := &serpent.Command{
@ -35,7 +38,7 @@ func (r *RootCmd) restart() *serpent.Command {
return err return err
} }
startReq, err := buildWorkspaceStartRequest(inv, client, workspace, parameterFlags, WorkspaceRestart) startReq, err := buildWorkspaceStartRequest(inv, client, workspace, parameterFlags, bflags, WorkspaceRestart)
if err != nil { if err != nil {
return err return err
} }
@ -48,9 +51,13 @@ func (r *RootCmd) restart() *serpent.Command {
return err return err
} }
build, err := client.CreateWorkspaceBuild(ctx, workspace.ID, codersdk.CreateWorkspaceBuildRequest{ wbr := codersdk.CreateWorkspaceBuildRequest{
Transition: codersdk.WorkspaceTransitionStop, Transition: codersdk.WorkspaceTransitionStop,
}) }
if bflags.provisionerLogDebug {
wbr.LogLevel = codersdk.ProvisionerLogLevelDebug
}
build, err := client.CreateWorkspaceBuild(ctx, workspace.ID, wbr)
if err != nil { if err != nil {
return err return err
} }
@ -65,7 +72,7 @@ func (r *RootCmd) restart() *serpent.Command {
// workspaces with the active version. // workspaces with the active version.
if cerr, ok := codersdk.AsError(err); ok && cerr.StatusCode() == http.StatusForbidden { if cerr, ok := codersdk.AsError(err); ok && cerr.StatusCode() == http.StatusForbidden {
_, _ = fmt.Fprintln(inv.Stdout, "Unable to restart the workspace with the template version from the last build. Policy may require you to restart with the current active template version.") _, _ = fmt.Fprintln(inv.Stdout, "Unable to restart the workspace with the template version from the last build. Policy may require you to restart with the current active template version.")
build, err = startWorkspace(inv, client, workspace, parameterFlags, WorkspaceUpdate) build, err = startWorkspace(inv, client, workspace, parameterFlags, bflags, WorkspaceUpdate)
if err != nil { if err != nil {
return xerrors.Errorf("start workspace with active template version: %w", err) return xerrors.Errorf("start workspace with active template version: %w", err)
} }
@ -87,6 +94,7 @@ func (r *RootCmd) restart() *serpent.Command {
} }
cmd.Options = append(cmd.Options, parameterFlags.allOptions()...) cmd.Options = append(cmd.Options, parameterFlags.allOptions()...)
cmd.Options = append(cmd.Options, bflags.cliOptions()...)
return cmd return cmd
} }

4
cli/ssh.go
View File

@ -649,9 +649,9 @@ func getWorkspaceAndAgent(ctx context.Context, inv *serpent.Invocation, client *
// It's possible for a workspace build to fail due to the template requiring starting // It's possible for a workspace build to fail due to the template requiring starting
// workspaces with the active version. // workspaces with the active version.
_, _ = fmt.Fprintf(inv.Stderr, "Workspace was stopped, starting workspace to allow connecting to %q...\n", workspace.Name) _, _ = fmt.Fprintf(inv.Stderr, "Workspace was stopped, starting workspace to allow connecting to %q...\n", workspace.Name)
_, err = startWorkspace(inv, client, workspace, workspaceParameterFlags{}, WorkspaceStart) _, err = startWorkspace(inv, client, workspace, workspaceParameterFlags{}, buildFlags{}, WorkspaceStart)
if cerr, ok := codersdk.AsError(err); ok && cerr.StatusCode() == http.StatusForbidden { if cerr, ok := codersdk.AsError(err); ok && cerr.StatusCode() == http.StatusForbidden {
_, err = startWorkspace(inv, client, workspace, workspaceParameterFlags{}, WorkspaceUpdate) _, err = startWorkspace(inv, client, workspace, workspaceParameterFlags{}, buildFlags{}, WorkspaceUpdate)
if err != nil { if err != nil {
return codersdk.Workspace{}, codersdk.WorkspaceAgent{}, xerrors.Errorf("start workspace with active template version: %w", err) return codersdk.Workspace{}, codersdk.WorkspaceAgent{}, xerrors.Errorf("start workspace with active template version: %w", err)
} }

25
cli/start.go
View File

@ -13,7 +13,10 @@ import (
) )
func (r *RootCmd) start() *serpent.Command { func (r *RootCmd) start() *serpent.Command {
var parameterFlags workspaceParameterFlags var (
parameterFlags workspaceParameterFlags
bflags buildFlags
)
client := new(codersdk.Client) client := new(codersdk.Client)
cmd := &serpent.Command{ cmd := &serpent.Command{
@ -45,12 +48,12 @@ func (r *RootCmd) start() *serpent.Command {
) )
build = workspace.LatestBuild build = workspace.LatestBuild
default: default:
build, err = startWorkspace(inv, client, workspace, parameterFlags, WorkspaceStart) build, err = startWorkspace(inv, client, workspace, parameterFlags, bflags, WorkspaceStart)
// It's possible for a workspace build to fail due to the template requiring starting // It's possible for a workspace build to fail due to the template requiring starting
// workspaces with the active version. // workspaces with the active version.
if cerr, ok := codersdk.AsError(err); ok && cerr.StatusCode() == http.StatusForbidden { if cerr, ok := codersdk.AsError(err); ok && cerr.StatusCode() == http.StatusForbidden {
_, _ = fmt.Fprintln(inv.Stdout, "Unable to start the workspace with the template version from the last build. Policy may require you to restart with the current active template version.") _, _ = fmt.Fprintln(inv.Stdout, "Unable to start the workspace with the template version from the last build. Policy may require you to restart with the current active template version.")
build, err = startWorkspace(inv, client, workspace, parameterFlags, WorkspaceUpdate) build, err = startWorkspace(inv, client, workspace, parameterFlags, bflags, WorkspaceUpdate)
if err != nil { if err != nil {
return xerrors.Errorf("start workspace with active template version: %w", err) return xerrors.Errorf("start workspace with active template version: %w", err)
} }
@ -73,11 +76,12 @@ func (r *RootCmd) start() *serpent.Command {
} }
cmd.Options = append(cmd.Options, parameterFlags.allOptions()...) cmd.Options = append(cmd.Options, parameterFlags.allOptions()...)
cmd.Options = append(cmd.Options, bflags.cliOptions()...)
return cmd return cmd
} }
func buildWorkspaceStartRequest(inv *serpent.Invocation, client *codersdk.Client, workspace codersdk.Workspace, parameterFlags workspaceParameterFlags, action WorkspaceCLIAction) (codersdk.CreateWorkspaceBuildRequest, error) { func buildWorkspaceStartRequest(inv *serpent.Invocation, client *codersdk.Client, workspace codersdk.Workspace, parameterFlags workspaceParameterFlags, buildFlags buildFlags, action WorkspaceCLIAction) (codersdk.CreateWorkspaceBuildRequest, error) {
version := workspace.LatestBuild.TemplateVersionID version := workspace.LatestBuild.TemplateVersionID
if workspace.AutomaticUpdates == codersdk.AutomaticUpdatesAlways || action == WorkspaceUpdate { if workspace.AutomaticUpdates == codersdk.AutomaticUpdatesAlways || action == WorkspaceUpdate {
@ -124,14 +128,19 @@ func buildWorkspaceStartRequest(inv *serpent.Invocation, client *codersdk.Client
return codersdk.CreateWorkspaceBuildRequest{}, err return codersdk.CreateWorkspaceBuildRequest{}, err
} }
return codersdk.CreateWorkspaceBuildRequest{ wbr := codersdk.CreateWorkspaceBuildRequest{
Transition: codersdk.WorkspaceTransitionStart, Transition: codersdk.WorkspaceTransitionStart,
RichParameterValues: buildParameters, RichParameterValues: buildParameters,
TemplateVersionID: version, TemplateVersionID: version,
}, nil }
if buildFlags.provisionerLogDebug {
wbr.LogLevel = codersdk.ProvisionerLogLevelDebug
}
return wbr, nil
} }
func startWorkspace(inv *serpent.Invocation, client *codersdk.Client, workspace codersdk.Workspace, parameterFlags workspaceParameterFlags, action WorkspaceCLIAction) (codersdk.WorkspaceBuild, error) { func startWorkspace(inv *serpent.Invocation, client *codersdk.Client, workspace codersdk.Workspace, parameterFlags workspaceParameterFlags, buildFlags buildFlags, action WorkspaceCLIAction) (codersdk.WorkspaceBuild, error) {
if workspace.DormantAt != nil { if workspace.DormantAt != nil {
_, _ = fmt.Fprintln(inv.Stdout, "Activating dormant workspace...") _, _ = fmt.Fprintln(inv.Stdout, "Activating dormant workspace...")
err := client.UpdateWorkspaceDormancy(inv.Context(), workspace.ID, codersdk.UpdateWorkspaceDormancy{ err := client.UpdateWorkspaceDormancy(inv.Context(), workspace.ID, codersdk.UpdateWorkspaceDormancy{
@ -141,7 +150,7 @@ func startWorkspace(inv *serpent.Invocation, client *codersdk.Client, workspace
return codersdk.WorkspaceBuild{}, xerrors.Errorf("activate workspace: %w", err) return codersdk.WorkspaceBuild{}, xerrors.Errorf("activate workspace: %w", err)
} }
} }
req, err := buildWorkspaceStartRequest(inv, client, workspace, parameterFlags, action) req, err := buildWorkspaceStartRequest(inv, client, workspace, parameterFlags, buildFlags, action)
if err != nil { if err != nil {
return codersdk.WorkspaceBuild{}, err return codersdk.WorkspaceBuild{}, err
} }

11
cli/stop.go
View File

@ -10,6 +10,7 @@ import (
) )
func (r *RootCmd) stop() *serpent.Command { func (r *RootCmd) stop() *serpent.Command {
var bflags buildFlags
client := new(codersdk.Client) client := new(codersdk.Client)
cmd := &serpent.Command{ cmd := &serpent.Command{
Annotations: workspaceCommand, Annotations: workspaceCommand,
@ -35,9 +36,13 @@ func (r *RootCmd) stop() *serpent.Command {
if err != nil { if err != nil {
return err return err
} }
build, err := client.CreateWorkspaceBuild(inv.Context(), workspace.ID, codersdk.CreateWorkspaceBuildRequest{ wbr := codersdk.CreateWorkspaceBuildRequest{
Transition: codersdk.WorkspaceTransitionStop, Transition: codersdk.WorkspaceTransitionStop,
}) }
if bflags.provisionerLogDebug {
wbr.LogLevel = codersdk.ProvisionerLogLevelDebug
}
build, err := client.CreateWorkspaceBuild(inv.Context(), workspace.ID, wbr)
if err != nil { if err != nil {
return err return err
} }
@ -56,5 +61,7 @@ func (r *RootCmd) stop() *serpent.Command {
return nil return nil
}, },
} }
cmd.Options = append(cmd.Options, bflags.cliOptions()...)
return cmd return cmd
} }

9
cli/update.go
View File

@ -10,8 +10,10 @@ import (
) )
func (r *RootCmd) update() *serpent.Command { func (r *RootCmd) update() *serpent.Command {
var parameterFlags workspaceParameterFlags var (
parameterFlags workspaceParameterFlags
bflags buildFlags
)
client := new(codersdk.Client) client := new(codersdk.Client)
cmd := &serpent.Command{ cmd := &serpent.Command{
Annotations: workspaceCommand, Annotations: workspaceCommand,
@ -32,7 +34,7 @@ func (r *RootCmd) update() *serpent.Command {
return nil return nil
} }
build, err := startWorkspace(inv, client, workspace, parameterFlags, WorkspaceUpdate) build, err := startWorkspace(inv, client, workspace, parameterFlags, bflags, WorkspaceUpdate)
if err != nil { if err != nil {
return xerrors.Errorf("start workspace: %w", err) return xerrors.Errorf("start workspace: %w", err)
} }
@ -54,5 +56,6 @@ func (r *RootCmd) update() *serpent.Command {
} }
cmd.Options = append(cmd.Options, parameterFlags.allOptions()...) cmd.Options = append(cmd.Options, parameterFlags.allOptions()...)
cmd.Options = append(cmd.Options, bflags.cliOptions()...)
return cmd return cmd
} }

2
scripts/develop.sh
View File

@ -150,7 +150,7 @@ fatal() {
trap 'fatal "Script encountered an error"' ERR trap 'fatal "Script encountered an error"' ERR
cdroot cdroot
DEBUG_DELVE="${debug}" start_cmd API "" "${CODER_DEV_SHIM}" server --http-address 0.0.0.0:3000 --swagger-enable --access-url "${CODER_DEV_ACCESS_URL}" --dangerous-allow-cors-requests=true "$@" DEBUG_DELVE="${debug}" start_cmd API "" "${CODER_DEV_SHIM}" server --http-address 0.0.0.0:3000 --swagger-enable --access-url "${CODER_DEV_ACCESS_URL}" --dangerous-allow-cors-requests=true --enable-terraform-debug-mode "$@"
echo '== Waiting for Coder to become ready' echo '== Waiting for Coder to become ready'
# Start the timeout in the background so interrupting this script # Start the timeout in the background so interrupting this script