Skip to content

fix: improve provisioner key cli usability #14834

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Sep 27, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions codersdk/provisionerdaemons.go
Original file line number Diff line number Diff line change
Expand Up @@ -275,11 +275,11 @@ func (c *Client) ServeProvisionerDaemon(ctx context.Context, req ServeProvisione
}

type ProvisionerKey struct {
ID uuid.UUID `json:"id" table:"-" format:"uuid"`
CreatedAt time.Time `json:"created_at" table:"created at" format:"date-time"`
OrganizationID uuid.UUID `json:"organization" table:"organization id" format:"uuid"`
Name string `json:"name" table:"name,default_sort"`
Tags map[string]string `json:"tags" table:"tags"`
ID uuid.UUID `json:"id" format:"uuid"`
CreatedAt time.Time `json:"created_at" format:"date-time"`
OrganizationID uuid.UUID `json:"organization" format:"uuid"`
Name string `json:"name"`
Tags map[string]string `json:"tags"`
// HashedSecret - never include the access token in the API response
}

Expand Down
24 changes: 12 additions & 12 deletions docs/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -916,34 +916,34 @@
"path": "reference/cli/port-forward.md"
},
{
"title": "provisionerd",
"title": "provisioner",
"description": "Manage provisioner daemons",
"path": "reference/cli/provisionerd.md"
"path": "reference/cli/provisioner.md"
},
{
"title": "provisionerd keys",
"title": "provisioner keys",
"description": "Manage provisioner keys",
"path": "reference/cli/provisionerd_keys.md"
"path": "reference/cli/provisioner_keys.md"
},
{
"title": "provisionerd keys create",
"title": "provisioner keys create",
"description": "Create a new provisioner key",
"path": "reference/cli/provisionerd_keys_create.md"
"path": "reference/cli/provisioner_keys_create.md"
},
{
"title": "provisionerd keys delete",
"title": "provisioner keys delete",
"description": "Delete a provisioner key",
"path": "reference/cli/provisionerd_keys_delete.md"
"path": "reference/cli/provisioner_keys_delete.md"
},
{
"title": "provisionerd keys list",
"title": "provisioner keys list",
"description": "List provisioner keys in an organization",
"path": "reference/cli/provisionerd_keys_list.md"
"path": "reference/cli/provisioner_keys_list.md"
},
{
"title": "provisionerd start",
"title": "provisioner start",
"description": "Run a provisioner daemon",
"path": "reference/cli/provisionerd_start.md"
"path": "reference/cli/provisioner_start.md"
},
{
"title": "publickey",
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cli/README.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

22 changes: 22 additions & 0 deletions docs/reference/cli/provisioner.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

23 changes: 23 additions & 0 deletions docs/reference/cli/provisioner_keys.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

22 changes: 0 additions & 22 deletions docs/reference/cli/provisionerd.md

This file was deleted.

23 changes: 0 additions & 23 deletions docs/reference/cli/provisionerd_keys.md

This file was deleted.

22 changes: 20 additions & 2 deletions enterprise/cli/provisionerdaemons.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ import "github.com/coder/serpent"

func (r *RootCmd) provisionerDaemons() *serpent.Command {
cmd := &serpent.Command{
Use: "provisionerd",
Use: "provisioner",
Short: "Manage provisioner daemons",
Handler: func(inv *serpent.Invocation) error {
return inv.Command.HelpHandler(inv)
},
Aliases: []string{"provisioner"},
Aliases: []string{"provisioners"},
Children: []*serpent.Command{
r.provisionerDaemonStart(),
r.provisionerKeys(),
Expand All @@ -18,3 +18,21 @@ func (r *RootCmd) provisionerDaemons() *serpent.Command {

return cmd
}

// The provisionerd command group is deprecated and hidden but kept around
// for backwards compatibility with the start command.
func (r *RootCmd) provisionerd() *serpent.Command {
cmd := &serpent.Command{
Use: "provisionerd",
Short: "Manage provisioner daemons",
Handler: func(inv *serpent.Invocation) error {
return inv.Command.HelpHandler(inv)
},
Children: []*serpent.Command{
r.provisionerDaemonStart(),
},
Hidden: true,
}

return cmd
}
1 change: 0 additions & 1 deletion enterprise/cli/provisionerdaemonstart.go
Original file line number Diff line number Diff line change
Expand Up @@ -270,7 +270,6 @@ func (r *RootCmd) provisionerDaemonStart() *serpent.Command {
Env: "CODER_PROVISIONER_DAEMON_KEY",
Description: "Provisioner key to authenticate with Coder server.",
Value: serpent.StringOf(&provisionerKey),
Hidden: true,
}
cmd.Options = serpent.OptionSet{
{
Expand Down
28 changes: 26 additions & 2 deletions enterprise/cli/provisionerkeys.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package cli
import (
"fmt"
"strings"
"time"

"golang.org/x/xerrors"

Expand Down Expand Up @@ -95,7 +96,7 @@ func (r *RootCmd) provisionerKeysList() *serpent.Command {
var (
orgContext = agpl.NewOrganizationContext()
formatter = cliui.NewOutputFormatter(
cliui.TableFormat([]codersdk.ProvisionerKey{}, nil),
cliui.TableFormat([]provisionerKeyListItem{}, nil),
cliui.JSONFormat(),
)
)
Expand Down Expand Up @@ -127,7 +128,7 @@ func (r *RootCmd) provisionerKeysList() *serpent.Command {
return nil
}

out, err := formatter.Format(inv.Context(), keys)
out, err := formatter.Format(inv.Context(), provisionerKeyList(keys))
if err != nil {
return xerrors.Errorf("display provisioner keys: %w", err)
}
Expand All @@ -144,6 +145,29 @@ func (r *RootCmd) provisionerKeysList() *serpent.Command {
return cmd
}

type provisionerKeyListItem struct {
CreatedAt time.Time `json:"created_at" table:"created at" format:"date-time"`
Name string `json:"name" table:"name,default_sort"`
Tags string `json:"tags" table:"tags"`
}

func provisionerKeyList(items []codersdk.ProvisionerKey) []provisionerKeyListItem {
var out []provisionerKeyListItem
for _, item := range items {
tags := []string{}
for k, v := range item.Tags {
tags = append(tags, fmt.Sprintf("%s=%s", k, v))
}
out = append(out, provisionerKeyListItem{
Name: item.Name,
CreatedAt: item.CreatedAt,
Tags: strings.Join(tags, ", "),
})
}

return out
}

func (r *RootCmd) provisionerKeysDelete() *serpent.Command {
orgContext := agpl.NewOrganizationContext()

Expand Down
1 change: 1 addition & 0 deletions enterprise/cli/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ func (r *RootCmd) enterpriseOnly() []*serpent.Command {
r.licenses(),
r.groups(),
r.provisionerDaemons(),
r.provisionerd(),
}
}

Expand Down
Loading