High: Shell: template support

Author: dmuhamedagic

doc/crm.8.txt

@@ -1355,6 +1355,14 @@ Commands for resources are:
 - `clone`
 - `ms`/`master` (master-slave)
 
+In order to streamline large configurations, it is possible to
+define a template which can later be referenced in primitives:
+
+- `rsc_template`
+
+In that case the primitive inherits all attributes defined in the
+template.
+
 There are three types of constraints:
 
 - `location`
@@ -1429,9 +1437,13 @@ instance attributes of that operation. A typical example is
 
 For multistate resources, roles are specified as `role=<role>`.
 
+A template may be defined for resources which are of the same
+type and which share most of the configuration. See 
+<<cmdhelp_configure_rsc_template,`rsc_template`>> for more information.
+
 Usage:
 ...............
-        primitive <rsc> [<class>:[<provider>:]]<type>
+        primitive <rsc> {[<class>:[<provider>:]]<type>|@<template>}
           [params attr_list]
           [meta attr_list]
           [utilization attr_list]
@@ -1462,6 +1474,9 @@ Example:
           params drbd_resource=r0 \
           op monitor role=Master interval=60s \
           op monitor role=Slave interval=300s
+
+        primitive xen0 @vm_scheme1 \
+          params xmfile=/etc/xen/vm/xen0
 ...............
 
 [[cmdhelp_configure_monitor,add monitor operation to a primitive]]
@@ -1565,6 +1580,40 @@ It is advisable to give meaningful names to attribute sets which
 are going to be referenced.
 ****************************
 
+[[cmdhelp_configure_rsc_template,define a resource template]]
+==== `rsc_template`
+
+The `rsc_template` command creates a resource template. It may be
+referenced in primitives. It is used to reduce large
+configurations with many similar resources.
+
+Usage:
+...............
+        rsc_template <name> [<class>:[<provider>:]]<type>
+          [params attr_list]
+          [meta attr_list]
+          [utilization attr_list]
+          [operations id_spec]
+            [op op_type [<attribute>=<value>...] ...]
+
+        attr_list :: [$id=<id>] <attr>=<val> [<attr>=<val>...] | $id-ref=<id>
+        id_spec :: $id=<id> | $id-ref=<id>
+        op_type :: start | stop | monitor
+...............
+Example:
+...............
+        rsc_template public_vm ocf:heartbeat:Xen \
+          op start timeout=300s \
+          op stop timeout=300s \
+          op monitor interval=30s timeout=60s \
+          op migrate_from timeout=600s \
+          op migrate_to timeout=600s
+        primitive xen0 @public_vm \
+          params xmfile=/etc/xen/xen0
+        primitive xen1 @public_vm \
+          params xmfile=/etc/xen/xen1
+...............
+
 [[cmdhelp_configure_location,a location preference]]
 ==== `location`
 

modules/cibconfig.py

@@ -33,7 +33,7 @@
 from clidisplay import CliDisplay
 from cibstatus import CibStatus
 from idmgmt import IdMgmt
-from ra import RAInfo, get_properties_list, get_pe_meta
+from ra import get_ra, get_properties_list, get_pe_meta
 
 def show_unrecognized_elems(doc):
     try:
