Skip to main content

DockerNode

Resource DockerNode in pulumi-portainer.
2 min read

Resource DockerNode in pulumi-portainer.

Pulumi type: portainer:index/dockerNode:DockerNode.

name is the Pulumi resource name. Nested object fields are documented under that object. They are not arguments of this resource.

Example#

Only required arguments are set. A string in angle brackets stands in for that argument. Any other value is an option or example written in the SDK description.

Arguments#

PropertyTypeRequiredDescription
availabilitystringnoDesired availability of the Swarm node (active, pause, or drain).
dockerNodeIdstringno
endpointIdnumberyesID of the Portainer environment (Docker Swarm cluster) where the node is managed.
labels{ [key: string]: string }noKey/value labels assigned to the Swarm node for placement and selection.
namestringnoDesired display name for the Swarm node.
nodeIdstringyesDocker Swarm node ID to update.
rolestringnoDesired role of the Swarm node (worker or manager).
versionnumberyesSwarm node version required for update operation

Outputs#

Computed outputs are produced by the provider. They are not constructor arguments.

PropertyTypeComputedDescription
availabilitystringnoDesired availability of the Swarm node (active, pause, or drain).
dockerNodeIdstringno
endpointIdnumbernoID of the Portainer environment (Docker Swarm cluster) where the node is managed.
labels{ [key: string]: string }noKey/value labels assigned to the Swarm node for placement and selection.
namestringnoDesired display name for the Swarm node.
nodeIdstringnoDocker Swarm node ID to update.
rolestringnoDesired role of the Swarm node (worker or manager).
versionnumbernoSwarm node version required for update operation