[build] Regenerate apidocs

teo · teo · commit 17f6d56eafae · 2024-11-27T17:32:27.000+01:00
diff --git a/coconut/doc/coconut.md b/coconut/doc/coconut.md
@@ -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 17-Aug-2023
+###### Auto generated by spf13/cobra on 27-Nov-2024
diff --git a/coconut/doc/coconut_about.md b/coconut/doc/coconut_about.md
@@ -31,4 +31,4 @@ coconut about [flags]
 
 * [coconut](coconut.md)	 - O² Control and Configuration Utility
 
-###### Auto generated by spf13/cobra on 17-Aug-2023
+###### Auto generated by spf13/cobra on 27-Nov-2024
diff --git a/coconut/doc/coconut_configuration.md b/coconut/doc/coconut_configuration.md
@@ -28,9 +28,8 @@ 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 17-Aug-2023
+###### Auto generated by spf13/cobra on 27-Nov-2024
diff --git a/coconut/doc/coconut_configuration_dump.md b/coconut/doc/coconut_configuration_dump.md
@@ -36,4 +36,4 @@ coconut configuration dump [key] [flags]
 
 * [coconut configuration](coconut_configuration.md)	 - view or modify O² configuration
 
-###### Auto generated by spf13/cobra on 17-Aug-2023
+###### Auto generated by spf13/cobra on 27-Nov-2024
diff --git a/coconut/doc/coconut_configuration_import.md b/coconut/doc/coconut_configuration_import.md
@@ -5,7 +5,7 @@ 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. 
+the configuration file to Consul under the <component>/<entry> path. 
 Supported configuration file types are JSON, YAML, TOML and INI, 
 and their file extensions are recognized automatically.
 
@@ -21,7 +21,7 @@ coconut conf import <component>/<run type>/<machine role>/<entry> <file_path>
 coconut conf import <component> <entry> <file_path> --new-component
 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>
+coconut conf import <component> <entry> <file_path> 
 coconut conf import <component> <entry> <file_path> --new-component
 
 ```
@@ -51,4 +51,4 @@ coconut conf import <component> <entry> <file_path> --new-component
 
 * [coconut configuration](coconut_configuration.md)	 - view or modify O² configuration
 
-###### Auto generated by spf13/cobra on 17-Aug-2023
+###### Auto generated by spf13/cobra on 27-Nov-2024
diff --git a/coconut/doc/coconut_configuration_list.md b/coconut/doc/coconut_configuration_list.md
@@ -42,4 +42,4 @@ coconut conf list <component> -t
 
 * [coconut configuration](coconut_configuration.md)	 - view or modify O² configuration
 
-###### Auto generated by spf13/cobra on 17-Aug-2023
+###### Auto generated by spf13/cobra on 27-Nov-2024
diff --git a/coconut/doc/coconut_configuration_show.md b/coconut/doc/coconut_configuration_show.md
@@ -6,6 +6,7 @@ Show configuration for the component and entry specified
 
 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]
@@ -17,7 +18,9 @@ coconut configuration show <component> <entry> [flags]
 coconut conf show <component> <entry> 
 coconut conf show <component> <entry> -t <timestamp>
 coconut conf show <component>/<run type>/<machine role>/<entry>
-coconut conf show <component> <entry> -r <run type> -l <machine role>'
+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> -r <run type> -l <machine role> -t <timestamp>'
 coconut conf show <component> <entry> -s -e '{"key1": "value1", "key2": "value2"}'
 ```
 
@@ -29,6 +32,7 @@ coconut conf show <component> <entry> -s -e '{"key1": "value1", "key2": "value2"
   -l, --role string                      request configuration for this O² machine role
   -r, --runtype string                   request configuration for this run type (e.g. PHYSICS, TECHNICAL, etc.)
   -s, --simulate                         simulate runtime template processing on the configuration payload
