Overledger Authorise Containerized Monthly subscription by Quant Network

Pre-requisite for Deploying the Authorise service

1. Create a VPC and subnet groups to deploy the Authorise service.

2. Create/register your Quant Connect account for free via the Quant Connect website (https://connect.overledger.dev/login  ). No credit card is required to create the account.

3. In your Connect account, you would need to create an application on the "My application" page and do the following:

• Select "Register new application." If you can not see that, select the plus sign next to the text "Applications created."
• Follow the setup steps shown in the popup window.
• You should see the information for your new application at the end. Copy the ClientID and Secret, which are needed for the CloudFormation template.

To deploy the Authorise service: CloudFormation Deployment

1. Use the provided AWS CloudFormation template. This is found on the Marketplace's deployment page.

2. Input the required parameters, including:

• ECS cluster name = The name you want to give your ECS cluster. (Make sure you do not have spaces in them.)
• VPC ID = The ID of the VPC which hosts the Authorise service and allows connections to Overledger.
• ECS Subnets for "tsr-module-ethereum" = ECS Subnets for "tsr-module-ethereum", which receives requests from the "transaction-signing-responder-release" and interacts with Lambda to manage KMS keys.
• Load balancer scheme for "tsr-module-ethereum" = Can be Internal or Internet-facing. (Recommended Internal)
• Load balancer subnets for "tsr-module-ethereum" = Can be Private or Public Subnets. (Recommended Private)
• ECS Subnets for "transaction-signing-responder-release" = ECS Subnets for "transaction-signing-responder-release" which can be accessed by Overledger.
• Load balancer scheme for "transaction-signing-responder-release" = Can be Internal or Internet-facing. (Recommended Internet-facing)
• Load balancer subnets for "transaction-signing-responder-release" = Can be Private or Public Subnets. (recommended Private)
• DocumentDB subnets = The subnet on which you would like to deploy the DocumentDB cluster.
• DocumentDB engine version = The version you would like to set for DocumentDB instances.
• DocumentDB parameter group family = The parameter group family you want to set for DocumentDB instances.
• DocumentDB instance class = The class you want to set for DocumentDB instances.
• DocumentDB master username = The Username you want to set for DocumentDB. Transaction Signing Responder Name = You create a unique name that helps to identify you when connecting to Overledger.
• Transaction Signing Responder Client ID = The ClientID you copied from your Connect account.
• Transaction Signing Responder Client Secret = The Secret you copied from your Connect account.
• JKS Password = The password you want to set for the Java Key Store.
• Authorise Network = Which Authorise service network would you like to connect to? (Testnet/Mainnet)

3. Deploy the stack and validate the provisioning of:

• 1 x DocumentDB Cluster
• 4 x Lambda Functions
• 1 x ECS Cluster
• 2 x Application Load Balancers
• 1 x Cognito User Pool
• 5 x Security Groups
• 2 x AWS Secrets Manager Secrets
• 2 x IAM Roles

Once the stack has finished setting up and deploying the services above, you will need to set up a Cognito Client App in your new Cognito User Pool with the following configuration:

1. Authentication Flows has the following settings:

• Username/password
• Secure Remote Password (SRP)
• Lambda triggers

2. OAuth Grant Types: Client credentials grant.

3. Identity Provider: Cognito User Pool Directory.

4. Allowed Callback URLs: https://quant.callback.url .

Now, the Authorise service is ready to use.

For documentation on setting up and using the Authorise API Endpoints, please use our documentation: https://docs.overledger.dev/reference/how-to-access-overledger-apis 

If you want some support, email us at: support@quant.network