Na testnet explorer docs (#3660)

* added doc on testing deployment with node explorer
This commit is contained in:
Nick Arini 2018-07-20 16:21:24 +01:00 committed by GitHub
parent cad684fbd3
commit e5d82cc9b4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
13 changed files with 188 additions and 6 deletions

View File

@ -106,6 +106,21 @@ your unique Corda instance on that instance:
.. warning:: This command will execute the install script as ROOT on your cloud instance. You may wish to examine the script prior to executing it on your machine.
You can now navigate to the external web address of the instance and
see any cordapps running on port 8080 (if you have any installed).
You can follow the progress of the installation by typing the following command in your terminal:
.. code:: bash
tail -f /opt/corda/logs/node-<VM-NAME>.log
Once the node has booted up you can navigate to the external web address of the instance on port 8080. If everything is working you should see the following:
.. image:: resources/installed-cordapps.png
Testing your deployment
-----------------------
To test your deployment is working correctly follow the instructions in :doc:`testnet-explorer-corda` to set up the Finance CorDapp and issue cash to a counterparty.
This will also demonstrate how to install a custom CorDapp.

View File

@ -131,5 +131,21 @@ your unique Corda node:
.. warning:: This command will execute the install script as ROOT on your cloud instance. You may wish to examine the script prior to executing it on your machine.
You can now navigate to the external web address of the instance and
see any cordapps running on port 8080 (if you have any installed).
You can follow the progress of the installation by typing the following command in your terminal:
.. code:: bash
tail -f /opt/corda/logs/node-<VM-NAME>.log
Once the node has booted up you can navigate to the external web address of the instance on port 8080. If everything is working you should see the following:
.. image:: resources/installed-cordapps.png
Testing your deployment
-----------------------
To test your deployment is working correctly follow the instructions in :doc:`testnet-explorer-corda` to set up the Finance CorDapp and issue cash to a counterparty.
This will also demonstrate how to install a custom CorDapp.

View File

@ -14,4 +14,5 @@ Networks
aws-vm-explore
gcp-vm
deploy-locally
testnet-explorer-corda
cipher-suites

View File

@ -155,3 +155,10 @@ Run the ``run-corda.sh`` script to start your Corda node.
Congratulations! You now have a running Corda node on Testnet.
.. warning:: It is possible to copy the ``node.zip`` file from your local machine to any other host machine and run the Corda node from there. Do not run multiple copies of the same node (i.e. with the same identity). If a new copy of the node appears on the network then the network map server will interpret this as a change in the address of the node and route traffic to the most recent instance. Any states which are on the old node will no longer be available and undefined behaviour may result. Please provision a new node from the application instead.
Testing your deployment
-----------------------
To test your deployment is working correctly follow the instructions in :doc:`testnet-explorer-corda` to set up the Finance CorDapp and issue cash to a counterparty.

View File

@ -116,5 +116,21 @@ your unique Corda instance:
.. warning:: This command will execute the install script as ROOT on your cloud instance. You may wish to examine the script prior to executing it on your machine.
You can now navigate to the external web address of the instance and
see any cordapps running on port 8080 (if you have any installed).
You can follow the progress of the installation by typing the following command in your terminal:
.. code:: bash
tail -f /opt/corda/logs/node-<VM-NAME>.log
Once the node has booted up you can navigate to the external web address of the instance on port 8080. If everything is working you should see the following:
.. image:: resources/installed-cordapps.png
Testing your deployment
-----------------------
To test your deployment is working correctly follow the instructions in :doc:`testnet-explorer-corda` to set up the Finance CorDapp and issue cash to a counterparty.
This will also demonstrate how to install a custom CorDapp.

Binary file not shown.

After

Width:  |  Height:  |  Size: 112 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 216 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 177 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 56 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 400 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 340 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

View File

@ -0,0 +1,127 @@
Using the Node Explorer to test a Corda node on Corda Testnet
=============================================================
This document will explain how to test the installation of a Corda node on Testnet.
Prerequisites
-------------
This guide assumes you have deployed a Corda node to the Corda Testnet.
.. note::
If you need to set up a node on Testnet first please follow the instructions: :doc:`corda-testnet-intro`.
Get the testing tools
---------------------
To run the tests and make sure your node is connecting correctly to the network you will need to download and install a
couple of resources.
1. Log into your Cloud VM via SSH.
2. Stop the Corda node(s) running on your cloud instance.
.. code:: bash
ps aux | grep corda.jar | awk '{ print $2 }' | xargs sudo kill
3. Download the finance CorDapp
In the terminal on your cloud instance run:
.. code:: bash
wget https://ci-artifactory.corda.r3cev.com/artifactory/corda-releases/net/corda/corda-finance/<VERSION>-corda/corda-finance-<VERSION>-corda.jar
This is required to run some flows to check your connections, and to issue/transfer cash to counterparties. Copy it to the Corda installation location:
.. code:: bash
sudo cp /home/<USER>/corda-finance-<VERSION>-corda.jar /opt/corda/cordapps/
4. Add the following line to the bottom of your ``node.conf``:
.. code:: bash
issuableCurrencies : [ USD ]
.. note:: Make sure that the config file is in the correct format, e.g., by ensuring that there's a comma at the end of the line prior to the added config.
4. Restart the Corda node:
.. code:: bash
cd /opt/corda
sudo ./run-corda.sh
Your node is now running the Finance Cordapp.
.. note:: You can double-check that the CorDapp is loaded in the log file ``/opt/corda/logs/node-<VM-NAME>.log``. This file will list installed apps at startup. Search for ``Loaded CorDapps`` in the logs.
6. Now download the Node Explorer to your **LOCAL** machine:
.. note:: Node Explorer is a JavaFX GUI which connects to the node over the RPC interface and allows you to send transactions.
Download the Node Explorer from here:
.. code:: bash
http://ci-artifactory.corda.r3cev.com/artifactory/corda-releases/net/corda/corda-tools-explorer/<VERSION>-corda/corda-tools-explorer-<VERSION>-corda.jar
.. warning:: This Node Explorer is incompatible with the Corda Enterprise distribution and vice versa as they currently use different serialisation schemes (Kryo vs AMQP).
7. Run the Node Explorer tool on your **LOCAL** machine.
.. code:: bash
java -jar corda-tools-explorer-<VERSION>-corda.jar
.. image:: resources/explorer-login.png
Connect to the node
-------------------
To connect to the node you will need:
* The IP address of your node (the public IP of your cloud instance). You can find this in the instance page of your cloud console.
* The port number of the RPC interface to the node, specified in ``/opt/corda/node.conf`` in the ``rpcSettings`` section, (by default this is 10003 on Testnet).
* The username and password of the RPC interface of the node, also in the ``node.conf`` in the ``rpcUsers`` section, (by default the username is ``cordazoneservice`` on Testnet).
Click on ``Connect`` to log into the node.
Check your network identity and counterparties
----------------------------------------------
Once Explorer has logged in to your node over RPC click on the ``Network`` tab in the side navigation of the Explorer UI:
.. image:: resources/explorer-network.png
If your Corda node is correctly configured and connected to the Testnet then you should be able to see the identities of your node, the Testnet notary and the network map listing all the counterparties currently on the network.
Test issuance transaction
-------------------------
Now we are going to try and issue some cash to a 'bank'. Click on the ``Cash`` tab.
.. image:: resources/explorer-cash-issue1.png
Now click on ``New Transaction`` and create an issuance to a known counterparty on the network by filling in the form:
.. image:: resources/explorer-cash-issue2.png
Click ``Execute`` and the transaction will start.
.. image:: resources/explorer-cash-issue3.png
Click on the red X to close the notification window and click on ``Transactions`` tab to see the transaction in progress, or wait for a success message to be displayed:
.. image:: resources/explorer-transactions.png
Congratulations! You have now successfully installed a CorDapp and executed a transaction on the Corda Testnet.