Skip to content

Latest commit

 

History

History
1235 lines (958 loc) · 68.4 KB

models.md

File metadata and controls

1235 lines (958 loc) · 68.4 KB
Raw

Models

Models:

Data Types

EmbeddedArtifact

name type required description
targetFolderRelativeToTask string optional
md5sum string optional
filename string optional
name string optional
content Array[byte] optional

ExecutorData

name type required description
skipLogrotateAndCompress boolean optional If true, do not run logrotate or compress old log files
loggingExtraFields Map[string,string] optional
embeddedArtifacts Array[EmbeddedArtifact] optional A list of the full content of any embedded artifacts
s3Artifacts Array[S3Artifact] optional List of s3 artifacts for the executor to download
successfulExitCodes Array[int] optional Allowable exit codes for the task to be considered FINISHED instead of FAILED
runningSentinel string optional
logrotateFrequency SingularityExecutorLogrotateFrequency optional Run logrotate this often. Can be HOURLY, DAILY, WEEKLY, MONTHLY
maxOpenFiles int optional Maximum number of open files the task process is allowed
externalArtifacts Array[ExternalArtifact] optional A list of external artifacts for the executor to download
user string optional Run the task process as this user
preserveTaskSandboxAfterFinish boolean optional If true, do not delete files in the task sandbox after the task process has terminated
extraCmdLineArgs Array[string] optional Extra arguments in addition to any provided in the cmd field
loggingTag string optional
sigKillProcessesAfterMillis long optional Send a sigkill to a process if it has not shut down this many millis after being sent a term signal
maxTaskThreads int optional Maximum number of threads a task is allowed to use
s3ArtifactSignatures Array[S3ArtifactSignature] optional A list of signatures use to verify downloaded s3artifacts
cmd string required Command for the custom executor to run

ExternalArtifact

name type required description
targetFolderRelativeToTask string optional
md5sum string optional
url string optional
filename string optional
filesize long optional
name string optional
isArtifactList boolean optional

HealthcheckOptions

name type required description
startupDelaySeconds int optional Wait this long before issuing the first healthcheck
responseTimeoutSeconds int optional Single healthcheck HTTP timeout in seconds.
intervalSeconds int optional Time to wait after a valid but failed healthcheck response to try again in seconds.
uri string required Healthcheck uri to hit
failureStatusCodes Array[int] optional Fail the healthcheck with no further retries if one of these status codes is returned
maxRetries int optional Maximum number of times to retry an individual healthcheck before failing the deploy.
startupTimeoutSeconds int optional Consider the task unhealthy/failed if the app has not started responding to healthchecks in this amount of time
portNumber long optional Perform healthcheck on this port (portIndex cannot also be used when using this setting)
startupIntervalSeconds int optional Time to wait after a failed healthcheck to try again in seconds.
protocol HealthcheckProtocol optional Healthcheck protocol - HTTP or HTTPS
portIndex int optional Perform healthcheck on this dynamically allocated port (e.g. 0 for first port), defaults to first port

LoadBalancerRequestId

name type required description
requestType LoadBalancerRequestType optional Allowable values: ADD, REMOVE, DEPLOY, DELETE
attemptNumber int optional
id string optional

MesosFileChunkObject

name type required description
nextOffset long optional
data string optional
offset long optional

MesosResourcesObject

name type required description
properties Map[string,Object] optional

MesosTaskStatisticsObject

name type required description
memFileBytes long optional
memLimitBytes long optional
cpusThrottledTimeSecs double optional
cpusSystemTimeSecs double optional
memRssBytes long optional
memAnonBytes long optional
memMappedFileBytes long optional
cpusLimit int optional
timestamp double optional
cpusNrPeriods long optional
cpusUserTimeSecs double optional
cpusNrThrottled long optional

Resources

name type required description
numPorts int optional
memoryMb double optional
diskMb double optional
cpus double optional

S3Artifact

name type required description
targetFolderRelativeToTask string optional
s3Bucket string optional
md5sum string optional
filename string optional
filesize long optional
s3ObjectKey string optional
name string optional
isArtifactList boolean optional

S3ArtifactSignature

name type required description
targetFolderRelativeToTask string optional
s3Bucket string optional
md5sum string optional
filename string optional
filesize long optional
s3ObjectKey string optional
name string optional
artifactFilename string optional
isArtifactList boolean optional

Set

name type required description
empty boolean optional

SingularityBounceRequest

name type required description
skipHealthchecks boolean optional Instruct replacement tasks for this bounce only to skip healthchecks
durationMillis long optional The number of milliseconds to wait before reversing the effects of this action (letting it expire)
message string optional A message to show to users about why this action was taken
actionId string optional An id to associate with this action for metadata purposes
runShellCommandBeforeKill SingularityShellCommand optional Attempt to run this shell command on each task before it is shut down
incremental boolean optional If present and set to true, old tasks will be killed as soon as replacement tasks are available, instead of waiting for all replacement tasks to be healthy

SingularityContainerInfo

name type required description
type SingularityContainerType required Container type, can be MESOS or DOCKER. Default is MESOS Allowable values: MESOS, DOCKER
volumes Array[SingularityVolume] optional List of volumes to mount. Applicable only to DOCKER container type
docker SingularityDockerInfo optional Information specific to docker runtime settings

SingularityDeleteRequestRequest

name type required description
message string optional A message to show to users about why this action was taken
actionId string optional An id to associate with this action for metadata purposes

SingularityDeploy

name type required description
customExecutorId string optional Custom Mesos executor id.
resources com.hubspot.mesos.Resources optional Resources required for this deploy.
uris Array[SingularityMesosArtifact] optional List of URIs to download before executing the deploy command.
containerInfo SingularityContainerInfo optional Container information for deployment into a container.
loadBalancerDomains Set optional List of domains to host this service on, for use with the load balancer api
healthcheck HealthcheckOptions optional HTTP Healthcheck settings
arguments Array[string] optional Command arguments.
taskEnv Map[int,Map[string,string]] optional Map of environment variable overrides for specific task instances.
autoAdvanceDeploySteps boolean optional automatically advance to the next target instance count after deployStepWaitTimeMs seconds
serviceBasePath string optional The base path for the API exposed by the deploy. Used in conjunction with the Load balancer API.
customExecutorSource string optional Custom Mesos executor source.
metadata Map[string,string] optional Map of metadata key/value pairs associated with the deployment.
healthcheckMaxRetries int optional Maximum number of times to retry an individual healthcheck before failing the deploy.
healthcheckTimeoutSeconds long optional Single healthcheck HTTP timeout in seconds.
healthcheckProtocol com.hubspot.singularity.HealthcheckProtocol optional Healthcheck protocol - HTTP or HTTPS
taskLabels Map[int,Map[string,string]] optional (Deprecated) Labels for specific tasks associated with this deploy, indexed by instance number
healthcheckPortIndex int optional Perform healthcheck on this dynamically allocated port (e.g. 0 for first port), defaults to first port
healthcheckMaxTotalTimeoutSeconds long optional Maximum amount of time to wait before failing a deploy for healthchecks to pass.
loadBalancerServiceIdOverride string optional Name of load balancer Service ID to use instead of the Request ID
mesosTaskLabels Map[int,List[SingularityMesosTaskLabel]] optional Labels for specific tasks associated with this deploy, indexed by instance number
labels Map[string,string] optional Labels for all tasks associated with this deploy
healthcheckUri string optional Deployment Healthcheck URI, if specified will be called after TASK_RUNNING.
user string optional Run tasks as this user
requestId string required Singularity Request Id which is associated with this deploy.
loadBalancerGroups Set optional List of load balancer groups associated with this deployment.
deployStepWaitTimeMs int optional wait this long between deploy steps
skipHealthchecksOnDeploy boolean optional Allows skipping of health checks when deploying.
mesosLabels Array[SingularityMesosTaskLabel] optional Labels for all tasks associated with this deploy
healthcheckIntervalSeconds long optional Time to wait after a failed healthcheck to try again in seconds.
command string optional Command to execute for this deployment.
executorData ExecutorData optional Executor specific information
loadBalancerAdditionalRoutes Array[string] optional Additional routes besides serviceBasePath used by this service
shell boolean optional Override the shell property on the mesos task
timestamp long optional Deploy timestamp.
deployInstanceCountPerStep int optional deploy this many instances at a time
considerHealthyAfterRunningForSeconds long optional Number of seconds that a service must be healthy to consider the deployment to be successful.
loadBalancerOptions Map[string,Object] optional Map (Key/Value) of options for the load balancer.
maxTaskRetries int optional allowed at most this many failed tasks to be retried before failing the deploy
loadBalancerPortIndex int optional Send this port to the load balancer api (e.g. 0 for first port), defaults to first port
loadBalancerTemplate string optional Name of load balancer template to use if not using the default template
customExecutorCmd string optional Custom Mesos executor
env Map[string,string] optional Map of environment variable definitions.
loadBalancerUpstreamGroup string optional Group name to tag all upstreams with in load balancer
customExecutorResources com.hubspot.mesos.Resources optional Resources to allocate for custom mesos executor
version string optional Deploy version
id string required Singularity deploy id.
deployHealthTimeoutSeconds long optional Number of seconds that Singularity waits for this service to become healthy (for it to download artifacts, start running, and optionally pass healthchecks.)

SingularityDeployFailure

