[coconut] Generate coconut user documentation

AliceO2Group · Oct 3, 2019 · 6f531f0 · 6f531f0
1 parent 2c28210
commit 6f531f0
Show file tree

Hide file tree

Showing 28 changed files with 186 additions and 26 deletions.
diff --git a/coconut/doc/coconut.md b/coconut/doc/coconut.md
@@ -30,4 +30,4 @@ For more information on the available commands, see the individual documentation
 * [coconut task](coconut_task.md)	 - manage active tasks
 * [coconut template](coconut_template.md)	 - query available workflow templates in configuration repositories
 
-###### Auto generated by spf13/cobra on 12-Sep-2019
+###### Auto generated by spf13/cobra on 3-Oct-2019
diff --git a/coconut/doc/coconut_about.md b/coconut/doc/coconut_about.md
@@ -29,4 +29,4 @@ coconut about [flags]
 
 * [coconut](coconut.md)	 - O² Control and Configuration Utility
 
-###### Auto generated by spf13/cobra on 12-Sep-2019
+###### Auto generated by spf13/cobra on 3-Oct-2019
diff --git a/coconut/doc/coconut_configuration.md b/coconut/doc/coconut_configuration.md
@@ -26,6 +26,9 @@ configuration store.
 
 * [coconut](coconut.md)	 - O² Control and Configuration Utility
 * [coconut configuration dump](coconut_configuration_dump.md)	 - dump configuration subtree
+* [coconut configuration history](coconut_configuration_history.md)	 - List all existing entries with timestamps of a specified component in Consul
+* [coconut configuration import](coconut_configuration_import.md)	 - Import a configuration file for the specified component and entry
 * [coconut configuration list](coconut_configuration_list.md)	 - List all existing O² components in Consul
+* [coconut configuration show](coconut_configuration_show.md)	 - Show configuration for the component and entry specified
 
-###### Auto generated by spf13/cobra on 12-Sep-2019
+###### Auto generated by spf13/cobra on 3-Oct-2019
diff --git a/coconut/doc/coconut_configuration_dump.md b/coconut/doc/coconut_configuration_dump.md
@@ -32,4 +32,4 @@ coconut configuration dump [key] [flags]
 
 * [coconut configuration](coconut_configuration.md)	 - view or modify O² configuration
 
-###### Auto generated by spf13/cobra on 12-Sep-2019
+###### Auto generated by spf13/cobra on 3-Oct-2019
diff --git a/coconut/doc/coconut_configuration_history.md b/coconut/doc/coconut_configuration_history.md
@@ -0,0 +1,42 @@
+## coconut configuration history
+
+List all existing entries with timestamps of a specified component in Consul
+
+### Synopsis
+
+The configuration history command returns all entries with 
+all of their associated timestamps or returns all timestamps for a specified component and entry
+
+```
+coconut configuration history <query> [flags]
+```
+
+### Examples
+
+```
+coconut conf history <component>
+coconut conf history <component> <entry>
+coconut conf history <component>/<entry>
+```
+
+### Options
+
+```
+  -h, --help            help for history
+  -o, --output string   output format for the returned entries (yaml/json) (default "yaml")
+```
+
+### Options inherited from parent commands
+
+```
+      --config string            optional configuration file for coconut (default $HOME/.config/coconut/settings.yaml)
+      --config_endpoint string   configuration endpoint used by AliECS core as PROTO://HOST:PORT (default "consul://127.0.0.1:8500")
+      --endpoint string          AliECS core endpoint as HOST:PORT (default "127.0.0.1:47102")
+  -v, --verbose                  show verbose output for debug purposes
+```
+
+### SEE ALSO
+
+* [coconut configuration](coconut_configuration.md)	 - view or modify O² configuration
+
+###### Auto generated by spf13/cobra on 3-Oct-2019
diff --git a/coconut/doc/coconut_configuration_import.md b/coconut/doc/coconut_configuration_import.md
@@ -0,0 +1,48 @@
+## coconut configuration import
+
+Import a configuration file for the specified component and entry
+
+### Synopsis
+
+The configuration import command generates a timestamp and saves
+the configuration file to Consul under the <component>/<entry>/<timestamp> path. 
+Supported configuration file types are JSON, YAML, TOML and INI, 
+and their file extensions are recognized automatically.
+
+```
+coconut configuration import <component> <entry> <file_path> [flags]
+```
+
+### Examples
+
+```
+coconut conf import <component> <entry> <file_path>
+coconut conf import <component>/<entry> <file_path>
+coconut conf import <component> <entry> <file_path> --new-component
+coconut conf import <component>/<entry> <file_path> --format=json
+coconut conf import <component> <entry> <file_path>.json
+
+```
+
+### Options
+
+```
+  -f, --format string   force a specific configuration file type, overriding any file extension
+  -h, --help            help for import
+  -n, --new-component   create a new configuration component while importing entry
+```
+
+### Options inherited from parent commands
+
+```
+      --config string            optional configuration file for coconut (default $HOME/.config/coconut/settings.yaml)
+      --config_endpoint string   configuration endpoint used by AliECS core as PROTO://HOST:PORT (default "consul://127.0.0.1:8500")
+      --endpoint string          AliECS core endpoint as HOST:PORT (default "127.0.0.1:47102")
+  -v, --verbose                  show verbose output for debug purposes
+```
+
+### SEE ALSO
+
+* [coconut configuration](coconut_configuration.md)	 - view or modify O² configuration
+
+###### Auto generated by spf13/cobra on 3-Oct-2019
diff --git a/coconut/doc/coconut_configuration_list.md b/coconut/doc/coconut_configuration_list.md
@@ -40,4 +40,4 @@ coconut conf list <component> -t <timestamp>
 
 * [coconut configuration](coconut_configuration.md)	 - view or modify O² configuration
 
