bulk.properties

#  -----------------------------------------------------------------------
#     Default values for bulk service
#  -----------------------------------------------------------------------
@DEFAULTS_HEADER@

#  ---- Cell name of the bulk service(s)
#
# If you customise this, you may need to set frontend.service.bulk-service
# as well, so your frontend service will be able to find the bulk service.
#
bulk.cell.name=${dcache.service.bulk}

bulk.cell.consume=${bulk.cell.name}
bulk.cell.subscribe=${bulk.pool-monitor.topic},${bulk.qos-transition-topic}

#  ----- Whether the service is replicable
#
#   Any service in dCache can have several instances as long as these
#   represent separate logical services. Some services can have several
#   instances representing the same logical service, providing some
#   degree of fault tolerance and load balancing. Such services are said
#   to be replicable.
#
#   Instances of a logical service share the same service name, and it is
#   important that the configuration for such instances is synchronized.
#
#   This property indicates if this service is replicable.
#
#   Bulk physical instances should all run over the same database instance.
#   HA will use leader semantics to guarantee that only one of those instances
#   is actually processing, i.e., storing, running, canceling or clearing requests.
#   The other instances are free to query for request information or status.
#
#   It is the administrator's responsibility to ensure that all
#   bulk service instances:
#
#       o  have a consistent dCache 'bulk' configuration,
#       o  share the same database.
#
(immutable)bulk.cell.replicable = true

#  ---- Global setting for directory expansion.
#
#           NONE:       do not allow any processing of targets inside a directory (depth 0)
#           TARGETS:    allow only the immediate children of directories to be processed (depth 1)
#           ALL:        allow full recursive processing of directories (depth N)
#
(one-of?NONE|TARGETS|ALL)bulk.allowed-directory-expansion=TARGETS

#  ---- Algorithm for promoting requests to active.
#
#       Implementations:
#
#           -   org.dcache.services.bulk.manager.scheduler.LeastRecentFirstScheduler:
#               selects the least recent requests to run in order of arrival
#               (first-come first-served).
#
bulk.request-scheduler=org.dcache.services.bulk.manager.scheduler.LeastRecentFirstScheduler

#  ---- Thread pool sizes.
#
#  - container-processing threads:          for running container jobs (one per request)
#                                           also serves as the default number of requests which
#                                           can be run concurrently and the capacity of the cache
#                                           serving to front the request storage.
#                                           The number of concurrent active requests can be
#                                           adjusted via an admin command to oversubscribe to
#                                           this preset number, which may allow for some speed up
#                                           if high latency requests such as pinning predominate.
#  - incoming-request threads:              for handling requests received on the message queue
#  - cancellation threads:                  for handling cancellation requests
#
bulk.limits.container-processing-threads=100
bulk.limits.incoming-request-threads=10
bulk.limits.cancellation-threads=${bulk.limits.container-processing-threads}

#  ---- Expiration of the cache serving to front the request storage.
#
bulk.limits.request-cache-expiration=1

#  ---- Expiration unit of the cache serving to front the request storage.
#
(one-of?MILLISECONDS|SECONDS|MINUTES|HOURS|DAYS)bulk.limits.request-cache-expiration.unit=HOURS

#  ---- Prevents users from monopolizing the service.
#       The limit is in terms of the number of submitted requests
#       which have not yet completed (but not necessarily cleared).
#
bulk.limits.max-requests-per-user=5000

#  ---- The maximum number of unexpanded targets which can appear in the bulk request list.
#       when request expansion is set to NONE.
#
bulk.limits.max.targets-per-flat-request=500

#  ---- The maximum number of unexpanded targets which can appear in the bulk request list.
#       when request expansion is set to TARGETS.
#
bulk.limits.max.targets-per-shallow-request=10

#  ---- The maximum number of unexpanded targets which can appear in the bulk request list.
#       when request expansion is set to ALL.
#
bulk.limits.max.targets-per-recursive-request=1

#  ---- The maximum number of directory listings that can occur concurrently.
#       This is necessary to avoid timing out calls to the PnfsManager.
#
bulk.limits.dir-list-semaphore=20

#  ---- The maximum number of target tasks that can occur concurrently.
#
bulk.limits.in-flight-semaphore=2000

