Version information
This version is compatible with:
- Puppet Enterprise 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
- Puppet >=4.7.0 <6.0.0
Start using this module
Add this module to your Puppetfile:
mod 'kpn-wildfly', '1.2.1'
Learn more about managing modules with a PuppetfileDocumentation
wildfly
Table of Contents
- Description
- Setup - The basics of getting started with wildfly
- 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
Description
This Wildfly module lets you use Puppet to install, deploy and configure multiple WildFly's (standalone only).
The module is based/uses code from the following modules:
- biemond-wildfly: https://github.com/biemond/biemond-wildfly
- puppetlabs-tomcat: https://github.com/puppetlabs/puppetlabs-tomcat
The best scenario would have been incorporating this code in the biemond-wildfly module, it is an issue: https://github.com/biemond/biemond-wildfly/issues/149
But we decided to give it our own twist and release this module, it is in NO WAY a real alternative to the biemond-wildfly module, it lacks a lot of features we would like to add, by releasing it to the public we hope to get movement on this module and improve the quality. Be free to test this release and make (major) PR's available for us.
Setup
What wildfly affects
It will install a WildFly version by your choice in a given directory.
Setup Requirements
This module requires the following modules:
Beginning with wildfly
This module is multi-based, it is not possible to just include the module and be done with it. It requires at least these lines of code to get a working installation.
Usage
The most basic usage would be the following:
wildfly::install { 'wildfly8':
catalina_home => '/opt/wildfly8',
source => 'http://download.jboss.org/wildfly/8.2.1.Final/wildfly-8.2.1.Final.tar.gz',
}
wildfly::instance { 'wildfly8':
catalina_home => '/opt/wildfly8',
manage_service => true,
port_properties => { "management-http" => 19990, "management-https" => 19993, "ajp" => 18009, "http" => 18080, "https" => 18443, },
}
This will install WildFly version 8 in /opt/wildfly8 with custom portnumbers. Note that the 'catalina_home' variable is the leading variable which determines which WildFly instance is configured.
Parameters wildfly class
catalina_home
Type: Path\
Default: /opt/wildfly
\
Values: Any valid path\
Description: Specifies the path to install WildFly
user
Type: string\
Default: wildfly
\
Values: a string value\
Description: Specifies the user under which the WildFly instance should run, when manage_user
is set to true the user will be created
group
Type: string\
Default: wildfly
\
Values: a string value\
Description: Specifies the group under which the WildFly instance should run, when manage_group
is set to true the group will be created
manage_user
Type: boolean\
Default: true\
Values: true/false\
Description: Specifies whenever to create or not the user defined in user
manage_group
Type: boolean\
Default: true\
Values: true/false\
Description: Specifies whenever to create or not the group defined in group
manage_base
Type: boolean\
Default: true\
Values: true/false\
Description: Specifies whenever to create or not the directory defined in catalina_home
mgmt_user
Type: hash\ Default: { 'username' => 'puppet', 'password' => fqdn_rand_string(30) }\ Values: hash with username and password as a string\ Description: Specifies the managment user and password
port_properties
Type: hash\ Default: { 'management-http' => 9990, 'management-https' => 9993, 'ajp' => 8009, 'http' => 8080, 'https' => 8443 }\ Values: hash with numeric values for port nummers\ Description: Specifies portnumbers for management-http, management-https, ajp, http and https
ip_properties
Type: hash\ Default: { 'management' => '127.0.0.1', 'public' => '127.0.0.1' }\ Values: hash with ipaddresses for management and public as a ip4 ip address\ Description: Specifies the managment and public ipaddress as a ip4 ip address
Parameters wildfly::install define
catalina_home
Type: Path\
Default: title of this define
\
Values: Any valid path\
Description: Specifies the path to install WildFly must be unique for multiple instances
install_from_source
Type: boolean\ Default: true\ Values: true/false\ Description: Specifies to install WildFly from a tar.gz file when true or from a package when false
source
Type: string\ Default: undef\ Values: an url to the instalation file for a WildFly or JDBC-driver\ Description: Specifies the url for an installation of WildFly (which should be a tar.gz file) or a JDBCD-driver (which should be a jar-file)
checksum
Type: string\ Default: undef\ Values: a sha256 value\ Description: Specifies the checksum_type checksum of the source specified
checksum_type
Type: list\ Default: sha256\ Values: sha1, sha256, sha512\ Description: Specifies the checksumtype to use for calculating the checksum
source_strip_first_dir
Type: boolean\ Default: true\ Values: true/false\ Description: Specifies that the first directory from the archive is stripped, most archives require this
proxy_type
Type: string\ Default: undef\ Values: undef, http, https, ftp\ Description: Specifies the proxy server type used by proxy_server. Normally this defaults to the protocol specified in the proxy_server URI
proxy_server
Type: string\ Default: undef\ Values: proxy-server\ Description: Specifies a proxy server to use when downloading WildFly binaries
allow_insecure
Type: boolean\ Default: false\ Values: true/false\ Description: Specifies if a https-url needs to secure (certificate check ok)
user
Type: string\
Default: $::wildfly::user
\
Values: a string value\
Description: Specifies the user under which the WildFly instance should run, when manage_user
is set to true the user will be created
group
Type: string\
Default: $::wildfly::group
\
Values: a string value\
Description: Specifies the group under which the WildFly instance should run, when manage_group
is set to true the group will be created
manage_user
Type: boolean\
Default: $::wildfly::manage_user
\
Values: true/false\
Description: Specifies whenever to create or not the user defined in user
manage_group
Type: boolean\
Default: $::wildfly::manage_group
\
Values: true/false\
Description: Specifies whenever to create or not the group defined in group
manage_base
Type: boolean\
Default: $::wildfly::manage_base
\
Values: true/false\
Description: Specifies whenever to create or not the directory defined in catalina_home
package_ensure
Type: string\
Default: undef\
Values: present/absent\
Description: Specifies if the package should be present or absent, only valid when install_from_source
is set to false
package_name
Type: string\
Default: undef\
Values: package name\
Description: Specifies the name of the package to install, only valid when install_from_source
is set to false
package_options
Type: string\ Default: undef\ Values: options\ Description: Specifies options for when installing a package
Parameters wildfly::instance define
catalina_home
Type: Path\
Default: $::wildfly::catalina_home
\
Values: Any valid path\
Description: Specifies the path to install WildFly
user
Type: string\
Default: $::wildfly::user
\
Values: a string value\
Description: Specifies the user under which the WildFly instance should run, when manage_user
is set to true the user will be created
group
Type: string\
Default: $::wildfly::group
\
Values: a string value\
Description: Specifies the group under which the WildFly instance should run, when manage_group
is set to true the group will be created
manage_user
Type: boolean\
Default: $::wildfly::manage_user
\
Values: true/false\
Description: Specifies whenever to create or not the user defined in user
manage_group
Type: boolean\
Default: $::wildfly::group
\
Values: true/false\
Description: Specifies whenever to create or not the group defined in group
manage_service
Type: boolean\ Default: true\ Values: true/false\ Description: Specifies whenever to enable the WildFly instance
port_properties
Type: hash\
Default: $::wildfly::port_properties
\
Values: hash with numeric values for port nummers\
Description: Specifies portnumbers for management-http, management-https, ajp, http and https
ip_properties
Type: hash\
Default: $::wildfly::ip_properties
\
Values: hash with ipaddresses for management and public as a ip4 ip address\
Description: Specifies the managment and public ipaddress as a ip4 ip address
java_home
Type: path\ Default: undef\ Values: none\ Description: Specifies the path for the Java installation to use
java_opts
Type: string\ Default: undef\ Values: none\ Description: Specifies the options for Java
java_xms
Type: string\
Default: 256m
\
Values: any\
Description: Specifies the xms setting for Java
java_xmx
Type: string\
Default: 512m
\
Values: any\
Description: Specifies the xmx setting for Java
remote_debug
Type: boolean\ Default: false\ Values: any\ Description: Specifies whenever to enable a debug port
remote_debug_port
Type: integer\ Default: 8787\ Values: port-number\ Description: Specifies the portnumber for the debug port
Parameters wildfly::resource define
mgmt_user
Type: hash\
Default: $::wildfly::mgmt_user
\
Values: hash with username and password as a string
Description: Specifies the managment user and password
port_properties
Type: hash\
Default: $::wildfly::port_properties
\
Values: hash with numeric values for port nummers\
Description: Specifies portnumbers for management-http, management-https, ajp, http and https
ip_properties
Type: hash\
Default: $::wildfly::ip_properties
\
Values: hash with ipaddresses for management and public as a ip4 ip address\
Description: Specifies the managment and public ipaddress as a ip4 ip address
ensure
Type: Enum[String]\
Default: present
\
Values: |present/absent\
Description: Specifies wheter the resource should be present or absent
recursive
Type: boolean\ Default: false\ Values: true / false\ Description: Specifies whether it should manage the resource recursively or not
undefine_attributes
Type: boolean\ Default: false\ Values: true / false\ Description: Specifies Whether it should undefine attributes with undef value
content
Type: hash\
Default: empty
\
Values: hash with content/state\
Description: Specifies Sets the content/state of the target resource
operation_headers
Type: hash\
Default: empty
\
Values: hash with operation headers\
Description: Specifies Sets operation-headers
(e.g. { 'allow-resource-service-restart' => true, 'rollback-on-runtime-failure' => false, 'blocking-timeout' => 600}
)
to be used when creating/destroying this resource.
profile
Type: string\ Default: undef\ Values: name of the target profile\ Description: Specifies Sets the target profile to prefix resource name. Requires domain mode
Parameters wildfly::service define
service_ensure
Type: Enum[String]\
Default: running
\
Values: running / stopped\
Description: Specifies wheter the service should be running or stopped
service_enable
Type: boolean\ Default: true\ Values: true / false\ Description: Specifies whether the service should be started after a reboot
service_name
Type: string\ Default: $title\ Values: valid string with the name of the service\ Description: Specifies the name of the service
Parameters wildfly::cli define
command
Type: string\ Default: $title\ Values: valid command to execute\ Description: Specifies The actual command to execute
unless
Type: string\
Default: cmd to check status\
Values: valid command to execute\
Description: If this parameter is set, then this cli
will only run if this command condition is met
onlyif
Type: string\
Default: cmd to check status\
Values: valid command to execute\
Description: If this parameter is set, then this cli
will run unless this command condition is met
mgmt_user
Type: hash\ Default: { 'username' => 'puppet', 'password' => fqdn_rand_string(30) }\ Values: hash with username and password as a string\ Description: Specifies the managment user and password
port_properties
Type: hash\ Default: { 'management-http' => 9990, 'management-https' => 9993, 'ajp' => 8009, 'http' => 8080, 'https' => 8443 }\ Values: hash with numeric values for port nummers\ Description: Specifies portnumbers for management-http, management-https, ajp, http and https
ip_properties
Type: hash\ Default: { 'management' => '127.0.0.1', 'public' => '127.0.0.1' }\ Values: hash with ipaddresses for management and public as a ip4 ip address\ Description: Specifies the managment and public ipaddress as a ip4 ip address
Parameters wildfly::datasource::driver define
dependencies
Type: array\ Default: undef\ Values: array os strings\ Description: Specifies the dependencies for a module in WildFly
driver_name
Type: string\ Default: undef\ Values: name of the driver\ Description: Specifies the name of the driver
driver_module_name
Type: string\ Default: undef\ Values: name of the module driver\ Description: Specifies the name of the module driver
Example
Add datasource
wildfly::config::module { 'org.postgresql:/opt/wildfly10':
source => 'https://jdbc.postgresql.org/download/postgresql-42.1.4.jar',
checksum => '4523ed32e9245e762e1df9f0942a147bece06561770a9195db093d9802297735',
dependencies => ['javax.api',
'javax.transaction.api'],
}
wildfly::datasources::driver { 'Driver postgresql:/opt/wildfly10':
driver_name => 'postgresql',
driver_module_name => 'org.postgresql',
driver_xa_datasource_class_name => 'org.postgresql.xa.PGXADataSource',
port_properties => { 'management-http' => 39990, 'management-https' => 39993, 'ajp' => 38009, 'http' => 38080, 'https' => 38443, },
}
wildfly::datasources::datasource { 'DemoDS:/opt/wildfly10':
config => {
'driver-name' => 'postgresql',
'connection-url' => 'jdbc:postgresql://localhost/postgres',
'jndi-name' => 'java:jboss/datasources/DemoDS',
},
port_properties => { 'management-http' => 39990, 'management-https' => 39993, 'ajp' => 38009, 'http' => 38080, 'https' => 38443, },
}
Reference
Here, include a complete list of your module's classes, types, providers, facts, along with the parameters for each. Users refer to this section (thus the name "Reference") to find specific details; most users don't read it per se.
Limitations
This is where you list OS compatibility, version compatibility, etc. If there are Known Issues, you might want to include them under their own heading here.
Development
Since your module is awesome, other users will want to play with it. Let them know what the ground rules for contributing are.
Release Notes/Contributors/Etc. Optional
If you aren't using changelog, put your release notes here (though you should
consider using changelog). You can also add any additional sections you feel
are necessary or important to include here. Please use the ##
header.
Reference
Here, include a complete list of your module's classes, types, providers, facts, along with the parameters for each. Users refer to this section (thus the name "Reference") to find specific details; most users don't read it per se.
Limitations
This module only works on RedHat 6 and 7, this is due to the limitations of WildFly (V11 and higher) and it's support for Java 1.7
Development
You can contribute by submitting issues, providing feedback and joining the discussions.
Go to: https://github.com/kpn-puppet/puppet-kpn-wildfly
If you want to fix bugs, add new features etc:
- Fork it
- Create a feature branch ( git checkout -b my-new-feature )
- Apply your changes and update rspec tests
- Run rspec tests ( bundle exec rake spec )
- Commit your changes ( git commit -am 'Added some feature' )
- Push to the branch ( git push origin my-new-feature )
- Create new Pull Request
Types in this module release
2019-03-25 Release 1.2.1
- fix support for unsecure interface in wildfly version 10
2019-02-15 Release 1.2.0
- add support for jacorb socket bindings
2019-02-11 Release 1.1.0
- add security domains
- add port properties
- add security options for multi instances
- add bind settings
2018-03-16 Release 1.0.0
- Move to version 1.0.0
- Support for Puppet 5
2017-11-13 Release 0.1.0
- Initial release of the module WildFly for the Puppet Forge
- Based on biemond-wildfly and puppetlabs-tomcat
- No way is this module complete or perfect
Dependencies
- puppetlabs/stdlib (>=4.13.1 <5.0.0)
- puppet/archive (>=2.0.0 <3.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 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 [yyyy] [name of copyright owner] 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.