summaryrefslogtreecommitdiff
path: root/cloudinit/config/cc_byobu.py
diff options
context:
space:
mode:
Diffstat (limited to 'cloudinit/config/cc_byobu.py')
-rwxr-xr-x[-rw-r--r--]cloudinit/config/cc_byobu.py40
1 files changed, 34 insertions, 6 deletions
diff --git a/cloudinit/config/cc_byobu.py b/cloudinit/config/cc_byobu.py
index ef0ce7ab..4a616e26 100644..100755
--- a/cloudinit/config/cc_byobu.py
+++ b/cloudinit/config/cc_byobu.py
@@ -18,11 +18,39 @@
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
-# Ensure this is aliased to a name not 'distros'
-# since the module attribute 'distros'
-# is a list of distros that are supported, not a sub-module
-from cloudinit import distros as ds
+"""
+Byobu
+-----
+**Summary:** enable/disable byobu system wide and for default user
+This module controls whether byobu is enabled or disabled system wide and for
+the default system user. If byobu is to be enabled, this module will ensure it
+is installed. Likewise, if it is to be disabled, it will be removed if
+installed.
+
+Valid configuration options for this module are:
+
+ - ``enable-system``: enable byobu system wide
+ - ``enable-user``: enable byobu for the default user
+ - ``disable-system``: disable byobu system wide
+ - ``disable-user``: disable byobu for the default user
+ - ``enable``: enable byobu both system wide and for default user
+ - ``disable``: disable byobu for all users
+ - ``user``: alias for ``enable-user``
+ - ``system``: alias for ``enable-system``
+
+**Internal name:** ``cc_byobu``
+
+**Module frequency:** per instance
+
+**Supported distros:** ubuntu, debian
+
+**Config keys**::
+
+ byobu_by_default: <user/system>
+"""
+
+from cloudinit.distros import ug_util
from cloudinit import util
distros = ['ubuntu', 'debian']
@@ -61,8 +89,8 @@ def handle(name, cfg, cloud, log, args):
shcmd = ""
if mod_user:
- (users, _groups) = ds.normalize_users_groups(cfg, cloud.distro)
- (user, _user_config) = ds.extract_default(users)
+ (users, _groups) = ug_util.normalize_users_groups(cfg, cloud.distro)
+ (user, _user_config) = ug_util.extract_default(users)
if not user:
log.warn(("No default byobu user provided, "
"can not launch %s for the default user"), bl_inst)