+  -t, --timestamp string                 request configuration for this timestamp
 ```
 
 ### Options inherited from parent commands
@@ -46,4 +50,4 @@ coconut conf show <component> <entry> -s -e '{"key1": "value1", "key2": "value2"
 
 * [coconut configuration](coconut_configuration.md)	 - view or modify O² configuration
 
-###### Auto generated by spf13/cobra on 17-Aug-2023
+###### Auto generated by spf13/cobra on 27-Nov-2024
diff --git a/coconut/doc/coconut_environment.md b/coconut/doc/coconut_environment.md
@@ -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 17-Aug-2023
+###### Auto generated by spf13/cobra on 27-Nov-2024
diff --git a/coconut/doc/coconut_environment_control.md b/coconut/doc/coconut_environment_control.md
@@ -41,4 +41,4 @@ coconut environment control [environment id] [flags]
 
 * [coconut environment](coconut_environment.md)	 - create, destroy and manage AliECS environments
 
-###### Auto generated by spf13/cobra on 17-Aug-2023
+###### Auto generated by spf13/cobra on 27-Nov-2024
diff --git a/coconut/doc/coconut_environment_create.md b/coconut/doc/coconut_environment_create.md
@@ -30,6 +30,7 @@ coconut environment create [flags]
 ### Options
 
 ```
+  -y, --asynchronous                     use asynchronous mode for environment creation
   -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"}`
@@ -53,4 +54,4 @@ coconut environment create [flags]
 
 * [coconut environment](coconut_environment.md)	 - create, destroy and manage AliECS environments
 
-###### Auto generated by spf13/cobra on 17-Aug-2023
+###### Auto generated by spf13/cobra on 27-Nov-2024
diff --git a/coconut/doc/coconut_environment_destroy.md b/coconut/doc/coconut_environment_destroy.md
@@ -38,4 +38,4 @@ coconut environment destroy [environment id] [flags]
 
 * [coconut environment](coconut_environment.md)	 - create, destroy and manage AliECS environments
 
-###### Auto generated by spf13/cobra on 17-Aug-2023
+###### Auto generated by spf13/cobra on 27-Nov-2024
diff --git a/coconut/doc/coconut_environment_list.md b/coconut/doc/coconut_environment_list.md
@@ -33,4 +33,4 @@ coconut environment list [flags]
 
 * [coconut environment](coconut_environment.md)	 - create, destroy and manage AliECS environments
 
-###### Auto generated by spf13/cobra on 17-Aug-2023
+###### Auto generated by spf13/cobra on 27-Nov-2024
diff --git a/coconut/doc/coconut_environment_show.md b/coconut/doc/coconut_environment_show.md
@@ -35,4 +35,4 @@ coconut environment show [environment id] [flags]
 
 * [coconut environment](coconut_environment.md)	 - create, destroy and manage AliECS environments
 
-###### Auto generated by spf13/cobra on 17-Aug-2023
+###### Auto generated by spf13/cobra on 27-Nov-2024
diff --git a/coconut/doc/coconut_info.md b/coconut/doc/coconut_info.md
@@ -32,4 +32,4 @@ coconut info [flags]
 
 * [coconut](coconut.md)	 - O² Control and Configuration Utility
 
-###### Auto generated by spf13/cobra on 17-Aug-2023
+###### Auto generated by spf13/cobra on 27-Nov-2024
diff --git a/coconut/doc/coconut_repository.md b/coconut/doc/coconut_repository.md
@@ -65,4 +65,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 17-Aug-2023
+###### Auto generated by spf13/cobra on 27-Nov-2024
diff --git a/coconut/doc/coconut_repository_add.md b/coconut/doc/coconut_repository_add.md
@@ -56,4 +56,4 @@ coconut repository add <repo url> [flags]
 
 * [coconut repository](coconut_repository.md)	 - manage git repositories for task and workflow configuration
 
