bb53f2056e
This fix tries to address the comment https://github.com/docker/docker/pull/30376#discussion_r97465334
where it was not possible to specify `--format` for `docker node ls`. The `--format` flag
is a quite useful flag that could be used in many places such as completion.
This fix implements `--format` for `docker node ls` and add `nodesFormat` in config.json
so that it is possible to specify the output when `docker node ls` is invoked.
Related documentations have been updated.
A set of unit tests have been added.
This fix is related to #30376.
Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
Upstream-commit: 4fc1d6782c
Component: cli
100 lines
2.4 KiB
Go
100 lines
2.4 KiB
Go
package formatter
|
|
|
|
import (
|
|
"github.com/docker/docker/api/types"
|
|
"github.com/docker/docker/api/types/swarm"
|
|
"github.com/docker/docker/cli/command"
|
|
)
|
|
|
|
const (
|
|
defaultNodeTableFormat = "table {{.ID}}\t{{.Hostname}}\t{{.Status}}\t{{.Availability}}\t{{.ManagerStatus}}"
|
|
|
|
nodeIDHeader = "ID"
|
|
hostnameHeader = "HOSTNAME"
|
|
availabilityHeader = "AVAILABILITY"
|
|
managerStatusHeader = "MANAGER STATUS"
|
|
)
|
|
|
|
// NewNodeFormat returns a Format for rendering using a node Context
|
|
func NewNodeFormat(source string, quiet bool) Format {
|
|
switch source {
|
|
case TableFormatKey:
|
|
if quiet {
|
|
return defaultQuietFormat
|
|
}
|
|
return defaultNodeTableFormat
|
|
case RawFormatKey:
|
|
if quiet {
|
|
return `node_id: {{.ID}}`
|
|
}
|
|
return `node_id: {{.ID}}\nhostname: {{.Hostname}}\nstatus: {{.Status}}\navailability: {{.Availability}}\nmanager_status: {{.ManagerStatus}}\n`
|
|
}
|
|
return Format(source)
|
|
}
|
|
|
|
// NodeWrite writes the context
|
|
func NodeWrite(ctx Context, nodes []swarm.Node, info types.Info) error {
|
|
render := func(format func(subContext subContext) error) error {
|
|
for _, node := range nodes {
|
|
nodeCtx := &nodeContext{n: node, info: info}
|
|
if err := format(nodeCtx); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
nodeCtx := nodeContext{}
|
|
nodeCtx.header = nodeHeaderContext{
|
|
"ID": nodeIDHeader,
|
|
"Hostname": hostnameHeader,
|
|
"Status": statusHeader,
|
|
"Availability": availabilityHeader,
|
|
"ManagerStatus": managerStatusHeader,
|
|
}
|
|
return ctx.Write(&nodeCtx, render)
|
|
}
|
|
|
|
type nodeHeaderContext map[string]string
|
|
|
|
type nodeContext struct {
|
|
HeaderContext
|
|
n swarm.Node
|
|
info types.Info
|
|
}
|
|
|
|
func (c *nodeContext) MarshalJSON() ([]byte, error) {
|
|
return marshalJSON(c)
|
|
}
|
|
|
|
func (c *nodeContext) ID() string {
|
|
nodeID := c.n.ID
|
|
if nodeID == c.info.Swarm.NodeID {
|
|
nodeID = nodeID + " *"
|
|
}
|
|
return nodeID
|
|
}
|
|
|
|
func (c *nodeContext) Hostname() string {
|
|
return c.n.Description.Hostname
|
|
}
|
|
|
|
func (c *nodeContext) Status() string {
|
|
return command.PrettyPrint(string(c.n.Status.State))
|
|
}
|
|
|
|
func (c *nodeContext) Availability() string {
|
|
return command.PrettyPrint(string(c.n.Spec.Availability))
|
|
}
|
|
|
|
func (c *nodeContext) ManagerStatus() string {
|
|
reachability := ""
|
|
if c.n.ManagerStatus != nil {
|
|
if c.n.ManagerStatus.Leader {
|
|
reachability = "Leader"
|
|
} else {
|
|
reachability = string(c.n.ManagerStatus.Reachability)
|
|
}
|
|
}
|
|
return command.PrettyPrint(reachability)
|
|
}
|