REFERENCE.md

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 class
• artifactory::install::archive: Install artifactory from archive
• artifactory::install::package: Install artifactory from package
• artifactory::repo: Pull in the platform specific repo classes
• artifactory::repo::apt: Setup APT repository on Debian-based distributions
• artifactory::repo::yum: Setup YUM repository on RedHat-based distributions
• artifactory::service: Configure the Artifactory system service.

Classes

artifactory

Install and configure Artifactory.

Parameters

The following parameters are available in the artifactory class:

• apt_baseurl
• apt_baseurl_pro
• apt_key_id
• apt_key_source
• apt_repos
• archive_data_dir
• archive_install_dir
• artifactory_home
• binary_provider_base_data_dir
• binary_provider_cache_dir
• binary_provider_cache_maxsize
• binary_provider_config_hash
• binary_provider_filesystem_dir
• binary_provider_type
• config_group
• config_owner
• db_password
• db_type
• db_url
• db_username
• download_filename
• download_url_oss
• download_url_pro
• edition
• install_method
• install_service_script
• jdbc_driver_url
• license_key
• manage_repo
• master_key
• package_name
• package_name_pro
• package_version
• pool_max_active
• pool_max_idle
• root_password
• service_name
• symlink_name
• use_temp_db_secrets
• yum_baseurl
• yum_baseurl_pro
• yum_gpgkey
• yum_gpgkey_pro
• yum_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