-###### Auto generated by spf13/cobra on 12-Sep-2019
+###### Auto generated by spf13/cobra on 3-Oct-2019
diff --git a/coconut/doc/coconut_configuration_show.md b/coconut/doc/coconut_configuration_show.md
@@ -0,0 +1,45 @@
+## coconut configuration show
+
+Show configuration for the component and entry specified
+
+### Synopsis
+
+The configuration show command returns the most recent 
+configuration revision for the specified component and entry. 
+It can also return a specific revision, requested with the --timestamp/-t flag
+
+```
+coconut configuration show <component> <entry> [flags]
+```
+
+### Examples
+
+```
+coconut conf show <component> <entry> 
+coconut conf show <component> <entry> -t <timestamp>
+coconut conf show <component>/<entry>
+coconut conf show <component>/<entry> -t <timestamp>
+coconut conf show <component>/<entry>@<timestamp>
+```
+
+### Options
+
+```
+  -h, --help               help for show
+  -t, --timestamp string   request configuration for this timestamp
+```
+
+### Options inherited from parent commands
+
+```
+      --config string            optional configuration file for coconut (default $HOME/.config/coconut/settings.yaml)
+      --config_endpoint string   configuration endpoint used by AliECS core as PROTO://HOST:PORT (default "consul://127.0.0.1:8500")
+      --endpoint string          AliECS core endpoint as HOST:PORT (default "127.0.0.1:47102")
+  -v, --verbose                  show verbose output for debug purposes
+```
+
+### SEE ALSO
+
+* [coconut configuration](coconut_configuration.md)	 - view or modify O² configuration
+
+###### Auto generated by spf13/cobra on 3-Oct-2019
diff --git a/coconut/doc/coconut_environment.md b/coconut/doc/coconut_environment.md
@@ -51,4 +51,4 @@ For more information on the behavior of coconut environments, see the subcommand
 * [coconut environment list](coconut_environment_list.md)	 - list environments
 * [coconut environment show](coconut_environment_show.md)	 - show environment information
 
-###### Auto generated by spf13/cobra on 12-Sep-2019
+###### Auto generated by spf13/cobra on 3-Oct-2019
diff --git a/coconut/doc/coconut_environment_control.md b/coconut/doc/coconut_environment_control.md
@@ -39,4 +39,4 @@ coconut environment control [environment id] [flags]
 
 * [coconut environment](coconut_environment.md)	 - create, destroy and manage AliECS environments
 
-###### Auto generated by spf13/cobra on 12-Sep-2019
+###### Auto generated by spf13/cobra on 3-Oct-2019
diff --git a/coconut/doc/coconut_environment_create.md b/coconut/doc/coconut_environment_create.md
@@ -44,4 +44,4 @@ coconut environment create [flags]
 
 * [coconut environment](coconut_environment.md)	 - create, destroy and manage AliECS environments
 
-###### Auto generated by spf13/cobra on 12-Sep-2019
+###### Auto generated by spf13/cobra on 3-Oct-2019
diff --git a/coconut/doc/coconut_environment_destroy.md b/coconut/doc/coconut_environment_destroy.md
@@ -34,4 +34,4 @@ coconut environment destroy [environment id] [flags]
 
 * [coconut environment](coconut_environment.md)	 - create, destroy and manage AliECS environments
 
