Version information
This version is compatible with:
- ,
Start using this module
Add this module to your Puppetfile:
mod 'Lavaburn-razor', '0.7.0'
Learn more about managing modules with a PuppetfileDocumentation
Puppet Module for Razor
Overview
This module installs and sets up Razor.
Table of Contents
Dependencies
The Database should be postgres >= 9.1
Modules:
- reidmv/yamlfile (REQUIRED)
- voxpupuli/puppet-filemapper 1.1.3 - Future versions not supported at present.
- puppetlabs/stdlib (REQUIRED)
- puppetlabs/postgresql (Optional)
- puppetlabs/apt (postgresql)
- puppetlabs/concat (postgresql)
- puppetlabs/vcsrepo (Optional)
- puppetlabs/tftp (Optional)
- puppetlabs/xinetd (tftp)
- maestrodev/wget (Optional/tftp)
- puppet/archive (Optional)
- If you want to set up PostgreSQL config:
- `include 'posgresql::server'` [puppetlabs/postgresql]
- If you want to compile the Microkernel (on Fedora/CentOS/RHEL)
- puppetlabs/vcsrepo module
- If you want to set up TFTP boot files
include 'wget'
class { '::tftp': }
[puppetlabs/tftp]
- If you want to download/extract a microkernel,
- Do not set microkernel_url to undef. (Default : puppetlabs precompiled)
- puppet/archive module
Notes
The dependency on reidmv/yamlfile is causing issues in Puppet 6. This will require a different solution.
Shiro Authentication is not fully tested. See notes in lib/puppet/provider/razo_rest.rb ?
SSL/TLS is not fully tested.
Usage
It is highly recommended to put secret keys in Hiera-eyaml and use automatic parameter lookup
Make sure to include all dependencies as per above.
Also see the examples/profile.pp file for an example on how to set up dependencies.
class { 'razor':
db_hostname => '127.0.0.1',
db_password => 'notasecretpassword',
server_http_port => '8150',
}
Unfortunately Puppet does not support autorequire for classes. Hence a dependency for each of the custom types must be set to Class['razor'].
Class['razor'] -> razor_broker...
razor_broker { 'name':
require => Class['razor'],
...
}
Razor_repo {
require => Class['razor'],
...
}
Note: you will probably need to run it twice anyway as the razor server service is very slow to start. API calls will only start working a few minutes after the service starting. [suggestions welcome to fix that]
Reference
Classes
razor
class { '::razor':
compile_microkernel => false,
db_hostname => $::fqdn,
db_database => 'razor',
db_user => 'razor',
db_password => 'notsecret',
}
This is the main class that can install client, server, database and tftp server (with microkernel download). Additionally, on CentOS, this class can also compile the microkernel.
Razor API
class { '::razor::api':
}
This class will set up configuration for the defined types. These use the REST API provided by the Razor Server.
Task
razor::task { 'task1':
module => 'mymodule1'
}
Hook Type
razor::hook_type { 'type1':
module => 'mymodule1'
}
Broker
razor::broker { 'broker1':
module => 'mymodule1'
}
Types
razor_broker
razor_broker { 'puppet-dev':
ensure => 'present',
broker_type => 'puppet',
configuration => {
'server' => 'puppet',
'environment' => 'dev'
},
}
- name: The broker name
- ensure: The basic property that the resource should be in.
Valid values are
present
,absent
. - broker_type: The broker type
- configuration: The broker configuration (Hash)
- provider: The specific backend to use for this
razor_broker
resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform. Available providers are:- rest: REST provider for Razor broker
razor_policy
razor_policy { 'install_ubuntu_on_hypervisor':
ensure => 'present',
repo => 'ubuntu-14.04.1',
task => 'ubuntu',
broker => 'puppet-dev',
hostname => 'host${id}.test.com',
root_password => 't3mporary',
max_count => undef,
before_policy => 'policy0',
node_metadata => {},
tags => ['small'],
}
- name: The policy name
- ensure: The basic property that the resource should be in.
Valid values are
present
,absent
. - repo: The repository to install from
- task: The task to use to install the repo
- broker: The broker to use after installation
- hostname: The hostname to set up (use ${id} inside)
- root_password: The root password to install with
- max_count: The maximum hosts to configure (set nil for unlimited)
- after_policy: The policy after this one
- before_policy: The policy before this one
- node_metadata: The node metadata [Hash]
- tags: The tags to look for [Array]
- provider: The specific backend to use for this
razor_policy
resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform. Available providers are:- rest: REST provider for Razor broker
razor_repo
razor_repo { 'ubuntu-14.04.1':
ensure => 'present',
iso_url => 'http://releases.ubuntu.com/14.04.1/ubuntu-14.04.1-server-amd64.iso',
task => 'ubuntu',
}
- name: The repository name
- ensure: The basic property that the resource should be in.
Valid values are
present
,absent
. - iso_url: The URL of the ISO to download
- url: The URL of a mirror (no downloads)
- task: The default task to perform to install the OS
- provider: The specific backend to use for this
razor_repo
resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform. Available providers are:- rest: REST provider for Razor broker
razor_tag
razor_tag { 'small':
ensure => 'present',
rule => ['=', ['fact', 'processorcount'], '1']
}
- name: The tag name
- ensure: The basic property that the resource should be in.
Valid values are
present
,absent
. - rule: The tag rule (Array)
- provider: The specific backend to use for this
razor_tag
resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform. Available providers are:- rest: REST provider for Razor broker
razor_hook
razor_hook { 'a':
ensure => 'present',
hook_type => '',
configuration => {}
}
- name: The hook name
- ensure: The basic property that the resource should be in.
Valid values are
present
,absent
. - hook_type: The hook type (as defined with razor::hook_type)
- configuration: A hash with hook configuration.
Compatibility
- compile_microkernel only works on RHEL/CentOS/Fedora (Razor Microkernel constraint)
- enable_server requires Postgres >= 9.1
This module has been tested using Beaker with Puppet 4.3.2 (Ruby 2.1.8) on:
- Ubuntu 12.04 (complete without microkernel compilation) - Razor Server 1.0.0 to 1.5.0
- Ubuntu 14.04 (complete without microkernel compilation) - Razor Server 1.0.0 to 1.5.0
- CentOS 6.6 (complete without microkernel compilation) - Razor Server 1.0.0 to 1.5.0
- CentOS 7.2 (complete with microkernel compilation) - Razor Server 1.4.0 (!) to 1.5.0
Testing
The use of rvm is encouraged to simulate different Ruby environments.
Setup: gem install bundler && bundle install --binstubs
Spec test
rake test
Acceptance Testing
This requires some work... helpers are no longer compatible with Puppet APT repository
PREVIOUSLY - Confirmed working on Ruby 2.4.5
rake beaker:ubuntu-12-04
Notes:
- Possible issues with bundler: gem uninstall bundler && gem install bundler -v 1.10.6 [Vagrant 1.8.1]
- Possible issue with vagrant "unable to mount VirtualBox shared folders": plugin install vagrant-vbguest
Copyright
Copyright 2017 Nicolas Truyens
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
[2019-01-03] Release 0.6.0
Summary:
Minor bugfixes for facts.
Features:
- Several bugfixes for facts
- Support for Ubuntu Xenial
- Spec tests for Puppet 4, 5 and 6
[2017-01-08] Release 0.5.0
Summary:
Full support for Razor Server 1.0.1 - 1.5.0
Features:
- Support for Ubuntu Trusty
- Support for CentOS 7 (From Razor Server 1.4.0)
- Support for AIO paths (Razor Server >= 1.4.0)
- Acceptance testing using Beaker included
Deprecated:
- The microkernel is now based on CentOS 7, so compilation on other platforms is not supported.
[2017-01-05] Release 0.4.0
Summary:
Migrating module to support new Puppet environments.
Features:
- Changed dependency to puppet/archive
- Dropped support for Ruby <= 2.1.x
- Dropped support for Puppet < 4.0.0
- General module cleanup
- Release includes older versions that were not released on the forge:
- Compatible with Razor Server 1.3.0
- Composable config file with yaml_setting
[2014-11-22] Release 0.1.3
Summary:
Small bugfixes Additional comments regarding dependencies
Features:
- REST provider warning if Post fails did not have the correct IP/port variable
- Autorequire commented, added comments to README and test/types.pp to make sure dependencies are included (requiring less runs)
- README comment: still 2 runs required due to long startup time of the Razor service
- Extra validation doe numeric entries, null-pointers in data
[2014-11-22] Release 0.1.2
Summary:
Serious bugfixes
Features:
- Added autorequire to Razor Class
- Found a bug on post_command that was introduced when adding the get_rest_info method
[2014-11-21] Release 0.1.1
Summary:
Some beauty fixes - this was my first release to the Forge.
Features:
Updated:
- README.markdown
- metadata.json
[2014-11-21] Release 0.1.0
Summary:
The initial release for this module.
Features:
- The module allows installation of Razor Server/Client/Database
- While not recommended, and with limited OS support, the module will allow the compilation of your own microkernel
- It can also set up a TFTP server and publish the 2 boot images
- Finally, custom types are available for configuring the Razor Server (through the REST API)
Dependencies
- puppetlabs/stdlib (>=4.0.0 <6.0.0)
- reidmv/yamlfile (>=0.2.0 < 1.0.0)
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS