Skip to content

dokku_scheduler_docker_local_property.md

Latest commit

 

History

History
79 lines (56 loc) · 2.42 KB

dokku_scheduler_docker_local_property.md

File metadata and controls

79 lines (56 loc) · 2.42 KB
Raw

dokku_scheduler_docker_local_property

Synopsis

Manages the scheduler-docker-local configuration for a given dokku application

Export support

Supported.

Probe support

Supported.

Identity

Keyed by app and property. Fields left empty are omitted from the address.

Parameters

Parameter Type Required Default Choices Description
app string yes Name of the app
property string yes Name of the scheduler-docker-local property to set
value string no Value to set for the scheduler-docker-local property
state string no present present, absent Desired state of the scheduler-docker-local configuration

Properties

property accepts one of the following, applied with dokku scheduler-docker-local:set. A property with no form in a scope is rejected there, matching dokku's own rejection.

Property Scopes Report key (app) Report key (global)
init-process app init-process
parallel-schedule-count app parallel-schedule-count

Examples

Enabling the init process for an app

dokku_scheduler_docker_local_property:
    app: node-js-app
    property: init-process
    value: "true"

Setting the parallel schedule count for an app

dokku_scheduler_docker_local_property:
    app: node-js-app
    property: parallel-schedule-count
    value: "4"

Clearing the init process for an app

dokku_scheduler_docker_local_property:
    app: node-js-app
    property: init-process
    state: absent

Return Values

Available after the task runs when captured with register:, referenced as result.<Key> (or registered.<name>.<Key>).

Key Returned Type Description
Changed always bool Whether the task changed server state.
State always string Resulting state of the resource.
DesiredState always string The state the task targeted.
Message always string Human-readable result message (may be empty).
Commands when a subprocess ran list Resolved dokku command lines executed.
Stdout when a subprocess ran string Captured stdout of the final command.
Stderr when a subprocess ran string Captured stderr of the final command.
ExitCode when a subprocess ran int Exit code of the final command.