Management commands for working with a particular docker node

Source: R/help.R

Methods for working with a particular docker node. Node objects are by using $node$get to fetch an existing node by name or id.

Details

Below is reference documentation for all methods for version '1.29' of the docker API - other versions are available. This documentation is automatically generated from docker's API schema, and so inaccuracies may exist between it and stevedore's interface (especially references to JSON objects). Please report any documentation that might be improved at https://github.com/richfitz/stevedore/issues

Methods

availability

Return the node's availability (active, pause, drain)

Usage:

  availability(reload = TRUE)

Arguments:

  • reload: Logical scalar, indicating if the information should be refreshed from the daemon. This is useful to set to FALSE after a node has been removed.

help

Display help for this object

Usage:

  help(help_type = getOption("help_type"))

Arguments:

  • help_type: Passed to utils::help, can be one of "text", "html" or "pdf" (or an abbreviation). By default it uses the value getOption("help_type") and should follow the same behaviour as other R help (e.g., using "?")

hostname

Return the node's hostname

Usage:

  hostname(reload = TRUE)

Arguments:

  • reload: Logical scalar, indicating if the information should be refreshed from the daemon. This is useful to set to FALSE after a node has been removed.

id

Return the node's id

Usage:

  id()
inspect

Return detailed information about this node. Similar to the cli command docker node inspect.

Usage:

  inspect(reload = TRUE)

Arguments:

  • reload: Logical scalar, indicating if the information should be refreshed from the daemon. This is useful to set to FALSE after a node has been removed.

reload

Refresh infomation on the node from the server, returning $inspect() invisibly.

Usage:

  reload()
role

Return the node's role (worker, manager))

Usage:

  role(reload = TRUE)

Arguments:

  • reload: Logical scalar, indicating if the information should be refreshed from the daemon. This is useful to set to FALSE after a node has been removed.

status

Return the node's status (

Usage:

  status(reload = TRUE)

Arguments:

  • reload: Logical scalar, indicating if the information should be refreshed from the daemon. This is useful to set to FALSE after a node has been removed.

node_update

Update a node. Similar to the cli command docker node update.

Usage:

  node_update(version, name = NULL, labels = NULL, role = NULL,
      availability = NULL)

Arguments:

  • version: The version number of the node object being updated. This is required to avoid conflicting writes.

  • name: Name for the node.

  • labels: User-defined key/value metadata.

  • role: Role of the node.

  • availability: Availability of the node.

version

Return the node's version. This is used by some other methods to avoid conflicting writes.

Usage:

  version(reload = TRUE)

Arguments:

  • reload: Logical scalar, indicating if the information should be refreshed from the daemon. This is useful to set to FALSE after a node has been removed.

See also

docker_node_collection for other node management methods.