name type required description
taskId SingularityTaskId optional
message string optional
reason SingularityDeployFailureReason optional Allowable values: TASK_FAILED_ON_STARTUP, TASK_FAILED_HEALTH_CHECKS, TASK_COULD_NOT_BE_SCHEDULED, TASK_NEVER_ENTERED_RUNNING, TASK_EXPECTED_RUNNING_FINISHED, DEPLOY_CANCELLED, DEPLOY_OVERDUE, FAILED_TO_SAVE_DEPLOY_STATE, LOAD_BALANCER_UPDATE_FAILED, PENDING_DEPLOY_REMOVED

SingularityDeployHistory

name type required description
deploy SingularityDeploy optional
deployStatistics SingularityDeployStatistics optional
deployResult SingularityDeployResult optional
deployMarker SingularityDeployMarker optional

SingularityDeployMarker

name type required description
user string optional
requestId string optional
message string optional
timestamp long optional
deployId string optional

SingularityDeployProgress

name type required description
autoAdvanceDeploySteps boolean optional
stepComplete boolean optional
deployStepWaitTimeMs long optional
timestamp long optional
deployInstanceCountPerStep int optional
failedDeployTasks Set optional
currentActiveInstances int optional
targetActiveInstances int optional

SingularityDeployRequest

name type required description
unpauseOnSuccessfulDeploy boolean optional If deploy is successful, also unpause the request
deploy SingularityDeploy required The Singularity deploy object, containing all the required details about the Deploy
updatedRequest SingularityRequest optional use this request data for this deploy, and update the request on successful deploy
message string optional A message to show users about this deploy (metadata)

SingularityDeployResult

name type required description
lbUpdate SingularityLoadBalancerUpdate optional
deployState DeployState optional Allowable values: SUCCEEDED, FAILED_INTERNAL_STATE, CANCELING, WAITING, OVERDUE, FAILED, CANCELED
deployFailures Array[SingularityDeployFailure] optional
message string optional
timestamp long optional

SingularityDeployStatistics

