Skip to content

Commit

Permalink
chore(docs): generate documents
Browse files Browse the repository at this point in the history
Signed-off-by: Derek Su <[email protected]>
  • Loading branch information
derekbit committed Jul 22, 2024
1 parent 733e5f6 commit 369a884
Show file tree
Hide file tree
Showing 16 changed files with 33 additions and 33 deletions.
4 changes: 2 additions & 2 deletions docs/longhornctl.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ CLI for Longhorn troubleshooting and operations.

```
-h, --help help for longhornctl
--image string Image containing longhornctl-local (default "longhornio/longhorn-cli:v1.8.0-dev")
--image string Image containing longhornctl-local (default "longhornio/longhorn-cli:v1.7.0-rc1")
--kube-config string Kubernetes config (kubeconfig) path
-l, --log-level string log level (trace, debug, info, warn, error, fatal, panic) (default "info")
```
Expand All @@ -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 17-Jul-2024
###### Auto generated by spf13/cobra on 22-Jul-2024
4 changes: 2 additions & 2 deletions docs/longhornctl_check.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Longhorn checking operations

```
-h, --help help for check
--image string Image containing longhornctl-local (default "longhornio/longhorn-cli:v1.8.0-dev")
--image string Image containing longhornctl-local (default "longhornio/longhorn-cli:v1.7.0-rc1")
--kube-config string Kubernetes config (kubeconfig) path
-l, --log-level string Log level (default "info")
```
Expand All @@ -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 17-Jul-2024
###### Auto generated by spf13/cobra on 22-Jul-2024
4 changes: 2 additions & 2 deletions docs/longhornctl_check_preflight.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ INFO[2024-07-16T17:17:42+08:00] Completed preflight checker
--enable-spdk Enable checking 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)
--image string Image containing longhornctl-local (default "longhornio/longhorn-cli:v1.8.0-dev")
--image string Image containing longhornctl-local (default "longhornio/longhorn-cli:v1.7.0-rc1")
--kube-config string Kubernetes config (kubeconfig) path
-l, --log-level string Log level (default "info")
--uio-driver string User space I/O driver for SPDK. (default "uio_pci_generic")
Expand All @@ -57,4 +57,4 @@ INFO[2024-07-16T17:17:42+08:00] Completed preflight checker

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

###### Auto generated by spf13/cobra on 17-Jul-2024
###### Auto generated by spf13/cobra on 22-Jul-2024
4 changes: 2 additions & 2 deletions docs/longhornctl_doc.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ longhornctl doc [output directory] [flags]
### Options inherited from parent commands

```
--image string Image containing longhornctl-local (default "longhornio/longhorn-cli:v1.8.0-dev")
--image string Image containing longhornctl-local (default "longhornio/longhorn-cli:v1.7.0-rc1")
--kube-config string Kubernetes config (kubeconfig) path
-l, --log-level string log level (trace, debug, info, warn, error, fatal, panic) (default "info")
```
Expand All @@ -28,4 +28,4 @@ longhornctl doc [output directory] [flags]

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

###### Auto generated by spf13/cobra on 17-Jul-2024
###### Auto generated by spf13/cobra on 22-Jul-2024
4 changes: 2 additions & 2 deletions docs/longhornctl_export.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Export Longhorn resources

```
-h, --help help for export
--image string Image containing longhornctl-local (default "longhornio/longhorn-cli:v1.8.0-dev")
--image string Image containing longhornctl-local (default "longhornio/longhorn-cli:v1.7.0-rc1")
--kube-config string Kubernetes config (kubeconfig) path
-l, --log-level string Log level (default "info")
```
Expand All @@ -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 17-Jul-2024
###### Auto generated by spf13/cobra on 22-Jul-2024
6 changes: 3 additions & 3 deletions docs/longhornctl_export_replica.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,9 @@ lost+found

