ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2025-04-19 08:36:39 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Remove files not wanted in ent documentation

Browse Source
This commit is contained in:
Anthony Keenan 2018-07-23 09:06:43 +01:00
parent 168664f7a8
commit c5e93cf5a4
4 changed files with 0 additions and 430 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/source/corda-networks-index.rst
View File

@ -12,7 +12,4 @@ Networks
corda-testnet-intro
azure-template-guide
testnet-explorer
gcp-vm
deploy-locally
testnet-explorer-corda
cipher-suites

164
docs/source/deploy-locally.rst
View File

@ -1,164 +0,0 @@
Setting up your local environment to allow the deployment of a Corda node
=========================================================================
.. contents::
This document explains how to set up your local network to enable a
Corda node to connect to the Corda Testnet. This assumes you are
downloading a node ZIP from: https://testnet.corda.network.
Pre-requisites
--------------
* Register for an account on https://testnet.corda.network.
Set up your local network
-------------------------
For a Corda node to be able to connect to the Corda Testnet and be
reachable by counterparties on that network it needs to be reachable
on the open internet. Corda is a server which requires an externally
visible IP address and several ports in order to operate correctly.
We recommend running your Coda node on cloud infrastructure. If you
wish to run Corda on your local machine then you will need to
configure your network to enable the Corda node to be reachable from
the internet.
.. note:: You will need access to your network router/gateway to the internet. If you do not have direct access then contact your administrator.
The following steps will describe how to use port forwarding on your
router to make sure packets intended for Corda are routed to the right
place on your local network.
Set up static IP address local host machine
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The next steps will configure your router to forward
packets to the Corda node, but for this it is required to set the host
machine to have a static IP address. If this isn't done, and the
network is using DHCP dynamic address allocation then the next time
the host machine is rebooted it may be on a different IP and the port
forwarding will no longer work.
Please consult your operating system documentation for instructions on
setting a static IP on the host machine.
Set up port forwarding on your router
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Port forwarding is a method of making a computer on your network
accessible to computers on the Internet, even though it is behind a router.
.. note:: All routers are slightly different and you will need to consult the documentation for your specific make and model.
Log in to the admin page of your router (often ``192.168.0.1``) in your
browser bar.
.. note:: Router administration IP and log in credentials are usually on the bottom or side of your router.
Navigate to the ``port forwarding`` section of the admin console.
Add rules for the following ports which Corda uses:
.. code:: bash
10002
10003
8080
.. note:: These ports are the defaults for Testnet which are specified
in the node.conf. If these conflict with existing services
on your host machine they can be changed in the
``/opt/corda/node.conf`` file.
For each rule you will also typically have to specify the rule name,
the static IP address of the host machine we configured earlier (the
same in each case) and the protocol (which is TCP in all cases here).
Please consult your router documentation for specific details on
enabling port forwarding.
Open firewall ports
~~~~~~~~~~~~~~~~~~~
If you are operating a firewall on your host machine or local network
you will also need to open the above ports for incoming traffic.
Please consult your firewall documentation for details.
Optional: Configure a static external IP address
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Corda expects nodes to have stable addresses over long periods of
time. ISPs typically assign dynamic IP addresses to a router and so if
your router is rebooted it may not obtain the same external IP and
therefore your Corda node will change its address on the Testnet.
You can request a static IP address from your ISP however this may
incur a cost.
If the IP address does change then this doesn't cause issues but it
will result in an update to the network map which then needs to be
propagated to all peers in the network. There may be some delay in the
ability to transact while this happens.
.. warning:: Corda nodes are expected to be online all the time and
will send a heartbeat to the network map server to
indicate they are operational. If they go offline for a
period of time (~24 hours in the case of Testnet) then
the node will be removed from the network map. Any nodes
which have queued messages for your node will drop these messages,
they won't be delivered and unexpected behaviour may
occur.
Test if the ports are open
~~~~~~~~~~~~~~~~~~~~~~~~~~
You can use a port checking tool to make sure the ports are open
properly.
Download and install your node
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Navigate to https://testnet.corda.network/platform.
Click on the ``Download`` button and wait for the ZIP
file to download:
.. image:: resources/testnet-download.png
.. note: This may take several seconds.
Unzip the file in your Corda root directory:
.. code:: bash
mkdir corda
cd corda
cp <PATH_TO_DOWNLOAD>/node.zip .
unzip node.zip
cd node
Run the ``run-corda.sh`` script to start your Corda node.
.. code:: bash
./run-corda.sh
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.

