Forge Home

managedmac

Comprehensive OS X Configuration and Management

4,069,877 downloads

10,214 latest version

3.0 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 0.7.3 (latest)
  • 0.7.2
  • 0.7.1 (deleted)
  • 0.6.0
  • 0.5.9 (deleted)
  • 0.5.7 (deleted)
  • 0.5.6 (deleted)
  • 0.5.5 (deleted)
  • 0.5.3 (deleted)
  • 0.5.1 (deleted)
  • 0.5.0 (deleted)
  • 0.4.5 (deleted)
  • 0.4.0 (deleted)
released Sep 25th 2015
This version is compatible with:
  • Puppet Enterprise >=3.8.3 <4.0.0
  • Puppet >=3.8.3 <4.0.0

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'sfu-managedmac', '0.7.3'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add sfu-managedmac
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install sfu-managedmac --version 0.7.3

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

sfu/managedmac — version 0.7.3 Sep 25th 2015

managedmac

Copyright 2015, Simon Fraser University.

Overview

A comprehensive collection of Puppet classes and types for managing OS X.


Puppet Version 4.x is not currently supported


Description

This is a giant Puppet module. It abstracts all the things. It won't win any awards for being small and portable and pretty, because it does A LOT OF STUFF.

Some of this stuff is very useful, a lot of it is new, all of it is IN ONE PLACE.

  • Mobileconfig Type for managing OS X profiles
  • Propertylist Type for managing OS X plist and preferences
  • Macauthdb Type for managing OS X Authorization DB
  • Macgroup Type for managing groups-in-groups
  • Manages Login/Logout Hooks globally
  • Manages ARD/ScreenSharing service and related ACLs
  • Manages Bluetooth/Airport power
  • Manages FileVault configuration
  • Raw Constructor classes for users, groups, etc.
  • Lots more...

Requirements

  • OS X 10.9 or greater
  • Puppet 3.x (No Puppet Version 4 support at this time)
  • puppetlabs-stdlib module
  • CFPropertyList gem
  • sqlite3 gem

How does it work?

This module was designed to be a world-engine for OS X.

You fuel it with Hiera data.

By itself, it does nothing, but...

Once, you've installed the components and created a configuration file, you have everything you need to begin terraforming.

Example:

--
managedmac::organization: My Organization         # identify yourself
managedmac::ntp::enable: true                     # turn on the ntp client
managedmac::ntp::servers:                         # use a list of ntp servers
  - time.apple.com
  - time1.google.com
managedmac::filevault::enable: true               # turn on FDE
managedmac::filevault::use_recovery_key: true     # use a recovery key
managedmac::filevault::show_recovery_key: true    # show the user the key
managedmac::mobileconfigs::payloads:              # manage the dock, but why?
  'managedmac.dock.alacarte':
    content:
      largesize: 128
      orientation: left
      tilesize: 128
      autohide: true
      PayloadType: 'com.apple.dock'
    displayname: 'Managed Mac: Dock Settings'

For more information about the zillions of options available, see files/sample.yaml.

What can I do with this thing?

Good question. Here are 1700 lines of heavily commented YAML you can peruse to get an idea!

It should give you good overview of what the module can do.

Classes

There are a number of classes included in this module; each one groups a specific set of configuration options.

Documentation on classes is available on the Github project page.

Custom Types

There are a few custom types used in this module. Naturally, once you have installed the module, these types will be available to use in your own Puppet code if you don't fancy using any of the builtin classes.

Documentation on custom types and providers is available on the Github project page.

More Documentation

For more docs, tutorials, and how-tos, see the project page on Github.