#  ---- Endpoint throttles
#
#       These help bulk avoid flooding the respective service (PinManager, QoSEngine, PnfsManager)
#       with requests at a rate it cannot handle.
#
bulk.limits.pin-manager-rate-per-second=1000
bulk.limits.pnfs-manager-rate-per-second=2000
bulk.limits.qos-engine-rate-per-second=500

#  ---- Interval of inactivity by the request manager consumer if not signalled
#       internally (as for instance when a request job completes).  The consumer checks
#       for request readiness and completion.
#
bulk.limits.sweep-interval=5
(one-of?MILLISECONDS|SECONDS|MINUTES)bulk.limits.sweep-interval.unit=SECONDS

#  ---- Distance in the past from current time serving as threshold for archiving
#       older completed or cancelled requests.  The archiver will archive and delete
#       all requests older than this window.
#
bulk.limits.archiver-window=14
(one-of?MILLISECONDS|SECONDS|MINUTES|HOURS|DAYS)bulk.limits.archiver-window.unit=DAYS

#  ---- How often the archiver should run.
#
bulk.limits.archiver-period=6
(one-of?MILLISECONDS|SECONDS|MINUTES|HOURS|DAYS)bulk.limits.archiver-period.unit=HOURS

#  ---- Amount of time the shutdown manager should wait for running jobs to complete
#       before disconnecting from the data store.
#
bulk.limits.shutdown-manager-wait=10
(one-of?MILLISECONDS|SECONDS|MINUTES)bulk.limits.shutdown-manager-wait.unit=SECONDS

# ---- Endpoint for contacting pnfs manager.
#
bulk.service.pnfsmanager=${dcache.service.pnfsmanager}

# ---- How long to wait for a response from the pnfs manager.
#
bulk.service.pnfsmanager.timeout=1
(one-of?MILLISECONDS|SECONDS|MINUTES|HOURS|DAYS)bulk.service.pnfsmanager.timeout.unit=MINUTES

# ---- Endpoint for contacting pin manager.
#
bulk.service.pinmanager=${dcache.service.pinmanager}

# ---- How long to wait for a response from the pin manager.
#
bulk.service.pinmanager.timeout=1
(one-of?MILLISECONDS|SECONDS|MINUTES|HOURS|DAYS)bulk.service.pinmanager.timeout.unit=MINUTES

# ---- Endpoint for contacting pool manager.
#
bulk.service.poolmanager=${dcache.service.poolmanager}

# ---- How long to wait for a response from the pool manager.
#
bulk.service.poolmanager.timeout=1
(one-of?MILLISECONDS|SECONDS|MINUTES|HOURS|DAYS)bulk.service.poolmanager.timeout.unit=MINUTES

# ---- Endpoint for contacting qos.
#
bulk.service.qos=${dcache.service.qos}

# ---- How long to wait for a response from qos.
#      The default timeout is slightly longer in order to support cancellations
#      of many requests simultaneously, especially if these requests each have many targets.
#
bulk.service.qos.timeout=5
(one-of?MILLISECONDS|SECONDS|MINUTES|HOURS|DAYS)bulk.service.qos.timeout.unit=MINUTES

# ---- How long to wait for a response from the HA leader.
#
bulk.service.ha-leader.timeout=1
(one-of?MILLISECONDS|SECONDS|MINUTES|HOURS|DAYS)bulk.service.ha-leader.timeout.unit=MINUTES

# Topic on which to expect pool monitor updates
#
bulk.pool-monitor.topic=${dcache.pool-monitor.topic}

# ---- Configuration for bulk database connection pool ---------------------------

bulk.db.connections.max=50

# ---- The minimum number of idle database connections.
#
bulk.db.connections.idle=1

(prefix)bulk.db.hikari-properties = Hikari-specific properties

# ---- Database related settings.
#
bulk.db.name=bulk
bulk.db.host=${dcache.db.host}
bulk.db.user=${dcache.db.user}
bulk.db.password=${dcache.db.password}
bulk.db.password.file=${dcache.db.password.file}
bulk.db.schema.auto=${dcache.db.schema.auto}
bulk.db.url=jdbc:postgresql://${bulk.db.host}/${bulk.db.name}?targetServerType=master
(immutable)bulk.db.schema.changelog=org/dcache/services/bulk/model/db.changelog-master.xml
bulk.db.fetch-size=1000