-###### Auto generated by spf13/cobra on 17-Aug-2023
+###### Auto generated by spf13/cobra on 27-Nov-2024
diff --git a/coconut/doc/coconut_repository_default-revision.md b/coconut/doc/coconut_repository_default-revision.md
@@ -41,4 +41,4 @@ coconut repository default-revision <global-default-revision | repo-id default-r
 
 * [coconut repository](coconut_repository.md)	 - manage git repositories for task and workflow configuration
 
-###### Auto generated by spf13/cobra on 17-Aug-2023
+###### Auto generated by spf13/cobra on 27-Nov-2024
diff --git a/coconut/doc/coconut_repository_default.md b/coconut/doc/coconut_repository_default.md
@@ -38,4 +38,4 @@ coconut repository default <repo id> [flags]
 
 * [coconut repository](coconut_repository.md)	 - manage git repositories for task and workflow configuration
 
-###### Auto generated by spf13/cobra on 17-Aug-2023
+###### Auto generated by spf13/cobra on 27-Nov-2024
diff --git a/coconut/doc/coconut_repository_list.md b/coconut/doc/coconut_repository_list.md
@@ -31,4 +31,4 @@ coconut repository list [flags]
 
 * [coconut repository](coconut_repository.md)	 - manage git repositories for task and workflow configuration
 
-###### Auto generated by spf13/cobra on 17-Aug-2023
+###### Auto generated by spf13/cobra on 27-Nov-2024
diff --git a/coconut/doc/coconut_repository_refresh.md b/coconut/doc/coconut_repository_refresh.md
@@ -39,4 +39,4 @@ coconut repository refresh [repo id] [flags]
 
 * [coconut repository](coconut_repository.md)	 - manage git repositories for task and workflow configuration
 
-###### Auto generated by spf13/cobra on 17-Aug-2023
+###### Auto generated by spf13/cobra on 27-Nov-2024
diff --git a/coconut/doc/coconut_repository_remove.md b/coconut/doc/coconut_repository_remove.md
@@ -39,4 +39,4 @@ coconut repository remove <repo id> [flags]
 
 * [coconut repository](coconut_repository.md)	 - manage git repositories for task and workflow configuration
 
-###### Auto generated by spf13/cobra on 17-Aug-2023
+###### Auto generated by spf13/cobra on 27-Nov-2024
diff --git a/coconut/doc/coconut_role.md b/coconut/doc/coconut_role.md
@@ -29,4 +29,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 17-Aug-2023
+###### Auto generated by spf13/cobra on 27-Nov-2024
diff --git a/coconut/doc/coconut_role_query.md b/coconut/doc/coconut_role_query.md
@@ -4,7 +4,24 @@ query O² roles
 
 ### Synopsis
 
