ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2025-04-18 08:10:47 +00:00
Code Issues Actions2 Packages Projects Releases Wiki Activity

Azure template guide ()

Browse Source 
* Azure template guide and testnet docs update
This commit is contained in:
Nick Arini 2018-07-20 16:29:10 +01:00 committed by GitHub
parent b44fc94997
commit 0c0d9b7906
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
16 changed files with 111 additions and 408 deletions

111
docs/source/aws-vm-explore.rst

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

73
docs/source/azure-template-guide.rst Normal file

@ -0,0 +1,73 @@
Using Azure Resource Manager Templates to deploy a Corda Enterprise node
========================================================================
This document will explain how to deploy a Corda Enterprise node to the Azure cloud using the Azure Resource Manager templates via the Azure Marketplace.
Prerequisites
-------------
You will need a Microsoft Azure account which can create new resource groups and resources within that group.
Find Corda Enterprise on Azure Marketplace
------------------------------------------
Go to https://azuremarketplace.microsoft.com/en-us/ and search for ``corda enterprise`` and select the ``Corda Enterprise Single Node`` option:
.. image:: resources/azure-template-search.png
Click on ``GET IT NOW``:
.. image:: resources/azure-template-marketplace.png
Click on ``Continue`` to agree to the terms:
.. image:: resources/azure-template-agree.png
This will take you to the Azure Cloud Portal. Log in to the Portal if you are not already. It should redirect to the Corda Enterprise template automatically:
.. image:: resources/azure-template-portal.png
Click on ``Create`` to enter the parameters for the deployment.
.. image:: resources/azure-template-basics.png
Enter the VM base name, an SSH public key or password to connect to the resources over SSH, an Azure region to host the deployment and create a new resource group to house the deployment. Click ``OK``.
.. image:: resources/azure-template-vm.png
Next select the virtual machine specification. The default here is suitable for Corda Enterprise so its fine to click ``OK``. Feel free to select a different specification of machine and storage if you have special requirements.
.. image:: resources/azure-template-settings.png
Next configure the Corda node settings. Currently the only version available with the template is the current release of Corda Enterprise. We may add more version options in the future.
Enter the city and country that you wish to be associated with your Corda node.
.. note:: This doesn't need to be the same as the Azure region you host your node in. It should represent the main location of your business operations.
You will need to obtain a ``one-time-download-key`` in order to set up the template. This will allow the template scripts to connect to, and provision the node to the Corda Testnet.
You can register with Testnet and obtain the ``ONE-TIME-DOWNLOAD-KEY`` at https://testnet.corda.network or see the Testnet documentation: :doc:`corda-testnet-intro`.
Finally you can select your database sizing in the ``Corda Data Tier Performance`` (the default is fine for typical usage).
Click ``OK``.
.. image:: resources/azure-template-summary.png
Wait for the validation checks to pass and check the settings. Click ``OK``.
.. image:: resources/azure-template-create.png
Check the Terms of Use and if everything is OK click ``Create``. Azure will now run the template and start to provision the node to your chosen region. This could take some time.
You will be redirected to your ``Dashbord`` where the deployment will appear if the deployment completes without errors.
You can now log in to your resource by selecting the virtual machine in the resource group and clicking on ``Connect``. Log in with SSH.
Testing the deployment
----------------------
You can test the deployment by following the instructions in :doc:`testnet-explorer`.

135
docs/source/azure-vm-explore.rst

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

6
docs/source/corda-networks-index.rst

@ -10,8 +10,6 @@ Networks
network-map
versioning
corda-testnet-intro
azure-vm-explore
aws-vm-explore
gcp-vm
deploy-locally
azure-template-guide
testnet-explorer
cipher-suites

34
docs/source/corda-testnet-intro.rst

@ -30,51 +30,43 @@ Fill in the form with your details.
.. note::
Testnet is currently invitation only. If your request is approved you will receive an email. Please fill in as many details as possible as it helps us proritise requests. The approval process will take place daily by a member of the r3 operations team reviewing all invite requests and making a decision based on current rate of onboarding of new customers.
Testnet is currently invitation only. If your request is approved you will receive an email. Please fill in as many details as possible as it helps us prioritise. The approval process will take place daily by a member of the R3 operations team reviewing all invite requests and making a decision based on the current rate of onboarding of new customers.
.. image:: resources/testnet-form.png
.. image:: resources/testnet-form.png
.. note::
We currently only support federated login using Google email accounts. Please ensure the email you use to register is a Gmail account or is set up as a Google account and that you use this email to log in.
Gmail is recommended. If you want to use a non-Gmail account you can enable your email for Google: https://support.google.com/accounts/answer/176347?hl=en
Gmail is recommended. If you want to use a non-Gmail account you can enable your email for Google: https://support.google.com/accounts/answer/176347?hl=en
Once you have been approved, navigate to https://testnet.corda.network and click on "I have an invitation".
Sign in using the Google login service:
.. image:: resources/testnet-signin.png
.. image:: resources/testnet-signin.png
When prompted approve the Testnet application:
.. image:: resources/testnet-signin-auth.png
.. image:: resources/testnet-signin-auth.png
.. note::
.. note::
At this point you may need to verify your email address is valid (if you are not using a Gmail address). If prompted check your email and click on the link to validate then return to the sign in page and sign in again.
At this point you may need to verify your email address is valid (if you are not using a Gmail address). 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
.. 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.
You can now copy the ``ONE-TIME-KEY`` and paste it into the parameter form of your cloud template.
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
.. 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 remote cloud terminal.
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.
.. 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. Please follow the instructions here: :doc:`deploy-locally`.
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.
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.
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 provisioning 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

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

