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

  1. Provide AWS account ID of your organization to Liminal for whitelisting.
  2. Provide the AWS region in which you want to deploy the MPC infrastructure.
  3. Ensure that you have IAM users with administrative access to AWS, who can perform MPC deployment.
  4. Networking- Select existing VPC with IGW + 2+ public subnets (different AZs) for ALB HA.
  5. 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.
  6. Prepare TAR Password and Ubuntu Password (8-32 alphanumeric characters each, entered twice during deployment); stored securely in AWS Secrets Manager.
  7. From CIDR (e.g., 10.0.0.0/8 for ports 8081/443)—avoid 0.0.0.0/0.
  8. If you plan to use an HTTPS SDK endpoint , create an ACM certificate in the deployment region for your domain (e.g., mpc-api.yourcompany.com) via AWS Certificate Manager > Request public certificate > DNS validation; copy ARN once "Issued". Enable via stack parameter and provide this ARN.
    Refer here for more details.
  9. Domain example: mpc-api.company.com (status must be "Issued")​
  10. Post-deployment: Create CNAME record mapping your domain to the ALB DNS name​.

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. Download the following cloudformation yaml file depending on your requirement:

    1. Testing environment (Dev)
      1. Standard
      2. Whitelabel
    2. Production environment (Prod)
      1. Standard
      2. Whitelabel

  7. Open CloudFormation. Select Create stack and then select New resources.

  8. Click on Choose an existing template and then select Upload a template file and then upload the yaml that was downloaded in step 6 .

  9. Select Next to go to the next screen.

  10. Under Provide a stack name, in the stack name field, enter the name of the stack (without spaces).

  11. Under VPC configuration, select the VPCid and then select 2 public subnets from the dropdown belonging to the selected VPC.

  12. Under RDS Configuration, in the RDSInstanceType field, select the database instance type from the dropdown, rest all fields can be left default. It is advised to select t3.large to avoid the risk of failure.

  13. Under EC2 Configuration, in the InstanceType field, select the instance from the dropdown. It is advised to select m5.large to avoid the risk of failure.

  14. In the KeyName field, select a key pair from the dropdown.

  15. 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.

  16. 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.

  17. 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.

  18. Under Passwords, in the UbuntuPasswordInput field, enter a strong alphanumeric password. You will require this password to use ubuntu user in EC2 machine.

  19. Review your changes, tick the acknowledgement box and then select Submit to submit your changes.

  20. Wait until all 18 resources are generated and the stack creation is completed.

    ❗️

    Important
    Ensure you prevent the accidental deletion of your stack by:

    1. Navigate to the Stack actions dropdown to the top right of the screen.
    2. Select Edit termination protection > Activated.
    3. Save it.

  21. Once the stack creation is completed, go to the S3 bucket which is created by the Stack.

  22. Wait until the zip file is populated in the S3 bucket under Objects, containing all the important modules and components required for MPC.

  23. 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.

  24. Go to your EC2 Dashboard. Select Instances > Instances in the left panel. Select the instance that is created.

  25. Log into it. And run the command docker ps to check if both the containers are running as shown in the following screenshot.

  26. Run the following commands to verify the installation.
    curl [http://localhost:8000/version](http://localhost:8000/version)
    curl [http://localhost:8081/info](http://localhost:8081/info)

    📘

    Note

    Here is a version number of the screenshot for reference. Your actual version may differ.

  27. Run the following command to verify that your MPC server is running successfully.
    curl [http://elasticip:8081/info](http://elasticip:8081/info)

Updated 4 months ago

Updated 4 months ago