Skip to content

Commit

Permalink
docs: update docs
Browse files Browse the repository at this point in the history
Longhorn 9532

Signed-off-by: Derek Su <[email protected]>
  • Loading branch information
derekbit committed Sep 27, 2024
1 parent 772b491 commit 9b4ff2f
Show file tree
Hide file tree
Showing 16 changed files with 18 additions and 18 deletions.
2 changes: 1 addition & 1 deletion docs/longhornctl.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ CLI for Longhorn troubleshooting and operations.
* [longhornctl trim](longhornctl_trim.md) - Longhorn trimming operations
* [longhornctl version](longhornctl_version.md) - Print longhornctl version

###### Auto generated by spf13/cobra on 26-Jul-2024
###### Auto generated by spf13/cobra on 27-Sep-2024
2 changes: 1 addition & 1 deletion docs/longhornctl_check.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ Longhorn checking operations
* [longhornctl](longhornctl.md) - Longhorn commandline interface.
* [longhornctl check preflight](longhornctl_check_preflight.md) - Check Longhorn preflight

###### Auto generated by spf13/cobra on 26-Jul-2024
###### Auto generated by spf13/cobra on 27-Sep-2024
4 changes: 2 additions & 2 deletions docs/longhornctl_check_preflight.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,11 @@ INFO[2024-07-16T17:17:42+08:00] Completed preflight checker
--image string Image containing longhornctl-local (default "longhornio/longhorn-cli:v1.8.0-dev")
--kube-config string Kubernetes config (kubeconfig) path
-l, --log-level string Log level (default "info")
--userspace-driver string Userspace I/O driver for SPDK. (default "vfio_pci")
--userspace-driver string Userspace I/O driver for SPDK.
```

### SEE ALSO

* [longhornctl check](longhornctl_check.md) - Longhorn checking operations

###### Auto generated by spf13/cobra on 26-Jul-2024
###### Auto generated by spf13/cobra on 27-Sep-2024
2 changes: 1 addition & 1 deletion docs/longhornctl_doc.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ longhornctl doc [output directory] [flags]

* [longhornctl](longhornctl.md) - Longhorn commandline interface.

###### Auto generated by spf13/cobra on 26-Jul-2024
###### Auto generated by spf13/cobra on 27-Sep-2024
2 changes: 1 addition & 1 deletion docs/longhornctl_export.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ Export Longhorn resources
* [longhornctl](longhornctl.md) - Longhorn commandline interface.
* [longhornctl export replica](longhornctl_export_replica.md) - Export Longhorn replica

###### Auto generated by spf13/cobra on 26-Jul-2024
###### Auto generated by spf13/cobra on 27-Sep-2024
2 changes: 1 addition & 1 deletion docs/longhornctl_export_replica.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,4 +62,4 @@ lost+found
* [longhornctl export](longhornctl_export.md) - Export Longhorn resources
* [longhornctl export replica stop](longhornctl_export_replica_stop.md) - Stop exporting Longhorn replica

###### Auto generated by spf13/cobra on 26-Jul-2024
###### Auto generated by spf13/cobra on 27-Sep-2024
2 changes: 1 addition & 1 deletion docs/longhornctl_export_replica_stop.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ INFO[2024-07-16T17:29:14+08:00] Successfully stopped exporting replica

* [longhornctl export replica](longhornctl_export_replica.md) - Export Longhorn replica

###### Auto generated by spf13/cobra on 26-Jul-2024
###### Auto generated by spf13/cobra on 27-Sep-2024
2 changes: 1 addition & 1 deletion docs/longhornctl_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ Longhorn information gathering operations
* [longhornctl](longhornctl.md) - Longhorn commandline interface.
* [longhornctl get replica](longhornctl_get_replica.md) - Get Longhorn replica information

###### Auto generated by spf13/cobra on 26-Jul-2024
###### Auto generated by spf13/cobra on 27-Sep-2024
2 changes: 1 addition & 1 deletion docs/longhornctl_get_replica.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,4 +60,4 @@ INFO[2024-07-16T17:23:51+08:00] Completed replica getter

* [longhornctl get](longhornctl_get.md) - Longhorn information gathering operations

###### Auto generated by spf13/cobra on 26-Jul-2024
###### Auto generated by spf13/cobra on 27-Sep-2024
2 changes: 1 addition & 1 deletion docs/longhornctl_global-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ longhornctl global-options [flags]

* [longhornctl](longhornctl.md) - Longhorn commandline interface.

###### Auto generated by spf13/cobra on 26-Jul-2024
###### Auto generated by spf13/cobra on 27-Sep-2024
2 changes: 1 addition & 1 deletion docs/longhornctl_install.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ Longhorn installation operations
* [longhornctl](longhornctl.md) - Longhorn commandline interface.
* [longhornctl install preflight](longhornctl_install_preflight.md) - Install Longhorn preflight

###### Auto generated by spf13/cobra on 26-Jul-2024
###### Auto generated by spf13/cobra on 27-Sep-2024
4 changes: 2 additions & 2 deletions docs/longhornctl_install_preflight.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ INFO[2024-07-16T17:09:08+08:00] Completed preflight installer. Use 'longhornctl

```
--allow-pci string Specify a comma-separated (,) list of allowed PCI devices. By default, all PCI devices are blocked by a non-valid address. (default "none")
--driver-override string Userspace driver for device bindings. Override default driver for PCI devices. (default "vfio_pci")
--driver-override string Userspace driver for device bindings. Override default driver for PCI devices.
--enable-spdk Enable installation of SPDK required packages, modules, and setup.
-h, --help help for preflight
--huge-page-size int Specify the huge page size in MiB for SPDK. (default 2048)
Expand All @@ -45,4 +45,4 @@ INFO[2024-07-16T17:09:08+08:00] Completed preflight installer. Use 'longhornctl
* [longhornctl install](longhornctl_install.md) - Longhorn installation operations
* [longhornctl install preflight stop](longhornctl_install_preflight_stop.md) - Stop Longhorn preflight installer