name type required description
lastTaskState ExtendedTaskState optional
numFailures int optional
numTasks int optional
averageRuntimeMillis long optional
lastFinishAt long optional
requestId string optional
deployId string optional
numSequentialRetries int optional
numSuccess int optional
instanceSequentialFailureTimestamps [com.google.common.collect.ListMultimap<java.lang.Integer, java.lang.Long>](models.md#model-com.google.common.collect.ListMultimap<java.lang.Integer, java.lang.Long>) optional

SingularityDeployUpdate

name type required description
deploy SingularityDeploy optional
deployResult SingularityDeployResult optional
eventType DeployEventType optional Allowable values: STARTING, FINISHED
deployMarker SingularityDeployMarker optional

SingularityDisabledAction

name type required description
expiresAt long optional
type SingularityAction optional Allowable values: BOUNCE_REQUEST, SCALE_REQUEST, REMOVE_REQUEST, CREATE_REQUEST, UPDATE_REQUEST, VIEW_REQUEST, PAUSE_REQUEST, KILL_TASK, BOUNCE_TASK, RUN_SHELL_COMMAND, ADD_METADATA, DEPLOY, CANCEL_DEPLOY, ADD_WEBHOOK, REMOVE_WEBHOOK, VIEW_WEBHOOKS, TASK_RECONCILIATION, STARTUP_TASK_RECONCILIATION, RUN_HEALTH_CHECKS, ADD_DISASTER, REMOVE_DISASTER, DISABLE_ACTION, ENABLE_ACTION, VIEW_DISASTERS, FREEZE_SLAVE, ACTIVATE_SLAVE, DECOMMISSION_SLAVE, VIEW_SLAVES, FREEZE_RACK, ACTIVATE_RACK, DECOMMISSION_RACK, VIEW_RACKS, SEND_EMAIL, PROCESS_OFFERS, CACHE_OFFERS, EXPENSIVE_API_CALLS, RUN_CLEANUP_POLLER, RUN_DEPLOY_POLLER, RUN_SCHEDULER_POLLER, RUN_EXPIRING_ACTION_POLLER
automaticallyClearable boolean optional
user string optional
message string optional

SingularityDisabledActionRequest

name type required description
type SingularityAction required The type of action to disable Allowable values: BOUNCE_REQUEST, SCALE_REQUEST, REMOVE_REQUEST, CREATE_REQUEST, UPDATE_REQUEST, VIEW_REQUEST, PAUSE_REQUEST, KILL_TASK, BOUNCE_TASK, RUN_SHELL_COMMAND, ADD_METADATA, DEPLOY, CANCEL_DEPLOY, ADD_WEBHOOK, REMOVE_WEBHOOK, VIEW_WEBHOOKS, TASK_RECONCILIATION, STARTUP_TASK_RECONCILIATION, RUN_HEALTH_CHECKS, ADD_DISASTER, REMOVE_DISASTER, DISABLE_ACTION, ENABLE_ACTION, VIEW_DISASTERS, FREEZE_SLAVE, ACTIVATE_SLAVE, DECOMMISSION_SLAVE, VIEW_SLAVES, FREEZE_RACK, ACTIVATE_RACK, DECOMMISSION_RACK, VIEW_RACKS, SEND_EMAIL, PROCESS_OFFERS, CACHE_OFFERS, EXPENSIVE_API_CALLS, RUN_CLEANUP_POLLER, RUN_DEPLOY_POLLER, RUN_SCHEDULER_POLLER, RUN_EXPIRING_ACTION_POLLER
message string optional An optional message/reason for disabling the action specified

SingularityDisaster

name type required description
type SingularityDisasterType optional Allowable values: EXCESSIVE_TASK_LAG, LOST_SLAVES, LOST_TASKS, USER_INITIATED
active boolean optional

SingularityDisasterDataPoint

name type required description
numLateTasks int optional
numPendingTasks int optional
numActiveTasks int optional
numLostSlaves int optional
numActiveSlaves int optional
timestamp long optional
numLostTasks int optional
avgTaskLagMillis long optional

SingularityDisastersData

name type required description
automatedActionsDisabled boolean optional
disasters Array[SingularityDisaster] optional
stats Array[SingularityDisasterDataPoint] optional

SingularityDockerInfo

name type required description
parameters Map[string,string] optional
forcePullImage boolean optional Always run docker pull even if the image already exists locally
dockerParameters Array[SingularityDockerParameter] optional Other docker run command line options to be set
privileged boolean required Controls use of the docker --privleged flag
network com.hubspot.mesos.SingularityDockerNetworkType optional Docker netowkr type. Value can be BRIDGE, HOST, or NONE
portMappings Array[SingularityDockerPortMapping] optional List of port mappings
image string required Docker image name

SingularityDockerParameter

name type required description
key string optional
value string optional

SingularityDockerPortMapping

name type required description
hostPort int required Port number, or index of port from offer on the host
containerPort int required Port number, or index of port from offer within the container
containerPortType SingularityPortMappingType optional Container port. Use the port number provided (LITERAL) or the dynamically allocated port at this index (FROM_OFFER) Allowable values: LITERAL, FROM_OFFER
protocol string optional Protocol for binding the port. Default is tcp
hostPortType SingularityPortMappingType optional Host port. Use the port number provided (LITERAL) or the dynamically allocated port at this index (FROM_OFFER) Allowable values: LITERAL, FROM_OFFER

SingularityExitCooldownRequest

name type required description
skipHealthchecks boolean optional Instruct new tasks that are scheduled immediately while executing cooldown to skip healthchecks
message string optional A message to show to users about why this action was taken
actionId string optional An id to associate with this action for metadata purposes

SingularityExpiringBounce

name type required description
user string optional
requestId string optional
startMillis long optional
deployId string optional
actionId string optional
expiringAPIRequestObject T optional

SingularityExpiringMachineState

name type required description
revertToState MachineState optional Allowable values: MISSING_ON_STARTUP, ACTIVE, STARTING_DECOMMISSION, DECOMMISSIONING, DECOMMISSIONED, DEAD, FROZEN
user string optional
startMillis long optional
actionId string optional
expiringAPIRequestObject T optional
machineId string optional
killTasksOnDecommissionTimeout boolean optional

SingularityExpiringPause

name type required description
user string optional
requestId string optional
startMillis long optional
actionId string optional
expiringAPIRequestObject T optional

SingularityExpiringScale

name type required description
revertToInstances int optional
user string optional
requestId string optional
bounce boolean optional
startMillis long optional
actionId string optional
expiringAPIRequestObject T optional

SingularityExpiringSkipHealthchecks

name type required description
user string optional
requestId string optional
startMillis long optional
actionId string optional
expiringAPIRequestObject T optional
revertToSkipHealthchecks boolean optional

SingularityHostState

name type required description
availableCachedMemory double optional
hostAddress string optional
hostname string optional
mesosConnected boolean optional
driverStatus string optional
master boolean optional
mesosMaster string optional
uptime long optional
availableCachedCpus double optional
offerCacheSize int optional
millisSinceLastOffer long optional

SingularityKillTaskRequest

name type required description
waitForReplacementTask boolean optional If set to true, treats this task kill as a bounce - launching another task and waiting for it to become healthy
override boolean optional If set to true, instructs the executor to attempt to immediately kill the task, rather than waiting gracefully
message string optional A message to show to users about why this action was taken
runShellCommandBeforeKill SingularityShellCommand optional Attempt to run this shell command on each task before it is shut down
actionId string optional An id to associate with this action for metadata purposes

SingularityLoadBalancerUpdate

name type required description
loadBalancerState BaragonRequestState optional Allowable values: UNKNOWN, FAILED, WAITING, SUCCESS, CANCELING, CANCELED, INVALID_REQUEST_NOOP
loadBalancerRequestId LoadBalancerRequestId optional
uri string optional
method LoadBalancerMethod optional Allowable values: PRE_ENQUEUE, ENQUEUE, CHECK_STATE, CANCEL, DELETE
message string optional
timestamp long optional

SingularityMachineChangeRequest

name type required description
durationMillis long optional The number of milliseconds to wait before reversing the effects of this action (letting it expire)
revertToState MachineState optional If a durationMillis is specified, return to this state when time has elapsed
message string optional A message to show to users about why this action was taken
actionId string optional An id to associate with this action for metadata purposes
killTasksOnDecommissionTimeout boolean optional If a machine has not successfully decommissioned in durationMillis, kill the remaining tasks on the machine

SingularityMachineStateHistoryUpdate

name type required description
state MachineState optional Allowable values: MISSING_ON_STARTUP, ACTIVE, STARTING_DECOMMISSION, DECOMMISSIONING, DECOMMISSIONED, DEAD, FROZEN
user string optional
message string optional
timestamp long optional
objectId string optional

SingularityMesosArtifact

name type required description
cache boolean optional
uri string optional
extract boolean optional
executable boolean optional

SingularityMesosTaskLabel

name type required description
key string optional
value string optional

SingularityPauseRequest

name type required description
durationMillis long optional The number of milliseconds to wait before reversing the effects of this action (letting it expire)
killTasks boolean optional If set to false, tasks will be allowed to finish instead of killed immediately
message string optional A message to show to users about why this action was taken
actionId string optional An id to associate with this action for metadata purposes
runShellCommandBeforeKill SingularityShellCommand optional Attempt to run this shell command on each task before it is shut down

SingularityPendingDeploy

name type required description
currentDeployState DeployState optional Allowable values: SUCCEEDED, FAILED_INTERNAL_STATE, CANCELING, WAITING, OVERDUE, FAILED, CANCELED
updatedRequest SingularityRequest optional
deployProgress SingularityDeployProgress optional
lastLoadBalancerUpdate SingularityLoadBalancerUpdate optional
deployMarker SingularityDeployMarker optional

SingularityPendingRequest

name type required description
resources Resources optional
runId string optional
skipHealthchecks boolean optional
user string optional
requestId string optional
message string optional
timestamp long optional
deployId string optional
actionId string optional
cmdLineArgsList Array[string] optional
pendingType PendingType optional Allowable values: IMMEDIATE, ONEOFF, BOUNCE, NEW_DEPLOY, NEXT_DEPLOY_STEP, UNPAUSED, RETRY, UPDATED_REQUEST, DECOMISSIONED_SLAVE_OR_RACK, TASK_DONE, STARTUP, CANCEL_BOUNCE, TASK_BOUNCE, DEPLOY_CANCELLED, DEPLOY_FAILED

SingularityPendingTask

name type required description
resources Resources optional
runId string optional
skipHealthchecks boolean optional
pendingTaskId SingularityPendingTaskId optional
user string optional
message string optional
actionId string optional
cmdLineArgsList Array[string] optional

SingularityPendingTaskId

name type required description
nextRunAt long optional
requestId string optional
deployId string optional
pendingType PendingType optional Allowable values: IMMEDIATE, ONEOFF, BOUNCE, NEW_DEPLOY, NEXT_DEPLOY_STEP, UNPAUSED, RETRY, UPDATED_REQUEST, DECOMISSIONED_SLAVE_OR_RACK, TASK_DONE, STARTUP, CANCEL_BOUNCE, TASK_BOUNCE, DEPLOY_CANCELLED, DEPLOY_FAILED
instanceNo int optional
createdAt long optional
id string optional

SingularityPriorityFreeze

name type required description
killTasks boolean required If true, kill currently running tasks, and do not launch new tasks below the minimumPriorityLevel. If false, do not launch new tasks below minimumPriorityLevel
message string optional An optional message/reason for creating the priority kill
actionId string optional A unique ID for this priority kill
minimumPriorityLevel double required Kill (if killTasks is true) or do not launch (if killTasks is false) tasks below this priority level

SingularityPriorityFreezeParent

name type required description
priorityFreeze SingularityPriorityFreeze optional
user string optional
timestamp long optional

SingularityRack

name type required description
currentState SingularityMachineStateHistoryUpdate optional
firstSeenAt long optional
id string optional

SingularityRequest

name type required description
hideEvenNumberAcrossRacksHint boolean optional
readOnlyGroups Set optional Users in these groups are allowed read only access to this request
taskExecutionTimeLimitMillis long optional If set, don't allow any taks for this request to run for longer than this amount of time
taskLogErrorRegexCaseSensitive boolean optional Determines if taskLogErrorRegex is case sensitive
schedule string optional A schedule in cron, RFC5545, or quartz format
skipHealthchecks boolean optional If true, do not run healthchecks
waitAtLeastMillisAfterTaskFinishesForReschedule long optional When a scheduled job finishes, wait at least this long before rescheduling it
taskPriorityLevel double optional a priority level from 0.0 to 1.0 for all tasks associated with the request
emailConfigurationOverrides Map[SingularityEmailType,List[SingularityEmailDestination]] optional Overrides for email recipients by email type for this request
rackAffinity Array[string] optional If set, prefer this specific rack when launching tasks
maxTasksPerOffer int optional Do not schedule more than this many tasks using a single offer from a single mesos slave
slavePlacement SlavePlacement optional Strategy for determining where to place new tasks. Can be SEPARATE, OPTIMISTIC, GREEDY, SEPARATE_BY_DEPLOY, or SEPARATE_BY_REQUEST
bounceAfterScale boolean optional Used for SingularityUI. If true, automatically trigger a bounce after changing the request's instance count
readWriteGroups Set optional Users in these groups are allowed read/write access to this request
group string optional Auth group associated with this request. Users in this group are allowed read/write access to this request
rackSensitive boolean optional Spread instances for this request evenly across separate racks
allowedSlaveAttributes Map[string,string] optional Allow tasks to run on slaves with these attributes, but do not restrict them to only these slaves
owners Array[string] optional A list of emails for the owners of this request
requiredRole string optional Mesos Role required for this request. Only offers with the required role will be accepted to execute the tasks associated with the request
requestType RequestType required The type of request, can be SERVICE, WORKER, SCHEDULED, ON_DEMAND, or RUN_ONCE Allowable values: SERVICE, WORKER, SCHEDULED, ON_DEMAND, RUN_ONCE
scheduledExpectedRuntimeMillis long optional Expected time for a non-long-running task to run. Singularity will notify owners if a task exceeds this time
quartzSchedule string optional A schedule in quartz format
requiredSlaveAttributes Map[string,string] optional Only allow tasks for this request to run on slaves which have these attributes
numRetriesOnFailure int optional For scheduled jobs, retry up to this many times if the job fails
loadBalanced boolean optional Indicates that a SERVICE should be load balanced
killOldNonLongRunningTasksAfterMillis long optional For non-long-running request types, kill a task after this amount of time if it has been put into CLEANING and has not shut down
instances int optional A count of tasks to run for long-running requests
scheduleType ScheduleType optional The type of schedule associated with the scheduled field. Can be CRON, QUARTZ, or RFC5545
scheduleTimeZone string optional Time zone to use when running the
allowBounceToSameHost boolean optional If set to true, allow tasks to be scheduled on the same host as an existing active task when bouncing
taskLogErrorRegex string optional Searching for errors in task logs to include in emails using this regex
id string required A unique id for the request

SingularityRequestCleanup

name type required description
skipHealthchecks boolean optional
requestId string optional
user string optional
killTasks boolean optional
cleanupType RequestCleanupType optional Allowable values: DELETING, PAUSING, BOUNCE, INCREMENTAL_BOUNCE
message string optional
timestamp long optional
deployId string optional
runShellCommandBeforeKill SingularityShellCommand optional
actionId string optional

SingularityRequestDeployState

name type required description
pendingDeploy SingularityDeployMarker optional
requestId string optional
activeDeploy SingularityDeployMarker optional

SingularityRequestGroup

name type required description
metadata Map[string,string] optional
requestIds Array[string] optional
id string optional

SingularityRequestHistory

name type required description
user string optional
message string optional
request SingularityRequest optional
eventType RequestHistoryType optional Allowable values: CREATED, UPDATED, DELETING, DELETED, PAUSED, UNPAUSED, ENTERED_COOLDOWN, EXITED_COOLDOWN, FINISHED, DEPLOYED_TO_UNPAUSE, BOUNCED, SCALED, SCALE_REVERTED
createdAt long optional

SingularityRequestParent

name type required description
expiringSkipHealthchecks SingularityExpiringSkipHealthchecks optional
state RequestState optional Allowable values: ACTIVE, DELETING, DELETED, PAUSED, SYSTEM_COOLDOWN, FINISHED, DEPLOYING_TO_UNPAUSE
pendingDeploy SingularityDeploy optional
activeDeploy SingularityDeploy optional
expiringPause SingularityExpiringPause optional
expiringBounce SingularityExpiringBounce optional
request SingularityRequest optional
pendingDeployState SingularityPendingDeploy optional
expiringScale SingularityExpiringScale optional
requestDeployState SingularityRequestDeployState optional

SingularityRunNowRequest

name type required description
resources Resources optional Override the resources from the active deploy for this run
runId string optional An id to associate with this request which will be associated with the corresponding launched tasks
skipHealthchecks boolean optional If set to true, healthchecks will be skipped for this task run
commandLineArgs Array[string] optional Command line arguments to be passed to the task
message string optional A message to show to users about why this action was taken

SingularityS3LogMetadata

name type required description
key string optional S3 key
size long optional File size (in bytes)
lastModified long optional Last modified time
endTime long optional Time the log file was finished being written to
startTime long optional Time the log file started being written to

SingularityS3SearchRequest

name type required description
requestsAndDeploys Map[string,List[string]] optional A map of request IDs to a list of deploy ids to search
listOnly boolean optional If true, do not generate download/get urls, only list objects
maxPerPage int optional Target number of results to return
taskIds Array[string] optional A list of task IDs to search for
excludeMetadata boolean optional if true, do not query for custom start/end time metadata
continuationTokens Map[string,ContinuationToken] optional S3 continuation tokens, return these to Singularity to continue searching subsequent pages of results
end long optional End timestamp (millis, 13 digit)
start long optional Start timestamp (millis, 13 digit)

SingularityS3SearchResult

name type required description
results Array[SingularityS3LogMetadata] optional List of S3 log metadata
lastPage boolean required If true, there are no further results for any bucket + prefix being searched
continuationTokens Map[string,ContinuationToken] optional S3 continuation tokens, return these to Singularity to continue searching subsequent pages of results

SingularitySandbox

name type required description
slaveHostname string optional Hostname of tasks's slave
files Array[SingularitySandboxFile] optional List of files inside sandbox
currentDirectory string optional Current directory
fullPathToRoot string optional Full path to the root of the Mesos task sandbox

SingularitySandboxFile

name type required description
size long optional File size (in bytes)
mode string optional File mode
mtime long optional Last modified time
name string optional Filename

SingularityScaleRequest

name type required description
skipHealthchecks boolean optional If set to true, healthchecks will be skipped while scaling this request (only)
durationMillis long optional The number of milliseconds to wait before reversing the effects of this action (letting it expire)
bounce boolean optional Bounce the request to get to the new scale
message string optional A message to show to users about why this action was taken
actionId string optional An id to associate with this action for metadata purposes
instances int optional The number of instances to scale to
incremental boolean optional If present and set to true, old tasks will be killed as soon as replacement tasks are available, instead of waiting for all replacement tasks to be healthy

SingularityShellCommand

name type required description
logfileName string optional File name for shell command output
user string optional User who requested the shell command
options Array[string] optional Additional options related to the shell command
name string required Name of the shell command to run

SingularitySkipHealthchecksRequest

name type required description
skipHealthchecks boolean optional If set to true, healthchecks will be skipped for all tasks for this request until reversed
durationMillis long optional The number of milliseconds to wait before reversing the effects of this action (letting it expire)
message string optional A message to show to users about why this action was taken
actionId string optional An id to associate with this action for metadata purposes

SingularitySlave

name type required description
resources MesosResourcesObject optional
currentState SingularityMachineStateHistoryUpdate optional
attributes Map[string,string] optional
host string optional Slave hostname
rackId string optional Slave rack ID
firstSeenAt long optional
id string optional

SingularityState

name type required description
activeRacks int optional
decomissioningRacks int optional
authDatastoreHealthy boolean optional
generatedAt long optional
activeSlaves int optional
pausedRequests int optional
activeTasks int optional
lbCleanupTasks int optional
overProvisionedRequestIds Array[string] optional
cleaningRequests int optional
deadSlaves int optional
lateTasks int optional
overProvisionedRequests int optional
decommissioningSlaves int optional
unknownRacks int optional
numDeploys int optional
cleaningTasks int optional
launchingTasks int optional
unknownSlaves int optional
oldestDeployStep long optional
activeRequests int optional
futureTasks int optional
lbCleanupRequests int optional
decommissioningRacks int optional
finishedRequests int optional
avgStatusUpdateDelayMs long optional
deadRacks int optional
pendingRequests int optional
maxTaskLag long optional
cooldownRequests int optional
hostStates Array[SingularityHostState] optional
allRequests int optional
underProvisionedRequests int optional
decomissioningSlaves int optional
oldestDeploy long optional
activeDeploys Array[SingularityDeployMarker] optional
minimumPriorityLevel double optional
scheduledTasks int optional
underProvisionedRequestIds Array[string] optional

SingularityTask

name type required description
taskId SingularityTaskId optional
taskRequest SingularityTaskRequest optional
rackId string optional

SingularityTaskCleanup

name type required description
taskId SingularityTaskId optional
user string optional
cleanupType TaskCleanupType optional Allowable values: USER_REQUESTED, USER_REQUESTED_TASK_BOUNCE, DECOMISSIONING, SCALING_DOWN, BOUNCING, INCREMENTAL_BOUNCE, DEPLOY_FAILED, NEW_DEPLOY_SUCCEEDED, DEPLOY_STEP_FINISHED, DEPLOY_CANCELED, TASK_EXCEEDED_TIME_LIMIT, UNHEALTHY_NEW_TASK, OVERDUE_NEW_TASK, USER_REQUESTED_DESTROY, INCREMENTAL_DEPLOY_FAILED, INCREMENTAL_DEPLOY_CANCELLED, PRIORITY_KILL, REBALANCE_RACKS, PAUSING, PAUSE, DECOMMISSION_TIMEOUT, REQUEST_DELETING
message string optional
runBeforeKillId SingularityTaskShellCommandRequestId optional
timestamp long optional
actionId string optional

SingularityTaskCredits

name type required description
remaining int optional
enabled boolean optional

SingularityTaskHealthcheckResult

name type required description
taskId SingularityTaskId optional
startup boolean optional
durationMillis long optional
errorMessage string optional
statusCode int optional
timestamp long optional
responseBody string optional

SingularityTaskHistory

name type required description
directory string optional
task SingularityTask optional
healthcheckResults Array[SingularityTaskHealthcheckResult] optional
loadBalancerUpdates Array[SingularityLoadBalancerUpdate] optional
taskMetadata Array[SingularityTaskMetadata] optional
containerId string optional
shellCommandHistory Array[SingularityTaskShellCommandHistory] optional
taskUpdates Array[SingularityTaskHistoryUpdate] optional

SingularityTaskHistoryUpdate

name type required description
taskId SingularityTaskId optional
statusReason string optional
statusMessage string optional
taskState ExtendedTaskState optional Allowable values: TASK_LAUNCHED, TASK_STAGING, TASK_STARTING, TASK_RUNNING, TASK_CLEANING, TASK_KILLING, TASK_FINISHED, TASK_FAILED, TASK_KILLED, TASK_LOST, TASK_LOST_WHILE_DOWN, TASK_ERROR
timestamp long optional
previous Set optional

SingularityTaskId

name type required description
requestId string optional
host string optional
deployId string optional
sanitizedHost string optional
rackId string optional
sanitizedRackId string optional
instanceNo int optional
startedAt long optional
id string optional

SingularityTaskIdHistory

name type required description
taskId SingularityTaskId optional
runId string optional
updatedAt long optional
lastTaskState ExtendedTaskState optional

SingularityTaskMetadata

name type required description
taskId SingularityTaskId optional
level MetadataLevel optional Allowable values: INFO, WARN, ERROR
type string optional
user string optional
message string optional
title string optional
timestamp long optional

SingularityTaskMetadataRequest

name type required description
level MetadataLevel optional Level of metadata, can be INFO, WARN, or ERROR
type string required A type to be associated with this metadata
message string optional An optional message
title string required A title to be associated with this metadata

SingularityTaskReconciliationStatistics

name type required description
taskReconciliationResponseP95 double optional
taskReconciliationResponseStddev double optional
taskReconciliationStartedAt long optional
taskReconciliationResponseCount long optional
taskReconciliationResponseP50 double optional
taskReconciliationResponseMean double optional
taskReconciliationResponseMin long optional
taskReconciliationDurationMillis long optional
taskReconciliationIterations int optional
taskReconciliationResponseP75 double optional
taskReconciliationResponseP99 double optional
taskReconciliationResponseMax long optional
taskReconciliationResponseP999 double optional
taskReconciliationResponseP98 double optional

SingularityTaskRequest

name type required description
deploy SingularityDeploy optional
request SingularityRequest optional
pendingTask SingularityPendingTask optional

SingularityTaskShellCommandHistory

name type required description
shellRequest SingularityTaskShellCommandRequest optional
shellUpdates Array[SingularityTaskShellCommandUpdate] optional

SingularityTaskShellCommandRequest

name type required description
taskId SingularityTaskId optional
user string optional
timestamp long optional
shellCommand SingularityShellCommand optional

SingularityTaskShellCommandRequestId

name type required description
taskId SingularityTaskId optional
name string optional
timestamp long optional

SingularityTaskShellCommandUpdate

name type required description
updateType UpdateType optional Allowable values: INVALID, ACKED, STARTED, FINISHED, FAILED
outputFilename string optional
message string optional
timestamp long optional
shellRequestId SingularityTaskShellCommandRequestId optional

SingularityUnpauseRequest

name type required description
skipHealthchecks boolean optional If set to true, instructs new tasks that are scheduled immediately while unpausing to skip healthchecks
message string optional A message to show to users about why this action was taken
actionId string optional An id to associate with this action for metadata purposes

SingularityUpdatePendingDeployRequest

name type required description
requestId string required Request id
deployId string required Deploy id
targetActiveInstances int required Updated target instance count for the active deploy

SingularityVolume

name type required description
hostPath string optional
containerPath string optional
mode SingularityDockerVolumeMode optional

SingularityWebhook

name type required description
type WebhookType optional Webhook type. Allowable values: TASK, REQUEST, DEPLOY
uri string optional URI to POST to.
user string optional User that created webhook.
timestamp long optional
id string optional Unique ID for webhook.

SingularityWebhookSummary

name type required description
webhook SingularityWebhook optional
queueSize int optional