[coconut] Update inline documentation for coconut conf

AliceO2Group · Jan 6, 2021 · 7c9b784 · 7c9b784
1 parent fa5c8b4
commit 7c9b784
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 7 deletions.
diff --git a/coconut/cmd/configuration_dump.go b/coconut/cmd/configuration_dump.go
@@ -36,7 +36,9 @@ var configurationDumpCmd = &cobra.Command{
 	Short: "dump configuration subtree",
 	Long: `The configuration dump command requests from O² Configuration 
 a subtree of key-values, and dumps it to standard output in the specified 
-format.`,
+format. This command has full read access to the O² Configuration store 
+and performs a raw query with no additional processing or access control
+semantics.`,
 	Run:   configuration.WrapCall(configuration.Dump),
 	Args:  cobra.ExactArgs(1),
 }

diff --git a/coconut/cmd/configuration_history.go b/coconut/cmd/configuration_history.go
@@ -34,7 +34,7 @@ var configurationHistoryCmd = &cobra.Command{
 	Aliases: []string{"h"},
 	Example: `coconut conf history <component>
 coconut conf history <component> <entry>
-coconut conf history <component>/<entry>`,
+coconut conf history <component>/<run type>/<machine role>/<entry>`,
 	Short: "List all existing entries with timestamps of a specified component in Consul",
 	Long: `The configuration history command returns all entries with 
 all of their associated timestamps or returns all timestamps for a specified component and entry`,

diff --git a/coconut/cmd/configuration_import.go b/coconut/cmd/configuration_import.go
@@ -33,9 +33,9 @@ var configurationImportCmd = &cobra.Command{
 	Use:   "import <component> <entry> <file_path>",
 	Aliases: []string{"i", "imp"},
 	Example: `coconut conf import <component> <entry> <file_path>
-coconut conf import <component>/<entry> <file_path>
+coconut conf import <component>/<run type>/<machine role>/<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>/<run type>/<machine role>/<entry> <file_path> --format=json
 coconut conf import <component> <entry> <file_path>.json
 coconut conf import <component> <entry> <file_path> --no-versioning 
 coconut conf import <component> <entry> <file_path> --no-versioning --new-component

diff --git a/coconut/cmd/configuration_show.go b/coconut/cmd/configuration_show.go
@@ -34,9 +34,10 @@ var configurationShowCmd = &cobra.Command{
 	Aliases: []string{"s"},
 	Example: `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>`,
+coconut conf show <component>/<run type>/<machine role>/<entry>
+coconut conf show <component>/<run type>/<machine role>/<entry> -t <timestamp>
+coconut conf show <component>/<run type>/<machine role>/<entry>@<timestamp>
+coconut conf show <component> <entry> -s -e '{"key1": "value1", "key2": "value2"}'`,
 	Short: "Show configuration for the component and entry specified",
 	Long: `The configuration show command returns the most recent 
 configuration revision for the specified component and entry.