-###### Auto generated by spf13/cobra on 12-Sep-2019
+###### Auto generated by spf13/cobra on 3-Oct-2019
diff --git a/coconut/doc/coconut_environment_list.md b/coconut/doc/coconut_environment_list.md
@@ -30,4 +30,4 @@ coconut environment list [flags]
 
 * [coconut environment](coconut_environment.md)	 - create, destroy and manage AliECS environments
 
-###### Auto generated by spf13/cobra on 12-Sep-2019
+###### Auto generated by spf13/cobra on 3-Oct-2019
diff --git a/coconut/doc/coconut_environment_show.md b/coconut/doc/coconut_environment_show.md
@@ -32,4 +32,4 @@ coconut environment show [environment id] [flags]
 
 * [coconut environment](coconut_environment.md)	 - create, destroy and manage AliECS environments
 
-###### Auto generated by spf13/cobra on 12-Sep-2019
+###### Auto generated by spf13/cobra on 3-Oct-2019
diff --git a/coconut/doc/coconut_info.md b/coconut/doc/coconut_info.md
@@ -30,4 +30,4 @@ coconut info [flags]
 
 * [coconut](coconut.md)	 - O² Control and Configuration Utility
 
-###### Auto generated by spf13/cobra on 12-Sep-2019
+###### Auto generated by spf13/cobra on 3-Oct-2019
diff --git a/coconut/doc/coconut_repository.md b/coconut/doc/coconut_repository.md
@@ -55,4 +55,4 @@ Make sure to run `coconut repo refresh` if you make changes to a configuration r
 * [coconut repository refresh](coconut_repository_refresh.md)	 - refresh git repositories
 * [coconut repository remove](coconut_repository_remove.md)	 - remove a git repository
 
-###### Auto generated by spf13/cobra on 12-Sep-2019
+###### Auto generated by spf13/cobra on 3-Oct-2019
diff --git a/coconut/doc/coconut_repository_add.md b/coconut/doc/coconut_repository_add.md
@@ -30,4 +30,4 @@ coconut repository add [flags]
 
 * [coconut repository](coconut_repository.md)	 - manage git repositories for task and workflow configuration
 
-###### Auto generated by spf13/cobra on 12-Sep-2019
+###### Auto generated by spf13/cobra on 3-Oct-2019
diff --git a/coconut/doc/coconut_repository_default.md b/coconut/doc/coconut_repository_default.md
@@ -30,4 +30,4 @@ coconut repository default [flags]
 
 * [coconut repository](coconut_repository.md)	 - manage git repositories for task and workflow configuration
 
-###### Auto generated by spf13/cobra on 12-Sep-2019
+###### Auto generated by spf13/cobra on 3-Oct-2019
diff --git a/coconut/doc/coconut_repository_list.md b/coconut/doc/coconut_repository_list.md
@@ -30,4 +30,4 @@ coconut repository list [flags]
 
 * [coconut repository](coconut_repository.md)	 - manage git repositories for task and workflow configuration
 
-###### Auto generated by spf13/cobra on 12-Sep-2019
+###### Auto generated by spf13/cobra on 3-Oct-2019
diff --git a/coconut/doc/coconut_repository_refresh.md b/coconut/doc/coconut_repository_refresh.md
@@ -30,4 +30,4 @@ coconut repository refresh [flags]
 
 * [coconut repository](coconut_repository.md)	 - manage git repositories for task and workflow configuration
 
-###### Auto generated by spf13/cobra on 12-Sep-2019
+###### Auto generated by spf13/cobra on 3-Oct-2019
diff --git a/coconut/doc/coconut_repository_remove.md b/coconut/doc/coconut_repository_remove.md
@@ -30,4 +30,4 @@ coconut repository remove [flags]
 
 * [coconut repository](coconut_repository.md)	 - manage git repositories for task and workflow configuration
 
-###### Auto generated by spf13/cobra on 12-Sep-2019
+###### Auto generated by spf13/cobra on 3-Oct-2019
diff --git a/coconut/doc/coconut_role.md b/coconut/doc/coconut_role.md
@@ -27,4 +27,4 @@ display information on active roles.
 * [coconut](coconut.md)	 - O² Control and Configuration Utility
 * [coconut role query](coconut_role_query.md)	 - query O² roles
 
