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.4.0 < 6.0.0
- ,
This module has been deprecated by its author since Oct 28th 2019.
The author has suggested fervid-artifactory as its replacement.
Start using this module
Documentation
Table of Contents
- Overview
- Module Description - What the module does and why it is useful
- Setup - The basics of getting started with artifactory
- 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 ONLY install Artifactory OSS.
If you are looking for the commercial installation look at:
Artifactory PRO: https://forge.puppet.com/autostructure/artifactory_pro
Artifactory HA: https://forge.puppet.com/autostructure/artifactory_ha
Github and gitlab are great for storing source control, but bad at storing installers and compiled packages.
This is where Artifactory comes in. It stores all of your organizations artifacts in an organized and secure manner.
Module Description
The Artifactory module installs, configures, and manages the Artifactory open source binary repository.
The Artifactory module manages both the installation and database configuration of Artifactory OSS.
Setup
Beginning with artifactory
If you want a server installed with the default options you can run
include '::artifactory'.
If you need to add database connectivity instantiate with the required parameters:
class { '::artifactory':
jdbc_driver_url => 'puppet:///modules/my_module/mysql.jar',
db_type => 'oracle',
db_url => 'jdbc:oracle:thin:@somedomain.com:1521:arti001',
db_username => 'my_username',
db_password => 'efw23gn2j3',
binary_provider_type => 'filesystem',
pool_max_active => 100,
pool_max_idle => 10,
binary_provider_cache_maxsize => $binary_provider_cache_maxsize,
binary_provider_filesystem_dir => '/var/opt/jfrog/artifactory/data/filestore',
binary_provider_cache_dir => '/var/opt/jfrog/artifactory/',
}
Usage
All interaction for the server is done via ::artifactory.
Reference
Classes
Public classes
artifactory: Installs and configures Artifactory.
Private classes
artifactory::yum: Installs yum configuration.artifactory::install: Installs packages.artifactory::config: Configures Artifactory.artifactory::service: Manages service.artifactory::mysql: Manages an automated mysql database
Parameters
artifactory
yum_name
Sets the name of the yum repository. Defaults to 'bintray-jfrog-artifactory-rpms'.
This can be changed if Artifactory needs to be setup from a different repository. Typically this is done if an organization has a 'trusted' yum repo.
yum_baseurl
Sets the base url of the yum repository to name. Defaults to 'http://jfrog.bintray.com/artifactory-rpms'.
This can be changed if Artifactory needs to be setup from a different repository. Typically this is done if an organization has a 'trusted' yum repo.
package_name
Sets the package name to install. Defaults to 'jfrog-artifactory-oss'.
This can be changed if Artifactory needs to install a differently named package. Possibly needed if na organization creates their own Artifactory package.
package_version
Sets the package version to. Defaults to 'present'.
This can be changed if you need to install a specific version. It takes the same values allowed for the ensure parameter of the standard package resource type.
manage_java
Tells the module whether or not to manage the java class. This defaults to true. Usually this is what you want.
If your organization actively manages the java installs across your environment set this to false.
root_password
Sets the root password for Puppet managed mysql database
jdbc_driver_url
Sets the location for the jdbc driver. The built-in file type is used to retrieve the driver.
This is required if using a new data source.
db_automate
Set to 'true' if you want Puppet to create a database. Only works with mysql. If true, we recommend using JDBC connector version 5.1.24. NOTE: Puppet may throw an error the first run while it waits for Artifactory to connect to database
db_type
Only required for database configuration. The type of database to configure for. Valid values are 'mssql', 'mysql', 'oracle', 'postgresql'.
db_url
Only required for database configuration. The url of the database.
db_username
Only required for database configuration. The username for the database account.
db_password
Only required for database configuration. The password for the database account.
binary_provider_type
Optional setting for the binary storage provider. The type of database to configure for. Valid values are 'filesystem', 'fullDb', 'cachedFS', 'S3'. Defaults to 'filesystem'.
filesystem (default)
This means that metadata is stored in the database, but binaries are stored in the file system. The default location is under $ARTIFACTORY_HOME/data/filestore however this can be modified.
fullDb
All the metadata and the binaries are stored as BLOBs in the database, objects are cached as in cachedFS.
cachedFS
Works the same way as filesystem but also has a binary LRU (Least Recently Used) cache for upload/download requests. Improves performance of instances with high IOPS (I/O Operations) or slow NFS access.
S3
This is the setting used for S3 Object Storage.
fullDbDirect
All the metadata and the binaries are stored as BLOBs in the database. No caching occurs.
pool_max_active
Optional setting for the maximum number of pooled database connections. Defaults to 100.
pool_max_idle
Optional setting for the maximum number of pooled idle database connections Defaults to 10.
binary_provider_cache_maxsize
Optional setting for the maximum cache size. This value specifies the maximum cache size (in bytes) to allocate on the system for caching BLOBs.
binary_provider_base_data_dir
Optional setting for the artifactory filestore base location. Defaults to '$ARTIFACTORY_HOME/data'.
binary_provider_filesystem_dir
Optional setting for the artifactory filestore location. If the binary.provider.type is set to filesystem this value specifies the location of the binaries in combination with binary_provider_base_data_dir. Defaults to 'filestore'.
binary_provider_cache_dir
Optional setting for the location of the cache. This should be set to your $ARTIFACTORY_HOME directory directly (not on the NFS).
master_key
Optional setting for the master key that Artifactory uses to connect to the database. If specified, it ensures that if your node terminates, a new one can be spun up that can connect to the same database as before. Otherwise, Artifactory will generate a new master key on first run.
Limitations
This module has been tested on:
- RedHat Enterprise Linux 5, 6, 7
- CentOS 5, 6, 7
Development
Since your module is awesome, other users will want to play with it. Let them know what the ground rules for contributing are.
Contributors
To see who's already involved, see the list of contributors.
2019-20-05 Release 2.1.0
- Database secrets are now read from a temporary file, allowing for encrypted passwords
- Master key for database can now be specified to re-use an existing database
- Module can now provision a Mysql database and connect it to Artifactory
- Smoothed out install script for better compatability with database
2018-22-08 Release 2.0.16
- Refactored for PDK and ensured all test pass.
2018-13-08 Release 2.0.14
- Refactored for PDK and ensured all test pass.
2018-03--14 Release 2.0.13
- Remove OJDBC JAR file and ha-node prop files
- Make artifactory version configurable
2018-02-28 Release 2.0.12
- Added fix for manage_java = false dependency
- Added enhancement for derby usage
2017-03-21 Release 2.0.9
- Fix simple puppet linter problems
2017-03-21 Release 2.0.8
- Change from wget to file type to grab binary drivers
2016-08-14 Release 2.0.7
- Fix JDBC permissions
2016-08-14 Release 2.0.5
- JDBC driver added as owner root, not artifactory
2016-07-26 Release 2.0.0
- Remove db_hostname and db_port. Use db_url instead.
2016-07-22 Release 1.0.5
- Added active management of java to module
2016-07-22 Release 1.0.3
- Added shields and final travis-ci tests
Dependencies
- puppetlabs-yumrepo_core (>= 1.0.0 <= 2.0.0)
- puppetlabs-mysql (>= 8.0.0 <= 9.0.0)
- puppetlabs-java (>= 1.5.0 <= 3.0.0)
- puppetlabs-stdlib (>= 4.0.0 < 6.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.