← Back to packages

Package intrinsic_proto.workcell_spec.v1

Service InstallerService

Message HardwareModuleConfig

Message IconHardwareModuleOptions

Message Image

Message InstallContainerAddonRequest

Message InstallContainerAddonsRequest

Message RemoveContainerAddonRequest

Enum AddonType

Services

service InstallerService intrinsic/kubernetes/workcell_spec/proto/installer.proto

Installs a (eg. 3rd party) container addon into the cluster

Installs multiple (eg. 3rd party) container addons into the cluster.

Removes a (eg. 3rd party) container addon from the cluster

Messages

message HardwareModuleConfig (Nested in intrinsic_proto.workcell_spec.v1.IconHardwareModuleOptions ) intrinsic/kubernetes/workcell_spec/proto/installer.proto

Contains the raw bytes representing the hardware module config to be used.

Field Type Description
1 content bytes

message IconHardwareModuleOptions intrinsic/kubernetes/workcell_spec/proto/installer.proto

Field Type Description
1 requires_atemsys bool

If true, then the hardware module requires an atemsys device to run.

2 rtpc_node_hostname string

The hostname of the node that this hardware module should run on.

3 run_with_realtime_priority bool

If true, then the hardware module runs with realtime priority.

4 hardware_module_config intrinsic_proto.workcell_spec.v1.IconHardwareModuleOptions.HardwareModuleConfig

The hardware module config in raw bytes to tbe used by the installer service.

5 isolate_network bool

If true, then the hardware module runs with normal cluster networking. if false, then the hardware module runs with host network interfaces.

6 running_ethercat_oss bool

If true, then the hardware module is running the EtherCAT OSS stack. and requires access to the /dev/EtherCAT0 device file.

message Image intrinsic/kubernetes/workcell_spec/proto/image.proto

Field Type Description
1 registry string

fully qualified url to container registry, e.g. 'gcr.io/'

2 name string

image name, will also be used in the template for the resources that run the image (e.g. pod or deployment)

3 tag string

image ref, e.g. '@sha256:' or ':'

4 auth_user string

private registry auth, e.g. for gcr.io use: user=oauth2accesstoken password="$(gcloud auth application-default print-access-token)"

5 auth_password string

message InstallContainerAddonRequest intrinsic/kubernetes/workcell_spec/proto/installer.proto

Field Type Description
1 name string

The addon name - must be a valid dns name - should not start with 'skill-' - the combination of (type,name) must be unique the generated namespace will by '$type-$name' Prefer to specify id instead of name

2 type intrinsic_proto.workcell_spec.v1.AddonType

The type of the addon, will determine the supported options

3 images repeated intrinsic_proto.workcell_spec.v1.Image
6 id string

The addon id - must be a valid id in. This must: - start with a letter in the alphabet - only contain [a-Z0-9._] - we recommend using reverse dns notation - should not start with 'skill-' - the combination of (type,name) must be unique the generated namespace will by '$type-$name'

7 version string

The semver version of the addon. Uses 0.0.1 if unspecified.

oneof addon_options
4 icon_hardware_module_options intrinsic_proto.workcell_spec.v1.IconHardwareModuleOptions

message InstallContainerAddonsRequest intrinsic/kubernetes/workcell_spec/proto/installer.proto

Field Type Description
1 requests repeated intrinsic_proto.workcell_spec.v1.InstallContainerAddonRequest

message RemoveContainerAddonRequest intrinsic/kubernetes/workcell_spec/proto/installer.proto

Field Type Description
1 name string

The addon name. Prefer to specify id instead of name

2 type intrinsic_proto.workcell_spec.v1.AddonType

The type of the addon

3 id string

The id of the addon

Enums

enum AddonType intrinsic/kubernetes/workcell_spec/proto/installer.proto

Name Number Description
ADDON_TYPE_UNKNOWN 0
ADDON_TYPE_SKILL 1
ADDON_TYPE_SKILL_BUNDLE 2
ADDON_TYPE_ICON_HARDWARE_MODULE 3