# ---- Activity plugin properties

bulk.plugin!delete.default-batch-size=100

#  ---- Algorithm for determining what action to take on job failures.
#
#       Implementations:
#
#            -  org.dcache.services.bulk.job.retry.NoRetryPolicy does not retry failures.
#
bulk.plugin!delete.retry-policy=org.dcache.services.bulk.activity.retry.NoRetryPolicy
bulk.plugin!pin.retry-policy=org.dcache.services.bulk.activity.retry.NoRetryPolicy
bulk.plugin!stage.retry-policy=org.dcache.services.bulk.activity.retry.NoRetryPolicy
bulk.plugin!unpin.retry-policy=org.dcache.services.bulk.activity.retry.NoRetryPolicy
bulk.plugin!release.retry-policy=org.dcache.services.bulk.activity.retry.NoRetryPolicy
bulk.plugin!update-qos.retry-policy=org.dcache.services.bulk.activity.retry.NoRetryPolicy
bulk.plugin!log-target.retry-policy=org.dcache.services.bulk.activity.retry.NoRetryPolicy

#  ---- Configurable activity defaults
#
bulk.plugin!pin.default-lifetime=5
(one-of?MILLISECONDS|SECONDS|MINUTES|HOURS|DAYS)bulk.plugin!pin.default-lifetime.unit=MINUTES

bulk.plugin!stage.default-lifetime=2
(one-of?MILLISECONDS|SECONDS|MINUTES|HOURS|DAYS)bulk.plugin!stage.default-lifetime.unit=DAYS

# Topic on which to expect qos transition completed updates
#
bulk.qos-transition-topic=${dcache.qos.transition-topic}

(deprecated)bulk.limits.counts-update-interval=no longer used
(deprecated)bulk.limits.counts-update-interval.unit=no longer used
(deprecated)bulk.ping.cell.name=no longer used
(deprecated)bulk.ping.cell.consume=no longer used
(deprecated)bulk.dir=no longer used
(deprecated)bulk.limits.max-running-jobs=use bulk.limits.container-processing-threads
(deprecated)bulk.limits.max-queued-jobs=no longer used
(deprecated)bulk.limits.avg-jobs-per-request=no longer used
(deprecated)bulk.limits.max-cleanup-jobs=no longer used
(deprecated)bulk.limits.max-callbacks=use bulk.limits.activity-callback-threads
(deprecated)bulk.limits.message-handler-threads=use bulk.limits.incoming-request-thread
(deprecated)bulk.limits.request-store-clear-threads=use bulk.limits.delay-clear-threads
(deprecated)bulk.limits.queue-sweep-interval=use bulk.limits.sweep-interval
(deprecated)bulk.store.request-store-dir=no longer used
(deprecated)bulk.service.ping=no longer used
(deprecated)bulk.service.ping.timeout=no longer used
(deprecated)bulk.service.ping.timeout.unit=no longer used
(deprecated)bulk.limits.dir-list-threads=use  bulk.limits.dir-list-semaphore
(deprecated)bulk.limits.delay-clear-threads=no longer used
(deprecated)bulk.limits.activity-callback-threads=no longer used
(deprecated)bulk.plugin!delete.max-permits=no longer used; see bulk.limits.in-flight-semaphore
(deprecated)bulk.plugin!pin.max-permits=no longer used; see bulk.limits.in-flight-semaphore
(deprecated)bulk.plugin!stage.max-permits=no longer used; see bulk.limits.in-flight-semaphore
(deprecated)bulk.plugin!unpin.max-permits=no longer used; see bulk.limits.in-flight-semaphore
(deprecated)bulk.plugin!release.max-permits=no longer used; see bulk.limits.in-flight-semaphore
(deprecated)bulk.plugin!update-qos.max-permits=no longer used; see bulk.limits.in-flight-semaphore
(deprecated)bulk.plugin!log-target.max-permits=no longer used; see bulk.limits.in-flight-semaphore