@@ -242,18 +242,18 @@ def process_primitive(prim, clash_dict):
             (ra_class, ra_provider, ra_type, name, value) -> [ resourcename ]
             if parameter "name" should be unique
             '''
-            ra_class = prim.getAttribute("class")
-            ra_provider = prim.getAttribute("provider")
-            ra_type = prim.getAttribute("type")
             ra_id = prim.getAttribute("id")
-            ra = RAInfo(ra_class, ra_type, ra_provider)
-            if ra == None:
+            r_node = reduce_primitive(prim)
+            if not r_node:
+                return # template not defined yet
+            ra = get_ra(r_node)
+            if not ra.mk_ra_node():  # no RA found?
                 return
             ra_params = ra.params()
-            for a in prim.getElementsByTagName("instance_attributes"):
+            for a in r_node.getElementsByTagName("instance_attributes"):
                 # params are in instance_attributes just below the parent
                 # operations may have some as well, e.g. OCF_CHECK_LEVEL
-                if a.parentNode != prim:
+                if a.parentNode != r_node:
                     continue
                 for p in a.getElementsByTagName("nvpair"):
                     name = p.getAttribute("name")
@@ -984,11 +984,22 @@ def cli_list2node(self,cli_list,oldnode):
         remove_id_used_attributes(get_topnode(cib_factory.doc,self.parent_type))
         return headnode
 
-def get_ra(node):
-    ra_type = node.getAttribute("type")
-    ra_class = node.getAttribute("class")
-    ra_provider = node.getAttribute("provider")
-    return RAInfo(ra_class,ra_type,ra_provider)
+def reduce_primitive(node):
+    '''
+    A primitive may reference template. If so, put the two
+    together.
+    Returns:
+        - if no template reference, node itself
+        - if template reference, but no template found, None
+        - return merged primitive node into template node
+    '''
+    template = node.getAttribute("template")
+    if not template:
+        return node
+    template_obj = cib_factory.find_object(template)
+    if not template_obj:
+        return None
+    return merge_nodes_2(node, template_obj.node)
 
 class CibPrimitive(CibObject):
     '''
@@ -1002,17 +1013,25 @@ class CibPrimitive(CibObject):
     def repr_cli_head(self,node):
         obj_type = vars.cib_cli_map[node.tagName]
         node_id = node.getAttribute("id")
-        ra_type = node.getAttribute("type")
-        ra_class = node.getAttribute("class")
-        ra_provider = node.getAttribute("provider")
-        s1 = s2 = ''
-        if ra_class:
-            s1 = "%s:"%ra_class
-        if ra_provider:
-            s2 = "%s:"%ra_provider
+        if obj_type == "primitive":
+            template_ref = node.getAttribute("template")
+        else:
+            template_ref = None
+        if template_ref:
+            rsc_spec = "@%s" % cli_display.idref(template_ref)
+        else:
+            ra_type = node.getAttribute("type")
+            ra_class = node.getAttribute("class")
+            ra_provider = node.getAttribute("provider")
+            s1 = s2 = ''
+            if ra_class:
+                s1 = "%s:"%ra_class
+            if ra_provider:
+                s2 = "%s:"%ra_provider
+            rsc_spec = ''.join((s1,s2,ra_type))
         s = cli_display.keyword(obj_type)
         id = cli_display.id(node_id)
-        return "%s %s %s" % (s, id, ''.join((s1,s2,ra_type)))
+        return "%s %s %s" % (s, id, rsc_spec)
     def repr_cli_child(self,c,format):
         if c.tagName in self.set_names:
             return "%s %s" % \
@@ -1080,31 +1099,30 @@ def check_sanity(self):
             common_err("%s: no xml (strange)" % self.obj_id)
             return user_prefs.get_check_rc()
         rc3 = sanity_check_meta(self.obj_id,self.node,vars.rsc_meta_attributes)
-        ra = get_ra(self.node)
+        if self.obj_type == "primitive":
+            r_node = reduce_primitive(self.node)
+            if not r_node:
+                # perhaps the template will be defined later
+                return rc3
+        else:
+            r_node = self.node
+        ra = get_ra(r_node)
         if not ra.mk_ra_node():  # no RA found?
             if cib_factory.is_asymm_cluster():
                 return rc3
             ra.error("no such resource agent")
             return user_prefs.get_check_rc()
+        actions = get_rsc_operations(r_node)
+        default_timeout = get_default_timeout()
+        rc2 = ra.sanity_check_ops(self.obj_id, actions, default_timeout)
         params = []
-        for c in self.node.childNodes:
+        for c in r_node.childNodes:
             if not is_element(c):
                 continue
             if c.tagName == "instance_attributes":
                 params += nvpairs2list(c)
