[docs] Update coconut documentation

AliceO2Group · Aug 17, 2023 · f563c8c · f563c8c
1 parent 7244c6b
commit f563c8c
Show file tree

Hide file tree

Showing 29 changed files with 163 additions and 104 deletions.
diff --git a/coconut/doc/coconut.md b/coconut/doc/coconut.md
@@ -13,11 +13,11 @@ For more information on the available commands, see the individual documentation
 
 ```
       --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")
+      --config_endpoint string   configuration endpoint used by AliECS core as PROTO://HOST:PORT (default "apricot://127.0.0.1:32101")
       --endpoint string          AliECS core endpoint as HOST:PORT (default "127.0.0.1:32102")
   -h, --help                     help for coconut
-      --nospinner                disable animations in output
       --nocolor                  disable colors in output
+      --nospinner                disable animations in output
   -v, --verbose                  show verbose output for debug purposes
 ```
 
@@ -32,4 +32,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 14-Jun-2021
+###### Auto generated by spf13/cobra on 17-Aug-2023
diff --git a/coconut/doc/coconut_about.md b/coconut/doc/coconut_about.md
@@ -20,15 +20,15 @@ coconut about [flags]
 
 ```
       --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")
+      --config_endpoint string   configuration endpoint used by AliECS core as PROTO://HOST:PORT (default "apricot://127.0.0.1:32101")
       --endpoint string          AliECS core endpoint as HOST:PORT (default "127.0.0.1:32102")
-      --nospinner                disable animations in output
       --nocolor                  disable colors in output
+      --nospinner                disable animations in output
   -v, --verbose                  show verbose output for debug purposes
 ```
 
 ### SEE ALSO
 
 * [coconut](coconut.md)	 - O² Control and Configuration Utility
 
-###### Auto generated by spf13/cobra on 14-Jun-2021
+###### Auto generated by spf13/cobra on 17-Aug-2023
diff --git a/coconut/doc/coconut_configuration.md b/coconut/doc/coconut_configuration.md
@@ -17,10 +17,10 @@ configuration store.
 
 ```
       --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")
+      --config_endpoint string   configuration endpoint used by AliECS core as PROTO://HOST:PORT (default "apricot://127.0.0.1:32101")
       --endpoint string          AliECS core endpoint as HOST:PORT (default "127.0.0.1:32102")
-      --nospinner                disable animations in output
       --nocolor                  disable colors in output
+      --nospinner                disable animations in output
   -v, --verbose                  show verbose output for debug purposes
 ```
 
