Version information
This version is compatible with:
- Puppet Enterprise 3.x
- Puppet 3.x
- , , ,
Start using this module
Add this module to your Puppetfile:
mod 'sgnl05-racktables', '0.4.1'
Learn more about managing modules with a PuppetfileDocumentation
racktables
Table of Contents
- Overview
- Module Description - What the module does and why it is useful
- Setup - The basics of getting started with racktables
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
Overview
This Puppet module installs RackTables, along with Apache, PHP, MySQL.
Module Description
RackTables is nifty and robust solution for datacenter and server room asset management. It helps document hardware assets, network addresses, space in racks, networks configuration and much much more.
Use this module to install a new instance of RackTables. The module will also install Apache, PHP, MySQL (optional) and some other dependencies for RackTables (php packages mostly).
WARNING: Use this module on NEW servers! Existing databases, webserver configs and RackTables installations will be replaced or purged.
Setup
What racktables affects
- Apache - Any existing config will be purged or replaced.
- MySQL - Existing databases and settings might be replaced.
- RackTables - Existing RackTable files might be replaced.
Beginning with RackTables module
To install RackTables version 0.20.10 with local database and default parameters:
class { '::racktables':
vhost => 'racktables.example.com',
release => 'RackTables-0.20.10',
install_db => true,
}
As soon as Puppet is done installing RackTables, go to the vhost address and append ?module=installer to the URL (Example URL: https://racktables.example.com/?module=installer). From there follow the RackTables installation steps (7 in total).
Default database settings are:
- database: racktables_db
- username: racktables_user
- password: racktables_pass
These values can be changed by adding parameters 'db_name', 'db_username' and 'db_password' to the ::racktables class (See more examples).
Handling the permissions of secret.php at installation step 3 and 4 of can be assisted by Puppet. Use parameter 'secretfile' on the ::racktables class and set it to "writable" on step 3 and "readonly" on step 4. Remember to run "puppet agent -t" on the target server after each of these steps. If you have an existing secretfile or template, the default behavior of 'secretfile' is to accept the contents as a string. For instance:
class { '::racktables':
vost => 'racktables.example.com',
release => 'RackTables-0.20.14',
secretfile => file('/path/to/file'),
}
Examples
Install RackTables with a new local database:
class { '::racktables':
vhost => 'racktables.example.com',
release => 'RackTables-0.20.14',
install_db => true,
db_name => 'racktables',
db_username => 'racktables',
db_password => 'make_a_strong_password',
}
Install RackTables, using a remote database with existing RackTables data:
class { '::racktables':
vhost => 'racktables.example.com',
release => 'RackTables-0.20.14',
db_name => 'example_db_name',
db_username => 'example_username',
db_password => 'example_password',
db_host => 'database.example.com',
secretfile => 'template',
}
Make sure there's a DNS entry for your vhost. After 'puppet agent -t' run on target machine, go to the vhost URL and follow the onscreen installation instructions.
Usage
###Classes and Defined Types
####Class: racktables
#####secretfile
Handles the inc/secret.php file. This can be put to good use during first time installation.
Available settings for this parameter are:
- "w" (writable)
- "r" (readonly) (these are useful for configuring Racktables manually through the web browser
- "template" (uses the included default template, or a custome one set through the
templatefile
parameter) - "absent" (deletes the file, if it exists)
- A string containing the contents of the secretfile
- undef (or just don't include the parameter) - this does nothing and leaves the file undeclared
If you set this attribute to "w" while installing RackTables so that the web server can write to the file, remember to later set it to "r" (for readonly) after configuration in step 4.
DEPRICATION WARNING: This parameter will be renamed to 'secretmode' in the next release of this module.
#####templatefile
String. Sets the template file to use for secret.php. The secretfile
parameter must be set to 'template' for this to work.
Defaults to 'racktables/secret.erb'.
#####vhost
String. The virtual host address to use for your racktables installation. Requires a valid DNS entry. Defaults to 'racktables.example.com'.
#####release
String. Selects what RackTables version to download. The version is pulled from https://github.com/RackTables/racktables/tree/REVISION (Revision = Git revision TAG). The RackTables project on GitHub has (so far) tagged every release with "RackTables-[version]". You can automatically upgrade the racktables version by modifying this attribute to a higher version number. Defaults to 'undef', which results in the default repo being downloaded. After first download, 'undef' setting will not modify local files even if the remote repo is updated.
#####install_db
Boolean. Set to 'true' to make this module install a mysql database on the target server. Defaults to 'false'.
#####db_username
String. Sets the mysql username for the racktables database. Defaults to 'racktables_user'.
#####db_password
String. Sets the password for the user defined in param "mysqluser". Defaults to 'racktables_pass'.
#####db_name
String. Sets the name of the database for racktables. Defaults to 'racktables_db'.
#####db_host
String. Sets the name of the database to connect to. Defaults to 'localhost'.
#####db_rootpw
String. Sets the root password on MySQL. Defaults to undef.
#####user_auth_src
String. "$user_auth_src" setting in inc/secret.php. Default setting is to authenticate users locally, but it is possible to employ existing LDAP or Apache user accounts. Check RackTables wiki for more information, in particular, this page for LDAP configuration details: http://wiki.racktables.org/index.php?title=LDAP Defaults to 'database'.
#####require_local_account
String. "$require_local_account" setting in inc/secret.php. See RackTables wiki on LDAP and SAML configuration for more information: http://wiki.racktables.org/ Defaults to true.
#####pdo_bufsize
String. "$pdo_bufsize" setting in inc/secret.php. Setting MySQL client buffer size may be required to make downloading work for larger files, but it does not work with mysqlnd. Example: '50 1024 1024' Defaults to undef.
#####ldap_options
Hash. "$LDAP_options" setting in inc/secret.php. See http://wiki.racktables.org/index.php?title=LDAP for details. Defaults to undef. Example class:
class { '::racktables':
vhost => 'racktables.example.com',
release => 'RackTables-0.20.14',
user_auth_src => 'ldap',
require_local_account => false,
ldap_options => {
'server' => 'localhost',
'domain' => 'example.com',
'search_attr' => '',
'search_dn' => '',
'search_bind_rdn' => 'NULL',
'search_bind_password' => 'NULL',
'displayname_attrs' => '',
'options' => 'array (LDAP_OPT_PROTOCOL_VERSION => 3)',
'use_tls' => '2',
}
}
#####saml_options
Hash. "$SAML_options" setting in inc/secret.php. See http://wiki.racktables.org/index.php?title=SAML for details. Defaults to undef. Example class:
class { '::racktables':
vhost => 'racktables.example.com',
release => 'RackTables-0.20.14',
user_auth_src => 'saml',
require_local_account => false,
saml_options => {
'simplesamlphp_basedir' => '../simplesaml',
'sp_profile' => 'default-sp',
'usernameAttribute' => 'eduPersonPrincipName',
'fullnameAttribute' => 'fullName',
'groupListAttribute' => 'memberOf',
}
}
#####helpdesk_banner
String. "$helpdesk_banner" setting in inc/secret.php. This HTML banner is intended to assist users in dispatching their issues to the local tech support service. Its text (in its verbatim form) will be appended to assorted error messages visible in user's browser (including "not authenticated" message). Beware of placing any sensitive information here, it will be readable by unauthorized visitors. Defaults to undef.
#####ssl_cert
String. Specifies the location of SSL certification. Defaults to undef.
#####ssl_key
String. Specifies the location of the SSL key. Defaults to undef.
#####ssl_chain
String. Specifies the location of the SSL chain. Defaults to undef.
#####apacheuser
String. Specifies the apache user. Used for setting permissions to inc/secret.php. Defaults to 'apache' for RedHat/CentOS and 'www-data' for Debian/Ubuntu.
#####datadir
String. Specifies the installation path of RackTables. Defaults to '/usr/local/share/RackTables'.
#####packages
Array. Defines what prerequisities to install. Defaults are operating system specific. See params.pp for details.
#####repoensure
String. Specify the ensure parameter for vcsrepo. Setting this to 'latest' will always pull new commits to the GitHub repo, which is usefull for development environments. Use only 'present' for production installations!
Defaults to 'present'. Valid values are 'present' and 'latest'.
#####vcsprovider
String. Defines what vcs system to use for downloading RackTables. Defaults to 'git'.
#####source
String. URL to the RackTables repo. Defaults to 'https://github.com/RackTables/racktables.git'.
Reference
###Classes
####Public Classes
racktables
: Starts the module and calls racktables::apache, racktables::mysql and racktables::installracktables::apache
: Installs Apache and a specified vhostracktables::mysql
: Installs MySQL and sets up an empty databaseracktables::install
: Pulls and installs RackTables from GitHub (or other specified source)racktables::config
: Handles the inc/secret.php file
####Private Classes
racktables::params
: Default parameters
Development
###Contributing
Please use pull requests (https://github.com/sgnl05/sgnl05-racktables/pulls) for any type of contribution.
0.4.1 2018-01-15
update: secretfile set to 'template' is now customisable through the templatefile parameter
update: added templatefile parameter
deprication warning: secretfile param will be renamed to secretmode in next version
0.3.4 2018-01-15
update: harden apache security (#11) by Roman Spiak
update: added ssl_chain parameter to apache install
0.3.3 2015-10-26
update: permit user-determined secret.php contents (#8) by Matt Simmons
0.3.2 2015-03-10
update: template file for inc/secret.php complete (#7)
0.3.1 2015-03-09
bugfix: fix warning "Could not look up qualified variable '::apache::default_ssl_cert'; class ::apache has not been evaluated" on Puppet version 3.4.x.
update: added $user_auth_src and $require_local_account settings to template
update: better parameter validations
0.3.0 2015-03-07
new feature: SSL certificates (#4)
new feature: template file for inc/secret.php (#5)
update: make local database install optional (#6)
0.2.1 2015-03-04
bugfix: root password for MySQL was always set to '$mysqlrootpw'
update: use public classes for apache, mysql and racktables install
0.2.0 2015-02-05
new feature: added ability to select what RackTables version to download
update: changed secret file handling
update: changed metadata.json requirements for puppetlabs-mysql to version 3.1.0. This should fix CentOS 7 support (not tested)
0.1.4 2014-09-05
update: added php5-curl dependency for Debian/Ubuntu
0.1.3 2014-09-05
update: php5-ldap dependency for Debian/Ubuntu. Thanks Jens Rosenbloom (#2)
update: changed attribute name 'secretwriteable' to 'secretfile' and changed the installation routine to be more intuitive regarding this file
0.1.2 2014-08-01
update: added support for Debian 7 by setting 'mpm_module' to "prefork" when calling apache install
workaround: Removed Redhat/CentOS 7 support in metadata.json as current puppetlabs-mysql version is broken on CentOS 7. (#1)
0.1.1 2014-07-31
update: better documentation
0.1.0 2014-07-30
initial release
Dependencies
- puppetlabs/stdlib (>= 2.4.0)
- puppetlabs/apache (>= 1.1.1)
- puppetlabs/mysql (>= 3.1.0)
- puppetlabs/vcsrepo (>= 1.1.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 APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [2013] [Puppet Labs] 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.