CORDA-2615 - Added description for configFile option in deployNodes Cordform Gradle task. (#2615)

* Added description for configFile option in deployNodes Cordform Gradle task.

* Addressing PR comments.

* Addressing PR comments.

* Addressing PR comments.

* Addressing PR comments.

* Addressing PR comments.
This commit is contained in:
szymonsztuka 2018-02-26 11:44:58 +00:00 committed by Katelyn Baker
parent 7e63c4e068
commit 69e001497a

View File

@ -120,6 +120,24 @@ nodes. Here is an example ``Cordform`` task called ``deployNodes`` that creates
}
}
To extend node configuration beyond the properties defined in the ``deployNodes`` task use the ``configFile`` property with the path (relative or absolute) set to an additional configuration file.
This file should follow the standard :doc:`corda-configuration-file` format, as per node.conf. The properties from this file will be appended to the generated node configuration.
The path to the file can also be added while running the Gradle task via the ``-PconfigFile`` command line option. However, the same file will be applied to all nodes.
Following the previous example ``PartyB`` node will have additional configuration options added from a file ``none-b.conf``:
.. sourcecode:: groovy
task deployNodes(type: net.corda.plugins.Cordform, dependsOn: ['jar']) {
[...]
node {
name "O=PartyB,L=New York,C=US"
[...]
// Grants user1 the ability to start the MyFlow flow.
rpcUsers = [[ user: "user1", "password": "test", "permissions": ["StartFlow.net.corda.flows.MyFlow"]]]
configFile = "samples/trader-demo/src/main/resources/none-b.conf"
}
}
Running this task will create three nodes in the ``build/nodes`` folder:
* A ``NetworkMapAndNotary`` node that: