Version information
This version is compatible with:
- Puppet Enterprise 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x
- Puppet >= 7.0.0 < 9.0.0
- , , ,
Start using this module
Add this module to your Puppetfile:
mod 'markt-artifactory', '4.0.0'Learn more about managing modules with a PuppetfileDocumentation
puppet-artifactory
Table of Contents
Overview
This module installs and configures JFrog Artifactory. Both the open source and commercial editions are supported.
Artifactory 7+ is recommended, but legacy support for Artifactory 6 is still available.
Usage
Basic usage
To setup Artifactory with default options only the desired version needs to be specified:
class { 'artifactory':
package_version => '7.90.7',
}
By default this module will install Artifactory from official RPM/DEB packages.
Archive installation
It is also possible to install Artifactory from the official tar.gz archive, which provides more flexibility and customization options:
class { 'artifactory':
install_method => 'archive',
package_version => '7.90.7',
}
The archive installation allows to customize installation paths, see reference for details.
Commercial editions
To install a commercial version of Artifactory:
class { 'artifactory':
edition => 'pro',
license_key => 'ABCDEFG1234567890',
package_version => '7.90.7',
...
}
Complex example
class { 'artifactory':
binary_provider_type => 'filesystem',
binary_provider_cache_dir => '/var/opt/jfrog/artifactory/',
binary_provider_cache_maxsize => $binary_provider_cache_maxsize,
binary_provider_filesystem_dir => '/var/opt/jfrog/artifactory/data/filestore',
db_type => 'oracle',
db_url => 'jdbc:oracle:thin:@somedomain.com:1521:arti001',
db_username => 'my_username',
db_password => 'efw23gn2j3',
jdbc_driver_url => 'puppet:///modules/my_module/mysql.jar',
package_version => '7.90.7',
pool_max_active => 100,
pool_max_idle => 10,
}
Reference
Classes and parameters are documented in REFERENCE.md.
Development
Contributing
Please use the GitHub issues functionality to report any bugs or requests for new features. Feel free to fork and submit pull requests for potential contributions.
All contributions must pass all existing tests, new features should provide additional unit/acceptance tests.
License
This module is a fork of fervidus/artifactory.
Copyright 2024 markt.de GmbH & Co. KG
Copyright 2016-2021 Bryan Belanger
Reference
Table of Contents
Classes
Public Classes
artifactory: Install and configure Artifactory.
Private Classes
artifactory::config: Manage Artifactory configuration.artifactory::install: Call the configured installation classartifactory::install::archive: Install artifactory from archiveartifactory::install::package: Install artifactory from packageartifactory::repo: Pull in the platform specific repo classesartifactory::repo::apt: Setup APT repository on Debian-based distributionsartifactory::repo::yum: Setup YUM repository on RedHat-based distributionsartifactory::service: Configure the Artifactory system service.
Classes
artifactory
Install and configure Artifactory.
Parameters
The following parameters are available in the artifactory class:
apt_baseurlapt_baseurl_proapt_key_idapt_key_sourceapt_reposarchive_data_dirarchive_install_dirartifactory_homebinary_provider_base_data_dirbinary_provider_cache_dirbinary_provider_cache_maxsizebinary_provider_config_hashbinary_provider_filesystem_dirbinary_provider_typeconfig_groupconfig_ownerdb_passworddb_typedb_urldb_usernamedownload_filenamedownload_url_ossdownload_url_proeditioninstall_methodinstall_service_scriptjdbc_driver_urllicense_keymanage_repomaster_keypackage_namepackage_name_propackage_versionpool_max_activepool_max_idleroot_passwordservice_namesymlink_nameuse_temp_db_secretsyum_baseurlyum_baseurl_proyum_gpgkeyyum_gpgkey_proyum_name
apt_baseurl
Data type: Optional[String]
Sets the URL of the APT repository.
Default value: undef
apt_baseurl_pro
Data type: Optional[String]
Sets the URL of the APT repository (Pro edition).
Default value: undef
apt_key_id
Data type: Optional[String]
Sets the ID of the APT repository key.
Default value: undef
apt_key_source
Data type: Optional[String]
Sets the URL of the APT repository.
Default value: undef
apt_repos
Data type: Optional[String]
Sets the names of the APT repositories to enable.
Default value: undef
archive_data_dir
Data type: Stdlib::Absolutepath
The Artifactory data directory that should be used for archive installations.
archive_install_dir
Data type: Stdlib::Absolutepath
The Artifactory app directory that should be used for archive installations.
artifactory_home
Data type: String
Specifies the main directory.
binary_provider_base_data_dir
Data type: Optional[String]
The filestore base location. Defaults to '$ARTIFACTORY_HOME/data'.
Default value: undef
binary_provider_cache_dir
Data type: Optional[String]
The location of the cache. This should be set to the $ARTIFACTORY_HOME directory (not on NFS).
Default value: undef
binary_provider_cache_maxsize
Data type: Optional[Integer]
This value specifies the maximum cache size (in bytes) to allocate for caching BLOBs.
Default value: undef
binary_provider_config_hash
Data type: Optional[Hash]
A hash containing configuration options for the binary provider.
Default value: undef
binary_provider_filesystem_dir
Data type: Optional[String]
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.
Default value: undef
binary_provider_type
Data type: Optional[Enum['filesystem', 'fullDb', 'cachedFS', 'fullDbDirect', 's3']]
Optional setting for the binary storage provider. The type of database to configure. Valid values are 'filesystem', 'fullDb', 'cachedFS', 'S3'. Defaults to 'filesystem'.
Default value: undef
config_group
Data type: String
Specifies the group owner of the configuration files.
config_owner
Data type: String
Specifies the owner of the configuration files.
db_password
Data type: Optional[String]
The password for the database account. Only required for database configuration.
Default value: undef
db_type
Data type: Optional[Enum['derby', 'mariadb', 'mssql', 'mysql', 'oracle', 'postgresql']]
The type of database to configure. Only required for database configuration.
Default value: undef
db_url
Data type: Optional[String]
The url of the database. Only required for database configuration.
Default value: undef
db_username
Data type: Optional[String]
The username for the database account. Only required for database configuration.
Default value: undef
download_filename
Data type: String
The filename of the archive distribution.
download_url_oss
Data type: String
The download URL for the open-source edition.
download_url_pro
Data type: String
The download URL for the pro edition.
edition
Data type: Enum['oss', 'pro', 'enterprise']
Specifies the Artifactory edition/license.
install_method
Data type: String
Whether to use a package or an archive to install artifactory.
install_service_script
Data type: String
Path to the installation script of the archive distribution.
jdbc_driver_url
Data type: Optional[String]
Sets the download location for the jdbc driver.
Default value: undef
license_key
Data type: Optional[String]
Specifies the license key (only commercial editions).
Default value: undef
manage_repo
Data type: Boolean
Whether to setup required repos or disable repo management.
master_key
Data type: Optional[String]
The master key that Artifactory uses to connect to the database. If specified, it ensures that if the 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.
Default value: undef
package_name
Data type: String
Sets the package name to install.
package_name_pro
Data type: String
Sets the package name to install (Pro edition).
package_version
Data type: String
Specifies the package version. It is highly recommended to set it to
a real version number. Setting the value to present may lead to a
broken config.
pool_max_active
Data type: Optional[Integer]
Maximum number of pooled database connections.
Default value: undef
pool_max_idle
Data type: Optional[Integer]
Maximum number of pooled idle database connections.
Default value: undef
root_password
Data type: String
Sets the root password for Puppet managed mysql database instance.
service_name
Data type: String
Specifies the name of the Artifactory system service.
symlink_name
Data type: String
Controls the name of a version-independent symlink for the archive
installation. It will always point to the release specified by $package_version.
use_temp_db_secrets
Data type: Boolean
Set to true to delete the temporary db.properties file on service start.
Set to false to persist the file in $artifactory_home/etc/db.properties,
which will allow to add database and storage options without Puppet
touching it.
yum_baseurl
Data type: Optional[String]
Sets the URL of the yum repository.
Default value: undef
yum_baseurl_pro
Data type: Optional[String]
Sets the URL of the yum repository (Pro edition).
Default value: undef
yum_gpgkey
Data type: Optional[String]
Sets the gpgkey URL of the yum repository.
Default value: undef
yum_gpgkey_pro
Data type: Optional[String]
Sets the gpgkey URL of the yum repository (Pro edition).
Default value: undef
yum_name
Data type: Optional[String]
Sets the name of the yum repository.
Default value: undef
Changelog
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
v4.0.0 - 2024-08-13
Added
- Add support for new installation method 'archive'
- Add support for Debian repository (#FV24)
- Add support for S3 binary store (#FV25)
- Enable GitHub Actions
Changed
- Remove default value for parameter
$package_version - Move default values to module data (Hiera)
- Move hardcoded YUM gpgkey to Hiera
- Update OS support and dependencies
- Convert documentation to Puppet Strings
- Update to PDK 3.2.0
- Update documentation
- Migrate unit tests to artifactory v7
Fixed
- Revive unit and acceptance tests
- Fix puppet-lint/rubocop offenses
Removed
- Remove support for setting up a MySQL server instance
- Remove dependency: puppetlabs/mysql
Dependencies
- puppetlabs/apt (>= 9.4.0 < 10.0.0)
- puppet/archive (>= 6.1.1 < 8.0.0)
- puppetlabs-yumrepo_core (>= 2.0.0 <= 3.0.0)
- puppetlabs-stdlib (>= 9.0.0 < 10.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.