Document all working commands

docs/datacenter.txt

@@ -0,0 +1,55 @@
+% Collins Golang CLI
+% Michael Schuett
+% February 12, 2019
+
+Synopsis
+========
+
+`collins datacenter` [site]...
+
+Description
+===========
+
+Collins datacenter manages multiple collins config files in your $HOME
+directory. It manages them via a symlink at ~/.collins.yml that points to
+files that are in the form of ~/.collins.yml.datacenter-name.
+
+Datacenter Examples
+------------
+
+List all currently configured collins config files.
+
+    collins datacenter --list
+
+Switch your ~/.collins.yml to point to a different site
+
+    collins datacenter irn3
+
+Options
+=======
+
+Datacenter options {.options}
+---------------
+
+`-n` *VALUES*, `--new` *VALUES*
+
+:   Create a new configuration file in the form of ~/.collins.yml.VALUE. You
+    can set --host, --username, and --password from the cli. If you do not it
+    will interactively ask you to fill them out.
+
+`-H` *VALUE*, `--host` *VALUE*
+
+:   Set the hostname at which collins lives.
+
+`-u` *VALUE*, `--username` *VALUE*
+
+:   Set the username via the cli. If not set the default name will be $USER.
+
+`-p` *VALUE*, `--password` *VALUE*
+
+:   Set the password to use for collins.
+
+`-l`, `--list`
+
+:   List all sites that collins is managing. The listed values can be made the
+    main config file with `collins datacenter $sitename`

docs/log.txt

