package peloton.api.v1alpha.pod

Get desktop application:
View/edit binary Protocol Buffers messages

AndConstraint represents a logical 'and' of constraints.

Used in: Constraint

• repeated Constraint constraints = 1

CommandSpec describes a command to be run in the container.

Used in: ContainerSpec, HealthCheckSpec

• string value = 1

  value is the command line to execute inside the container.

• repeated string arguments = 2

  Arguments to the command.

Constraint represents a host label constraint or a related pods label constraint. This is used to require that a host have certain label constraints or to require that the pods already running on the host have certain label constraints.

Used in: AndConstraint, OrConstraint, PodSpec, private.hostmgr.v1alpha.hostmgr.HostFilter

• Constraint.Type type = 1

• optional LabelConstraint label_constraint = 2

• optional AndConstraint and_constraint = 3

• optional OrConstraint or_constraint = 4

Used in: Constraint

• CONSTRAINT_TYPE_INVALID = 0

  Reserved for compatibility.

• CONSTRAINT_TYPE_LABEL = 1

• CONSTRAINT_TYPE_AND = 2

• CONSTRAINT_TYPE_OR = 3

A single application container running inside a pod.

Used in: PodSpec

• string name = 1

  Name of the container. Each container in a pod must have a unique name. Cannot be updated.

• optional ResourceSpec resource = 2

  Resource config of the container

• optional mesos.v1.ContainerInfo container = 3

  Container config of the container Deprecated.

• optional mesos.v1.CommandInfo command = 4

  Command line config of the container Deprecated.

• optional mesos.v1.ExecutorInfo executor = 8

  Custom executor config of the task. Deprecated.

• optional HealthCheckSpec liveness_check = 5

  Liveness health check config of the container

• optional HealthCheckSpec readiness_check = 6

  Readiness health check config of the container This is currently not supported.

• repeated PortSpec ports = 7

  List of network ports to be allocated for the container. These ports will be assigned on the pod network namespace if the pod has its own network name space. If the pod does not have its own network name space, the ports will be assigned on the host network.

• optional CommandSpec entrypoint = 9

  Entrypoint command.

• repeated Environment environment = 10

  List of environment variables to set in the container.

• string image = 11

  Image name.

• repeated VolumeMount volume_mounts = 12

  Pod volumes to mount into the container's filesystem.

Runtime states of a container in a pod.

Used in: ContainerStatus

• CONTAINER_STATE_INVALID = 0

  Invalid state.

• CONTAINER_STATE_PENDING = 1

  The container has not been created yet.

• CONTAINER_STATE_LAUNCHED = 2

  The container has been launched.

• CONTAINER_STATE_STARTING = 3

  The container is being started on a host.

• CONTAINER_STATE_RUNNING = 4

  The container is running on a host.

• CONTAINER_STATE_SUCCEEDED = 5

  The container terminated with an exit code of zero.

• CONTAINER_STATE_FAILED = 6

  The container terminated with a non-zero exit code.

• CONTAINER_STATE_KILLING = 7

  The container is being killed.

• CONTAINER_STATE_KILLED = 8

  Execution of the container was terminated by the system.

Runtime status of a container in a pod.

Used in: PodEvent, PodStatus

• string name = 1

  Name of the container

• ContainerState state = 2

  Runtime state of the container.

• map<string, uint32> ports = 3

  Dynamic ports reserved on the host while this container is running.

• string message = 4

  The message that explains the current state of a container such as why the container is failed. Only track the latest one if the container has been retried and failed multiple times.

• string reason = 5

  The reason that explains the current state of a container. Only track the latest one if the container has been retried and failed multiple times.

• uint32 failure_count = 6

  The number of times the container has failed after retries.

• optional HealthStatus healthy = 7

  The result of the health check.

• string image = 8

  The image the container is running.

• string start_time = 9

  The time when the container starts to run. Will be unset if the pod hasn't started running yet. The time is represented in RFC3339 form with UTC timezone.

• string completion_time = 10

  The time when the container terminated. Will be unset if the pod hasn't completed yet. The time is represented in RFC3339 form with UTC timezone.

• optional TerminationStatus terminationStatus = 11

  Termination status of the task. Set only if the task is in a non-successful terminal state such as CONTAINER_STATE_FAILED or CONTAINER_STATE_KILLED.

Environment represents an environment variable present in a container.

Used in: ContainerSpec

• string name = 1

  Name of the environment variable.

• string value = 2

  Value of the environment variable.