-###### Auto generated by spf13/cobra on 12-Sep-2019
+###### Auto generated by spf13/cobra on 3-Oct-2019
diff --git a/coconut/doc/coconut_role_query.md b/coconut/doc/coconut_role_query.md
@@ -29,4 +29,4 @@ coconut role query [environment id] [query path] [flags]
 
 * [coconut role](coconut_role.md)	 - query roles in an environment
 
-###### Auto generated by spf13/cobra on 12-Sep-2019
+###### Auto generated by spf13/cobra on 3-Oct-2019
diff --git a/coconut/doc/coconut_task.md b/coconut/doc/coconut_task.md
@@ -28,4 +28,4 @@ manage active tasks.
 * [coconut task clean](coconut_task_clean.md)	 - clean up idle O² tasks
 * [coconut task list](coconut_task_list.md)	 - list O² tasks
 
-###### Auto generated by spf13/cobra on 12-Sep-2019
+###### Auto generated by spf13/cobra on 3-Oct-2019
diff --git a/coconut/doc/coconut_task_clean.md b/coconut/doc/coconut_task_clean.md
@@ -31,4 +31,4 @@ coconut task clean [flags]
 
 * [coconut task](coconut_task.md)	 - manage active tasks
 
-###### Auto generated by spf13/cobra on 12-Sep-2019
+###### Auto generated by spf13/cobra on 3-Oct-2019
diff --git a/coconut/doc/coconut_task_list.md b/coconut/doc/coconut_task_list.md
@@ -30,4 +30,4 @@ coconut task list [flags]
 
 * [coconut task](coconut_task.md)	 - manage active tasks
 
-###### Auto generated by spf13/cobra on 12-Sep-2019
+###### Auto generated by spf13/cobra on 3-Oct-2019
diff --git a/coconut/doc/coconut_template.md b/coconut/doc/coconut_template.md
@@ -27,4 +27,4 @@ display information on available workflow templates.
 * [coconut](coconut.md)	 - O² Control and Configuration Utility
 * [coconut template list](coconut_template_list.md)	 - list available workflow templates
 
-###### Auto generated by spf13/cobra on 12-Sep-2019
+###### Auto generated by spf13/cobra on 3-Oct-2019
diff --git a/coconut/doc/coconut_template_list.md b/coconut/doc/coconut_template_list.md
@@ -7,14 +7,36 @@ list available workflow templates
 The template list command shows a list of available workflow templates.
 These workflow templates can then be loaded to create an environment.
 
+`coconut templ list` can be called with 
+1) a combination of the `--repo` , `--revision` , `--all-branches` , `--all-tags`flags, or with
+2) an argument in the form of [repo-pattern]@[revision-pattern], where the patterns are globbing.
+
 ```
 coconut template list [flags]
 ```
 
+### Examples
+
+```
+ * `coconut templ list` lists templates from the HEAD of master for all git repositories
+ * `coconut templ list *AliceO2Group*` lists all templates coming from the HEAD of master of git repositories that match the pattern *AliceO2Group*
+ * `coconut templ list *@v*` lists templates coming from revisions matching the `v*`pattern for all git repositories
+ * `coconut templ list --repo=*AliceO2Group*` lists all templates coming from the HEAD of master of git repositories that match the pattern *AliceO2Group*
+ * `coconut templ list --revision=dev*` lists templates coming from revisions matching the `dev*`pattern for all git repositories
+ * `coconut templ list --repo=*gitlab.cern.ch* --revision=master` lists templates for revisions `master`for git repositories matching `*gitlab.cern.ch*`
+ * `coconut templ list --all-branches` lists templates from all branches for all git repositories
+ * `coconut templ list --repo=*github.com* --all-tags` lists templates from all tags for git repositories which match the *github.com* pattern
+ * `coconut templ list --revision=5c7f1c1fded1b87243998579ed876c8035a08377 ` lists templates from the commit corresponding to the hash for all git repositories
+```
+
 ### Options
 
 ```
-  -h, --help   help for list
+  -b, --all-branches        list templates from all branches
+  -t, --all-tags            list templates from all tags
+  -h, --help                help for list
+  -r, --repository string   repositories to list templates from (default "*")
+  -i, --revision string     revisions (branches/tags) to list templates from (default "master")
 ```
 
 ### Options inherited from parent commands
@@ -30,4 +52,4 @@ coconut template list [flags]
 
 * [coconut template](coconut_template.md)	 - query available workflow templates in configuration repositories
 
-###### Auto generated by spf13/cobra on 12-Sep-2019
+###### Auto generated by spf13/cobra on 3-Oct-2019