diff --git a/Makefile b/Makefile index e349e826..4fcb0f8f 100644 --- a/Makefile +++ b/Makefile @@ -314,7 +314,7 @@ docs/coconut: docs/grpc: @echo -e "generating gRPC API documentation \033[1;33m==>\033[0m \033[1;34m./docs\033[0m" @cd apricot/protos && PATH="$(ROOT_DIR)/tools:$$PATH" protoc --doc_out="$(ROOT_DIR)/docs" --doc_opt=markdown,apidocs_apricot.md "apricot.proto" - @cd core/protos && PATH="$(ROOT_DIR)/tools:$$PATH" protoc --doc_out="$(ROOT_DIR)/docs" --doc_opt=markdown,apidocs_aliecs.md "o2control.proto" + @cd core/protos && PATH="$(ROOT_DIR)/tools:$$PATH" protoc -I=. -I=../../common --doc_out="$(ROOT_DIR)/docs" --doc_opt=markdown,apidocs_aliecs.md "o2control.proto" @cd occ/protos && PATH="$(ROOT_DIR)/tools:$$PATH" protoc --doc_out="$(ROOT_DIR)/docs" --doc_opt=markdown,apidocs_occ.md "occ.proto" docs/swaggo: diff --git a/coconut/cmd/role_query.go b/coconut/cmd/role_query.go index 9270772f..59f7f63e 100644 --- a/coconut/cmd/role_query.go +++ b/coconut/cmd/role_query.go @@ -34,9 +34,26 @@ var roleQueryCmd = &cobra.Command{ Use: "query [environment id] [query path]", Aliases: []string{"query", "q"}, Short: "query O² roles", - Long: `The role query command returns one or more role trees.`, - Run: control.WrapCall(control.QueryRoles), - Args: cobra.ExactArgs(2), + Long: `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`, + Run: control.WrapCall(control.QueryRoles), + Args: cobra.ExactArgs(2), } func init() { diff --git a/coconut/doc/coconut.md b/coconut/doc/coconut.md index 2d19d4b2..697d659a 100644 --- 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 index 9aee6a5e..8c0730d5 100644 --- 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 index 3f8d501f..133d4db4 100644 --- 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 index 5bc9439c..d49696b8 100644 --- 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 index dcfc7b6e..c811015c 100644 --- 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 // path. +the configuration file to Consul under the / 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 /// coconut conf import --new-component coconut conf import /// --format=json coconut conf import .json -coconut conf import +coconut conf import coconut conf import --new-component ``` @@ -51,4 +51,4 @@ coconut conf import --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 index a74b6ae9..65c1d6fe 100644 --- a/coconut/doc/coconut_configuration_list.md +++ b/coconut/doc/coconut_configuration_list.md @@ -42,4 +42,4 @@ coconut conf list -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 index 2230e2ef..0776f4cb 100644 --- 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 [flags] @@ -17,7 +18,9 @@ coconut configuration show [flags] coconut conf show coconut conf show -t coconut conf show /// -coconut conf show -r -l ' +coconut conf show /// -t +coconut conf show ///@ +coconut conf show -r -l -t ' coconut conf show -s -e '{"key1": "value1", "key2": "value2"}' ``` @@ -29,6 +32,7 @@ coconut conf show -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 -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 index 75b10f3f..e1575dd8 100644 --- 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 index f9eaef1c..57417d5a 100644 --- 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 index 1b09b860..ce39b734 100644 --- 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 index 637f4e21..c0747e82 100644 --- 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 index 27686007..17a5da98 100644 --- 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 index edb0f4a6..d33f8e4c 100644 --- 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 index ed26fa8f..0f45e3d5 100644 --- 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 index bac7482c..32156d56 100644 --- 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 index 77c9ae58..90db22e4 100644 --- a/coconut/doc/coconut_repository_add.md +++ b/coconut/doc/coconut_repository_add.md @@ -56,4 +56,4 @@ coconut repository add [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 index ee97f30b..0a934c08 100644 --- a/coconut/doc/coconut_repository_default-revision.md +++ b/coconut/doc/coconut_repository_default-revision.md @@ -41,4 +41,4 @@ coconut repository default-revision [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 index 5c27d39a..4878ac9b 100644 --- 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 index 978b47fd..a6486cbb 100644 --- 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 index 74fa8b17..f69c1842 100644 --- a/coconut/doc/coconut_repository_remove.md +++ b/coconut/doc/coconut_repository_remove.md @@ -39,4 +39,4 @@ coconut repository remove [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 index f06453a1..16037474 100644 --- 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 index 504cb016..6d562679 100644 --- 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 index fc6e0d85..f5261acb 100644 --- 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 index 936c2bd8..53175448 100644 --- 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 index 8b6d6d46..65cbad07 100644 --- 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 index 6057fba5..efdcb6aa 100644 --- 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 index 4d6c9842..47853a11 100644 --- 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 index 6284356c..82ff39c3 100644 --- a/docs/apidocs_aliecs.md +++ b/docs/apidocs_aliecs.md @@ -21,12 +21,8 @@ - [EnvironmentInfo.UserVarsEntry](#o2control-EnvironmentInfo-UserVarsEntry) - [EnvironmentInfo.VarsEntry](#o2control-EnvironmentInfo-VarsEntry) - [EnvironmentOperation](#o2control-EnvironmentOperation) - - [Ev_EnvironmentEvent](#o2control-Ev_EnvironmentEvent) - - [Ev_RoleEvent](#o2control-Ev_RoleEvent) - - [Ev_TaskEvent](#o2control-Ev_TaskEvent) - - [Event](#o2control-Event) - - [Event_MesosHeartbeat](#o2control-Event_MesosHeartbeat) - [GetActiveDetectorsReply](#o2control-GetActiveDetectorsReply) + - [GetAvailableDetectorsReply](#o2control-GetAvailableDetectorsReply) - [GetEnvironmentPropertiesReply](#o2control-GetEnvironmentPropertiesReply) - [GetEnvironmentPropertiesReply.PropertiesEntry](#o2control-GetEnvironmentPropertiesReply-PropertiesEntry) - [GetEnvironmentPropertiesRequest](#o2control-GetEnvironmentPropertiesRequest) @@ -74,11 +70,7 @@ - [SetRepoDefaultRevisionReply](#o2control-SetRepoDefaultRevisionReply) - [SetRepoDefaultRevisionRequest](#o2control-SetRepoDefaultRevisionRequest) - [ShortTaskInfo](#o2control-ShortTaskInfo) - - [StatusReply](#o2control-StatusReply) - - [StatusRequest](#o2control-StatusRequest) - - [StatusUpdate](#o2control-StatusUpdate) - [SubscribeRequest](#o2control-SubscribeRequest) - - [TaskClassInfo](#o2control-TaskClassInfo) - [TaskDeploymentInfo](#o2control-TaskDeploymentInfo) - [TaskInfo](#o2control-TaskInfo) - [TaskInfo.PropertiesEntry](#o2control-TaskInfo-PropertiesEntry) @@ -91,7 +83,6 @@ - [ControlEnvironmentRequest.Optype](#o2control-ControlEnvironmentRequest-Optype) - [EnvironmentOperation.Optype](#o2control-EnvironmentOperation-Optype) - - [StatusUpdate.Level](#o2control-StatusUpdate-Level) - [VarSpecMessage.Type](#o2control-VarSpecMessage-Type) - [VarSpecMessage.UiWidget](#o2control-VarSpecMessage-UiWidget) @@ -237,6 +228,7 @@ | ----- | ---- | ----- | ----------- | | id | [string](#string) | | | | type | [ControlEnvironmentRequest.Optype](#o2control-ControlEnvironmentRequest-Optype) | | | +| requestUser | [common.User](#common-User) | | | @@ -270,6 +262,7 @@ | keepTasks | [bool](#bool) | | | | allowInRunningState | [bool](#bool) | | | | force | [bool](#bool) | | | +| requestUser | [common.User](#common-User) | | | @@ -398,94 +391,24 @@ - - -### Ev_EnvironmentEvent - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| environmentId | [string](#string) | | | -| state | [string](#string) | | | -| currentRunNumber | [uint32](#uint32) | | | -| error | [string](#string) | | | -| message | [string](#string) | | | - - - - - - - - -### Ev_RoleEvent - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| name | [string](#string) | | | -| status | [string](#string) | | | -| state | [string](#string) | | | -| rolePath | [string](#string) | | | - - - - - - - + -### Ev_TaskEvent +### GetActiveDetectorsReply | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| name | [string](#string) | | | -| taskid | [string](#string) | | | -| state | [string](#string) | | | -| status | [string](#string) | | | -| hostname | [string](#string) | | | -| className | [string](#string) | | | +| detectors | [string](#string) | repeated | | - + -### Event - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| timestamp | [string](#string) | | | -| environmentEvent | [Ev_EnvironmentEvent](#o2control-Ev_EnvironmentEvent) | | | -| taskEvent | [Ev_TaskEvent](#o2control-Ev_TaskEvent) | | | -| roleEvent | [Ev_RoleEvent](#o2control-Ev_RoleEvent) | | | - - - - - - - - -### Event_MesosHeartbeat - - - - - - - - - -### GetActiveDetectorsReply +### GetAvailableDetectorsReply @@ -905,6 +828,7 @@ Roles | workflowTemplate | [string](#string) | | | | vars | [NewAutoEnvironmentRequest.VarsEntry](#o2control-NewAutoEnvironmentRequest-VarsEntry) | repeated | | | id | [string](#string) | | | +| requestUser | [common.User](#common-User) | | | @@ -954,6 +878,8 @@ Roles | workflowTemplate | [string](#string) | | | | vars | [NewEnvironmentRequest.VarsEntry](#o2control-NewEnvironmentRequest-VarsEntry) | repeated | | | public | [bool](#bool) | | | +| autoTransition | [bool](#bool) | | | +| requestUser | [common.User](#common-User) | | | @@ -1251,49 +1177,7 @@ Tasks | pid | [string](#string) | | | | sandboxStdout | [string](#string) | | | | claimable | [bool](#bool) | | | - - - - - - - - -### StatusReply - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| state | [string](#string) | | | -| statusUpdates | [StatusUpdate](#o2control-StatusUpdate) | repeated | | - - - - - - - - -### StatusRequest -Global status -////////////////////////////////////// - - - - - - - - -### StatusUpdate - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| level | [StatusUpdate.Level](#o2control-StatusUpdate-Level) | | | -| mesosHeartbeat | [Event_MesosHeartbeat](#o2control-Event_MesosHeartbeat) | | TODO add other events here and in events.proto | +| critical | [bool](#bool) | | | @@ -1315,22 +1199,6 @@ Global status - - -### TaskClassInfo - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| name | [string](#string) | | | -| controlMode | [string](#string) | | | - - - - - - ### TaskDeploymentInfo @@ -1358,7 +1226,6 @@ Global status | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | shortInfo | [ShortTaskInfo](#o2control-ShortTaskInfo) | | | -| classInfo | [TaskClassInfo](#o2control-TaskClassInfo) | | | | inboundChannels | [ChannelInfo](#o2control-ChannelInfo) | repeated | | | outboundChannels | [ChannelInfo](#o2control-ChannelInfo) | repeated | | | commandInfo | [CommandInfo](#o2control-CommandInfo) | | | @@ -1523,20 +1390,6 @@ Not implemented yet - - -### StatusUpdate.Level - - -| Name | Number | Description | -| ---- | ------ | ----------- | -| DEBUG | 0 | | -| INFO | 1 | | -| WARNING | 2 | | -| ERROR | 3 | | - - - ### VarSpecMessage.Type @@ -1580,17 +1433,16 @@ Not implemented yet | Method Name | Request Type | Response Type | Description | | ----------- | ------------ | ------------- | ------------| -| TrackStatus | [StatusRequest](#o2control-StatusRequest) | [StatusReply](#o2control-StatusReply) stream | | | GetFrameworkInfo | [GetFrameworkInfoRequest](#o2control-GetFrameworkInfoRequest) | [GetFrameworkInfoReply](#o2control-GetFrameworkInfoReply) | | -| Teardown | [TeardownRequest](#o2control-TeardownRequest) | [TeardownReply](#o2control-TeardownReply) | | | GetEnvironments | [GetEnvironmentsRequest](#o2control-GetEnvironmentsRequest) | [GetEnvironmentsReply](#o2control-GetEnvironmentsReply) | | | NewAutoEnvironment | [NewAutoEnvironmentRequest](#o2control-NewAutoEnvironmentRequest) | [NewAutoEnvironmentReply](#o2control-NewAutoEnvironmentReply) | | | NewEnvironment | [NewEnvironmentRequest](#o2control-NewEnvironmentRequest) | [NewEnvironmentReply](#o2control-NewEnvironmentReply) | | | GetEnvironment | [GetEnvironmentRequest](#o2control-GetEnvironmentRequest) | [GetEnvironmentReply](#o2control-GetEnvironmentReply) | | | ControlEnvironment | [ControlEnvironmentRequest](#o2control-ControlEnvironmentRequest) | [ControlEnvironmentReply](#o2control-ControlEnvironmentReply) | | -| ModifyEnvironment | [ModifyEnvironmentRequest](#o2control-ModifyEnvironmentRequest) | [ModifyEnvironmentReply](#o2control-ModifyEnvironmentReply) | | | DestroyEnvironment | [DestroyEnvironmentRequest](#o2control-DestroyEnvironmentRequest) | [DestroyEnvironmentReply](#o2control-DestroyEnvironmentReply) | | | GetActiveDetectors | [Empty](#o2control-Empty) | [GetActiveDetectorsReply](#o2control-GetActiveDetectorsReply) | | +| GetAvailableDetectors | [Empty](#o2control-Empty) | [GetAvailableDetectorsReply](#o2control-GetAvailableDetectorsReply) | | +| NewEnvironmentAsync | [NewEnvironmentRequest](#o2control-NewEnvironmentRequest) | [NewEnvironmentReply](#o2control-NewEnvironmentReply) | | | GetTasks | [GetTasksRequest](#o2control-GetTasksRequest) | [GetTasksReply](#o2control-GetTasksReply) | | | GetTask | [GetTaskRequest](#o2control-GetTaskRequest) | [GetTaskReply](#o2control-GetTaskReply) | | | CleanupTasks | [CleanupTasksRequest](#o2control-CleanupTasksRequest) | [CleanupTasksReply](#o2control-CleanupTasksReply) | | @@ -1603,8 +1455,10 @@ Not implemented yet | SetDefaultRepo | [SetDefaultRepoRequest](#o2control-SetDefaultRepoRequest) | [Empty](#o2control-Empty) | | | SetGlobalDefaultRevision | [SetGlobalDefaultRevisionRequest](#o2control-SetGlobalDefaultRevisionRequest) | [Empty](#o2control-Empty) | | | SetRepoDefaultRevision | [SetRepoDefaultRevisionRequest](#o2control-SetRepoDefaultRevisionRequest) | [SetRepoDefaultRevisionReply](#o2control-SetRepoDefaultRevisionReply) | | -| Subscribe | [SubscribeRequest](#o2control-SubscribeRequest) | [Event](#o2control-Event) stream | | +| Subscribe | [SubscribeRequest](#o2control-SubscribeRequest) | [.events.Event](#events-Event) stream | | | GetIntegratedServices | [Empty](#o2control-Empty) | [ListIntegratedServicesReply](#o2control-ListIntegratedServicesReply) | | +| Teardown | [TeardownRequest](#o2control-TeardownRequest) | [TeardownReply](#o2control-TeardownReply) | Reserved and not implemented: | +| ModifyEnvironment | [ModifyEnvironmentRequest](#o2control-ModifyEnvironmentRequest) | [ModifyEnvironmentReply](#o2control-ModifyEnvironmentReply) | | diff --git a/docs/apidocs_apricot.md b/docs/apidocs_apricot.md index 8e2f8585..88a12024 100644 --- a/docs/apidocs_apricot.md +++ b/docs/apidocs_apricot.md @@ -22,6 +22,7 @@ - [DetectorsResponse](#apricot-DetectorsResponse) - [Empty](#apricot-Empty) - [GetEntryRequest](#apricot-GetEntryRequest) + - [GetRuntimeEntriesRequest](#apricot-GetRuntimeEntriesRequest) - [GetRuntimeEntryRequest](#apricot-GetRuntimeEntryRequest) - [HostEntriesResponse](#apricot-HostEntriesResponse) - [HostGetRequest](#apricot-HostGetRequest) @@ -329,6 +330,21 @@ + + +### GetRuntimeEntriesRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| component | [string](#string) | | | + + + + + + ### GetRuntimeEntryRequest @@ -603,6 +619,7 @@ | GetEndpointsForCRUCard | [CardRequest](#apricot-CardRequest) | [CRUCardEndpointResponse](#apricot-CRUCardEndpointResponse) | | | GetRuntimeEntry | [GetRuntimeEntryRequest](#apricot-GetRuntimeEntryRequest) | [ComponentResponse](#apricot-ComponentResponse) | Runtime KV calls | | SetRuntimeEntry | [SetRuntimeEntryRequest](#apricot-SetRuntimeEntryRequest) | [Empty](#apricot-Empty) | | +| GetRuntimeEntries | [GetRuntimeEntriesRequest](#apricot-GetRuntimeEntriesRequest) | [StringMap](#apricot-StringMap) | | | ListRuntimeEntries | [ListRuntimeEntriesRequest](#apricot-ListRuntimeEntriesRequest) | [ComponentEntriesResponse](#apricot-ComponentEntriesResponse) | | | ListComponents | [Empty](#apricot-Empty) | [ComponentEntriesResponse](#apricot-ComponentEntriesResponse) | Component configuration calls | | ListComponentEntries | [ListComponentEntriesRequest](#apricot-ListComponentEntriesRequest) | [ComponentEntriesResponse](#apricot-ComponentEntriesResponse) | |