```
--data-dir string Specify the Longhorn data directory. If not provided, the default will be attempted, or it will fall back to the directory of longhorn-disk.cfg. (default "/var/lib/longhorn")
--engine-image string Engine image to use to create volume from the replica. (default "longhornio/longhorn-engine:v1.8.0-dev")
--engine-image string Engine image to use to create volume from the replica. (default "longhornio/longhorn-engine:v1.7.0-rc1")
-h, --help help for replica
--image string Image containing longhornctl-local (default "longhornio/longhorn-cli:v1.8.0-dev")
--image string Image containing longhornctl-local (default "longhornio/longhorn-cli:v1.7.0-rc1")
--kube-config string Kubernetes config (kubeconfig) path
-l, --log-level string Log level (default "info")
--name string Specify the replica directory name to export. The replica data directory name is not the same as the Kubernetes Replica custom resource (CR) object name. To retrieve the replica directory name, use 'longhornctl get replica'.
Expand All @@ -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 17-Jul-2024
###### Auto generated by spf13/cobra on 22-Jul-2024
4 changes: 2 additions & 2 deletions docs/longhornctl_export_replica_stop.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ INFO[2024-07-16T17:29:14+08:00] Successfully stopped exporting replica

```
-h, --help help for stop
--image string Image containing longhornctl-local (default "longhornio/longhorn-cli:v1.8.0-dev")
--image string Image containing longhornctl-local (default "longhornio/longhorn-cli:v1.7.0-rc1")
--kube-config string Kubernetes config (kubeconfig) path
-l, --log-level string Log level (default "info")
```
Expand All @@ -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 17-Jul-2024
###### Auto generated by spf13/cobra on 22-Jul-2024
4 changes: 2 additions & 2 deletions docs/longhornctl_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Longhorn information gathering operations

```
-h, --help help for get
--image string Image containing longhornctl-local (default "longhornio/longhorn-cli:v1.8.0-dev")
--image string Image containing longhornctl-local (default "longhornio/longhorn-cli:v1.7.0-rc1")
--kube-config string Kubernetes config (kubeconfig) path
-l, --log-level string Log level (default "info")
```
Expand All @@ -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 17-Jul-2024
###### Auto generated by spf13/cobra on 22-Jul-2024
4 changes: 2 additions & 2 deletions docs/longhornctl_get_replica.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ INFO[2024-07-16T17:23:51+08:00] Completed replica getter
```
--data-dir string Specify the Longhorn data directory. If not provided, the default will be attempted, or it will fall back to the directory of longhorn-disk.cfg. (default "/var/lib/longhorn")
-h, --help help for replica
--image string Image containing longhornctl-local (default "longhornio/longhorn-cli:v1.8.0-dev")
--image string Image containing longhornctl-local (default "longhornio/longhorn-cli:v1.7.0-rc1")
--kube-config string Kubernetes config (kubeconfig) path
-l, --log-level string Log level (default "info")
--name string Specify the name of the replica to retrieve information.
Expand All @@ -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 17-Jul-2024
###### Auto generated by spf13/cobra on 22-Jul-2024
4 changes: 2 additions & 2 deletions docs/longhornctl_global-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ longhornctl global-options [flags]
### Options inherited from parent commands

```
--image string Image containing longhornctl-local (default "longhornio/longhorn-cli:v1.8.0-dev")
--image string Image containing longhornctl-local (default "longhornio/longhorn-cli:v1.7.0-rc1")
--kube-config string Kubernetes config (kubeconfig) path
-l, --log-level string log level (trace, debug, info, warn, error, fatal, panic) (default "info")
```
Expand All @@ -28,4 +28,4 @@ longhornctl global-options [flags]

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

###### Auto generated by spf13/cobra on 17-Jul-2024
###### Auto generated by spf13/cobra on 22-Jul-2024
4 changes: 2 additions & 2 deletions docs/longhornctl_install.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Longhorn installation operations

