package hashicorp.nomad.plugins.base.proto

Get desktop application:
View/edit binary Protocol Buffers messages

BasePlugin is the methods that all Nomad plugins must support.

• rpc PluginInfo (PluginInfoRequest, PluginInfoResponse)

  base.proto:14

  PluginInfo describes the type and version of a plugin.

  message PluginInfoRequest

  base.proto:31

  PluginInfoRequest is used to request the plugins basic information.

  (message has no fields)

  message PluginInfoResponse

  base.proto:35

  PluginInfoResponse returns basic information about the plugin such that Nomad can decide whether to load the plugin or not.

  • PluginType type = 1

    type indicates what type of plugin this is.

  • repeated string plugin_api_versions = 2

    plugin_api_versions indicates the versions of the Nomad Plugin API this plugin supports.

  • string plugin_version = 3

    plugin_version is the semver version of this individual plugin. This is divorce from Nomad’s development and versioning.

  • string name = 4

    name is the name of the plugin

• rpc ConfigSchema (ConfigSchemaRequest, ConfigSchemaResponse)

  base.proto:17

  ConfigSchema returns the schema for parsing the plugins configuration.

  message ConfigSchemaRequest

  base.proto:52

  ConfigSchemaRequest is used to request the configurations schema.

  (message has no fields)

  message ConfigSchemaResponse

  base.proto:55

  ConfigSchemaResponse returns the plugins configuration schema.

  • optional shared.hclspec.Spec spec = 1

    spec is the plugins configuration schema

• rpc SetConfig (SetConfigRequest, SetConfigResponse)

  base.proto:20

  SetConfig is used to set the configuration.

  message SetConfigRequest

  base.proto:61

  SetConfigRequest is used to set the configuration

  • bytes msgpack_config = 1

    msgpack_config is the configuration encoded as MessagePack.

  • optional NomadConfig nomad_config = 2

    nomad_config is the nomad client configuration sent to all plugins.

  • string plugin_api_version = 3

    plugin_api_version is the api version to use.

  message SetConfigResponse

  base.proto:132

  SetConfigResponse is used to respond to setting the configuration

  (message has no fields)

numalib/Topology

Used in: NomadDriverConfig

• repeated uint32 node_ids = 1

• optional ClientTopologySLIT distances = 2

• repeated ClientTopologyCore cores = 3

• uint64 override_total_compute = 4

• uint64 override_withold_compute = 5

numalib/Core

Used in: ClientTopology

• uint32 socket_id = 1

• uint32 node_id = 2

• uint32 core_id = 3

• CoreGrade core_grade = 4

• bool disable = 5

• uint64 base_speed = 6

• uint64 max_speed = 7

• uint64 guess_speed = 8

numalib/SLIT

Used in: ClientTopology

• uint32 dimension = 1

  dimension is the row and column size of the slit matrix

• repeated uint32 values = 2

  values is the flattened matrix of slit values

Used in: ClientTopologyCore

• Performance = 0

• Efficiency = 1

NomadConfig is the client configuration sent to all plugins

Used in: SetConfigRequest

• optional NomadDriverConfig driver = 1

  driver specific configuration sent to all plugins

NomadDriverConfig is the driver specific client configuration sent to all driver plugins

Used in: NomadConfig

• uint32 ClientMaxPort = 1

  ClientMaxPort is the upper range of the ports that the client uses for communicating with plugin subsystems over loopback buf:lint:ignore FIELD_LOWER_SNAKE_CASE

• uint32 ClientMinPort = 2

  ClientMinPort is the lower range of the ports that the client uses for communicating with plugin subsystems over loopback buf:lint:ignore FIELD_LOWER_SNAKE_CASE

• optional ClientTopology Topology = 3

  Topology is the complex hardware topology detected by the client combined with client configuration.

PluginType enumerates the type of plugins Nomad supports

Used in: PluginInfoResponse

• UNKNOWN = 0

• DRIVER = 2

• DEVICE = 3