ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2024-12-18 20:47:57 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

CORDA-3358: Add capsule-friendly argument to docs (#5627)

Browse Source 
CORDA-3358: Add capsule-friendly argument to docs (#5627)
This commit is contained in:
Jonathan Locke 2019-11-13 10:36:07 +00:00 committed by GitHub
commit bec865dc57
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/source/checkpoint-tooling.rst
View File

@ -163,15 +163,15 @@ problems associated with checkpoints for flows that appear to not be completing.
The checkpoint agent can be downloaded from `here <https://software.r3.com/artifactory/corda-releases/net/corda/corda-tools-checkpoint-agent/>`_.
To run simply pass in the following jar to the JVM used to start a Corda node: ``-javaagent:<PATH>/checkpoint-agent.jar[=arg=value,...]``
To run simply pass in the following jar to the JVM used to start a Corda node: ``-Dcapsule.jvm.args=-javaagent:<PATH>/checkpoint-agent.jar[=arg=value,...]``
.. note:: As above also ensure to use the jar when using corda gradle plugin configuration tasks: e.g. ``cordformation deployNodes`` task.
See https://docs.corda.net/head/generating-a-node.html#the-cordform-task
.. warning:: This tool requires additional memory footprint and we recommended a minimal heap size of at least 1Gb.
The agent can be customised with a number of optional parameters described below.
.. note:: When using the gradle plugin utilities for deploying and running nodes, ensure the checkpoint agent jar is correctly passed to capsule as follows:
``-Dcapsule.jvm.args=-javaagent:checkpoint-agent.jar[=arg=value,...]``
Configuration
-------------