Skip to content

Commit d610094

Browse files
committed
Updated the docs to reflect the new name of a JVM option (#10623)
1 parent 5dc386f commit d610094

3 files changed

Lines changed: 6 additions & 6 deletions

File tree

doc/sphinx-guides/source/developers/big-data-support.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -188,4 +188,4 @@ An overview of the control and data transfer interactions between components was
188188

189189
See also :ref:`Globus settings <:GlobusSettings>`.
190190

191-
An alternative, experimental implementation of Globus polling of ongoing upload transfers has been added in v6.4. This framework does not rely on the instance staying up continuously for the duration of the transfer and saves the state information about Globus upload requests in the database. Due to its experimental nature it is not enabled by default. See the ``globus-use-experimental-async-framework`` feature flag and the JVM option ``dataverse.globus.taskMonitoringServer`` described in the Configuration guide.
191+
An alternative, experimental implementation of Globus polling of ongoing upload transfers has been added in v6.4. This framework does not rely on the instance staying up continuously for the duration of the transfer and saves the state information about Globus upload requests in the database. Due to its experimental nature it is not enabled by default. See the ``globus-use-experimental-async-framework`` feature flag and the JVM option ``dataverse.files.globus-monitoring-server`` described in the Configuration guide.

doc/sphinx-guides/source/developers/globus-api.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ As the transfer can take significant time and the API call is asynchronous, the
185185

186186
Once the transfer completes, Dataverse will remove the write permission for the principal.
187187

188-
An alternative, experimental implementation of Globus polling of ongoing upload transfers has been added in v6.4. This new framework does not rely on the instance staying up continuously for the duration of the transfer and saves the state information about Globus upload requests in the database. Due to its experimental nature it is not enabled by default. See the ``globus-use-experimental-async-framework`` feature flag and the JVM option ``dataverse.globus.taskMonitoringServer`` described in the Configuration guide.
188+
An alternative, experimental implementation of Globus polling of ongoing upload transfers has been added in v6.4. This new framework does not rely on the instance staying up continuously for the duration of the transfer and saves the state information about Globus upload requests in the database. Due to its experimental nature it is not enabled by default. See the ``globus-use-experimental-async-framework`` feature flag and the JVM option ``dataverse.files.globus-monitoring-server`` described in the Configuration guide.
189189

190190
Note that when using a managed endpoint that uses the Globus S3 Connector, the checksum should be correct as Dataverse can validate it. For file-based endpoints, the checksum should be included if available but Dataverse cannot verify it.
191191

doc/sphinx-guides/source/installation/config.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3266,10 +3266,10 @@ The email for your institution that you'd like to appear in bag-info.txt. See :r
32663266

32673267
Can also be set via *MicroProfile Config API* sources, e.g. the environment variable ``DATAVERSE_BAGIT_SOURCEORG_EMAIL``.
32683268

3269-
.. _dataverse.globus.taskMonitoringServer:
3269+
.. _dataverse.files.globus-monitoring-server:
32703270

3271-
dataverse.globus.taskMonitoringServer
3272-
+++++++++++++++++++++++++++++++++++++
3271+
dataverse.files.globus-monitoring-server
3272+
++++++++++++++++++++++++++++++++++++++++
32733273

32743274
This setting is required in conjunction with the ``globus-use-experimental-async-framework`` feature flag. Setting it to true designates the Dataverse instance to serve as the dedicated polling server. It is needed so that the new framework can be used in a multi-node installation.
32753275

@@ -3309,7 +3309,7 @@ please find all known feature flags below. Any of these flags can be activated u
33093309
- Removes the reason field in the `Publish/Return To Author` dialog that was added as a required field in v6.2 and makes the reason an optional parameter in the :ref:`return-a-dataset` API call.
33103310
- ``Off``
33113311
* - globus-use-experimental-async-framework
3312-
- Activates a new experimental implementation of Globus polling of ongoing remote data transfers that does not rely on the instance staying up continuously for the duration of the transfers and saves the state information about Globus upload requests in the database. Added in v6.4. Note that the JVM option ``dataverse.globus.taskMonitoringServer`` described above must also be enabled on one (and only one, in a multi-node installation) Dataverse instance.
3312+
- Activates a new experimental implementation of Globus polling of ongoing remote data transfers that does not rely on the instance staying up continuously for the duration of the transfers and saves the state information about Globus upload requests in the database. Added in v6.4. Note that the JVM option ``dataverse.files.globus-monitoring-server`` described above must also be enabled on one (and only one, in a multi-node installation) Dataverse instance.
33133313
- ``Off``
33143314

33153315
**Note:** Feature flags can be set via any `supported MicroProfile Config API source`_, e.g. the environment variable

0 commit comments

Comments
 (0)