HTTPGetSpec describes an action based on HTTP Get request.

Used in: HealthCheckSpec

• string scheme = 1

  The scheme to use for connecting to the host. Currently http and https are supported.

• uint32 port = 2

  Port to send the HTTP GET. Deprecated.

• string path = 3

  The request path on the HTTP server.

• repeated HTTPGetSpec.HTTPHeader http_headers = 4

  Custom HTTP headers to set in the request. HTTP allows repeated headers.

• optional PortSpec port_spec = 5

  Port to send the HTTP GET.

HTTPHeader describes a custom HTTP header to be used in the HTTP request.

Used in: HTTPGetSpec

• string name = 1

  The header field name

• string value = 2

  The header field value

Health check configuration for a container.

Used in: ContainerSpec

• bool enabled = 1

  Whether the health check is enabled.

• uint32 initial_interval_secs = 2

  Start time wait in seconds. Default value is 15.

• uint32 interval_secs = 3

  Interval in seconds between two health checks. Default value is 10.

• uint32 max_consecutive_failures = 4

  Max number of consecutive failures before failing health check. Default value is 3.

• uint32 timeout_secs = 5

  Health check command timeout in seconds. Default value is 20.

• HealthCheckSpec.HealthCheckType type = 6

  Type of health check to run.

• optional HealthCheckSpec.CommandCheck command_check = 7

  Only applicable when type is `COMMAND`. Deprecated

• optional HealthCheckSpec.HTTPCheck http_check = 8

  Only applicable when type is 'HTTP'. Deprecated

• uint32 success_threshold = 9

  Minimum consecutive successes for the health check to be considered successful after a failure. Defaults to 1. Only available in the Kubelet runtime.

• optional CommandSpec command = 10

  Command to run in the container to do the health check. Only applicable when type is `COMMAND`.

• optional HTTPGetSpec http_get = 11

  HTTP Get request to perform. Only applicable when type is 'HTTP'.

Deprecated.

Used in: HealthCheckSpec

• string command = 1

  Health check command to be executed. Note that this command by default inherits all environment varibles from the container it's monitoring, unless `unshare_environments` is set to true.

• bool unshare_environments = 2

  If set, this check will not share the environment variables of the container.

Deprecated.

HTTP health check to be executed. Sends a GET request to scheme://<host>:port/path. Host is not configurable and is resolved automatically.

Used in: HealthCheckSpec

• string scheme = 1

  Currently http and https are supported.

• uint32 port = 2

  Port to send the HTTP GET.

• string path = 3

  The request path.

Type of health check to run.

Used in: HealthCheckSpec

• HEALTH_CHECK_TYPE_UNKNOWN = 0

  Reserved for future compatibility of new types.

• HEALTH_CHECK_TYPE_COMMAND = 1

  Command line based health check

• HEALTH_CHECK_TYPE_HTTP = 2

  HTTP endpoint based health check

HealthState is the health check state of a container.

Used in: HealthStatus

• HEALTH_STATE_INVALID = 0

  Default value.

• HEALTH_STATE_DISABLED = 1

  If the health check config is not enabled in the container config, then the health state is DISABLED.

• HEALTH_STATE_UNKNOWN = 2

  If the health check config is enabled in the container config, but the container has not reported the output of the health check yet, then the health state is UNKNOWN.

• HEALTH_STATE_HEALTHY = 3

  The container passes the health check.

• HEALTH_STATE_UNHEALTHY = 4

  The container failed to pass the health check.

The result of the health check.

Used in: ContainerStatus

• HealthState state = 1

  The health check state.

• string output = 2

  The output of the health check run.

Pod InstanceID range [from, to)

Used in: job.stateless.RestartSpec, job.stateless.WorkflowInfo, job.stateless.svc.GetReplaceJobDiffResponse, job.stateless.svc.ListPodsRequest

• uint32 from = 1

• uint32 to = 2

LabelConstraint represents a constraint on the number of occurrences of a given label from the set of host labels or pod labels present on the host.

Used in: Constraint

• LabelConstraint.Kind kind = 1

  Determines which labels the constraint should apply to.

• LabelConstraint.Condition condition = 2

  Determines which constraint there should be on the number of occurrences of the label.

• optional peloton.Label label = 3

  The label which this defines a constraint on: For Kind == HOST, each attribute on host agent is transformed to a label, with `hostname` as a special label which is always inferred from agent hostname and set.

• uint32 requirement = 4

  A limit on the number of occurrences of the label.