136
docs/source/gcp-vm.rst
View File

@ -1,136 +0,0 @@
Deploying Corda to Corda Testnet from a Google Cloud Platform VM
================================================================
.. contents::
This document explains how to deploy a Corda node to Google Cloud Platform that can connect directly to the Corda Testnet. A self service download link can be obtained from https://testnet.corda.network. This document will describe how to set up a virtual machine on the Google Cloud Platform (GCP) to deploy your pre-configured Corda node and automatically connnect to Testnet.
Pre-requisites
--------------
* Ensure you have a registered Google Cloud Platform account with
billing enabled (https://cloud.google.com/billing/docs/how-to/manage-billing-account) which can create virtual machines under your subscription(s) and you are logged on to the GCP console: https://console.cloud.google.com.
Deploy Corda node
-----------------
Browse to https://console.cloud.google.com and log in with your
Google credentials.
**STEP 1: Create a GCP Project**
In the project drop down click on the plus icon to create a new
project to house your Corda resources.
.. image:: resources/consolegcp.png
.. image:: resources/console2.png
.. image:: resources/newprojectgcp.png
Enter a project name and click Create.
**STEP 2: Launch the VM**
In the left hand side nav click on Compute Engine.
.. image:: resources/gcpcompute.png
Click on Create Instance.
.. image:: resources/consolegcpcreatevm.png
Fill in the form with the desired VM specs:
Recommended minimum 4vCPU with 15GB memory and 40GB Persistent disk.
Ubuntu 16.04 LTS.
Allow full API access.
Dont worry about firewall settings as you will configure those later.
.. image:: resources/gcpconsolevmsettings.png
Click Create and wait a few sections for your instance to provision
and start running.
**STEP 3: Connect to your VM and set up the environment**
Once your instance is running click on the SSH button to launch a
cloud SSH terminal in a new window.
.. image:: resources/gcpconsolelaunchssh.png
.. image:: resources/gcpshell.png
Run the following to configure the firewall to allow Corda traffic
.. code:: bash
gcloud compute firewall-rules create nodetonode --allow tcp:10002
gcloud compute firewall-rules create nodetorpc --allow tcp:10003
gcloud compute firewall-rules create webserver --allow tcp:8080
Promote the ephemeral IP address associated with this
instance to a static IP address.
First check the region and select the one you are using from the list:
.. code:: bash
gcloud compute regions list
Find your external IP:
.. code:: bash
gcloud compute addresses list
Run this command with the ephemeral IP address as the argument to
the --addresses flag and the region:
.. code:: bash
gcloud compute addresses create corda-node --addresses 35.204.53.61 --region europe-west4
**STEP 4: Download and set up your Corda node**
Now your GCP environment is configured you can switch to the Testnet
web application and click on the copy to clipboard button to get a one
time installation script.
.. note:: If you have not already set up your account on Testnet then please visit https://testnet.corda.network and sign up.
.. image:: resources/testnet-platform.png
You can generate as many Testnet identites as you like by refreshing
this page to generate a new one time link.
In the terminal of your cloud instance paste the command you just copied to install and run
your unique Corda instance:
.. code:: bash
sudo ONE_TIME_DOWNLOAD_KEY=YOUR_UNIQUE_DOWNLOAD_KEY_HERE bash -c "$(curl -L https://testnet.corda.network/api/user/node/install.sh)"
.. 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 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.

127
docs/source/testnet-explorer-corda.rst
View File

@ -1,127 +0,0 @@
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.