.. _cfgmgr.action.service_actions.docker:

:cmd:`om cfg docker`
--------------------

Wrap the docker client command, setting automatically the socket parameter to join the service-private docker daemon. The {as_service}, {images} and {instances} words in the wrapped command are replaced by, respectively, the registry login username/password/email parameters to log as a service using <path>@<nodename> as the username and the node uuid as password (which is what is expected when the opensvc collector is used as the JWT manager for the registry), the set of docker instance names and images for container resources passing the --tags, --rid and --subsets filters. This is useful to remove all instances of a service or all instances of resources with a tag like 'frontend'. Note the opensvc filters must be positioned before the docker command in the arguments list.

:opt:`--color=<string>`
+++++++++++++++++++++++

	Colorize output. Possible values are:
	
	* auto: guess based on tty presence
	* always|yes: always colorize
	* never|no: never colorize

:opt:`--daemon`
+++++++++++++++

	A flag inhibiting the command daemonization. Set by the daemonization routine.

:opt:`--debug`
++++++++++++++

	Increase stream and file log verbosity up to the debug level.

:opt:`--env`
++++++++++++

	Export the uppercased variable in the os environment.
	
	With the create action only, set a env section parameter in the service configuration file. Multiple ``--env <key>=<val>`` can be specified. For all other actions.

:opt:`--local`
++++++++++++++

	Execute the service action on the local service instances only, ignoring cluster-wide considerations.

:opt:`--namespace=<string>`
+++++++++++++++++++++++++++

	The namespace to switch to for the action. Namespaces are cluster partitions. A default namespace can be set for the session setting the OSVC_NAMESPACE environment variable.

:opt:`--node=<string>`
++++++++++++++++++++++

	The node to send a request to. If not specified the local node is targeted.

:opt:`--status=<string>`
++++++++++++++++++++++++

	Operate only on service with a local instance in the specified availability status (up, down, warn, ...).

:opt:`--waitlock=<string>`
++++++++++++++++++++++++++

	A duration expression like ``5s``. The maximum wait time when acquiring the service action lock.

:opt:`-h, --help`
+++++++++++++++++

	Show this help message and exit.

:opt:`-p, --parallel`
+++++++++++++++++++++

	Start actions on specified services in parallel. :kw:`max_parallel` in node.conf limits the number of parallel running subprocesses.

:opt:`-s, VAL, --service=<string>`
++++++++++++++++++++++++++++++++++

	A service selector expression ``[!]<expr>[<sep>[!]<expr>]`` where:
	
	- ``!`` is the expression negation operator
	
	- ``<sep>`` can be:
	
	  - ``,`` OR expressions
	
	  - ``+`` AND expressions
	
	- ``<expr>`` can be:
	
	  - a shell glob on service names
	
	  - ``<param><op><value>`` where:
	
	    - ``<param>`` can be:
	
	      - ``<rid>:``
	
	      - ``<group>:``
	
	      - ``<rid>.<key>``
	
	      - ``<group>.<key>``
	
	      - ``<single value jsonpath expression on the $.monitor.services.<path> dictionary extended under the 'nodes' key by each instance 'status' and 'config' data>``
	
	    - ``<op>`` can be:
	
	      - ``<``  ``>``  ``<=``  ``>=``  ``=``
	
	      - ``~`` with regexp value
	
	Examples:
	
	- ``*dns,ha*+app.timeout>1``
	
	- ``ip:+task:``
	
	- ``!*excluded``
	
	- ``$.avail=warn``
	
	- ``$.nodes.*.status.avail=warn``
	
	Note:
	
	- ``!`` usage requires single quoting the expression to prevent shell history expansion