BIN
docs/source/resources/azure-template-agree.png Normal file

Binary file not shown.
Side by Side

After

(image error) Size: 352 KiB

BIN
docs/source/resources/azure-template-basics.png Normal file

Binary file not shown.
Side by Side

After

(image error) Size: 251 KiB

BIN
docs/source/resources/azure-template-create.png Normal file

Binary file not shown.
Side by Side

After

(image error) Size: 466 KiB

BIN
docs/source/resources/azure-template-marketplace.png Normal file

Binary file not shown.
Side by Side

After

(image error) Size: 308 KiB

BIN
docs/source/resources/azure-template-portal.png Normal file

Binary file not shown.
Side by Side

After

(image error) Size: 277 KiB

BIN
docs/source/resources/azure-template-search.png Normal file

Binary file not shown.
Side by Side

After

(image error) Size: 825 KiB

BIN
docs/source/resources/azure-template-settings.png Normal file

Binary file not shown.
Side by Side

After

(image error) Size: 244 KiB

BIN
docs/source/resources/azure-template-summary.png Normal file

Binary file not shown.
Side by Side

After

(image error) Size: 302 KiB

BIN
docs/source/resources/azure-template-vm.png Normal file

Binary file not shown.
Side by Side

After

(image error) Size: 226 KiB

40
docs/source/testnet-explorer.rst

@ -1,7 +1,7 @@
Using the Node Explorer to test a Corda Enterprise node on Corda Testnet
========================================================================
This document will explain how to test the installation of a Corda Enterprise node on Azure or AWS.
This document will explain how to test the installation of a Corda Enterprise node on Corda Testnet.
Prerequisites
@ -18,6 +18,7 @@ This guide assumes you have deployed a Corda Enterprise node to either Azure or
It also assumes your node is provisioned and connected to the Corda Testnet although the instructions below should work
for any Corda Enterprise node connected to any Corda network.
.. note:: If you need to set up a Corda Enterprise node using the Cloud templates, see: :doc:`azure-template-guide`.
Get the testing tools
---------------------
@ -36,18 +37,25 @@ couple of resources.
.. warning:: If this is an HA node, make sure to stop both the hot and cold nodes before proceeding. Any database migration should be performed whilst both nodes are offline.
3. Copy the finance CorDapp from ``/home/ubuntu/apps/`` to ``/opt/corda/cordapps/``.
3. Download the Resources:
Download the finance CorDapp and database manager to your VM instance:
.. code:: bash
wget http://downloads.corda.net/cordapps/net/corda/finance/ENT-3.1/corda-finance-3.1.jar \
http://downloads.corda.net/cordapps/net/corda/finance/ENT-3.1/corda-finance-3.1-sources.jar \
http://downloads.corda.net/tools/database-manager/corda-tools-database-manager-3.1.jar
Copy the downloads from ``/home/<USER>/`` to ``/opt/corda/cordapps/``.
This is required to run some flows to check your connections, and to issue/transfer cash to counterparties.
.. code:: bash
sudo cp /home/ubuntu/apps/*.jar /opt/corda/cordapps/
.. note::
sudo cp /home/<USER>/corda-finance-*.jar /opt/corda/cordapps/
If you are not using a cloud template then you will need to download and manually install these files to the default install location.
4. Create a symbolic link to the shared database driver folder
.. code:: bash
@ -59,9 +67,9 @@ couple of resources.
.. code:: bash
cd /opt/corda
sudo java -jar /home/ubuntu/tools/corda-tools-database-manager-3.0.jar --base-directory /opt/corda --execute-migration
sudo java -jar /home/<USER>/corda-tools-database-manager-3.0.jar --base-directory /opt/corda --execute-migration
6. Add the following line to your ``node.conf``:
6. Add the following line to the bottom of your ``node.conf``:
.. code:: bash
@ -77,23 +85,21 @@ couple of resources.
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.
.. 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.
8. Now download the Node Explorer to your local machine:
A copy of the Enterprise node explorer is included in the ``/home/ubuntu/tools/`` directory of the VM. Run the following command from your local machine.
8. Now download the Node Explorer to your **LOCAL** machine:
.. code:: bash
scp ubuntu@<IP>:tools/corda-tools-node-explorer-<VERSION>.jar .
wget http://downloads.corda.net/tools/explorer/ENT-3.1/corda-tools-explorer-3.1.jar
.. note:: The Enterprise Node Explorer is incompatible with open source versions of Corda and vice versa as they currently use different serialisation schemes (Kryo vs AMQP).
.. warning:: The Enterprise Node Explorer is incompatible with open source versions of Corda and vice versa as they currently use different serialisation schemes (Kryo vs AMQP).
9. Run the Node Explorer tool on your local machine.
9. Run the Node Explorer tool on your **LOCAL** machine.
.. code:: bash
java -jar corda-tools-explorer-<VERSION>.jar
java -jar corda-tools-explorer-3.1.jar
.. image:: resources/explorer-login.png