Condition represents a constraint on the number of occurrences of the label.

Used in: LabelConstraint

• LABEL_CONSTRAINT_CONDITION_INVALID = 0

• LABEL_CONSTRAINT_CONDITION_LESS_THAN = 1

• LABEL_CONSTRAINT_CONDITION_EQUAL = 2

• LABEL_CONSTRAINT_CONDITION_GREATER_THAN = 3

Kind represents whatever the constraint applies to the labels on the host or to the labels of the pods that are located on the host.

Used in: LabelConstraint

• LABEL_CONSTRAINT_KIND_INVALID = 0

• LABEL_CONSTRAINT_KIND_POD = 1

• LABEL_CONSTRAINT_KIND_HOST = 2

OrConstraint represents a logical 'or' of constraints.

Used in: Constraint

• repeated Constraint constraints = 1

Persistent volume configuration for a pod. Deprecated

Used in: PodSpec

• string container_path = 1

  Volume mount path inside container.

• uint32 size_mb = 2

  Volume size in MB.

Pod events of a particular run of a job instance.

Used in: svc.GetPodEventsResponse, private.eventstream.v1alpha.event.Event

• optional peloton.PodID pod_id = 1

  The current pod ID.

• string actual_state = 2

  Actual state of a pod.

• string desired_state = 3

  Goal State of a pod.

• string timestamp = 4

  The time when the event was created. The time is represented in RFC3339 form with UTC timezone.

• optional peloton.EntityVersion version = 5

  The entity version currently used by the pod.

• optional peloton.EntityVersion desired_version = 6

  The desired entity version that should be used by the pod.

• string agent_id = 7

  The agentID for the pod.

• string hostname = 8

  The host on which the pod is running.

• string message = 9

  Short human friendly message explaining state.

• string reason = 10

  The short reason for the pod event.

• optional peloton.PodID prev_pod_id = 11

  The previous pod ID.

• string healthy = 12

  The health check result of the pod.

• optional peloton.PodID desired_pod_id = 13

  The desired pod ID.

• repeated ContainerStatus container_status = 14

  Status of the containers.

• repeated ContainerStatus init_container_status = 15

  Status of the init containers.

Info of a pod in a Job.

Used in: job.stateless.svc.QueryPodsResponse, svc.GetPodResponse

• optional PodSpec spec = 1

  Configuration of the pod.

• optional PodStatus status = 2

  Runtime status of the pod.

Pod configuration for a given job instance Note that only add string/slice/ptr type into PodConfig directly due to the limitation of go reflection inside our pod specific config logic.

Used in: job.stateless.JobSpec, PodInfo, private.hostmgr.v1alpha.hostmgr.LaunchablePod

• optional peloton.PodName pod_name = 1

  Name of the pod

• repeated peloton.Label labels = 2

  List of user-defined labels for the pod

• repeated ContainerSpec init_containers = 3

  List of initialization containers belonging to the pod. These containers are assumed to run to completion and are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed. Init containers cannot be configured to have readiness or liveness health checks.

• repeated ContainerSpec containers = 4

  List of containers belonging to the pod. These will be started in parallel after init containers terminate. There must be at least one container in a pod.

• optional Constraint constraint = 5

  Constraint on the attributes of the host or labels on pods on the host that this pod should run on. Use `AndConstraint`/`OrConstraint` to compose multiple constraints if necessary.

• optional RestartPolicy restart_policy = 6

  Pod restart policy on failures

• optional PersistentVolumeSpec volume = 7

  Persistent volume config of the pod. Deprecated

• optional PreemptionPolicy preemption_policy = 8

  Preemption policy of the pod

• bool controller = 9

  Whether this is a controller pod. A controller is a special batch pod which controls other pods inside a job. E.g. spark driver pods in a spark job will be a controller pod.

• uint32 kill_grace_period_seconds = 10

  This is used to set the amount of time between when the executor sends the SIGTERM message to gracefully terminate a pod and when it kills it by sending SIGKILL. If you do not set the grace period duration the default is 30 seconds.

• bool revocable = 11

  revocable represents pod to use physical or slack resources.

• repeated volume.VolumeSpec volumes = 12

  List of volumes that can be mounted by containers belonging to the pod.

• optional apachemesos.PodSpec mesos_spec = 13

  Extra configuration specific to the Mesos runtime. Experimental and is subject to change.

• repeated PortSpec host_ports = 14

  List of network ports to be allocated for all the containers in the pod on the host network.

