Testnet documentation pages (#3287)

* added doc page for running Corda on GCP vis Explore

* Fix bash code examples

* add images

* add images

* more typos fixed

* typo

* fix firewall commands

* more screenshots

* add screenshots for new projewct

* scale images

* screenshot

* added screenshot

* Bold steps

* more screenshots

* added screenshots

* upload screenshots

* added screenshots

* add contents

* add azure file

* add azure file

* updated azure screenshots

* updated azure screenshots

* more screenshots and text

* Updated run commands

* Updated run commands

* Update azure-vm-explore.rst

* Fix urls

* add AWS setup for explore

* aws screenshots

* update test for AWS

* aws screenshots

* aws screenshots

* add screenshots

* AWS updates

* AWS

* aws screenshot

* aws screenshots

* aws images

* aws updates

* aws updates

* aws screenshot

* Updated intro to new branding

* Added resoure group docs to azure page

* Updated azure screenshots

* Updated azure screenshots

* Updated azure screenshots

* Updated azure screenshots

* Updated aws docs

* Updated GCP docs

* Updated GCP docs

* Adding a Testnet overview page

* Adding a Testnet overview page

* Adding a Testnet overview page

* Adding a Testnet overview page

* Adding a Testnet overview page

* Adding a Testnet overview page

* Adding elastic IP to AWS

* Adding elastic IP to AWS

* Adding elastic IP to AWS

* updated dl link

* Update aws-vm-explore.rst

* update dl link

* Update gcp-vm.rst

* Fixing changes requested by RGB.

* Fixed link

* Additional changes requested in review.

* Updated based on RGB review comments.

* Minor formatting

* minor formatting

* Address review comments

* Address the review comments from RGB

* typo

* typo

* typo

* typo

* make underlines same length as headers

* Fix review comments

* Fix review comments

* fix review comments

* adding to index
This commit is contained in:
Nick Arini 2018-07-11 14:12:52 +01:00 committed by Joel Dudley
parent 9503c9684e
commit 017ffab60b
51 changed files with 445 additions and 0 deletions

View File

@ -0,0 +1,111 @@
Deploying Corda to Corda Testnet from an AWS Cloud Platform VM
==============================================================
.. contents::
This document explains how to deploy a Corda node to AWS 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 AWS
Cloud Platform to deploy your pre-configured Corda node and automatically connnect
to Testnet.
Pre-requisites
--------------
* Ensure you have a registered Amazon AWS account which can create virtual machines and you are logged on to the AWS console: https://console.aws.amazon.com.
Deploy Corda node
-----------------
Browse to https://console.aws.amazon.com and log in with your AWS account.
**STEP 1: Launch a new virtual machine**
Click on Launch a virtual machine with EC2.
.. image:: resources/aws-launch.png
In the quick start wizard scroll down and select the most recent Ubuntu machine image as the Amazon Machine Image (AMI).
.. image:: resources/aws_select_ubuntu.png
Select the instance type (for example t2.xlarge).
.. image:: resources/aws-instance-type.png
Configure a couple of other settings before we review and launch
Under the storage tab (Step 4) increase the storage to 40GB:
.. image:: resources/aws-storage.png
Configure the security group (Step 6) to open the firewall ports which Corda uses.
.. image:: resources/aws-firewall.png
Add a firewall rule for port range 10002-10003 and allow connection from Anywhere. Add another rule for the webserver on port 8080.
Click on the Review and Launch button then if everything looks ok click Launch.
You will be prompted to set up keys to securely access the VM remotely over ssh. Select "Create a new key pair" from the drop down and enter a name for the key file. Click download to get the keys and keep them safe on your local machine.
.. note:: These keys are just for connecting to your VM and are separate from the keys Corda will use to sign transactions. These keys will be generated as part of the download bundle.
.. image:: resources/aws-keys.png
Click "Launch Instances".
Click on the link to go to the Instances pages in the AWS console where after a few minutes you will be able to see your instance running.
.. image:: resources/aws-instances.png
**STEP 2: Set up static IP address**
On AWS a permanent IP address is called an Elastic IP. Click on the
"Elastic IP" link in the navigation panel on the left hand side of the console and then click on "Allocate new address":
.. image:: resources/aws-elastic.png
Follow the form then once the address is allocated click on "Actions"
then "Associate address":
.. image:: resources/aws-elastic-actions.png
Then select the instance you created for your Corda node to attach the
IP address to.
**STEP 3: Connect to your VM and set up the environment**
In the instances console click on "Connect" and follow the instructions to connect to your instance using ssh.
.. image:: resources/aws-instances-connect.png
.. image:: resources/aws-connect.png
**STEP 4: Download and set up your Corda node**
Now your AWS environment is configured you can switch back 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 on that 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 now navigate to the external web address of the instance and
see any cordapps running on port 8080 (if you have any installed).

View File

@ -0,0 +1,135 @@
Deploying Corda to Corda Testnet from an Azure Cloud Platform VM
================================================================
.. contents::
This document explains how to deploy a Corda node to Azure 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 Azure Cloud Platform to deploy your pre-configured Corda node and automatically connnect to Testnet.
Pre-requisites
--------------
* Ensure you have a registered Microsoft Azure account which can create virtual machines and you are logged on to the Azure portal: https://portal.azure.com.
Deploy Corda node
-----------------
Browse to https://portal.azure.com and log in with your Microsoft account.
**STEP 1: Create a Resource Group**
Click on the "Resource groups" link in the side nav in the Azure
Portal and then click "Add":
.. image:: resources/azure-rg.png
Fill in the form and click "Create":
.. image:: resources/azure-rg-2.png
**STEP 2: Launch the VM**
At the top of the left sidenav click on the button with the green cross "Create a resource".
In this example we are going to use an Ubuntu server so select the latest Ubuntu Server option.
.. image:: resources/azure-select-ubuntu.png
Fill in the form:
.. image:: resources/azure-vm-form.png
Add a username (to log into the VM) and choose and enter a password.
Choose the resource group we created earlier from the "Use existing" dropdown.
Select a cloud region geographically near to your location to host your VM.
Click on OK.
Choose the "D4S_V3 Standard" option and click "Select":
.. image:: resources/azure-instance-type.png
Click on "Public IP address" to open the settings panel
.. image:: resources/azure-vm-settings.png
Set the IP address to "Static" under Assignment.
.. note:: This is so the IP address for your node does not change rapidly in the global network map.
.. image:: resources/azure-set-static-ip.png
Click OK.
Next click on "Network security group (firewall)":
.. image:: resources/azure-nsg.png
Add inbound rules for ports 8080 (webserver), and
10002-10003 for the P2P and RPC ports used by the Corda node
respectively:
Add 3 rules with the following port, name and priorities:
.. code:: bash
Port range: 10002, Priority: 1041 Name: Port_10002
Port range: 10003, Priority: 1042 Name: Port_10003
Port range: 8080, Priority: 1043 Name: Port_8080
.. note:: The priority has to be unique number in the range 900
(highest) and 4096 (lowest) priority. Make sure each rule
has a unique priority or there will be a validation failure and error message.
.. image:: resources/azure-nsg-2.png
Click OK and OK again on the Settings panel.
.. image:: resources/azure-settings-ok.png
Click "Create" and wait a few minutes for your instance to provision
and start running.
.. image:: resources/azure-create-vm.png
**STEP 3: Connect to your VM and set up the environment**
Once your instance is running click on the "Connect" button and copy the ssh command:
.. image:: resources/azure-ssh.png
Enter the ssh command into your terminal. At the prompt to continue connecting type yes and then enter the password you configured earlier to log into the remote VM:
.. image:: resources/azure-shell.png
**STEP 4: Download and set up your Corda node**
Now your Azure 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 node:
.. 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 now navigate to the external web address of the instance and
see any cordapps running on port 8080 (if you have any installed).

View File

@ -8,4 +8,8 @@ Networks
permissioning
network-map
versioning
corda-testnet-intro
azure-vm-explore
aws-vm-explore
gcp-vm
cipher-suites

View File

@ -0,0 +1,75 @@
The Corda Testnet
=================
.. contents::
The Corda Testnet is an open public network of Corda nodes on the internet. It is designed to be a complement to *the* Corda Network where any entity can transact real world value with any other counterparty in the context of any application. The Corda Testnet is designed for "non-production" use in a genuine global context of Corda nodes, including but not limited to CorDapp development, multi-party testing, demonstration and showcasing of applications and services, learning, training and development of the Corda platform technology and specific applications of Corda.
The Corda Testnet is based on exactly the same technology as the main Corda Network, but can be joined on a self-service basis through the automated provisioning system described below.
The Corda Testnet is currently in private beta. Interested parties can request in invitation to join the Corda Testnet by completing a short request form (see below).
Deploying a Corda node to the Corda Testnet
-------------------------------------------
Access to the Corda Testnet is enabled by visiting https://testnet.corda.network.
.. image:: resources/testnet-landing.png
:target: https://testnet.corda.network
Click on "Join the Corda Testnet".
Select whether you want to register a company or as an individual on the Testnet.
This will create you an account with the Testnet onboarding application which will enable you to provision and manage multiple Corda nodes on Testnet. You will log in to this account to view and manage you Corda Testnet identitiy certificates.
.. image:: resources/testnet-account-type.png
Fill in the form with your details. This helps prioritise requests to join the private beta.
.. image:: resources/testnet-form.png
Note we currently only support federated login using either Google email accounts or Github enabled email accounts. Please ensure the email you use to register is either set up as a Google or Github account and that you use this email to log in with the appropriate service.
To enable your email for Google please see https://support.google.com/accounts/answer/176347?hl=en
To set up a Github account please see https://github.com/join
Once you have been approved to join the beta you will receive an email. Follow the link in the email to sign in or click on "I have an invitation" on the https://testnet.corda.network
Sign in using either the Google or Github login services:
.. image:: resources/testnet-signin.png
When prompted approve the Testnet application:
.. image:: resources/testnet-signin-auth.png
At this point you may need to verify your email address is valid. If prompted check your email and click on the link to validate then return to the sign in page and sign in again.
Next agree to the terms of service:
.. image:: resources/testnet-terms.png
You can now choose how to deploy your Corda node to the Corda Testnet. We strongly recommend hosting your Corda node on a public cloud resource.
.. note:: If you host your node on your own machine or a corporate server you must ensure it is reachable from the public internet at a specific IP address. This will typically require port forwarding on your router.
Select the cloud provider you wish to use for documentation on how to specifically configure Corda for that environment.
.. image:: resources/testnet-platform-clean.png
Once your cloud instance is set up you can install and run your Testnet pre-provisioned Corda node by clicking on "Copy" and pasting the one time link into your cloud shell.
The installation script will download the Corda binaries as well as your PKI certificates, private keys and suporting files and will install and run Corda on your fresh cloud VM. Your node will register itself with the Corda Testnet when it first runs and be added to the global network map and be visible to counterparties after approximately 5 minutes.
Hosting a Corda node locally is possible but will require manually configuring firewall and port forwarding on your local router. If you want this option then click on the "Download" button to download a Zip file with a pre-configured Corda node.
A note on identities on Corda Testnet
-------------------------------------
Unlike the main Corda Network, which is designed for verified real world identities, The Corda Testnet automatically assigns a "distinguished name" as your identity on the network. This is to prevent name abuse such as the use of offensive language in the names or name squatting. This allows the provision of a node to be automatic and instantaneous. It also enables the same user to safely generate many nodes without accidental name conflicts. If you require a human readable name then please contact support and a partial organsation name can be approved.

120
docs/source/gcp-vm.rst Normal file
View File

@ -0,0 +1,120 @@
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 now navigate to the external web address of the instance and
see any cordapps running on port 8080 (if you have any installed).

Binary file not shown.

After

Width:  |  Height:  |  Size: 223 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 109 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 107 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 269 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 433 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 178 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 166 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 216 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 135 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 194 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 406 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 367 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 412 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 436 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 188 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 422 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 174 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 338 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 484 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 120 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 100 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 283 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 310 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 460 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 331 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 637 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 200 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 288 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 342 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 387 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 519 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 869 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 264 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 362 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 255 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 317 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 250 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 110 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.3 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.6 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.5 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.4 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.4 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.4 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.6 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.6 MiB