groups.py

This file lets you specify or dynamically build groups of nodes in your environment.

As with nodes.py, you define your groups as a dictionary:

groups = {
    'all': {
        'member_patterns': (
            r".*",
        ),
    },
    'group1': {
        'members': (
            'node1',
        ),
    },
}

All group attributes are optional.


Group attribute reference

This section is a reference for all possible attributes you can define for a group:

groups = {
     'group1': {
         # THIS PART IS EXPLAINED HERE
         'bundles': ["bundle1", "bundle2"],
         'members': ["node1"],
         'members_add': lambda node: node.os == 'debian',
         'members_remove': lambda node: node.os == 'ubuntu',
         'member_patterns': [r"^cluster1\."],
         'metadata': {'foo': "bar"},
         'os': 'linux',
         'subgroups': ["group2", "group3"],
         'subgroup_patterns': [r"^group.*pattern$"],
     },
}

Note that many attributes from nodes.py (e.g. bundles) may also be set at group level, but aren't explicitly documented here again.


member_patterns

A list of regular expressions. Node names matching these expressions will be added to the group members.

Matches are determined using the search() method.


members

A tuple or list of node names that belong to this group.


members_add and members_remove

For these attributes you can provide a function that takes a node object as its only argument. The function must return a boolean. The function will be called once for every node in the repo. If True, this node will be added (members_add) to or removed (members_remove) from this group.

Inside your function you may query node attributes and groups, but you will not see groups or attributes added as a result of a different members_add / members_remove function. Only attributes and groups that have been set statically will be available. You can, however, remove a node with members_remove that you added with members_add (but not vice-versa).
You should also avoid using node.metadata here. Since metadata ultimately depends on group memberships, only metadata set in nodes.py will be returned here.


metadata

A dictionary that will be accessible from each node's node.metadata. For each node, BundleWrap will merge the metadata of all of the node's groups first, then merge in the metadata from the node itself.

Metadata is merged recursively by default, meaning nested dicts will overlay each other. Lists will be appended to each other, but not recursed into. In come cases, you want to overwrite instead of merge a piece of metadata. This is accomplished through the use of bundlewrap.metadata.atomic() and best illustrated as an example:

from bundlewrap.metadata import atomic

groups = {
    'all': {
        'metadata': {
            'interfaces': {
                'eth0': {},
            },
            'nameservers': ["8.8.8.8", "8.8.4.4"],
            'ntp_servers': ["pool.ntp.org"],
        },
    },
    'internal': {
        'metadata':
            'interfaces': {
                'eth1': {},
            },
            'nameservers': atomic(["10.0.0.1", "10.0.0.2"]),
            'ntp_servers': ["10.0.0.1", "10.0.0.2"],
        },
    },
}

A node in both groups will end up with eth0 and eth1.

The nameservers however are overwritten, so that nodes that are in both the "all" and the "internal" group will only have the 10.0.0.x ones while nodes just in the "all" group will have the 8.8.x.x nameservers.

The NTP servers are appended: a node in both groups will have all three nameservers.

BundleWrap will consider group hierarchy when merging metadata. For example, it is possible to define a default nameserver for the "eu" group and then override it for the "eu.frankfurt" subgroup. The catch is that this only works for groups that are connected through a subgroup hierarchy. Independent groups will have their metadata merged in an undefined order. bw test will report conflicting metadata in independent groups as a metadata collision.
Also see the documentation for node.metadata for more information.


subgroups

A tuple or list of group names whose members should be recursively included in this group.


subgroup_patterns

A list of regular expressions. Nodes in with group names matching these expressions will be added to the group members.

Matches are determined using the search() method.


use_shadow_passwords

See node attribute documentation. May be overridden by subgroups or individual nodes.