-The role query command returns one or more role trees.
+The role query command returns one or more role subtrees within a given environment.
+
+It allows the user to inspect the environment's workflow at runtime, after template processing operations, including
+iterator expansion, just-in-time subworkflow inclusion, and variable substitution, have taken place.
+
+For the target role or roles, it also prints the locally defined variables, as well as the consolidated variable
+stack from the point of view of that role.
+
+The role query command accepts two arguments: the environment ID and the query path. The query path is a dot-separated
+walk through the role tree of the given environment, starting from the root role. Wildcard expressions are allowed, as
+per https://github.com/gobwas/glob syntax.
+
+Examples:
+ * `coconut role query 2rE9AV3m1HL readout-dataflow` - queries the role `readout-dataflow` in environment `2rE9AV3m1HL`, prints the full tree, along with the variables defined in the root role
+ * `coconut role query 2rE9AV3m1HL readout-dataflow.host-aido2-bld4-lab102` - queries the role `readout-dataflow.host-aido2-bld4-lab102`, prints the subtree of that role, along with the variables defined in it
+ * `coconut role query 2rE9AV3m1HL readout-dataflow.host-aido2-bld4-lab102.data-distribution.stfs` - queries the role at the given path, it is a task role so there is no subtree, prints the variables defined in that role
+ * `coconut role query 2rE9AV3m1HL readout-dataflow.host-aido2-bld4-lab*` - queries the roles matching the given glob expression, prints all the subtrees and variables
+ * `coconut role query 2rE9AV3m1HL readout-dataflow.host-aido2-bld4-lab*.data-distribution.*` - queries the task roles matching the given glob expression, prints all the variables
 
 ```
 coconut role query [environment id] [query path] [flags]
@@ -31,4 +48,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 17-Aug-2023
+###### Auto generated by spf13/cobra on 27-Nov-2024
diff --git a/coconut/doc/coconut_task.md b/coconut/doc/coconut_task.md
@@ -30,4 +30,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 17-Aug-2023
+###### Auto generated by spf13/cobra on 27-Nov-2024
diff --git a/coconut/doc/coconut_task_clean.md b/coconut/doc/coconut_task_clean.md
@@ -33,4 +33,4 @@ coconut task clean [flags]
 
 * [coconut task](coconut_task.md)	 - manage active tasks
 
-###### Auto generated by spf13/cobra on 17-Aug-2023
+###### Auto generated by spf13/cobra on 27-Nov-2024
diff --git a/coconut/doc/coconut_task_list.md b/coconut/doc/coconut_task_list.md
@@ -32,4 +32,4 @@ coconut task list [flags]
 
 * [coconut task](coconut_task.md)	 - manage active tasks
 
-###### Auto generated by spf13/cobra on 17-Aug-2023
+###### Auto generated by spf13/cobra on 27-Nov-2024
diff --git a/coconut/doc/coconut_template.md b/coconut/doc/coconut_template.md
@@ -29,4 +29,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 17-Aug-2023
+###### Auto generated by spf13/cobra on 27-Nov-2024
diff --git a/coconut/doc/coconut_template_list.md b/coconut/doc/coconut_template_list.md
@@ -57,4 +57,4 @@ coconut template list [flags]
 
 * [coconut template](coconut_template.md)	 - query available workflow templates in configuration repositories
 
-###### Auto generated by spf13/cobra on 17-Aug-2023
+###### Auto generated by spf13/cobra on 27-Nov-2024
diff --git a/docs/apidocs_aliecs.md b/docs/apidocs_aliecs.md
diff --git a/docs/apidocs_apricot.md b/docs/apidocs_apricot.md

Original file line number	Diff line number	Diff line change
`@@ -31,4 +31,4 @@ coconut about [flags]`
`31`	`31`
`32`	`32`	`* [coconut](coconut.md) - O² Control and Configuration Utility`
`33`	`33`
`34`		`-###### Auto generated by spf13/cobra on 17-Aug-2023`
	`34`	`+###### Auto generated by spf13/cobra on 27-Nov-2024`
Original file line number	Diff line number	Diff line change
`@@ -36,4 +36,4 @@ coconut configuration dump [key] [flags]`
`36`	`36`
`37`	`37`	`* [coconut configuration](coconut_configuration.md) - view or modify O² configuration`
`38`	`38`
`39`		`-###### Auto generated by spf13/cobra on 17-Aug-2023`
	`39`	`+###### Auto generated by spf13/cobra on 27-Nov-2024`
Original file line number	Diff line number	Diff line change
`@@ -42,4 +42,4 @@ coconut conf list <component> -t`
`42`	`42`
`43`	`43`	`* [coconut configuration](coconut_configuration.md) - view or modify O² configuration`
`44`	`44`
`45`		`-###### Auto generated by spf13/cobra on 17-Aug-2023`
	`45`	`+###### Auto generated by spf13/cobra on 27-Nov-2024`
Original file line number	Diff line number	Diff line change
`@@ -41,4 +41,4 @@ coconut environment control [environment id] [flags]`
`41`	`41`
`42`	`42`	`* [coconut environment](coconut_environment.md) - create, destroy and manage AliECS environments`
`43`	`43`
`44`		`-###### Auto generated by spf13/cobra on 17-Aug-2023`
	`44`	`+###### Auto generated by spf13/cobra on 27-Nov-2024`