jhon287 / artifactory_ha Goto Github PK

1. Overview
2. Module Description - What the module does and why it is useful
3. Setup - The basics of getting started with artifactory
   • Setup requirements
   • Beginning with artifactory
4. Usage - Configuration options and additional functionality
5. Reference - An under-the-hood peek at what the module is doing and how
6. Limitations - OS compatibility, etc.
7. Development - Guide for contributing to the module

This ONLY install Artifactory HA.

If you are looking for the regulare commercial installation, or OSS, look at:

Artifactory OSS: https://forge.puppet.com/fervid/artifactory

Artifactory PRO: https://forge.puppet.com/fervid/artifactory_pro

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.

The Artifactory HA module installs, configures, and manages the Artifactory pro binary repository.

The Artifactory HA module manages both the installation and database configuration of Artifactory Pro.

Requires a JDK to be installed.

Artifactory ha requires a license key, cluster configurations and nfs location information.

class { '::artifactory_ha':
  license_key                    => 'abc123',
  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',
  security_token                => 'ABC1MY0Token1',
  is_primary                    => true,
  cluster_home                  => '/nfs/mount/location',
  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/',
}

All interaction for the server is done via ::artifactory_pro.

• artifactory: Installs and configures Artifactory.

• artifactory_ha::config: Configures Artifactory Pro.
• artifactory_ha::post_config: Does pro post configuration.

• artifactory_ha::plugin: Adds a groovy plugin to the server

Sets the name of the Artifactory license key'.

This is required.

Sets the name of the yum repository. Defaults to 'bintray-jfrog-artifactory-pro-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.

Sets the base url of the yum repository to name. Defaults to 'http://jfrog.bintray.com/artifactory-pro-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.

Sets the package name to install. Defaults to 'jfrog-artifactory-pro'.

This can be changed if Artifactory needs to install a differently named package. Possibly needed if an organization creates their own Artifactory package.

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.

Tells the module whether or not to manage the Artifactory YUM repository. This defaults to true.

If Artifactory YUM repository is already managed set this to false.

Sets the location for the jdbc driver. Uses the wget module to retrieve the driver.

This is required if using a new data source.

The type of database to configure for. Valid values are 'mariadb', 'mssql', 'mysql', 'oracle', 'postgresql'.

The hostname of the database.

The port of the database.

The username for the database account.

The password for the database account.

Security token that is unique among all the members of this cluster.

True or false. There must be one primary per cluster. All other cluster nodes shold be false.

The NFS clust home directory.

Optional setting for the binary storage provider. The type of database to configure for. Valid values are 'filesystem', 'fullDb', 'cachedFS', 'S3'. Defaults to 'filesystem'.

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.

All the metadata and the binaries are stored as BLOBs in the database.

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.

This is the setting used for S3 Object Storage.

Optional setting for the maximum number of pooled database connections. Defaults to 100.

Optional setting for the maximum number of pooled idle database connections Defaults to 10.

Optional setting for the maximum cache size. This value specifies the maximum cache size (in bytes) to allocate on the system for caching BLOBs.

Optional setting for the artifactory filestore location. The binary.provider.type is set to filesystem this value specifies the location of the binaries. Defaults to '$ARTIFACTORY_HOME/data/filestore'.

Optional setting for the location of the cache. This should be set to your $ARTIFACTORY_HOME directory directly (not on the NFS).

The url to the location of the groovy file.

This module has been tested on:

• RedHat Enterprise Linux 5, 6, 7
• CentOS 5, 6, 7

Since your module is awesome, other users will want to play with it. Let them know what the ground rules for contributing are.

This module is based on work by Fervid. The following contributors have contributed to this module:

• Bryan Belanger
• Paul Talbot