```
-h, --help help for install
--image string Image containing longhornctl-local (default "longhornio/longhorn-cli:v1.8.0-dev")
--image string Image containing longhornctl-local (default "longhornio/longhorn-cli:v1.7.0-rc1")
--kube-config string Kubernetes config (kubeconfig) path
-l, --log-level string Log level (default "info")
```
Expand All @@ -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 17-Jul-2024
###### Auto generated by spf13/cobra on 22-Jul-2024
4 changes: 2 additions & 2 deletions docs/longhornctl_install_preflight.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ INFO[2024-07-16T17:09:08+08:00] Completed preflight installer. Use 'longhornctl
--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)
--image string Image containing longhornctl-local (default "longhornio/longhorn-cli:v1.8.0-dev")
--image string Image containing longhornctl-local (default "longhornio/longhorn-cli:v1.7.0-rc1")
--kube-config string Kubernetes config (kubeconfig) path
-l, --log-level string Log level (default "info")
--operating-system string Specify the operating system ("", cos). Leave this empty to use the package manager for installation.
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 17-Jul-2024
###### Auto generated by spf13/cobra on 22-Jul-2024
4 changes: 2 additions & 2 deletions docs/longhornctl_install_preflight_stop.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ INFO[2024-07-16T17:21:32+08:00] Successfully stopped preflight installer

```
-h, --help help for stop
--image string Image containing longhornctl-local (default "longhornio/longhorn-cli:v1.8.0-dev")
--image string Image containing longhornctl-local (default "longhornio/longhorn-cli:v1.7.0-rc1")
--kube-config string Kubernetes config (kubeconfig) path
-l, --log-level string Log level (default "info")
--operating-system string Specify the operating system ("", cos). Leave this empty to use the package manager for installation.
Expand All @@ -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 17-Jul-2024
###### Auto generated by spf13/cobra on 22-Jul-2024
4 changes: 2 additions & 2 deletions docs/longhornctl_trim.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Longhorn trimming operations

```
-h, --help help for trim
--image string Image containing longhornctl-local (default "longhornio/longhorn-cli:v1.8.0-dev")
--image string Image containing longhornctl-local (default "longhornio/longhorn-cli:v1.7.0-rc1")
--kube-config string Kubernetes config (kubeconfig) path
-l, --log-level string Log level (default "info")
```
Expand All @@ -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 17-Jul-2024
###### Auto generated by spf13/cobra on 22-Jul-2024
4 changes: 2 additions & 2 deletions docs/longhornctl_trim_volume.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ INFO[2024-07-16T17:32:01+08:00] Completed volume trimmer vo

```
-h, --help help for volume
--image string Image containing longhornctl-local (default "longhornio/longhorn-cli:v1.8.0-dev")
--image string Image containing longhornctl-local (default "longhornio/longhorn-cli:v1.7.0-rc1")
--kube-config string Kubernetes config (kubeconfig) path
-l, --log-level string Log level (default "info")
--longhorn-namespace string Namespace where Longhorn is deployed within the Kubernetes cluster. (default "longhorn-system")
Expand All @@ -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 17-Jul-2024
###### Auto generated by spf13/cobra on 22-Jul-2024
4 changes: 2 additions & 2 deletions docs/longhornctl_version.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ longhornctl version [flags]
### Options inherited from parent commands

```
--image string Image containing longhornctl-local (default "longhornio/longhorn-cli:v1.8.0-dev")
--image string Image containing longhornctl-local (default "longhornio/longhorn-cli:v1.7.0-rc1")
--kube-config string Kubernetes config (kubeconfig) path
-l, --log-level string log level (trace, debug, info, warn, error, fatal, panic) (default "info")
```
Expand All @@ -24,4 +24,4 @@ longhornctl version [flags]

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

###### Auto generated by spf13/cobra on 17-Jul-2024
###### Auto generated by spf13/cobra on 22-Jul-2024

0 comments on commit 369a884

Please sign in to comment.