Skip to content

Commit

Permalink
add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Lior Nabat committed Dec 16, 2022
1 parent fc58676 commit c03a791
Show file tree
Hide file tree
Showing 66 changed files with 838 additions and 192 deletions.
67 changes: 5 additions & 62 deletions .idea/workspace.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion cmd/root/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ import (
"github.com/kubemq-io/kubemqctl/pkg/config"
"github.com/kubemq-io/kubemqctl/pkg/utils"
"github.com/spf13/cobra"
"github.com/spf13/cobra/doc"
)

var (
Expand Down Expand Up @@ -84,7 +85,7 @@ func Execute(version string, args []string) {
rootCmd.AddCommand(install.NewCmdInstall(ctx, cfg))
rootCmd.AddCommand(build.NewCmdBuild(ctx, cfg))

//_ = doc.GenMarkdownTree(rootCmd, "./docs")
_ = doc.GenMarkdownTree(rootCmd, "./docs")

utils.CheckErr(rootCmd.Execute())
}
Expand Down
11 changes: 5 additions & 6 deletions docs/kubemqctl.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@



### Synopsis



### Options

```
Expand All @@ -15,16 +11,19 @@

### SEE ALSO

* [kubemqctl build](kubemqctl_build.md) - Load KubeMQ builder in browser
* [kubemqctl commands](kubemqctl_commands.md) - Execute Kubemq 'commands' RPC commands
* [kubemqctl config](kubemqctl_config.md) - Run Kubemqctl configuration wizard command
* [kubemqctl create](kubemqctl_create.md) - Executes Kubemq create commands
* [kubemqctl create](kubemqctl_create.md) -
* [kubemqctl delete](kubemqctl_delete.md) - Executes delete commands
* [kubemqctl events](kubemqctl_events.md) - Execute Kubemq 'events' Pub/Sub commands
* [kubemqctl events_store](kubemqctl_events_store.md) - Execute Kubemq 'events_store' Pub/Sub commands
* [kubemqctl generate](kubemqctl_generate.md) - Generate various kubemq related artifacts
* [kubemqctl get](kubemqctl_get.md) - Executes Kubemq get commands
* [kubemqctl install](kubemqctl_install.md) - Executes Kubemq install cluster command
* [kubemqctl queries](kubemqctl_queries.md) - Execute Kubemq 'queries' RPC based commands
* [kubemqctl queues](kubemqctl_queues.md) - Execute Kubemq 'queues' commands
* [kubemqctl scale](kubemqctl_scale.md) - Executes Kubemq scale commands
* [kubemqctl set](kubemqctl_set.md) - Executes set commands

###### Auto generated by spf13/cobra on 16-Apr-2020
###### Auto generated by spf13/cobra on 16-Dec-2022
35 changes: 35 additions & 0 deletions docs/kubemqctl_build.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
## kubemqctl build

Load KubeMQ builder in browser

### Synopsis

Load KubeMQ builder in browser

```
kubemqctl build [flags]
```

### Examples

```
kubemqctl build
```

### Options

```
-h, --help help for build
```

### Options inherited from parent commands

```
--config string set kubemqctl configuration file (default "./.kubemqctl.yaml")
```

### SEE ALSO

* [kubemqctl](kubemqctl.md) -

###### Auto generated by spf13/cobra on 16-Dec-2022
4 changes: 2 additions & 2 deletions docs/kubemqctl_commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ kubemqctl commands [flags]

* [kubemqctl](kubemqctl.md) -
* [kubemqctl commands attach](kubemqctl_commands_attach.md) - Attach to 'commands' channels command
* [kubemqctl commands receive](kubemqctl_commands_receive.md) - Receive a message from 'commands' channel command
* [kubemqctl commands receive](kubemqctl_commands_receive.md) - Receive a body from 'commands' channel command
* [kubemqctl commands send](kubemqctl_commands_send.md) - Send messages to 'commands' channel command

###### Auto generated by spf13/cobra on 16-Apr-2020
###### Auto generated by spf13/cobra on 16-Dec-2022
2 changes: 1 addition & 1 deletion docs/kubemqctl_commands_attach.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,4 @@ kubemqctl commands attach [flags]

* [kubemqctl commands](kubemqctl_commands.md) - Execute Kubemq 'commands' RPC commands

###### Auto generated by spf13/cobra on 16-Apr-2020
###### Auto generated by spf13/cobra on 16-Dec-2022
10 changes: 5 additions & 5 deletions docs/kubemqctl_commands_receive.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## kubemqctl commands receive

Receive a message from 'commands' channel command
Receive a body from 'commands' channel command

### Synopsis

Receive (Subscribe) command allows to consume a message from 'commands' channel and response with appropriate reply
Receive (Subscribe) command allows to consume a body from 'commands' channel and response with appropriate reply

```
kubemqctl commands receive [flags]
Expand All @@ -14,10 +14,10 @@ kubemqctl commands receive [flags]

```
# Receive commands from a 'commands' channel (blocks until next message)
# Receive commands from a 'commands' channel (blocks until next body)
kubemqctl commands receive some-channel
# Receive commands from a 'commands' channel with group (blocks until next message)
# Receive commands from a 'commands' channel with group (blocks until next body)
kubemqctl commands receive some-channel -g G1
```
Expand All @@ -40,4 +40,4 @@ kubemqctl commands receive [flags]

* [kubemqctl commands](kubemqctl_commands.md) - Execute Kubemq 'commands' RPC commands

###### Auto generated by spf13/cobra on 16-Apr-2020
###### Auto generated by spf13/cobra on 16-Dec-2022
10 changes: 6 additions & 4 deletions docs/kubemqctl_commands_send.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,20 @@ kubemqctl commands send [flags]
kubemqctl commands send some-channel some-command
# Send command to a 'commands' channel with metadata
kubemqctl commands send some-channel some-message -m some-metadata
kubemqctl commands send some-channel some-body -m some-metadata
# Send command to a 'commands' channel with 120 seconds timeout
kubemqctl commands send some-channel some-message -o 120
kubemqctl commands send some-channel some-body -o 120
```

### Options

```
-b, --build build kubemq targets request
-f, --file set load body from file
-h, --help help for send
-m, --metadata string Set metadata message
-m, --metadata string Set metadata body
-o, --timeout int Set command timeout (default 30)
```

Expand All @@ -43,4 +45,4 @@ kubemqctl commands send [flags]

* [kubemqctl commands](kubemqctl_commands.md) - Execute Kubemq 'commands' RPC commands

###### Auto generated by spf13/cobra on 16-Apr-2020
###### Auto generated by spf13/cobra on 16-Dec-2022
6 changes: 5 additions & 1 deletion docs/kubemqctl_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,9 @@ kubemqctl config [flags]
### SEE ALSO

* [kubemqctl](kubemqctl.md) -
* [kubemqctl config access](kubemqctl_config_access.md) - Config access command allows to set Kubemqctl access
* [kubemqctl config connection](kubemqctl_config_connection.md) - Config connection command allows to set Kubemqctl connection
* [kubemqctl config context](kubemqctl_config_context.md) - Config context command allows to set Kubemqctl context
* [kubemqctl config license](kubemqctl_config_license.md) - Config license command allows to set Kubemqctl license

###### Auto generated by spf13/cobra on 16-Apr-2020
###### Auto generated by spf13/cobra on 16-Dec-2022
38 changes: 38 additions & 0 deletions docs/kubemqctl_config_access.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
## kubemqctl config access

Config access command allows to set Kubemqctl access

### Synopsis

Config access command allows to set Kubemqctl access

```
kubemqctl config access [flags]
```

### Examples

```
# Execute access configuration
# kubemqctl config access
```

### Options

```
-h, --help help for access
```

### Options inherited from parent commands

```
--config string set kubemqctl configuration file (default "./.kubemqctl.yaml")
```

### SEE ALSO

* [kubemqctl config](kubemqctl_config.md) - Run Kubemqctl configuration wizard command

###### Auto generated by spf13/cobra on 16-Dec-2022
38 changes: 38 additions & 0 deletions docs/kubemqctl_config_connection.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
## kubemqctl config connection

Config connection command allows to set Kubemqctl connection

### Synopsis

Config connection command allows to set Kubemqctl connection

```
kubemqctl config connection [flags]
```

### Examples

```
# Execute connection configuration
# kubemqctl config connection
```

### Options

```
-h, --help help for connection
```

### Options inherited from parent commands

```
--config string set kubemqctl configuration file (default "./.kubemqctl.yaml")
```

### SEE ALSO

* [kubemqctl config](kubemqctl_config.md) - Run Kubemqctl configuration wizard command

###### Auto generated by spf13/cobra on 16-Dec-2022
38 changes: 38 additions & 0 deletions docs/kubemqctl_config_context.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
## kubemqctl config context

Config context command allows to set Kubemqctl context

### Synopsis

Config context command allows to set Kubemqctl context

```
kubemqctl config context [flags]
```

### Examples

```
# Execute context configuration
# kubemqctl config context
```

### Options

```
-h, --help help for context
```

### Options inherited from parent commands

```
--config string set kubemqctl configuration file (default "./.kubemqctl.yaml")
```

### SEE ALSO

* [kubemqctl config](kubemqctl_config.md) - Run Kubemqctl configuration wizard command

###### Auto generated by spf13/cobra on 16-Dec-2022
Loading

0 comments on commit c03a791

Please sign in to comment.