clustvirt/cmd/clustvirt.go

30 lines
1.4 KiB
Go
Raw Normal View History

// Package cmd contains the main application file for ClustVirt.
// This command is used for everything, implementing the command pattern
// with the help of spf13/cobra.
// After building, the executable's first argument must be one of the valid
// commands, such as `daemon`, `api`, `query`, `host`, etc. This pattern allows
// for a simple way to access functionality, reducing the need to use the
// REST api directly.
package cmd
// Global Arguments:
// All commands can use the following arguments:
// --output none|json|xml: Set the output type, none being just plain log,
// json outputing as a JSON document, and XML outputing as an XML document
// Commands planned:
// config: actions associated with the configuration of clustvirt
// set: set a configuration value
// get: get the current value of a configuration options
// list: list available configuration options
// daemon: actions associated with running clustvirt in daemon mode
// start: start the daemon
// stop: safely stop the daemon
// status: query the status of the daemon
// api: query the REST api. There must a clustvirt daemon running for this to function
// host: actions associated with a specific host in the cluster
// vm: actions asociated with a specifc vm in the cluster
// storagepool: actions associated with storage pools
// auth: actions associated with authentication
// network: actions to define networks