package determined.resourcepool.v1

Get desktop application:
View/edit binary Protocol Buffers messages

List of arbitrary user-defined tags that are added to the Determined agent instances

Used in: ResourcePoolAwsDetail

• string key = 1

  The key of the custom tag

• string value = 2

  The value of the custom tag

The fitting policy of the scheduler.

Used in: ResourcePool

• FITTING_POLICY_UNSPECIFIED = 0

  Unspecified. This value will never actually be returned by the API, it is just an artifact of using protobuf.

• FITTING_POLICY_BEST = 1

  Best fit. Tasks are preferentially “packed” together on the smallest number of agents

• FITTING_POLICY_WORST = 2

  Worst fit. Tasks are placed on under-utilized agents, spreading out the tasks.

• FITTING_POLICY_KUBERNETES = 3

  A kubernetes placeholder. In k8s, the task placement is delegated to the k8s scheduler so the fitting policy is not relevant.

• FITTING_POLICY_SLURM = 4

  A slurm placeholder. When running on slurm, task placement is delegated.

• FITTING_POLICY_PBS = 5

  A PBS placeholder. When running on PBS, task placement is delegated.

A kubernetes priority class

Used in: ResourcePoolPrioritySchedulerDetail

• string priority_class = 1

  Priority class name.

• int32 priority_value = 2

  Priority class value.

A Resource Pool is a pool of resources where containers are run.

Used in: api.v1.GetResourcePoolsResponse

• string name = 1

  The unique name of the resource pool.

• string description = 2

  The description of the resource pool

• ResourcePoolType type = 3

  The type of the resource pool (AWS/GCP/STATIC)

• int32 num_agents = 4

  The number of agents running in the resource pool

• int32 slots_available = 5

  The total number of slots that exist in the resource pool

• int32 slots_used = 6

  The number of slots that are actively running workloads

• device.v1.Type slot_type = 32

  Slot device type: cpu, gpu, ...

• int32 aux_container_capacity = 7

  The max number of aux containers that can run in this resource pool

• int32 aux_containers_running = 8

  The current number of aux containers running in this resource pool

• bool default_compute_pool = 9

  Is this resource pool the default compute pool?

• bool default_aux_pool = 10

  Is this resource pool the default auxiliary pool?

• bool preemptible = 11

  Is this resource pool using preemptible/spot instances? Only meaningful in an AWS or GCP resource pool.

• int32 min_agents = 12

  When using dynamic agents, the minimum number of agents that can exist in the resource pool.

• int32 max_agents = 13

  When using dynamic agents, the maximum number of agents that can exist in the resource pool.

• int32 slots_per_agent = 14

  The number of slots that exists on an dynamic agent.

• int32 aux_container_capacity_per_agent = 15

  The maximum number of auxiliary containers that can run on an individual agent

• SchedulerType scheduler_type = 16

  The type of the scheduler. Either 'FAIR_SHARE', 'PRIORITY', or 'ROUND_ROBIN'

• FittingPolicy scheduler_fitting_policy = 17

  The fitting policy of the scheduler.

• string location = 18

  The location of the resource pool. For AWS this returns the region and for GCP this return the zone.

• string image_id = 19

  The VM image used for the agents when using dynamic agents.

• string instance_type = 20

  The instance type of the agents when using dynamic agents. For AWS this is the Instance Type. For GCP this is the machine type combined with the number and types of GPUs. To work with this data programattically, we recommend working with the ResourcePool.details.aws.instanceType and ResourcePool.details.gcp.machineType/gpuType/gpuNum.

• string master_url = 21

  The url of the Determined master

• string master_cert_name = 22

  A hostname for which the master’s TLS certificate is valid, if the host specified by the master_url option is an IP address or is not contained in the certificate

• string startup_script = 23

  The startup script for the agent. This runs on the node the agent runs on.

• string container_startup_script = 24

  The startup script for the agent's container. This runs in the container determined-agent runs in.

• string agent_docker_network = 25

  The Docker network to use for the agent when using dynamic agents.

• string agent_docker_runtime = 26

  The docker runtime to use for the agent when using dynamic agents

• string agent_docker_image = 27

  The docker image to use for the agent when using dynamic agents

• string agent_fluent_image = 28

  the Fluent docker image to use

• float max_idle_agent_period = 29

  The maximum idle period of agents in seconds. The master waits for this period of time before shutting down idle agents.

• float max_agent_starting_period = 30

  The maximum starting period of agents in seconds. The master waits for this period of time for starting agents before retrying.

• optional ResourcePoolDetail details = 31

  GCP, AWS and Priority Scheduler details

• string accelerator = 33

  GCP, AWS accelerator information

• optional job.v1.QueueStats stats = 34

  Job queue stats

• map<string, string> resource_manager_metadata = 35

  Resource manager's metadata.

• string cluster_name = 36

  Resource manager's associated cluster name.

