Skip to content

Latest commit

 

History

History
387 lines (204 loc) · 6.51 KB

REFERENCE.md

File metadata and controls

387 lines (204 loc) · 6.51 KB

Reference

Table of Contents

Classes

Classes

artifactory

artifactory: See README.md for documentation.

Parameters

The following parameters are available in the artifactory class.

edition

Data type: Enum['oss', 'pro', 'enterprise']

The edition to install from open source to professional.

Default value: 'oss'

manage_repo

Data type: Boolean

True if the apt repo should be managed and false otherwise.

Default value: true

use_temp_db_secrets

Data type: Boolean

Use a temp db.

Default value: true

yum_name

Data type: String

The name of the rpm for yum.

Default value: 'bintray-jfrog-artifactory-rpms'

yum_baseurl

Data type: String

The url for the yum repository.

Default value: 'https://jfrog.bintray.com/artifactory-rpms'

yum_baseurl_pro

Data type: String

The url for the yum pro repsitory.

Default value: 'https://jfrog.bintray.com/artifactory-pro-rpms'

debian_name

Data type: String

The name of the debian folder.

Default value: 'bintray-jfrog-artifactory-debs'

debian_baseurl

Data type: String

The base url for debian downloads.

Default value: 'https://jfrog.bintray.com/artifactory-debs'

debian_baseurl_pro

Data type: String

The base url for the pro debian downloads.

Default value: 'https://jfrog.bintray.com/artifactory-pro-debs'

package_name

Data type: String

The name of the package for open source.

Default value: 'jfrog-artifactory-oss'

package_name_pro

Data type: String

The name of the package for the pro version.

Default value: 'jfrog-artifactory-pro'

package_version

Data type: String

The version of the package.

Default value: 'present'

artifactory_home

Data type: String

The home directory for artifactory.

Default value: '/var/opt/jfrog/artifactory'

config_owner

Data type: String

The owner of the configuration.

Default value: 'artifactory'

config_group

Data type: String

The group woner of the configuration.

Default value: 'artifactory'

root_password

Data type: String

The root password for artifactory.

Default value: 'password'

jdbc_driver_url

Data type: Optional[String]

The url to download jdbc driver.

Default value: undef

db_type

Data type: Optional[Enum[ 'derby', 'mariadb', 'mssql', 'mysql', 'oracle', 'postgresql', ]]

The database type.

Default value: undef

db_url

Data type: Optional[String]

The url to the database.

Default value: undef

db_username

Data type: Optional[String]

The database username.

Default value: undef

db_password

Data type: Optional[String]

The database password.

Default value: undef

db_automate

Data type: Boolean

True if to automate the db and false otherwise.

Default value: false

binary_provider_type

Data type: Optional[Enum[ 'filesystem', 'fullDb', 'cachedFS', 'fullDbDirect', ]]

The type of binary to use.

Default value: undef

pool_max_active

Data type: Optional[Integer]

The max pool size.

Default value: undef

pool_max_idle

Data type: Optional[Integer]

The max idel pool size.

Default value: undef

binary_provider_cache_maxsize

Data type: Optional[Integer]

The binary provider's max cache size.

Default value: undef

binary_provider_base_data_dir

Data type: Optional[String]

The binary provider's base data directory.

Default value: undef

binary_provider_filesystem_dir

Data type: Optional[String]

The binary provider's filesystem dir.

Default value: undef

binary_provider_cache_dir

Data type: Optional[String]

The binary provider's cache dir.

Default value: undef

master_key

Data type: Optional[String]

The master key.

Default value: undef

license_key

Data type: Optional[String]

The license key.

Default value: undef

install_apache

Data type: Boolean

Installs an apache server and configures a vhost to proxy to artifactory.

Default value: false

servername

Data type: Optional[String]

Sets the Apache server name via Apache's ServerName directive

Default value: undef

serveradmin

Data type: Optional[String]

Specifies the email address Apache displays when it renders 1 of its error pages.

Default value: undef

use_ssl

Data type: Boolean

If true, configures apache to use SSL. Port 80 is rewrittent o 443.

Default value: false

ssl_cert

Data type: Optional[String]

The public certificate.

Default value: undef

ssl_key

Data type: Optional[String]

The private ssl certificate.

Default value: undef

ssl_chain

Data type: Optional[String]

The SSL certificate authority.

Default value: undef

artifactory_system_properties

Data type: Optional[Array[String]]

The system properties for artifactory.

Default value: undef

artifactory::apache

Sets up an apache proxy.

artifactory::apt

Sets up the debian repository to install artifactory.

artifactory::config

== Class artifactory::config

This class is called from artifactory for service config.

artifactory::install

== Class artifactory::install

This class is called from artifactory for install.

artifactory::mysql

Manages mysql server if automated

artifactory::service

== Class artifactory::service

This class is meant to be called from artifactory. It ensure the service is running.

artifactory::yum

== Class artifactory::install

This class is called from artifactory for install.