###### Auto generated by spf13/cobra on 26-Jul-2024
###### Auto generated by spf13/cobra on 27-Sep-2024
2 changes: 1 addition & 1 deletion docs/longhornctl_install_preflight_stop.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,4 @@ INFO[2024-07-16T17:21:32+08:00] Successfully stopped preflight installer

* [longhornctl install preflight](longhornctl_install_preflight.md) - Install Longhorn preflight

###### Auto generated by spf13/cobra on 26-Jul-2024
###### Auto generated by spf13/cobra on 27-Sep-2024
2 changes: 1 addition & 1 deletion docs/longhornctl_trim.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ Longhorn trimming operations
* [longhornctl](longhornctl.md) - Longhorn commandline interface.
* [longhornctl trim volume](longhornctl_trim_volume.md) - Trim a Longhorn volume

###### Auto generated by spf13/cobra on 26-Jul-2024
###### Auto generated by spf13/cobra on 27-Sep-2024
2 changes: 1 addition & 1 deletion docs/longhornctl_trim_volume.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ INFO[2024-07-16T17:32:01+08:00] Completed volume trimmer vo

* [longhornctl trim](longhornctl_trim.md) - Longhorn trimming operations

###### Auto generated by spf13/cobra on 26-Jul-2024
###### Auto generated by spf13/cobra on 27-Sep-2024
2 changes: 1 addition & 1 deletion docs/longhornctl_version.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ longhornctl version [flags]

* [longhornctl](longhornctl.md) - Longhorn commandline interface.

###### Auto generated by spf13/cobra on 26-Jul-2024
###### Auto generated by spf13/cobra on 27-Sep-2024

0 comments on commit 9b4ff2f

Please sign in to comment.