AWS-specific details about the resource pool

Used in: ResourcePoolDetail

• string region = 1

  The region the resource pool exists in

• int32 root_volume_size = 2

  Size of the root volume of the Determined agent in GB

• string image_id = 3

  The AMI ID of the Determined agent

• string tag_key = 4

  Key for tagging the Determined agent instances

• string tag_value = 5

  Value for tagging the Determined agent instances

• string instance_name = 6

  Name to set for the Determined agent instances

• string ssh_key_name = 7

  The name of the SSH key registered with AWS for SSH key access to the agent instances

• bool public_ip = 8

  Whether to use public IP addresses for the Determined agent

• string subnet_id = 9

  The ID of the subnet to run the Determined agents in

• string security_group_id = 10

  The ID of the security group to run the Determined agents as

• string iam_instance_profile_arn = 11

  The Amazon Resource Name (ARN) of the IAM instance profile to attach to the agent instances.

• string instance_type = 12

  AWS instance type to use for dynamic agents

• string log_group = 13

  The log group

• string log_stream = 14

  The log stream

• bool spot_enabled = 15

  Whether to use spot instances

• string spot_max_price = 16

  The maximum price per hour to pay for a spot instance

• repeated AwsCustomTag custom_tags = 17

  List of arbitrary user-defined tags that are added to the Determined agent instances

Detailed information about the resource pool

Used in: ResourcePool

• optional ResourcePoolAwsDetail aws = 1

  AWS-specific details

• optional ResourcePoolGcpDetail gcp = 2

  GCP-specific details

• optional ResourcePoolPrioritySchedulerDetail priority_scheduler = 3

  Priority scheduler-specific details

GCP-specific details about the resource pool

Used in: ResourcePoolDetail

• string project = 1

  The project ID of the GCP resources used by Determined

• string zone = 2

  The zone of the GCP resources used by Determined

• int32 boot_disk_size = 3

  Size of the root volume of the Determined agent in GB

• string boot_disk_source_image = 4

  The boot disk source image of the Determined agent

• string label_key = 5

  Key for labeling the Determined agent instances.

• string label_value = 6

  Value for labeling the Determined agent instances

• string name_prefix = 7

  Name prefix to set for the Determined agent instances

• string network = 8

  Network resource for the Determined agent instances

• string subnetwork = 9

  Subnetwork resource for the Determined agent instances

• bool external_ip = 10

  Whether to use external IP addresses for the Determined agent instances

• repeated string network_tags = 11

  The network tags to set firewalls for the Determined agent instances

• string service_account_email = 12

  Email of the service account for the Determined agent instances.

• repeated string service_account_scopes = 13

  List of scopes authorized for the Determined agent instances

• string machine_type = 14

  Type of machine for the Determined agents

• string gpu_type = 15

  Type of GPU for the Determined agents

• int32 gpu_num = 16

  Number of GPUs for the Determined agents

• bool preemptible = 17

  Whether to use preemptible instances

• float operation_timeout_period = 18

  The timeout period for tracking a GCP operation in seconds

Details related to the priority scheduler. This will only be present if the schedulerType=priority

Used in: ResourcePoolDetail

• bool preemption = 1

  Whether lower priority tasks should be preempted to schedule higher priority tasks

• int32 default_priority = 2

  The priority that is assigned to tasks that do not explicitly specify a priority.

• repeated K8PriorityClass k8_priorities = 3

  List of available priorities for K8 (if applicable).

The type of the ResourcePool.

Used in: ResourcePool

• RESOURCE_POOL_TYPE_UNSPECIFIED = 0

  Unspecified. This value will never actually be returned by the API, it is just an artifact of using protobuf.

• RESOURCE_POOL_TYPE_AWS = 1

  An AWS resource pool.

• RESOURCE_POOL_TYPE_GCP = 2

  A GCP resource pool.

• RESOURCE_POOL_TYPE_STATIC = 3

  A static resource pool.

• RESOURCE_POOL_TYPE_K8S = 4

  The kubernetes resource pool.

The type of the Scheduler.

Used in: ResourcePool

• SCHEDULER_TYPE_UNSPECIFIED = 0

  Unspecified. This value will never actually be returned by the API, it is just an artifact of using protobuf.

• SCHEDULER_TYPE_PRIORITY = 1

  The priority scheduler.

• SCHEDULER_TYPE_FAIR_SHARE = 2

  The fair share scheduler.

• SCHEDULER_TYPE_ROUND_ROBIN = 3

  The round robin scheduler

• SCHEDULER_TYPE_KUBERNETES = 4

  The kubernetes scheduler.

• SCHEDULER_TYPE_SLURM = 5

  A slurm placeholder. When running on slurm, all scheduling behavior is delegated.

• SCHEDULER_TYPE_PBS = 6

  A PBS placeholder. When running on PBS, all scheduling behavior is delegated.