Skip to content

dokku_apps_property.md

Latest commit

 

History

History
92 lines (67 loc) · 2.66 KB

dokku_apps_property.md

File metadata and controls

92 lines (67 loc) · 2.66 KB
Raw

dokku_apps_property

Synopsis

Manages the apps plugin configuration for a given dokku application or globally

Export support

Supported.

Probe support

Supported.

Identity

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

Parameters

Parameter Type Required Default Choices Description
app string no Name of the app. Required if Global is false.
global bool no Flag indicating if the property should be applied globally
property string yes Name of the property to set
value string no Value to set for the property
state string no present present, absent Desired state of the property

Properties

property accepts one of the following, applied with dokku apps: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)
deploy-source app deploy-source
deploy-source-metadata app deploy-source-metadata
disable-autocreation global global-disable-autocreation

Examples

Disabling app auto-creation globally

dokku_apps_property:
    app: ""
    global: true
    property: disable-autocreation
    value: "true"

Overriding the deploy-source for an app

dokku_apps_property:
    app: node-js-app
    property: deploy-source
    value: git

Overriding the deploy-source-metadata for an app

dokku_apps_property:
    app: node-js-app
    property: deploy-source-metadata
    value: https://example.com/repo

Re-enabling app auto-creation globally

dokku_apps_property:
    app: ""
    global: true
    property: disable-autocreation
    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.