From 267b4acf281219483f246e8074e8f437e3f4f55e Mon Sep 17 00:00:00 2001 From: LankyDan Date: Wed, 26 Jun 2019 13:42:20 +0100 Subject: [PATCH] ENT-3496 Improve flow draining docs --- docs/source/upgrading-cordapps.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/source/upgrading-cordapps.rst b/docs/source/upgrading-cordapps.rst index 60ea99bbbc..4489e498ef 100644 --- a/docs/source/upgrading-cordapps.rst +++ b/docs/source/upgrading-cordapps.rst @@ -284,7 +284,11 @@ the standard ``run`` command to invoke the RPC. See :doc:`shell` to learn more. To assist in draining a node, the ``dumpCheckpoints`` shell command will output JSON representations of each checkpointed flow. A zip containing the JSON files is created in the ``logs`` directory of the node. This information can then be used to determine the state of stuck flows or flows that experienced internal errors and were kept in the node for manual intervention. To drain these flows, -the node will need to be restarted or the checkpoint record will need to be manually deleted from the checkpoint table. +the node will need to be restarted or the flow will need to be removed using ``killFlow``. + +.. warning:: Deleting checkpoints manually or via ``killFlow`` can lead to an inconsistent ledger among transacting parties. Great care + and coordination with a flow's counterparties must be taken to ensure that a initiating flow and flows responding to it are correctly + removed. This experience will be improved in the future. Making it easier to kill flows while notifying their counterparties. .. _contract_upgrading_ref: