DEFAULT
*******

.. _cfg.DEFAULT.comment:

:kw:`comment`
=============

================= ================================================================
**scopable**      False
**required**      False
**default**       
**scope order**   specific > generic
================= ================================================================

Helps users understand the role of the service and resources, which is nice to on-call support people having to operate on a service they are not usually responsible for.

.. _cfg.DEFAULT.disable:

:kw:`disable`
=============

================= ================================================================
**scopable**      True
**required**      False
**default**       False
**scope order**   specific > generic
**candidates**    True | False
**convert**       boolean
================= ================================================================

A disabled resource will be ignored on service startup and shutdown. Its status is always reported ``n/a``.

Set in DEFAULT, the whole service is disabled. A disabled service does not honor :c-action:`start` and :c-action:`stop` actions. These actions immediately return success.

:cmd:`om <path> disable` only sets :kw:`DEFAULT.disable`. As resources disabled state is not changed, :cmd:`om <path> enable` does not enable disabled resources.

.. _cfg.DEFAULT.drpnodes:

:kw:`drpnodes`
==============

================= ================================================================
**scopable**      True
**required**      False
**default**       
**scope order**   specific > generic
**convert**       list_lower
================= ================================================================

Alternate backup nodes, where the service could be activated in a DRP situation if the 'drpnode' is not available. These nodes are also data synchronization targets for :c-res:`sync` resources.

.. _cfg.DEFAULT.env:

:kw:`env`
=========

================= ================================================================
**scopable**      False
**required**      False
**default**       <same as node env>
**scope order**   specific > generic
**candidates**    CERT | DEV | DRP | FOR | INT | MUS | POC | PRA | PRD | PRJ | PPR | PPRD | QUAL | RCT | REC | STG | TMP | TST | UAT
================= ================================================================

A non-PRD service can not be brought up on a PRD node, but a PRD service can be startup on a non-PRD node (in a DRP situation). The default value is the node env.

.. _cfg.DEFAULT.id:

:kw:`id`
========

================= ================================================================
**scopable**      False
**required**      False
**default**       <random uuid>
**scope order**   specific > generic
================= ================================================================

A RFC 4122 random uuid generated by the agent. To use as reference in resources definitions instead of the service name, so the service can be renamed without affecting the resources.

.. _cfg.DEFAULT.lock_timeout:

:kw:`lock_timeout`
==================

================= ================================================================
**scopable**      False
**required**      False
**default**       60
**scope order**   specific > generic
**convert**       duration
================= ================================================================

A duration expression, like ``1m30s``. The maximum wait time for the action lock acquire. The :cmd:`--waitlock` option overrides this parameter.

.. _cfg.DEFAULT.nodes:

:kw:`nodes`
===========

================= ================================================================
**scopable**      True
**required**      False
**default**       <hostname of the current node>
**scope order**   specific > generic
**convert**       nodes_selector
================= ================================================================

A node selector expression specifying the list of cluster nodes hosting service instances.