From c1bac5f87c1aac165dda89ea274c8b915cf5e553 Mon Sep 17 00:00:00 2001 From: Joel Rebello Date: Tue, 5 Sep 2023 12:10:57 +0200 Subject: [PATCH] generate docs with `make gen-docs` --- docs/mctl.md | 1 + docs/mctl_collect.md | 29 +++++++++++++++++++++++++++++ docs/mctl_collect_inventory.md | 30 ++++++++++++++++++++++++++++++ docs/mctl_collect_status.md | 28 ++++++++++++++++++++++++++++ docs/mctl_delete.md | 1 + docs/mctl_delete_firmware.md | 28 ++++++++++++++++++++++++++++ 6 files changed, 117 insertions(+) create mode 100644 docs/mctl_collect.md create mode 100644 docs/mctl_collect_inventory.md create mode 100644 docs/mctl_collect_status.md create mode 100644 docs/mctl_delete_firmware.md diff --git a/docs/mctl.md b/docs/mctl.md index b0962abb..3ec2d23c 100644 --- a/docs/mctl.md +++ b/docs/mctl.md @@ -14,6 +14,7 @@ mctl is a CLI utility to interact with metal toolbox services ### SEE ALSO +* [mctl collect](mctl_collect.md) - Collect current server firmware status and bios configuration * [mctl completion](mctl_completion.md) - Generate the autocompletion script for the specified shell * [mctl create](mctl_create.md) - Create resources * [mctl delete](mctl_delete.md) - Delete resources diff --git a/docs/mctl_collect.md b/docs/mctl_collect.md new file mode 100644 index 00000000..1ff4d062 --- /dev/null +++ b/docs/mctl_collect.md @@ -0,0 +1,29 @@ +[Auto generated by spf13/cobra]: <> + +## mctl collect + +Collect current server firmware status and bios configuration + +``` +mctl collect [flags] +``` + +### Options + +``` + -h, --help help for collect +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $XDG_CONFIG_HOME/mctl/config.yml) + --reauth re-authenticate with oauth services +``` + +### SEE ALSO + +* [mctl](mctl.md) - mctl is a CLI utility to interact with metal toolbox services +* [mctl collect inventory](mctl_collect_inventory.md) - Collect current server firmware status and bios configuration +* [mctl collect status](mctl_collect_status.md) - check the progress of a inventory collection for a server + diff --git a/docs/mctl_collect_inventory.md b/docs/mctl_collect_inventory.md new file mode 100644 index 00000000..3408073d --- /dev/null +++ b/docs/mctl_collect_inventory.md @@ -0,0 +1,30 @@ +[Auto generated by spf13/cobra]: <> + +## mctl collect inventory + +Collect current server firmware status and bios configuration + +``` +mctl collect inventory [flags] +``` + +### Options + +``` + -h, --help help for inventory + --server string server UUID + --skip-bios-config Skip BIOS configuration data collection + --skip-fw-status Skip firmware status data collection +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $XDG_CONFIG_HOME/mctl/config.yml) + --reauth re-authenticate with oauth services +``` + +### SEE ALSO + +* [mctl collect](mctl_collect.md) - Collect current server firmware status and bios configuration + diff --git a/docs/mctl_collect_status.md b/docs/mctl_collect_status.md new file mode 100644 index 00000000..0a16f147 --- /dev/null +++ b/docs/mctl_collect_status.md @@ -0,0 +1,28 @@ +[Auto generated by spf13/cobra]: <> + +## mctl collect status + +check the progress of a inventory collection for a server + +``` +mctl collect status --server | -s [flags] +``` + +### Options + +``` + -h, --help help for status + -s, --server string server id (typically a UUID) +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $XDG_CONFIG_HOME/mctl/config.yml) + --reauth re-authenticate with oauth services +``` + +### SEE ALSO + +* [mctl collect](mctl_collect.md) - Collect current server firmware status and bios configuration + diff --git a/docs/mctl_delete.md b/docs/mctl_delete.md index 35360822..ffc35259 100644 --- a/docs/mctl_delete.md +++ b/docs/mctl_delete.md @@ -25,5 +25,6 @@ mctl delete [flags] * [mctl](mctl.md) - mctl is a CLI utility to interact with metal toolbox services * [mctl delete condition](mctl_delete_condition.md) - delete server condition +* [mctl delete firmware](mctl_delete_firmware.md) - Delete a firmware object * [mctl delete firmware-set](mctl_delete_firmware-set.md) - Delete a firmware set diff --git a/docs/mctl_delete_firmware.md b/docs/mctl_delete_firmware.md new file mode 100644 index 00000000..79aea976 --- /dev/null +++ b/docs/mctl_delete_firmware.md @@ -0,0 +1,28 @@ +[Auto generated by spf13/cobra]: <> + +## mctl delete firmware + +Delete a firmware object + +``` +mctl delete firmware [flags] +``` + +### Options + +``` + -f, --firmware-id string UUID of firmware object to be deleted + -h, --help help for firmware +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $XDG_CONFIG_HOME/mctl/config.yml) + --reauth re-authenticate with oauth services +``` + +### SEE ALSO + +* [mctl delete](mctl_delete.md) - Delete resources +