Skip to content

Commit 6f531f0

Browse files
teoteo
committed
[coconut] Generate coconut user documentation
1 parent 2c28210 commit 6f531f0

28 files changed

+186
-26
lines changed

‎coconut/doc/coconut.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,4 @@ For more information on the available commands, see the individual documentation
3030
* [coconut task](coconut_task.md) - manage active tasks
3131
* [coconut template](coconut_template.md) - query available workflow templates in configuration repositories
3232

33-
###### Auto generated by spf13/cobra on 12-Sep-2019
33+
###### Auto generated by spf13/cobra on 3-Oct-2019

‎coconut/doc/coconut_about.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,4 @@ coconut about [flags]
2929

3030
* [coconut](coconut.md) - O² Control and Configuration Utility
3131

32-
###### Auto generated by spf13/cobra on 12-Sep-2019
32+
###### Auto generated by spf13/cobra on 3-Oct-2019

‎coconut/doc/coconut_configuration.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ configuration store.
2626

2727
* [coconut](coconut.md) - O² Control and Configuration Utility
2828
* [coconut configuration dump](coconut_configuration_dump.md) - dump configuration subtree
29+
* [coconut configuration history](coconut_configuration_history.md) - List all existing entries with timestamps of a specified component in Consul
30+
* [coconut configuration import](coconut_configuration_import.md) - Import a configuration file for the specified component and entry
2931
* [coconut configuration list](coconut_configuration_list.md) - List all existing O² components in Consul
32+
* [coconut configuration show](coconut_configuration_show.md) - Show configuration for the component and entry specified
3033

31-
###### Auto generated by spf13/cobra on 12-Sep-2019
34+
###### Auto generated by spf13/cobra on 3-Oct-2019

‎coconut/doc/coconut_configuration_dump.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,4 @@ coconut configuration dump [key] [flags]
3232

3333
* [coconut configuration](coconut_configuration.md) - view or modify O² configuration
3434

35-
###### Auto generated by spf13/cobra on 12-Sep-2019
35+
###### Auto generated by spf13/cobra on 3-Oct-2019

‎coconut/doc/coconut_configuration_history.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
## coconut configuration history
2+
3+
List all existing entries with timestamps of a specified component in Consul
4+
5+
### Synopsis
6+
7+
The configuration history command returns all entries with
8+
all of their associated timestamps or returns all timestamps for a specified component and entry
9+
10+
```
11+
coconut configuration history <query> [flags]
12+
```
13+
14+
### Examples
15+
16+
```
17+
coconut conf history <component>
18+
coconut conf history <component> <entry>
19+
coconut conf history <component>/<entry>
20+
```
21+
22+
### Options
23+
24+
```
25+
-h, --help help for history
26+
-o, --output string output format for the returned entries (yaml/json) (default "yaml")
27+
```
28+
29+
### Options inherited from parent commands
30+
31+
```
32+
--config string optional configuration file for coconut (default $HOME/.config/coconut/settings.yaml)
33+
--config_endpoint string configuration endpoint used by AliECS core as PROTO://HOST:PORT (default "consul://127.0.0.1:8500")
34+
--endpoint string AliECS core endpoint as HOST:PORT (default "127.0.0.1:47102")
35+
-v, --verbose show verbose output for debug purposes
36+
```
37+
38+
### SEE ALSO
39+
40+
* [coconut configuration](coconut_configuration.md) - view or modify O² configuration
41+
42+
###### Auto generated by spf13/cobra on 3-Oct-2019

