actuatorconfiguration

Some actuators expose parameters that can be configured. For these actuators an actuatorconfiguration resource defines a particular set of values for these parameters. When creating an operation resource you can then optionally specify the identifiers of actuatorconfiguration resources that should be used to configure the actuators used in the operation.

Some examples of configuration parameters are:

• location of storage e.g. PVC name
• A REST endpoint
• what compute resources are available

Often these parameters capture things that change depending on the system the actuator is running on. For example, one system has A100 GPUs but another does not, and the configuration allows the actuator to know before trying to submit an experiment that it can't be executed on the given system.

creating an actuatorconfiguration¶

Similar to operation resources, creating an actuatorconfiguration involves writing a YAML containing values for the configurable actuator parameters.

Getting input options and potential values¶

The available parameters can be found by checking the actuator documentation or a default configuration can be obtained using

ado template actuatorconfiguration --actuator-identifier $ACTUATORNAME

The output file will be called "$ACTUATORNAME_actuatorconfiguration_template_$RANDOM_ID.yaml"

The schema of the configuration YAML, which includes documentation on each field, can additionally be output using

ado template actuatorconfiguration --actuator-identifier $ACTUATORNAME --include-schema

The schema will be output to a file called "$ACTUATORNAME_actuatorconfiguration_template_$RANDOM_ID_schema.yaml"

Creation and validation¶

Once the desired values are set and saved in a file called $ACTUATOR_CONFIGURATION_FILE then the actuatorconfiguration resource can be created with:

ado create actuatorconfiguration -f $ACTUATOR_CONFIGURATION_FILE

This will return an identifier with the format "actuatorconfiguration-$ACTUATORNAME-$RANDOM_ID" e.g.

> Success! Created actuator configuration with identifier `actuatorconfiguration-robotic_lab-3edc9cd3`

The supplied parameters are sent to the actuator for validation before the resource is created. If any errors are detected, a warning will be displayed describing the issue, and the resource will not be created.

Using an actuatorconfiguration¶

actuatorconfigurations are used when creating operation resources. See specifying actuator parameters in the operation resource documentation for details.

Other ado commands that work with actuatorconfiguration¶

• ado get actuatorconfigurations
  • list stored actuatorconfigurations or retrieve their representations
• ado show related actuatorconfiguration ID
  • show operations using an actuatorconfiguration
• ado edit actuatorconfiguration ID
  • set the name, description, and labels for an actuatorconfiguration
• ado delete actuatorconfiguration ID
  • delete an actuatorconfiguration