Version information
Start using this module
Add this module to your Puppetfile:
mod 'xebialabs-xlrelease', '1.0.0'Learn more about managing modules with a PuppetfileDocumentation
#xlrelease
####Table of Contents
##Overview
A module that takes care of the installation and configuration regarding XL-Release by Xebialabs
##Module Description This Module is geared toward the installation and configuration of Xebialabs XL-Release. It will take care of the installation of xl-release on linux based systems as well as doing a lot of the standard configuration required to setup a production ready instance of xl-release.
##Setup
###Setup Requirements
This module requires the following:
- pluginsync enabled
- module puppetlabs-stdlib installed
- module puppetlabs-concat installed
###Beginning with [puppet-xlrelease]
##Usage
###basic installation
class{xlrelease:
install_java => true,
install_type: 'download'
xlr_download_user: '<your download user>'
xlr_download_password: '<your download password'
xlr_licsource: 'https://dist.xebialabs.com/customer/licenses/download/xl-release-license.lic'
}
this will install a basic instance of xl-release at /opt/xl-release/xl-release-server which will respond on port 5516.
###adding configuration adding a xl-deploy server to the configuration
xlrelease_xld_server{'default':
properties => { 'url' => 'http://your.xld.instance:4516/<context_root>',
'username' => 'your xld user',
'password' => 'your xld password'
}
}
adding a jenkins server to the configuration
xlrelease_config_item{'jenkins_default':
type => 'jenkins.Server',
properties => { username: "jenkins user name"
title: "title in xlr"
proxyHost: <optional proxy host .. null for no proxy>
proxyPort: <optional proxy port .. null for no port>
password: "jenkins user password"
url: 'http://your_jenkins_host_goes_here:and_the_port_here'
}
}
adding a git repo to the configuration
xlrelease_config_item{'your_git_repo':
type => 'git.Repository',
properties => { username: "git user name"
title: "title in xlr"
password: "git user password"
url: 'http://url.to.git/repo'
}
}
adding a xl-deploy server to the configuration from a different system using puppet this code could be used in a manifest when installing a xl-deploy server using puppet
xlrelease_xld_server{'default':
properties => { 'url' => "http://${fqdn}:4516/<context_root>",
'username' => 'your xld user',
'password' => 'your xld password'
}
rest_url => 'http://user:password@your.xl-release.com:5516/<something>'
}
adding a jenkins server to the configuration from a different system using puppet this code could be used in a manifest when installing a jenkins server using puppet
xlrelease_config_item{'jenkins_default':
type => 'jenkins.Server',
rest_url => 'http://user:password@your.xl-release.com:5516/<something>',
properties => { username: "jenkins user name"
title: "title in xlr"
proxyHost: <optional proxy host .. null for no proxy>
proxyPort: <optional proxy port .. null for no port>
password: "jenkins user password"
url: 'http://your_jenkins_host_goes_here:and_the_port_here'
}
}
adding a git repo to the configuration form a different system using puppet
xlrelease_config_item{'your_git_repo':
type => 'git.Repository',
rest_url => 'http://user:password@your.xl-release.com:5516/<something>',
properties => { username: "git user name"
title: "title in xlr"
password: "git user password"
url: 'http://url.to.git/repo'
}
}
###using hiera
basic installation
---
xlrelease::install_java: true
xlrelease::install_type: 'download'
xlrelease::xlr_download_user: 'get one'
xlrelease::xlr_download_password: 'not telling you that'
xlrelease::xlr_licsource: 'https://dist.xebialabs.com/customer/licenses/download/xl-release-license.lic'
adding a xl-deploy server to the configuration the module commes equiped with a hash parameters for use with hiera
---
xlrelease::xlr_xldeploy_hash:
'default':
properties:
url: "http://your.xld.instance:4516/<context_root>"
username: "your xld user"
password: "your xld password"
adding a jenkins server and a git repo to the configuration
---
xlrelease::xlr_config_item_hash:
'jenkins1':
type: 'jenkins.Server'
title: 'jenkins1'
properties:
username: "jenkins user"
title: "title in xlr"
proxyHost: <optional proxy host .. null for no proxy>
proxyPort: <optional proxy host .. null for no proxy>
password: "jenkins user password"
url: 'http://your_jenkins_host_goes_here:and_the_port_here'
'git_test1':
type: 'git.Repository'
title: 'git_test1'
properties:
username: 'git user name'
password: 'title in xlr'
url: 'http://url.to.git/repo'
title: 'title in xlr'
##Reference
####Public classes
xlrelease
#####os_user
the user that will be used to run xlr and installed on the os by the module (unless it's already there)
default: xlrelease
#####os_group
the group that will be used to run xlr and installed on the os by the module (unless it's already there)
default: xlrelease
#####tmp_dir
specifies a temporary file storage space for the module to store downloaded stuff
default: /var/tmp
#####xlr_version
specifies the version of xlr to install
default : 4.5.1
#####xlr_basedir
specifies the base installation directory for xlr
default: /opt/xl-release
#####xlr_serverhome
specifies the xlrelease server home directory
default: /opt/xl-release/xl-release-server
#####xlr_licsource
specifies where the xl-release license can be obtained
default: no help there .. sorry
#####xlr_repopath
specifies the path to the xlr repository on the filesystem
either specify a full path prefixed with file:/// or a directory relative to the server home
default: repository
#####xlr_initrepo
specifies if we should initialize the repo upon installation
default: true
#####xlr_http_port
specifies the port xlr will respond to
default: 5516
#####xlr_http_bind_address
specifies the address the instance binds to
default: 0.0.0.0 (listens to all incomming traffic)
#####xlr_http_context_root
specifies the context root xlr will respond on
default: /
#####xlr_importable_packages_path
specifies the path to the imporatble packages
either specify a full path prefixed with file:/// or a directory relative to the server home
default: importablePackages
#####xlr_ssl
specifies if the module should setup ssl traffic to the server
default: false
#####xlr_download_user
specifies the xlr download user account (can be obtaind from xebialabs)
default: undef
#####xlr_download_password
specifies the xlr download user password (can be obtained form http://www.xebialabs.com)
default: undef
#####xlr_download_proxy_url
specifies a proxy url if one is needed to obtain a direct internet connection
default: undef
#####xlr_rest_user
specifies the restuser to be used for interfacing from the module to the xlr instance
default: admin
#####xlr_rest_password
specifies the restusers password
default: xebialabs
#####xlr_admin_password
specifies the admin password xlr will be setup with
default: xebialabs
#####java_home
specifies the java_home which will be used to run xlr
default: 'RedHat' : '/usr/lib/jvm/jre-1.7.0-openjdk.x86_64'
'Debian' : '/usr/lib/jvm/java-7-openjdk-amd64'
#####install_java
specifies if java should be installed as part of this modules duties
#####install_type
specifies the type of installation method where gonna use:
default: download
choices:
download: download source from xebialabs.com (preffered)
puppetfiles: get the source from a specified puppet files location
#####puppetfiles_xlrelease_source
specifies the source location of the xlr installation for use with a puppetfiles installation type
#####custom_download_server_url
specify a custom download url (other than the standard xebialabs one provided by the module)
#####xlr_xldeploy_hash
allows for the specification of multiple xl-deploy instances in a hash format (see instructions above)
#####xlr_config_item_hash
allows for the specifiaction of multiple xl-release configuration items in a hash format (see instructions above)
####types and provider pairs xlrelease_xld_server
this resource can be used to configure a xl-deploy instance in a xlr instance
#####type
the type of ci to configure in xlr (no point in changing this on this resource !!!!)
default : 'xlrelease.DeployitServerDefinition'
#####properties
the properties the should be configured in xld
'url': the url to reach the xldeploy server on
'username': the username of the xldeploy server
'password': the password to go along with the username
#####rest_url
a url to reach the external xlr server on (which is optional)
use this if u are using this resource from a different server other than the xlr server
default: undef
xlrelease_config_item
this resource can be used to influence a configuration item in an xlr instance
#####type the type of ci to configure in xlr posiblities: jenkins.Server, git.Repository (amongst others ... this has to be valid in xlr) #####properties the properties the should be configured in xld (dependent on the type) #####rest_url a url to reach the external xlr server on (which is optional) use this if u are using this resource from a different server other than the xlr server default: undef
##Limitations
###os compatibility
- Debian (all recent versions)
- Ubuntu (all recent versions) 12.02 and 14.02 supported
- Redhat (6&7 supported)
- CentOS (6&7 supported)
###xlrelease compatibility versions 4.0.13 and 4.5.1 tested ##Development
- No real rules yet, but a test set will be setup pretty soon.
- Pull requests will be evaluated and if they make sense they will be incorporated in the module
##Release Notes/Contributors/Etc Optional
###Maintainers
- Wian Vos
###Contributors
- Wian Vos
help wanted
Types in this module release
YYYY-MM-DD Release 0.0.1
- something you did
- something else you did
Dependencies
- puppetlabs/stdlib (>= 4.1.0)
- puppetlabs/inifile (>= 1.0.0)
- puppetlabs/concat (>= 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 [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.