diff --git a/docs/source/aws-vm.rst b/docs/source/aws-vm.rst new file mode 100644 index 0000000000..0a532e339d --- /dev/null +++ b/docs/source/aws-vm.rst @@ -0,0 +1,72 @@ +Building a Corda VM from the AWS Marketplace +============================================ + +To help you design, build and test applications on Corda, called CorDapps, a Corda network AMI can be deployed from the `AWS Marketplace `_. Instructions on running Corda nodes can be found `here `_. + +This Corda network offering builds a pre-configured network of Corda nodes as Ubuntu virtual machines (VM). The network consists of a Notary node and three Corda nodes using version 1 of Corda. The following guide will also show you how to load one of four `Corda Sample apps `_ which demonstrates the basic principles of Corda. When you are ready to go further with developing on Corda and start making contributions to the project head over to the `Corda.net `_. + +Pre-requisites +-------------- +* Ensure you have a registered AWS account which can create virtual machines under your subscription(s) and you are logged on to the `AWS portal `_ +* It is recommended you generate a private-public SSH key pair (see `here `_) + + +Deploying a Corda Network +--------------------------- + +Browse to the `AWS Marketplace `_ and search for Corda. + +Follow the instructions to deploy the AMI to an instance of EC2 which is in a region near to your location. + +Build and Run a Sample CorDapp +------------------------------ +Once the instance is running ssh into the instance using your keypair + +.. sourcecode:: shell + + cd ~/dev + +There are 4 sample apps available by default + +.. sourcecode:: shell + + ubuntu@ip-xxx-xxx-xxx-xxx:~/dev$ ls -la + total 24 + drwxrwxr-x 6 ubuntu ubuntu 4096 Nov 13 21:48 . + drwxr-xr-x 8 ubuntu ubuntu 4096 Nov 21 16:34 .. + drwxrwxr-x 11 ubuntu ubuntu 4096 Oct 31 19:02 cordapp-example + drwxrwxr-x 9 ubuntu ubuntu 4096 Nov 13 21:48 obligation-cordapp + drwxrwxr-x 11 ubuntu ubuntu 4096 Nov 13 21:48 oracle-example + drwxrwxr-x 8 ubuntu ubuntu 4096 Nov 13 21:48 yo-cordapp + +cd into the Corda sample you would like to run. For example: + +.. sourcecode:: shell + + cd cordapp-example/ + +Follow instructions for the specific sample at https://www.corda.net/samples to build and run the Corda sample +For example: with cordapp-example (IOU app) the following commands would be run: + +.. sourcecode:: shell + + ./gradlew deployNodes + ./kotlin-source/build/nodes/runnodes + +Then start the Corda webserver + +.. sourcecode:: shell + + find ~/dev/cordapp-example/kotlin-source/ -name corda-webserver.jar -execdir sh -c 'java -jar {} &' \; + +You can now interact with your running CorDapp. See the instructions `here `_ + +Next Steps +---------- +Now you have built a Corda network and used a basic Corda Cordapp do go and visit the `dedicated Corda website `_ + +Additional support is available on `Stack Overflow `_ and the `Corda Slack channel `_. + +You can build and run any other `Corda samples `_ or your own custom CorDapp here. + +Or to join the growing Corda community and get straight into the Corda open source codebase, head over to the `Github Corda repo `_ diff --git a/docs/source/tools-index.rst b/docs/source/tools-index.rst index 36d24534a0..3955a0cbe1 100644 --- a/docs/source/tools-index.rst +++ b/docs/source/tools-index.rst @@ -8,4 +8,5 @@ Tools demobench node-explorer azure-vm + aws-vm loadtesting \ No newline at end of file