API Reference

Deploy MPC on your AWS server

Liminal enables you to deploy MPC infrastructure on your servers, giving you full control over your keys and assets. Assign a DevOps specialist from your organisation to help with deploying MPC infrastructure on AWS. Or else, delegate this task to someone with an intermediate familiarity with AWS.

Prerequisites

  • Provide AWS account ID of your organisation to Liminal for whitelisting.
  • Provide the AWS region in which you want to deploy the MPC infrastructure.
  • Ensure that you have IAM users with administrative access to AWS, who can perform MPC deployment.
  • Ensure that you have existing SSH keys in your AWS account. If not, create a new one.
  • Go to EC2 Dashboard > Network & Security > Key Pair in the left panel and check for the .pem key. If it doesn’t exist, then create a new one.
  • Ensure that your elastic IP has an available quota for your region. In the EC2 Dashboard, go to EC2 Dashboard > Elastic IPs in the left panel and check whether the quota is fully used or not.

Deploy MPC on AWS

Take the following steps to deploy MPC on your AWS server.

  1. Log into your AWS account and go to your EC2 Dashboard.
  2. Select your region using the dropdown on top of the screen.
  3. Select Images > AMIs in the left panel.
  4. Select the Owned by me dropdown and then select Private images.
  5. Search for the private image of MPC shared by Liminal in the search bar. This is the AMI which will be used in the CloudFormation script shared by Liminal.
  6. Open CloudFormation. Select Create stack and then select New resources.
  7. Under Specify template, in the Amazon s3 URL field, enter any one of the following urls:
  8. Select Next to go to the next screen.
  9. Under Provide a stack name, in the stack name field, enter the name of the stack (without spaces).
  10. Under VPC configuration, select the VPCid and then select 2 public subnets from the dropdown belonging to the selected VPC.
  11. Under RDS Configuration, in the RDSInstanceType field, select the database instance type from the dropdown, rest all fields can be left default.
  12. Under EC2 Configuration, in the InstanceType field, select the instance from the dropdown.
  13. In the KeyName field, select a key pair from the dropdown.
  14. In the SSHLocation field, enter the IP address in CIDR format, for example 3.1.5.67/32, which is where you will log into your new EC2 instance.
  15. In the AllowAPIAccessFrom field, enter the IP address of your application server in CIDR format, such as 3.1.5.67/32, which is where you will connect to Liminal SDK APIs.
  16. Under Passwords, in the TarPassword field, enter a strong alphanumeric password. You will require this password to open a password-protected zip file in your S3 bucket.
  17. Review your changes, tick the acknowledgement box and then select Submit to submit your changes.
    Wait until all 18 resources are generated and the stack creation is completed.

Important: To prevent accidental deletion of your stack, go to the Stack actions dropdown on top right of your screen. Select Edit termination protection > Activated, and then save it.

  1. Wait until all 18 resources are generated and the stack creation is completed.
  2. Once the stack creation is completed, go to the S3 bucket which is created by the Stack.
  3. Wait until the zip file is populated in the S3 bucket under Objects, containing all the important modules and components required for MPC.
  4. Download this file to store a copy of it in the vault or password manager. This file can be opened using the TarPassword you created earlier.
  5. Go to your EC2 Dashboard. Select Instances > Instances in the left panel. Select the instance that is created.
  6. Log into it. And run the command docker ps to check if both the containers are running as shown in the following screenshot.

  1. Run the following commands to verify the installation.
    1. curl http://localhost:8000/version
    2. curl http://localhost:8081/info

Note that the version number in the above screenshot is for reference only. Your actual version may differ.

  1. Run the following command to verify that your MPC server is running successfully.
    curl http://elasticip:8081/info