-        rc1 = ra.sanity_check_params(self.obj_id, params)
-        actions = {}
-        for c in self.node.childNodes:
-            if not is_element(c):
-                continue
-            if c.tagName == "operations":
-                for c2 in c.childNodes:
-                    if is_element(c2) and c2.tagName == "op":
-                        op,pl = op2list(c2)
-                        if op:
-                            actions[op] = pl
-        default_timeout = get_default_timeout()
-        rc2 = ra.sanity_check_ops(self.obj_id, actions, default_timeout)
+        rc1 = ra.sanity_check_params(self.obj_id, params,
+                existence_only = (self.obj_type != "primitive"))
         return rc1 | rc2 | rc3
 
 class CibContainer(CibObject):
@@ -1389,6 +1407,7 @@ def get_default_timeout():
     "group": ( "group", CibContainer, "resources" ),
     "clone": ( "clone", CibContainer, "resources" ),
     "master": ( "ms", CibContainer, "resources" ),
+    "template": ( "rsc_template", CibPrimitive, "resources" ),
     "rsc_location": ( "location", CibLocation, "constraints" ),
     "rsc_colocation": ( "colocation", CibSimpleConstraint, "constraints" ),
     "rsc_order": ( "order", CibSimpleConstraint, "constraints" ),
@@ -1755,6 +1774,10 @@ def f_prim_id_list(self):
         "List of possible primitives ids (for group completion)."
         return [x.obj_id for x in self.cib_objects \
             if x.obj_type == "primitive" and not x.parent]