@@ -33,4 +33,4 @@ configuration store.
 * [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 14-Jun-2021
+###### Auto generated by spf13/cobra on 17-Aug-2023
diff --git a/coconut/doc/coconut_configuration_dump.md b/coconut/doc/coconut_configuration_dump.md
@@ -25,15 +25,15 @@ coconut configuration dump [key] [flags]
 
 ```
       --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")
+      --config_endpoint string   configuration endpoint used by AliECS core as PROTO://HOST:PORT (default "apricot://127.0.0.1:32101")
       --endpoint string          AliECS core endpoint as HOST:PORT (default "127.0.0.1:32102")
-      --nospinner                disable animations in output
       --nocolor                  disable colors in output
+      --nospinner                disable animations in output
   -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 14-Jun-2021
+###### Auto generated by spf13/cobra on 17-Aug-2023
diff --git a/coconut/doc/coconut_configuration_history.md b/coconut/doc/coconut_configuration_history.md
@@ -31,15 +31,15 @@ coconut conf history <component>/<run type>/<machine role>/<entry>
 
 ```
       --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")
+      --config_endpoint string   configuration endpoint used by AliECS core as PROTO://HOST:PORT (default "apricot://127.0.0.1:32101")
       --endpoint string          AliECS core endpoint as HOST:PORT (default "127.0.0.1:32102")
-      --nospinner                disable animations in output
       --nocolor                  disable colors in output
+      --nospinner                disable animations in output
   -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 14-Jun-2021
+###### Auto generated by spf13/cobra on 17-Aug-2023
diff --git a/coconut/doc/coconut_configuration_import.md b/coconut/doc/coconut_configuration_import.md
@@ -41,15 +41,15 @@ coconut conf import <component> <entry> <file_path> --no-versioning --new-compon
 
 ```
       --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")
+      --config_endpoint string   configuration endpoint used by AliECS core as PROTO://HOST:PORT (default "apricot://127.0.0.1:32101")
       --endpoint string          AliECS core endpoint as HOST:PORT (default "127.0.0.1:32102")
-      --nospinner                disable animations in output
       --nocolor                  disable colors in output
+      --nospinner                disable animations in output
   -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 14-Jun-2021
+###### Auto generated by spf13/cobra on 17-Aug-2023
diff --git a/coconut/doc/coconut_configuration_list.md b/coconut/doc/coconut_configuration_list.md
@@ -31,15 +31,15 @@ coconut conf list <component> -t
 
 ```
       --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")
+      --config_endpoint string   configuration endpoint used by AliECS core as PROTO://HOST:PORT (default "apricot://127.0.0.1:32101")
       --endpoint string          AliECS core endpoint as HOST:PORT (default "127.0.0.1:32102")
-      --nospinner                disable animations in output
       --nocolor                  disable colors in output
+      --nospinner                disable animations in output
   -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 14-Jun-2021
+###### Auto generated by spf13/cobra on 17-Aug-2023
diff --git a/coconut/doc/coconut_configuration_show.md b/coconut/doc/coconut_configuration_show.md
@@ -39,15 +39,15 @@ coconut conf show <component> <entry> -s -e '{"key1": "value1", "key2": "value2"
 
 ```
       --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")
+      --config_endpoint string   configuration endpoint used by AliECS core as PROTO://HOST:PORT (default "apricot://127.0.0.1:32101")
       --endpoint string          AliECS core endpoint as HOST:PORT (default "127.0.0.1:32102")
-      --nospinner                disable animations in output
       --nocolor                  disable colors in output
+      --nospinner                disable animations in output
   -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 14-Jun-2021
+###### Auto generated by spf13/cobra on 17-Aug-2023
diff --git a/coconut/doc/coconut_environment.md b/coconut/doc/coconut_environment.md
@@ -37,10 +37,10 @@ For more information on the behavior of coconut environments, see the subcommand
 
 ```
       --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")
+      --config_endpoint string   configuration endpoint used by AliECS core as PROTO://HOST:PORT (default "apricot://127.0.0.1:32101")
       --endpoint string          AliECS core endpoint as HOST:PORT (default "127.0.0.1:32102")
-      --nospinner                disable animations in output
       --nocolor                  disable colors in output
+      --nospinner                disable animations in output
   -v, --verbose                  show verbose output for debug purposes
 ```
 
@@ -53,4 +53,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 14-Jun-2021
+###### Auto generated by spf13/cobra on 17-Aug-2023
diff --git a/coconut/doc/coconut_environment_control.md b/coconut/doc/coconut_environment_control.md
@@ -30,15 +30,15 @@ coconut environment control [environment id] [flags]
 
 ```
       --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")
+      --config_endpoint string   configuration endpoint used by AliECS core as PROTO://HOST:PORT (default "apricot://127.0.0.1:32101")
       --endpoint string          AliECS core endpoint as HOST:PORT (default "127.0.0.1:32102")
-      --nospinner                disable animations in output
       --nocolor                  disable colors in output
+      --nospinner                disable animations in output
   -v, --verbose                  show verbose output for debug purposes
 ```
 
 ### SEE ALSO
 
 * [coconut environment](coconut_environment.md)	 - create, destroy and manage AliECS environments
 
-###### Auto generated by spf13/cobra on 14-Jun-2021
+###### Auto generated by spf13/cobra on 17-Aug-2023
diff --git a/coconut/doc/coconut_environment_create.md b/coconut/doc/coconut_environment_create.md
@@ -17,6 +17,9 @@ Examples:
  * `coconut env create -w github.com/AliceO2Group/MyConfRepo/myworkflow` - loads a workflow from a specific git repository, HEAD of master branch
  * `coconut env create -w myworkflow@rev` - loads a workflow from default repository, on branch, tag or revision `rev`
  * `coconut env create -w github.com/AliceO2Group/MyConfRepo/myworkflow@rev` - loads a workflow from a specific git repository, on branch, tag or revision `rev`
+ * `coconut env create -c /home/myrepo/myconfigfile.json -e '{"hosts":"[\"my-test-machine\"]"}'`
+ * `coconut env create -c consul:///o2/runtime/COG-v1/TECHNICAL -w readout-dataflow@myBranch -e '{"hosts":"[\"my-test-machine\"]"}'`
+ * `coconut env create -c TECHNICAL -e '{"hosts":"[\"my-test-machine\"]"}'`
 
 For more information on the AliECS workflow configuration system, see documentation for the `coconut repository` command.
 
@@ -28,24 +31,26 @@ coconut environment create [flags]
 
 ```
   -a, --auto                             create an autorun environment
+  -c, --configuration string             high-level configuration payload to be loaded for the new environment
   -e, --extra-vars key1=val1,key2=val2   values passed using key=value CSV or JSON syntax, interpreted as strings key1=val1,key2=val2 or `{"key1": "value1", "key2": "value2"}`
   -h, --help                             help for create
+  -p, --public                           control public rights of the environment (default true)
   -w, --workflow-template string         workflow to be loaded in the new environment
 ```
 
 ### 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")
+      --config_endpoint string   configuration endpoint used by AliECS core as PROTO://HOST:PORT (default "apricot://127.0.0.1:32101")
       --endpoint string          AliECS core endpoint as HOST:PORT (default "127.0.0.1:32102")
-      --nospinner                disable animations in output
       --nocolor                  disable colors in output
+      --nospinner                disable animations in output
   -v, --verbose                  show verbose output for debug purposes
 ```
 
 ### SEE ALSO
 
 * [coconut environment](coconut_environment.md)	 - create, destroy and manage AliECS environments
 
-###### Auto generated by spf13/cobra on 14-Jun-2021
+###### Auto generated by spf13/cobra on 17-Aug-2023
diff --git a/coconut/doc/coconut_environment_destroy.md b/coconut/doc/coconut_environment_destroy.md
@@ -27,15 +27,15 @@ coconut environment destroy [environment id] [flags]
 
 ```
       --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")
+      --config_endpoint string   configuration endpoint used by AliECS core as PROTO://HOST:PORT (default "apricot://127.0.0.1:32101")
       --endpoint string          AliECS core endpoint as HOST:PORT (default "127.0.0.1:32102")
-      --nospinner                disable animations in output
       --nocolor                  disable colors in output
+      --nospinner                disable animations in output
   -v, --verbose                  show verbose output for debug purposes
 ```
 
 ### SEE ALSO
 
 * [coconut environment](coconut_environment.md)	 - create, destroy and manage AliECS environments
 
-###### Auto generated by spf13/cobra on 14-Jun-2021
+###### Auto generated by spf13/cobra on 17-Aug-2023
diff --git a/coconut/doc/coconut_environment_list.md b/coconut/doc/coconut_environment_list.md
@@ -14,22 +14,23 @@ coconut environment list [flags]
 ### Options
 
 ```
-  -h, --help   help for list
+  -h, --help       help for list
+  -s, --show-all   print public and non-public environments
 ```
 
 ### 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")
+      --config_endpoint string   configuration endpoint used by AliECS core as PROTO://HOST:PORT (default "apricot://127.0.0.1:32101")
       --endpoint string          AliECS core endpoint as HOST:PORT (default "127.0.0.1:32102")
-      --nospinner                disable animations in output
       --nocolor                  disable colors in output
+      --nospinner                disable animations in output
   -v, --verbose                  show verbose output for debug purposes
 ```
 
 ### SEE ALSO
 
 * [coconut environment](coconut_environment.md)	 - create, destroy and manage AliECS environments
 
-###### Auto generated by spf13/cobra on 14-Jun-2021
+###### Auto generated by spf13/cobra on 17-Aug-2023
diff --git a/coconut/doc/coconut_environment_show.md b/coconut/doc/coconut_environment_show.md
@@ -15,6 +15,7 @@ coconut environment show [environment id] [flags]
 
 ```
   -h, --help       help for show
+  -s, --services   print information on this environment from integrated services
   -t, --tasks      print a list of tasks in this environment
   -w, --workflow   print the workflow tree
 ```
@@ -23,15 +24,15 @@ coconut environment show [environment id] [flags]
 
 ```
       --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")
+      --config_endpoint string   configuration endpoint used by AliECS core as PROTO://HOST:PORT (default "apricot://127.0.0.1:32101")
       --endpoint string          AliECS core endpoint as HOST:PORT (default "127.0.0.1:32102")
-      --nospinner                disable animations in output
       --nocolor                  disable colors in output
+      --nospinner                disable animations in output
   -v, --verbose                  show verbose output for debug purposes
 ```
 
 ### SEE ALSO
 
 * [coconut environment](coconut_environment.md)	 - create, destroy and manage AliECS environments
 
-###### Auto generated by spf13/cobra on 14-Jun-2021
+###### Auto generated by spf13/cobra on 17-Aug-2023
diff --git a/coconut/doc/coconut_info.md b/coconut/doc/coconut_info.md
@@ -21,15 +21,15 @@ coconut info [flags]
 
 ```
       --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")
+      --config_endpoint string   configuration endpoint used by AliECS core as PROTO://HOST:PORT (default "apricot://127.0.0.1:32101")
       --endpoint string          AliECS core endpoint as HOST:PORT (default "127.0.0.1:32102")
-      --nospinner                disable animations in output
       --nocolor                  disable colors in output
+      --nospinner                disable animations in output
   -v, --verbose                  show verbose output for debug purposes
 ```
 
 ### SEE ALSO
 
 * [coconut](coconut.md)	 - O² Control and Configuration Utility
 
-###### Auto generated by spf13/cobra on 14-Jun-2021
+###### Auto generated by spf13/cobra on 17-Aug-2023