https://github.com/hostnet/puppet-lint-roles-profiles

https://github.com/hostnet/puppet-lint-roles-profiles

puppet puppet-lint

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/hostnet/puppet-lint-roles-profiles
• Owner: hostnet
• License: mit
• Created: 2018-03-06T21:17:46.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2018-03-07T18:06:18.000Z (almost 7 years ago)
• Last Synced: 2024-08-31T23:18:10.169Z (5 months ago)
• Topics: puppet, puppet-lint
• Language: Ruby
• Size: 6.84 KB
• Stars: 1
• Watchers: 6
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# puppet-lint-roles-profiles

This plugin validates that the code base adheres to the roles and profiles

workflow[1].

## Installation

To use this plugin, add the following line to the Gemfile in your Puppet code

base and run `bundle install`.

```ruby

gem 'puppet-lint-roles-profiles'

```

## Usage

### roles_include_profiles

**--fix-support: No**

Will raise a warning if a roles does anything other than `include` `profile`s.

Resource like class definitions will also raise an error.

```

WARNING: roles must only include profiles

```

What you did:

```puppet

class role::foo {

  class { 'ssh': }

```

or:

```puppet

class role::foo {

  class { 'profile::ssh': }

}

```

What you should have done:

```

class role::foo {

  include profile::ssh

}

```

### roles_with_params

**--fix-support: No**

Will raise a warning when a role has class parameters

```

Warning: roles must not have any parameters

```

### roles_inherits_roles

**--fix-support: No**

Will raise a warning when a role inherits something other than a role

### nodes_include_one_role

**--fix-support: No**

Will raise a warning when a node definition contains more than one role

`include` (except comments).

## References

[1] https://puppet.com/docs/pe/2017.2/r_n_p_full_example.html