Basic Sharding Configuration

type

Sharding

lenientLimit

Default: 0 (0 means the redundancy value is used)

The minimum number of successful writes that must be maintained for an upload to be successful. The next balance cycle (triggered with the GC mechanism) will eventually transfer the binary to enough nodes such that the redundancy commitment is preserved.

In other words, Leniency governs the minimal allowed redundancy in cases where the redundancy commitment was not kept temporarily.

For example, if lenientLimit is set to 3, my setup includes 4 filestores, and 1 of them goes down, writing will continue. If a 2nd filestore goes down, writing will stop.

The amount of currently active nodes must always be greater or equal than the configured lenientLimit. If set to 0, the redundancy value has to be kept.

readBehavior

This parameter dictates the strategy for reading binaries from the mounts that make up the sharded filestore.

Possible values are:

roundRobin (default): Binaries are read from each mount using a round robin strategy.

writeBehavior

This parameter dictates the strategy for writing binaries to the mounts that make up the sharded filestore.

Possible values are:

roundRobin (default):Binaries are written to each mount using a round robin strategy.

freeSpace:Binaries are written to the mount with the greatest absolute volume of free space available.

percentageFreeSpace:Binaries are written to the mount with the percentage of free space available.

redundancy

Default: 1

The number of copies that should be stored for each binary in the filestore. Note that redundancy must be less than or equal to the number of mounts in your system for Artifactory to work with this configuration.

concurrentStreamWaitTimeout

Default: 30,000 ms

To support the specified redundancy, accumulates the write stream in a buffer, and uses “r” threads (according to the specified redundancy) to write to each of the redundant copies of the binary being written. A binary can only be considered written once all redundant threads have completed their write operation. Since all threads are competing for the write stream buffer, each one will complete the write operation at a different time. This parameter specifies the amount of time (ms) that any thread will wait for all the others to complete their write operation.

concurrentStreamBufferKb

Default: 32 Kb

The size of the write buffer used to accumulate the write stream before being replicated for writing to the “r” redundant copies of the binary.

enableShardingBalancer

Default: true

Set this flag to false if you want to disable the balancing sharding mechanism.

maxBalancingRunTime

Default: 0.0 ms

Once a failed mount has been restored, this parameter specifies how long each balancing session may run before it lapses until the next Garbage Collection has been completed. For more details about balancing, see Using Balancing to Recover from Mount Failure.

disableBalanceOnAddStream

Default: false

If this flag is false, when a binary is uploaded Artifactory checks if the binary is present in the other shards. If the number of instances found in the other shards is greater than the value of redundancy, Artifactory will delete the number of instances of the binary greater than redundancy in the next balance cycle. For example, if Artifactory finds 4 binary instances in the other shards and redundancy = 2, in the next balance cycle Artifactory will delete 2 instances of that binary.

If this flag is true, the check during upload is disabled and the balance cycle is not triggered.

freeSpaceSampleInterval

Default: 36,000,000 ms (10 hours)

To implement its write behavior, Artifactory needs to periodically query the mounts in the sharded filestore to check for free space. Since this check may be a resource-intensive operation, you may use this parameter to control the time interval between free space checks.

minSpareUploaderExecutor

Default: 2

Artifactory maintains a pool of threads to execute writes to each redundant unit of storage. Depending on the intensity of write activity, eventually, some of the threads may become idle and are then candidates for being killed. However, Artifactory does need to maintain some threads alive for when write activities begin again. This parameter specifies the minimum number of threads that should be kept alive to supply redundant storage units.

uploaderCleanupIdleTime

Default: 120,000 ms (2 min)

The maximum period of time threads may remain idle before becoming candidates for being killed.

balancerThreads

Default: 1

The number of threads to use for the rebalancing operations.

accessibleCheckThreads

Default: 2

The number of threads to use for checking that shards are accessible.

accessibleCheckTimeoutMillis

Default: 15000 milliseconds (15 seconds)

The maximum time to wait while checking if shards are accessible.