+    def rsc_template_list(self):
+        "List of templates."
+        return [x.obj_id for x in self.cib_objects \
+            if x.obj_type == "rsc_template"]
     def f_children_id_list(self):
         "List of possible child ids (for clone/master completion)."
         return [x.obj_id for x in self.cib_objects \
@@ -1800,13 +1823,19 @@ def default_timeouts(self,*args):
                 common_warn("element %s is not a primitive" % obj_id)
                 rc = False
                 continue
-            ra = get_ra(obj.node)
+            r_node = reduce_primitive(obj.node)
+            if not r_node:
+                # cannot do anything without template defined
+                common_warn("template for %s not defined" % obj_id)
+                rc = False
+                continue
+            ra = get_ra(r_node)
             if not ra.mk_ra_node():  # no RA found?
                 if not self.is_asymm_cluster():
                     ra.error("no resource agent found for %s" % obj_id)
                 continue
             obj_modified = False
-            for c in obj.node.childNodes:
+            for c in r_node.childNodes:
                 if not is_element(c):
                     continue
                 if c.tagName == "operations":
@@ -1818,7 +1847,7 @@ def default_timeouts(self,*args):
                             continue
                         if op in implied_actions:
                             implied_actions.remove(op)
-                        elif can_migrate(obj.node) and op in implied_migrate_actions:
+                        elif can_migrate(r_node) and op in implied_migrate_actions:
                             implied_migrate_actions.remove(op)
                         elif is_ms(obj.node.parentNode) and op in implied_ms_actions:
                             implied_ms_actions.remove(op)
@@ -1829,7 +1858,7 @@ def default_timeouts(self,*args):
                             c2.setAttribute("timeout",adv_timeout)
                             obj_modified = True
             l = implied_actions
-            if can_migrate(obj.node):
+            if can_migrate(r_node):
                 l += implied_migrate_actions
             if is_ms(obj.node.parentNode):
                 l += implied_ms_actions
@@ -2123,7 +2152,7 @@ def merge_from_cli(self,obj,cli_list):
         if not node:
             return
         if obj.obj_type in vars.nvset_cli_names:
-            rc = merge_nvpairs(obj.node, node)
+            rc = merge_attributes(obj.node, node, "nvpair")
         else:
             rc = merge_nodes(obj.node, node)
         if rc:

modules/cliformat.py

@@ -88,17 +88,6 @@ def nvpairs2list(node, add_id = False):
         pl.append([name,value])
     return pl
 
-def op2list(node):
-    pl = []
-    action = ""
-    for name in node.attributes.keys():
-        if name == "name":
-            action = node.getAttribute(name)
-        elif name != "id": # skip the id
-            pl.append([name,node.getAttribute(name)])
-    if not action:
-        common_err("op is invalid (no name)")
-    return action,pl
 def op_instattr(node):
     pl = []
     for c in node.childNodes:

modules/completion.py

@@ -121,6 +121,10 @@ def node_id_list(idx,delimiter = False):
     if delimiter:
         return ' '
     return cib_factory.node_id_list()
+def rsc_template_list(idx,delimiter = False):
+    if delimiter:
+        return ' '
+    return cib_factory.rsc_template_list()
 def node_attr_keyw_list(idx,delimiter = False):
     if delimiter:
         return ' '
@@ -182,12 +186,11 @@ def ticket_cmd_list(idx,delimiter = False):
 # completion for primitives including help for parameters
 # (help also available for properties)
 #
-def get_primitive_type(words):
-    try:
-        idx = words.index("primitive") + 2
-        type_word = words[idx]
-    except: type_word = ''
-    return type_word
+def get_prim_token(words, n):
+    for key in ("primitive", "rsc_template"):
+        try: return words[words.index(key)+n-1]
+        except: pass
+    return ''
 def ra_type_list(toks,idx,delimiter):
     if idx == 2:
         if toks[0] == "ocf":
@@ -257,6 +260,12 @@ def get_lastkeyw(words,keyw):
     for w in revwords:
         if w in keyw:
             return w
+def ra_classes_or_tmpl(idx,delimiter = False):
+    words = readline.get_line_buffer().split()
+    if words[-1].startswith('@'):
+        return rsc_template_list(idx,delimiter)
+    else:
+        return ra_classes_list(idx,delimiter)
 def primitive_complete_complex(idx,delimiter = False):
     '''
     This completer depends on the content of the line, i.e. on
@@ -269,19 +278,24 @@ def primitive_complete_complex(idx,delimiter = False):
     }
     # manage the resource type
     words = readline.get_line_buffer().split()
-    type_word = get_primitive_type(words)
-    toks = type_word.split(':')
-    if toks[0] != "ocf":
-        idx += 1
-    if idx in (2,3):
-        return ra_type_list(toks,idx,delimiter)
-    # create an ra object
-    ra = None
-    ra_class,provider,rsc_type = disambiguate_ra_type(type_word)
-    if ra_type_validate(type_word,ra_class,provider,rsc_type):
-        ra = RAInfo(ra_class,rsc_type,provider)
+    cmd = get_prim_token(words, 1)
+    type_word = get_prim_token(words, 3)
+    with_template = cmd == "primitive" and type_word.startswith('@')
+    if with_template:
+        # template reference
+        ra = get_ra(cib_factory.find_object(type_word[1:]).node)
+    else:
+        toks = type_word.split(':')
+        if toks[0] != "ocf":
+            idx += 1
+        if idx in (2,3):
+            return ra_type_list(toks,idx,delimiter)
+        ra = None
+        ra_class,provider,rsc_type = disambiguate_ra_type(type_word)
+        if ra_type_validate(type_word,ra_class,provider,rsc_type):
+            ra = RAInfo(ra_class,rsc_type,provider)
     keywords = completers_set.keys()
-    if idx == 4:
+    if idx == 4 or (idx == 2 and with_template):
         if delimiter:
             return ' '
         return keywords
@@ -464,7 +478,8 @@ def setup_readline():
         "save" : None,
         "load" : None,
         "node" : (node_id_list,node_attr_keyw_list),
-        "primitive" : (null_list,ra_classes_list,primitive_complete_complex,loop),
+        "primitive" : (null_list,ra_classes_or_tmpl,primitive_complete_complex,loop),
+        "rsc_template" : (null_list,ra_classes_list,primitive_complete_complex,loop),
         "group" : (null_list,f_prim_id_list,loop),
         "clone" : (null_list,f_children_id_list),
         "ms" : (null_list,f_children_id_list),