‎coconut/doc/coconut_configuration_import.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
## coconut configuration import
2+
3+
Import a configuration file for the specified component and entry
4+
5+
### Synopsis
6+
7+
The configuration import command generates a timestamp and saves
8+
the configuration file to Consul under the <component>/<entry>/<timestamp> path.
9+
Supported configuration file types are JSON, YAML, TOML and INI,
10+
and their file extensions are recognized automatically.
11+
12+
```
13+
coconut configuration import <component> <entry> <file_path> [flags]
14+
```
15+
16+
### Examples
17+
18+
```
19+
coconut conf import <component> <entry> <file_path>
20+
coconut conf import <component>/<entry> <file_path>
21+
coconut conf import <component> <entry> <file_path> --new-component
22+
coconut conf import <component>/<entry> <file_path> --format=json
23+
coconut conf import <component> <entry> <file_path>.json
24+
25+
```
26+
27+
### Options
28+
29+
```
30+
-f, --format string force a specific configuration file type, overriding any file extension
31+
-h, --help help for import
32+
-n, --new-component create a new configuration component while importing entry
33+
```
34+
35+
### Options inherited from parent commands
36+
37+
```
38+
--config string optional configuration file for coconut (default $HOME/.config/coconut/settings.yaml)
39+
--config_endpoint string configuration endpoint used by AliECS core as PROTO://HOST:PORT (default "consul://127.0.0.1:8500")
40+
--endpoint string AliECS core endpoint as HOST:PORT (default "127.0.0.1:47102")
41+
-v, --verbose show verbose output for debug purposes
42+
```
43+
44+
### SEE ALSO
45+
46+
* [coconut configuration](coconut_configuration.md) - view or modify O² configuration
47+
48+
###### Auto generated by spf13/cobra on 3-Oct-2019

‎coconut/doc/coconut_configuration_list.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,4 +40,4 @@ coconut conf list <component> -t <timestamp>
4040

4141
* [coconut configuration](coconut_configuration.md) - view or modify O² configuration
4242

43-
###### Auto generated by spf13/cobra on 12-Sep-2019
43+
###### Auto generated by spf13/cobra on 3-Oct-2019

‎coconut/doc/coconut_configuration_show.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
## coconut configuration show
2+
3+
Show configuration for the component and entry specified
4+
5+
### Synopsis
6+
7+
The configuration show command returns the most recent
8+
configuration revision for the specified component and entry.
9+
It can also return a specific revision, requested with the --timestamp/-t flag
10+
11+
```
12+
coconut configuration show <component> <entry> [flags]
13+
```
14+
15+
### Examples
16+
17+
```
18+
coconut conf show <component> <entry>
19+
coconut conf show <component> <entry> -t <timestamp>
20+
coconut conf show <component>/<entry>
21+
coconut conf show <component>/<entry> -t <timestamp>
22+
coconut conf show <component>/<entry>@<timestamp>
23+
```
24+
25+
### Options
26+
27+
```
28+
-h, --help help for show
29+
-t, --timestamp string request configuration for this timestamp
30+
```
31+
32+
### Options inherited from parent commands
33+
34+
```
35+
--config string optional configuration file for coconut (default $HOME/.config/coconut/settings.yaml)
36+
--config_endpoint string configuration endpoint used by AliECS core as PROTO://HOST:PORT (default "consul://127.0.0.1:8500")
37+
--endpoint string AliECS core endpoint as HOST:PORT (default "127.0.0.1:47102")
38+
-v, --verbose show verbose output for debug purposes
39+
```
40+
41+
### SEE ALSO
42+
43+
* [coconut configuration](coconut_configuration.md) - view or modify O² configuration
44+
45+
###### Auto generated by spf13/cobra on 3-Oct-2019

‎coconut/doc/coconut_environment.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,4 +51,4 @@ For more information on the behavior of coconut environments, see the subcommand
5151
* [coconut environment list](coconut_environment_list.md) - list environments
5252
* [coconut environment show](coconut_environment_show.md) - show environment information
5353

54-
###### Auto generated by spf13/cobra on 12-Sep-2019
54+
###### Auto generated by spf13/cobra on 3-Oct-2019

‎coconut/doc/coconut_environment_control.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,4 +39,4 @@ coconut environment control [environment id] [flags]
3939

4040
* [coconut environment](coconut_environment.md) - create, destroy and manage AliECS environments
4141

42-
###### Auto generated by spf13/cobra on 12-Sep-2019
42+
###### Auto generated by spf13/cobra on 3-Oct-2019

0 commit comments

Comments
 (0)