@@ -0,0 +1,68 @@
+% Collins Golang CLI
+% Michael Schuett
+% February 12, 2019
+
+Synopsis
+========
+
+`collins log` [options]...
+
+Description
+===========
+
+Collins log will output logs from a single, multiple, or all tags that you
+specify.
+
+Log Examples
+------------
+
+List all logs for everything in collins. This might take a while.
+
+    collins log --all
+
+Follow a log for multiple assets.
+
+    collins log -t M00001,M00002 --follow
+
+Options
+=======
+
+Log options {.options}
+---------------
+
+`-a`, `--all`
+
+:   List all logs for every asset that you have in collins.
+
+`-n` *VALUE*, `--number` *VALUE*
+
+:   Set a limit on the number of logs that are output. By default only 20 logs
+    are ouput for a given asset. This means getting the output for two assets
+    would print out 40 logs by default.
+
+`-f`, `--follow`
+
+:   Tail the assets logs. This isn't instant but will query collins for new
+    logs that may have shown up every 2 seconds.
+
+`-s` *VALUE*, `--severity` *VALUE*
+
+:   Limit the log severity that is shown. By default all logs will be shown.
+    The following severity levels are valid.
+
+    ::: {#severity-levels}
+    - `EMERGENCY`
+    - `ALERT`
+    - `ERROR`
+    - `INFORMATIONAL`
+    - `DEBUG`
+    - `NOTE`
+    - `CRITICAL`
+    - `WARNING`
+    - `NOTICE`
+    :::
+
+`-t` *VALUES*, `--tags` *VALUES*
+
+:   Specify the tags to get logs from. You can specify multiple logs with a
+    comma (ex. tag1,tag2,tag3).

docs/power.txt

@@ -0,0 +1,56 @@
+% Collins Golang CLI
+% Michael Schuett
+% February 12, 2019
+
+Synopsis
+========
+
+`collins power` [options]...
+
+Description
+===========
+
+Collins power lets you change or list the current status of an asset if
+it has been configured properly with IPMI.
+
+Power Examples
+------------
+
+Show the current status.
+
+    collins power --status -t M001
+
+Power down an asset.
+
+    collins power -t M00001 -p off
+
+Options
+=======
+
+Power options {.options}
+---------------
+
+`-s`, `--status`
+
+:   List the current status of an asset.
+
+`-p` *VALUE*, `--power` *VALUE*
+
+:   Set the status of an asset. The following are valid power states.
+
+    ::: {#power-states}
+    - `reboot`
+    - `rebootSoft`
+    - `reboothard`
+    - `poweron`
+    - `on`
+    - `poweroff`
+    - `off`
+    - `identif`
+    - `verify`
+    :::
+
+`-t` *VALUES*, `--tags` *VALUES*
+
+:   The tags on which to operate. You can specify multiple with a comma in the
+    format of tag1,tag2.

docs/provision.txt

@@ -0,0 +1,59 @@
+% Collins Golang CLI
+% Michael Schuett
+% February 12, 2019
+
+Synopsis
+========
+
+`collins provision` [options]...
+
+Description
+===========
+
+Provision a new asset in collins.
+
+Provision Examples
+------------
+
+Provision a devnode
+
+    collins provision -n devnode -p DEVELOPMENT -t M0001
+
+Options
+=======
+
+Provision options {.options}
+---------------
+
+`-n` *VALUE*, `--nodeclass` *VALUE*
+
+:   Set the nodeclass to be used when provisioning the asset. Most of the time
+    this and pool should be all you need since a collins profile will set the
+    other values based on the nodeclass.
+
+`-p` *VALUE*, `--pool` *VALUE*
+
+:   Specify the pool for the asset to be provisioned into.
+
+`-r`, `--role`
+
+:   Specify the primary role of the asset.
+
+`-R` *VALUE*, `--secondary-role` *VALUE*
+
+:   Specify the secondary role of the asset
+
+`-s` *VALUE*, `--suffix` *VALUE*
+
+:   Specify a suffix to use when creating the hostname provided the nodeclass
+    allows for it.
+
+`-b` *VALUE*, `--build-contact` *VALUE*
+
+:   Set the build contact that will be shown as the contact in collins. My
+    default we use the $USER environment variable.
+
+`-t` *VALUES*, `--tags` *VALUES*
+
+:   Specify the tags that are to be provisioned. Multiple can be set in the
+    form of tag1,tag2.

docs/state.txt

@@ -0,0 +1,39 @@
+% Collins Golang CLI
+% Michael Schuett
+% February 12, 2019
+
+Synopsis
+========
+
+`collins state` [options]...
+
+Description
+===========
+
+Output all states that are available in to be set on an asset in collins.
+
+State Examples
+------------
+
+List all states in collins.
+
+    collins state --list
+
+Options
+=======
+
+State options {.options}
+---------------
+
+`-l`, `--list`
+
+:   List all states for your collins instance.
+
+`-H`, `--show-header`
+
+:   Show headers when listing all states.
+
+`-f`, `--field--separator`
+
+:   Choose how columns are seperated in the output from list. By default `/t`
+    is used.

man/datacenter.1

@@ -0,0 +1,54 @@
+.\" Automatically generated by Pandoc 2.6
+.\"
+.TH "Collins Golang CLI" "" "February 12, 2019" "" ""
+.hy
+.SH Synopsis
+.PP
+\f[C]collins datacenter\f[R] [site]\&...
+.SH Description
+.PP
+Collins datacenter manages multiple collins config files in your $HOME
+directory.
+It manages them via a symlink at \[ti]/.collins.yml that points to files
+that are in the form of \[ti]/.collins.yml.datacenter-name.
+.SS Datacenter Examples
+.PP
+List all currently configured collins config files.
+.IP
+.nf
+\f[C]
+collins datacenter --list
+\f[R]
+.fi
+.PP
+Switch your \[ti]/.collins.yml to point to a different site
+.IP
+.nf
+\f[C]
+collins datacenter irn3
+\f[R]
+.fi
+.SH Options
+.SS Datacenter options
+.TP
+.B \f[C]-n\f[R] \f[I]VALUES\f[R], \f[C]--new\f[R] \f[I]VALUES\f[R]
+Create a new configuration file in the form of \[ti]/.collins.yml.VALUE.
+You can set \[en]host, \[en]username, and \[en]password from the cli.
+If you do not it will interactively ask you to fill them out.
+.TP
+.B \f[C]-H\f[R] \f[I]VALUE\f[R], \f[C]--host\f[R] \f[I]VALUE\f[R]
+Set the hostname at which collins lives.
+.TP
+.B \f[C]-u\f[R] \f[I]VALUE\f[R], \f[C]--username\f[R] \f[I]VALUE\f[R]
+Set the username via the cli.
+If not set the default name will be $USER.
+.TP
+.B \f[C]-p\f[R] \f[I]VALUE\f[R], \f[C]--password\f[R] \f[I]VALUE\f[R]
+Set the password to use for collins.
+.TP
+.B \f[C]-l\f[R], \f[C]--list\f[R]
+List all sites that collins is managing.
+The listed values can be made the main config file with
+\f[C]collins datacenter $sitename\f[R]
+.SH AUTHORS
+Michael Schuett.