Runtime states of a pod instance.

Used in: PodStatus, QuerySpec

• POD_STATE_INVALID = 0

  Invalid state.

• POD_STATE_INITIALIZED = 1

  The pod is being initialized.

• POD_STATE_PENDING = 2

  The pod is pending and waiting for resources.

• POD_STATE_READY = 3

  The pod has been allocated with resources and ready for placement.

• POD_STATE_PLACING = 4

  The pod is being placed to a host based on its resource requirements and constraints.

• POD_STATE_PLACED = 5

  The pod has been assigned to a host matching the resource requirements and constraints.

• POD_STATE_LAUNCHING = 6

  The pod is taken from resmgr to be launched.

• POD_STATE_LAUNCHED = 7

  The pod is being launched in Job manager.

• POD_STATE_STARTING = 8

  Either init containers are starting/running or the main containers in the pod are being started.

• POD_STATE_RUNNING = 9

  All containers in the pod are running.

• POD_STATE_SUCCEEDED = 10

  All containers in the pod terminated with an exit code of zero.

• POD_STATE_FAILED = 11

  At least on container in the pod terminated with a non-zero exit code.

• POD_STATE_LOST = 12

  The pod is lost.

• POD_STATE_KILLING = 13

  The pod is being killed.

• POD_STATE_KILLED = 14

  At least one of the containers in the pod was terminated by the system.

• POD_STATE_PREEMPTING = 15

  The pod is being preempted by another one on the node.

• POD_STATE_DELETED = 16

  The pod is to be deleted after termination.

• POD_STATE_RESERVED = 17

  The pod is to be reserved on a node.

Runtime status of a pod instance in a Job.

Used in: PodInfo, PodSummary, svc.GetPodCacheResponse

• PodState state = 1

  Runtime state of the pod.

• optional peloton.PodID pod_id = 2

  The current pod ID for this pod.

• string start_time = 3

  The time when the pod starts to run. Will be unset if the pod hasn't started running yet. The time is represented in RFC3339 form with UTC timezone.

• string completion_time = 4

  The time when the pod is completed. Will be unset if the pod hasn't completed yet. The time is represented in RFC3339 form with UTC timezone.

• string host = 5

  The name of the host where the pod is running.

• repeated ContainerStatus init_containers_status = 6

  Status of the init containers.

• repeated ContainerStatus containers_status = 7

  Status of the containers.

• PodState desired_state = 8

  The desired state of the pod which should be eventually reached by the system.

• string message = 9

  The message that explains the current state of a pod.

• string reason = 10

  The reason that explains the current state of a pod.

• uint32 failure_count = 11

  The number of times the pod has failed after retries.

• optional peloton.VolumeID volume_id = 12

  persistent volume id. Deprecated.

• optional peloton.EntityVersion version = 13

  The entity version currently used by the pod. TODO Avoid leaking job abstractions into public pod APIs. Remove after internal protobuf structures are defined.

• optional peloton.EntityVersion desired_version = 14

  The desired entity version that should be used by the pod. TODO Avoid leaking job abstractions into public pod APIs. Remove after internal protobuf structures are defined.

• optional mesos.v1.AgentID agent_id = 15

  the id of mesos agent on the host to be launched. Deprecated.

• optional peloton.Revision revision = 16

  Revision of the current pod status.

• optional peloton.PodID prev_pod_id = 17

  The pod id of the previous pod.

• map<string, double> resource_usage = 18

  The resource usage for this pod. The map key is each resource kind in string format and the map value is the number of unit-seconds of that resource used by the job. Example: if a pod that uses 1 CPU and finishes in 10 seconds, this map will contain <"cpu":10>.

• optional peloton.PodID desired_pod_id = 19

  The desired pod ID for this pod.

• string desiredHost = 20

  The name of the host where the pod should be running on upon restart. It is used for best effort in-place update/restart.

• string host_id = 21

  The identifier for the host runtime agent.

Summary information about a pod.

Used in: job.stateless.svc.ListPodsResponse, watch.svc.WatchResponse

• optional peloton.PodName pod_name = 1

  Name of the pod.

• optional PodStatus status = 3

  Runtime status of the pod.

Network port configuration for a container.

Used in: ContainerSpec, HTTPGetSpec, PodSpec

• string name = 1

  Name of the network port, e.g. http, tchannel. Required field.

• uint32 value = 2

  Static port number assigned. Only applicable when type is PORT_TYPE_STATIC.

