Version information
Start using this module
Add this module to your Puppetfile:
mod 'frozenfoxx-vundle', '0.1.1'
Learn more about managing modules with a PuppetfileDocumentation
puppet-vundle
Table of Contents
- Description
- Setup - The basics of getting started with vundle
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- Contribute - Guide for contributing to the module
Description
This is a module designed to configure and install Vundle, the plug-in manager for Vim. It has been designed with Linux and Unix systems in mind for Puppet 4+. Separate installations of Vundle for every user are easily handled which gives a great degree of flexibility.
While not required due to the complexity of some of the options Hiera's usage is strongly encouraged.
Setup
Setup Requirements
- Git
- Vim
- Puppet >= 4.0
- Facter >= 3.0
- Stdlib module
Beginning with vundle
Getting started with Vundle is as simple as including the module with the name of the user desired:
vundle::installation { 'username': }
Additional options can be attached easily:
vundle::installation { 'username:'
plugins => [ 'someuser/someplugin', 'otheruser/someplugin'],
}
If using Hiera which is highly recommended you'll end up with this:
puppet code
$vundleusers = hiera_hash('vundleusers')
create_resources('vundle::installation', $vundleusers)
hiera.yaml
---
vundleusers:
user1:
plugins:
- 'vundlemaker/vundleplugin'
- 'vundlemaker2/vundleplugin'
Usage
Vundle is installed and configured on a per-user basis. You're going to want to as a result use the defined type, vundle::installation { 'username': }
. To create many, it's recommend to use a hash in Hiera and use a create_resources
call to do this, like so:
puppet code:
$userList = hiera_hash('vundle-users')
create_resources('vundle::installation', $userList)
hiera file:
---
vundle-users:
'user1':
plugins:
- 'vundlemaker3/vim-someplugin'
'user2':
path: '/home/notnormal/user2'
plugins:
- 'vundlemaker4/vim-otherplugin'
- 'L9'
If desired, this plugin can also install Vim easily by setting viminstall => true
.
Reference
name
: used as the username to install Vundle under.path
: path to the user's home. Default:/home/${name}
plugins
: array of strings for Plugin lines in the.vimrc
. Default:[]
viminstall
: allows installing Vim directly. Default:false
Limitations
This module has only been tested on Ubuntu systems. It will likely work with others but has not been tested at this time.
Contribute
- Fork it
- Create a topic branch
- Improve/fix
- Push new topic branch
- Submit a PR
Dependencies
- puppetlabs-stdlib (>= 1.0.0)
- puppetlabs-git (>= 0.5.0)
MIT License Copyright (c) 2016 FOXX Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.