Skip to content

dokku_ports.md

Latest commit

 

History

History
99 lines (75 loc) · 2.4 KB

dokku_ports.md

File metadata and controls

99 lines (75 loc) · 2.4 KB
Raw

dokku_ports

Synopsis

Manages the ports for a given dokku application

Export support

Supported.

Probe support

Supported.

Identity

Keyed by app. Manages the whole port_mappings collection; entries are identified by scheme and host.

Parameters

Parameter Type Required Default Choices Description
app string yes Name of the app
port_mappings list no Port mappings to set; omit for state 'clear'; under state 'present' and 'set' no two may share a scheme and host port. Each item has: scheme, host, container.
state string no present present, absent, set, clear Desired state of the ports

Examples

Map http port 80 to container port 5000

dokku_ports:
    app: node-js-app
    port_mappings:
        - scheme: http
          host: 80
          container: 5000

Map both http and https ports

dokku_ports:
    app: node-js-app
    port_mappings:
        - scheme: http
          host: 80
          container: 5000
        - scheme: https
          host: 443
          container: 5000

Remove a port mapping

dokku_ports:
    app: node-js-app
    port_mappings:
        - scheme: http
          host: 80
          container: 5000
    state: absent

Replace every port mapping on an app

dokku_ports:
    app: node-js-app
    port_mappings:
        - scheme: https
          host: 443
          container: 5000
    state: set

Clear all port mappings from an app

dokku_ports:
    app: node-js-app
    state: clear

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.