• string env_name = 3

  Environment variable name to be exported when running a container for this port. Only applicable when type is PORT_TYPE_DYNAMIC_ENV_VAR.

• string template_name = 4

  Template variable for a dynamic port in the format: {{port.$NAME}}, where $NAME is a unique name of the port that can contain characters 'a'-'z', '-', '_' and '.'. This variable can be used in other parts of PodSpec to reference a port value (for example in env variables). Specifying a port as a template variable allows communicating the value of the port between containers in the pod. Only applicable when type is PORT_TYPE_DYNAMIC_TEMPLATE_VAR.

• PortSpec.PortType type = 5

  Type of the port

Type of the port

Used in: PortSpec

• PORT_TYPE_INVALID = 0

  Invalid port type

• PORT_TYPE_STATIC = 1

  Static port

• PORT_TYPE_DYNAMIC_ENV_VAR = 2

  Dynamic port that will be exported into environment variable

• PORT_TYPE_DYNAMIC_TEMPLATE_VAR = 3

  Dynamic port specified as a template variable

Preemption policy for a pod.

Used in: PodSpec

• bool kill_on_preempt = 2

  This policy defines if the pod should be restarted after it is preempted. If set to true the pod will not be rescheduled after it is preempted. If set to false the pod will be rescheduled. Defaults to false

QuerySpec specifies the list of query criteria for pods. All indexed fields should be part of this message. And all fields in this message have to be indexed too.

Used in: job.stateless.svc.QueryPodsRequest

• optional query.PaginationSpec pagination = 1

  The spec of how to do pagination for the query results.

• repeated PodState pod_states = 2

  List of pod states to query the pods. Will match all pods if the list is empty.

• repeated peloton.PodName names = 3

  List of pod names to query the pods. Will match all names if the list is empty.

• repeated string hosts = 4

  List of hosts to query the pods. Will match all hosts if the list is empty.

Resource configuration for a container.

Used in: ContainerSpec, private.hostmgr.v1alpha.hostmgr.ResourceConstraint

• double cpu_limit = 1

  CPU limit in number of CPU cores.

• double mem_limit_mb = 2

  Memory limit in MB.

• double disk_limit_mb = 3

  Disk limit in MB.

• uint32 fd_limit = 4

  File descriptor limit.

• double gpu_limit = 5

  GPU limit in number of GPUs.

Restart policy for a pod.

Used in: PodSpec

• uint32 max_failures = 1

  Max number of pod failures can occur before giving up scheduling retry, no backoff for now. Default 0 means no retry on failures.

TerminationStatus contains details about termination of a task. It mainly contains Peloton-specific reasons for termination.

Used in: ContainerStatus

• TerminationStatus.Reason reason = 1

  Reason for termination.

• uint32 exit_code = 2

  If non-zero, exit status when the container terminated.

• string signal = 3

  Name of signal received by the container when it terminated.

Reason lists various causes for a task termination

Used in: TerminationStatus

• TERMINATION_STATUS_REASON_INVALID = 0

  Default value.

• TERMINATION_STATUS_REASON_KILLED_ON_REQUEST = 1

  Task was killed because a stop request was received from a client.

• TERMINATION_STATUS_REASON_FAILED = 2

  Task failed. See also TerminationStatus.exit_code, TerminationStatus.signal and ContainerStatus.message.

• TERMINATION_STATUS_REASON_KILLED_HOST_MAINTENANCE = 3

  Task was killed to put the host in to maintenance.

• TERMINATION_STATUS_REASON_PREEMPTED_RESOURCES = 4

  Task was killed to reclaim resources allocated to it.

• TERMINATION_STATUS_REASON_DEADLINE_TIMEOUT_EXCEEDED = 5

  Task was killed due to deadline tracker exceeding task timeout

• TERMINATION_STATUS_REASON_KILLED_FOR_UPDATE = 6

  Task was killed for update

• TERMINATION_STATUS_REASON_KILLED_FOR_RESTART = 7

  Task was killed for restart

• TERMINATION_STATUS_REASON_KILLED_FOR_SLA_AWARE_RESTART = 8

  Task was killed for sla aware restart

VolumeMount describes a mounting of a Volume within a container.

Used in: ContainerSpec

• string name = 1

  This must match the Name of a Volume in the PodSpec.

• bool read_only = 2

  Mounted read-only if true, read-write otherwise (false or unspecified).

• string mount_path = 3

  Path within the container at which the volume should be mounted.