Skip to content

Latest commit

 

History

History
56 lines (38 loc) · 1.38 KB

File metadata and controls

56 lines (38 loc) · 1.38 KB

dokku_app_lock

Synopsis

Locks or unlocks a dokku application from deployment

Export support

Supported.

Probe support

Supported.

Identity

Keyed by app.

Parameters

Parameter Type Required Default Choices Description
app string yes Name of the app
state string no present present, absent Desired lock state

Examples

Lock an app

dokku_app_lock:
    app: node-js-app

Unlock an app

dokku_app_lock:
    app: node-js-app
    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.