mirror of
https://github.com/corda/corda.git
synced 2024-12-18 20:47:57 +00:00
low hanging fruit
This commit is contained in:
parent
328becb2d3
commit
ed94387eff
@ -234,7 +234,7 @@ The same example in Java:
|
|||||||
|
|
||||||
|
|
||||||
Starting a node missing CorDapp(s)
|
Starting a node missing CorDapp(s)
|
||||||
*********************************
|
**********************************
|
||||||
|
|
||||||
When running the Corda node ensure all CordDapp JARs are placed in ``cordapps`` directory of each node.
|
When running the Corda node ensure all CordDapp JARs are placed in ``cordapps`` directory of each node.
|
||||||
By default Gradle Cordform task ``deployNodes`` copies all JARs if CorDapps to deploy are specified.
|
By default Gradle Cordform task ``deployNodes`` copies all JARs if CorDapps to deploy are specified.
|
||||||
|
@ -20,7 +20,7 @@ Version 4.0
|
|||||||
* New configuration property ``database.initialiseAppSchema`` with values ``UPDATE``, ``VALIDATE`` and ``NONE``.
|
* New configuration property ``database.initialiseAppSchema`` with values ``UPDATE``, ``VALIDATE`` and ``NONE``.
|
||||||
The property controls the behavior of the Hibernate DDL generation. ``UPDATE`` performs an update of CorDapp schemas, while
|
The property controls the behavior of the Hibernate DDL generation. ``UPDATE`` performs an update of CorDapp schemas, while
|
||||||
``VALIDATE`` only verifies their integrity. The property does not affect the node-specific DDL handling and
|
``VALIDATE`` only verifies their integrity. The property does not affect the node-specific DDL handling and
|
||||||
complements ``database.initialiseSchema`` to disable DDL handling altogether.
|
complements ``database.initialiseSchema`` to disable DDL handling altogether.
|
||||||
|
|
||||||
* ``JacksonSupport.createInMemoryMapper`` was incorrectly marked as deprecated and is no longer so.
|
* ``JacksonSupport.createInMemoryMapper`` was incorrectly marked as deprecated and is no longer so.
|
||||||
|
|
||||||
|
@ -74,7 +74,7 @@ Parameter stability
|
|||||||
~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
* Avoid removing parameters. If, for some reason, a parameter needs to be renamed, add a new parameter with the new name and deprecate the old parameter, or alternatively
|
* Avoid removing parameters. If, for some reason, a parameter needs to be renamed, add a new parameter with the new name and deprecate the old parameter, or alternatively
|
||||||
keep both versions of the parameter. See :ref:`cli-ux-backwards-compatibility` for more information.
|
keep both versions of the parameter. See :ref:`cli-ux-backwards-compatibility` for more information.
|
||||||
|
|
||||||
|
|
||||||
Notes for adding a new a command line application
|
Notes for adding a new a command line application
|
||||||
|
@ -69,10 +69,10 @@ The Corda Network provides an endpoint serving an empty certificate revocation l
|
|||||||
This is intended for deployments that do not provide a CRL infrastructure but still require strict CRL mode checking.
|
This is intended for deployments that do not provide a CRL infrastructure but still require strict CRL mode checking.
|
||||||
In order to use this, add the following to your configuration file:
|
In order to use this, add the following to your configuration file:
|
||||||
|
|
||||||
.. parsed-literal::
|
.. parsed-literal::
|
||||||
|
|
||||||
tlsCertCrlDistPoint = "https://crl.cordaconnect.org/cordatls.crl"
|
tlsCertCrlDistPoint = "https://crl.cordaconnect.org/cordatls.crl"
|
||||||
tlsCertCrlIssuer = "C=US, L=New York, O=R3 HoldCo LLC, OU=Corda, CN=Corda Root CA"
|
tlsCertCrlIssuer = "C=US, L=New York, O=R3 HoldCo LLC, OU=Corda, CN=Corda Root CA"
|
||||||
|
|
||||||
This set-up ensures that the TLS-level certificates are embedded with the CRL distribution point referencing the CRL issued by R3.
|
This set-up ensures that the TLS-level certificates are embedded with the CRL distribution point referencing the CRL issued by R3.
|
||||||
In cases where a proprietary CRL infrastructure is provided those values need to be changed accordingly.
|
In cases where a proprietary CRL infrastructure is provided those values need to be changed accordingly.
|
||||||
|
@ -158,7 +158,7 @@ For further information about managing dependencies, see
|
|||||||
|
|
||||||
Signing the CorDapp JAR
|
Signing the CorDapp JAR
|
||||||
^^^^^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
The ``cordapp`` plugin can sign the generated CorDapp JAR file using `JAR signing and verification tool <https://docs.oracle.com/javase/tutorial/deployment/jar/signing.html>`_.
|
The ``cordapp`` plugin can sign the generated CorDapp JAR file using `JAR signing and verification tool <https://docs.oracle.com/javase/tutorial/deployment/jar/signing.html>`__.
|
||||||
Signing the CorDapp enables its contract classes to use signature constraints instead of other types of the constraints,
|
Signing the CorDapp enables its contract classes to use signature constraints instead of other types of the constraints,
|
||||||
for constraints explanation refer to :doc:`api-contract-constraints`.
|
for constraints explanation refer to :doc:`api-contract-constraints`.
|
||||||
By default the JAR file is signed by Corda development certificate.
|
By default the JAR file is signed by Corda development certificate.
|
||||||
@ -253,7 +253,7 @@ Then the build process can set the value for *custom.sigalg* system property and
|
|||||||
|
|
||||||
./gradlew -Dcustom.sigalg="SHA256withECDSA" -Dsigning.keystore="/path/to/keystore.jks" -Dsigning.alias="alias" -Dsigning.storepass="password" -Dsigning.keypass="password"
|
./gradlew -Dcustom.sigalg="SHA256withECDSA" -Dsigning.keystore="/path/to/keystore.jks" -Dsigning.alias="alias" -Dsigning.storepass="password" -Dsigning.keypass="password"
|
||||||
|
|
||||||
To check if CorDapp is signed use `JAR signing and verification tool <https://docs.oracle.com/javase/tutorial/deployment/jar/verify.html>`_:
|
To check if CorDapp is signed use `JAR signing and verification tool <https://docs.oracle.com/javase/tutorial/deployment/jar/verify.html>`__:
|
||||||
|
|
||||||
.. sourcecode:: shell
|
.. sourcecode:: shell
|
||||||
|
|
||||||
|
@ -24,7 +24,7 @@ You can find out more about network maps and network parameters from :doc:`netwo
|
|||||||
Bootstrapping a test network
|
Bootstrapping a test network
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
The Corda Network Bootstrapper can be downloaded from `here <https://www.corda.net/resources>`_.
|
The Corda Network Bootstrapper can be downloaded from `here <https://www.corda.net/resources>`__.
|
||||||
|
|
||||||
Create a directory containing a node config file, ending in "_node.conf", for each node you want to create. "devMode" must be set to true. Then run the
|
Create a directory containing a node config file, ending in "_node.conf", for each node you want to create. "devMode" must be set to true. Then run the
|
||||||
following command:
|
following command:
|
||||||
@ -292,7 +292,7 @@ ignored. If a field is not provided and you are bootstrapping a new network, a s
|
|||||||
are updating an existing network, the value in the existing network parameters file will be used.
|
are updating an existing network, the value in the existing network parameters file will be used.
|
||||||
|
|
||||||
.. note:: All fields can be used with placeholders for environment variables. For example: ``${KEY_STORE_PASSWORD}`` would be replaced by the contents of environment
|
.. note:: All fields can be used with placeholders for environment variables. For example: ``${KEY_STORE_PASSWORD}`` would be replaced by the contents of environment
|
||||||
variable ``KEY_STORE_PASSWORD``. See: :ref:`corda-configuration-hiding-sensitive-data` .
|
variable ``KEY_STORE_PASSWORD``. See: :ref:`corda-configuration-hiding-sensitive-data` .
|
||||||
|
|
||||||
The available configuration fields are listed below:
|
The available configuration fields are listed below:
|
||||||
|
|
||||||
@ -303,7 +303,7 @@ The available configuration fields are listed below:
|
|||||||
:maxTransactionSize: The maximum permitted transaction size, in bytes.
|
:maxTransactionSize: The maximum permitted transaction size, in bytes.
|
||||||
|
|
||||||
:eventHorizon: The time after which nodes will be removed from the network map if they have not been seen during this period. This parameter uses
|
:eventHorizon: The time after which nodes will be removed from the network map if they have not been seen during this period. This parameter uses
|
||||||
the ``parse`` function on the ``java.time.Duration`` class to interpret the data. See `here <https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html#parse-java.lang.CharSequence->`_
|
the ``parse`` function on the ``java.time.Duration`` class to interpret the data. See `here <https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html#parse-java.lang.CharSequence->`__
|
||||||
for information on valid inputs.
|
for information on valid inputs.
|
||||||
|
|
||||||
:packageOwnership: A list of package owners. See `Package namespace ownership`_ for more information. For each package owner, the following fields
|
:packageOwnership: A list of package owners. See `Package namespace ownership`_ for more information. For each package owner, the following fields
|
||||||
@ -365,7 +365,7 @@ For each package to be registered, the following are required:
|
|||||||
:keystoreAlias: The alias for the name associated with the certificate to be associated with the package namespace.
|
:keystoreAlias: The alias for the name associated with the certificate to be associated with the package namespace.
|
||||||
|
|
||||||
Using the `Example CorDapp <https://github.com/corda/cordapp-example>`_ as an example, we will initialise a simple network and then register and unregister a package namespace.
|
Using the `Example CorDapp <https://github.com/corda/cordapp-example>`_ as an example, we will initialise a simple network and then register and unregister a package namespace.
|
||||||
Checkout the Example CorDapp and follow the instructions to build it `here <https://docs.corda.net/tutorial-cordapp.html#building-the-example-cordapp>`_.
|
Checkout the Example CorDapp and follow the instructions to build it `here <https://docs.corda.net/tutorial-cordapp.html#building-the-example-cordapp>`__.
|
||||||
|
|
||||||
.. note:: You can point to any existing bootstrapped corda network (this will have the effect of updating the associated network parameters file).
|
.. note:: You can point to any existing bootstrapped corda network (this will have the effect of updating the associated network parameters file).
|
||||||
|
|
||||||
|
@ -87,7 +87,7 @@ formats for accessing MBeans, and provides client libraries to work with that pr
|
|||||||
|
|
||||||
Here are a few ways to build dashboards and extract monitoring data for a node:
|
Here are a few ways to build dashboards and extract monitoring data for a node:
|
||||||
|
|
||||||
* `hawtio <http://hawt.io>`_ is a web based console that connects directly to JVM's that have been instrumented with a
|
* `Hawtio <http://hawt.io>`_ is a web based console that connects directly to JVM's that have been instrumented with a
|
||||||
jolokia agent. This tool provides a nice JMX dashboard very similar to the traditional JVisualVM / JConsole MBbeans original.
|
jolokia agent. This tool provides a nice JMX dashboard very similar to the traditional JVisualVM / JConsole MBbeans original.
|
||||||
* `JMX2Graphite <https://github.com/logzio/jmx2graphite>`_ is a tool that can be pointed to /monitoring/json and will
|
* `JMX2Graphite <https://github.com/logzio/jmx2graphite>`_ is a tool that can be pointed to /monitoring/json and will
|
||||||
scrape the statistics found there, then insert them into the Graphite monitoring tool on a regular basis. It runs
|
scrape the statistics found there, then insert them into the Graphite monitoring tool on a regular basis. It runs
|
||||||
@ -135,7 +135,7 @@ When starting Corda nodes using the 'driver DSL', you should see a startup messa
|
|||||||
**Starting out-of-process Node USA Bank Corp, debug port is not enabled, jolokia monitoring port is 7005 {}**
|
**Starting out-of-process Node USA Bank Corp, debug port is not enabled, jolokia monitoring port is 7005 {}**
|
||||||
|
|
||||||
|
|
||||||
The following diagram illustrates Corda flow metrics visualized using `hawtio <https://hawt.io>`_ :
|
The following diagram illustrates Corda flow metrics visualized using hawtio:
|
||||||
|
|
||||||
.. image:: resources/hawtio-jmx.png
|
.. image:: resources/hawtio-jmx.png
|
||||||
|
|
||||||
@ -178,9 +178,8 @@ Take a simple node config that wishes to protect the node cryptographic stores:
|
|||||||
By delegating to a password store, and using `command substitution` it is possible to ensure that sensitive passwords never appear in plain text.
|
By delegating to a password store, and using `command substitution` it is possible to ensure that sensitive passwords never appear in plain text.
|
||||||
The below examples are of loading Corda with the KEY_PASS and TRUST_PASS variables read from a program named ``corporatePasswordStore``.
|
The below examples are of loading Corda with the KEY_PASS and TRUST_PASS variables read from a program named ``corporatePasswordStore``.
|
||||||
|
|
||||||
|
|
||||||
Bash
|
Bash
|
||||||
~~~~
|
++++
|
||||||
|
|
||||||
.. sourcecode:: shell
|
.. sourcecode:: shell
|
||||||
|
|
||||||
@ -188,9 +187,8 @@ Bash
|
|||||||
|
|
||||||
.. warning:: If this approach is taken, the passwords will appear in the shell history.
|
.. warning:: If this approach is taken, the passwords will appear in the shell history.
|
||||||
|
|
||||||
|
|
||||||
Windows PowerShell
|
Windows PowerShell
|
||||||
~~~~~~~~~~~~~~~~~~
|
++++++++++++++++++
|
||||||
|
|
||||||
.. sourcecode:: shell
|
.. sourcecode:: shell
|
||||||
|
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
Node command-line options
|
Node command-line options
|
||||||
====================
|
=========================
|
||||||
|
|
||||||
The node can optionally be started with the following command-line options:
|
The node can optionally be started with the following command-line options:
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user