Bodo Managed Cloud Platform on AWS

Registration

a. Subscribe through the AWS Marketplace.

b. After confirming your subscription, you should click Set up your Account at the top right corner of the page. Bodo Platform's registration page will open in a new tab.

c. Fill out the fields with your information. If this is your individual account, use a unique name such as firstname_lastname for the Organization Name field.

d. Check the box for accepting terms and conditions and click on SIGN UP:

e. A page confirming that an activation link was sent to your email will appear. Please open the email and click on the activation link: Clicking on the confirmation link will take you to the bodo platform page where you can use your newly created credentials to sign in:

Setting AWS Credentials

To use Bodo on AWS, you need to link your AWS account to the Bodo platform.

This can be done using the Cloud Configuration page in the left sidebar and followed by clicking on Create Cloud Configuration at the top right corner of the page as shown in the picture below:

To be able to use the Bodo Platform to launch clusters and notebooks, you must grant it permission to access your AWS account and provision the required resources in it. This can be done through three ways:

1. AWS CloudFormation Quick Start

Tip

You need the following set of permissions to successfully create the resources defined in the CloudFormation stack:

- [`AWSCloudFormationFullAccess`](https://docs.aws.amazon.com/aws-managed-policy/latest/reference/AWSCloudFormationFullAccess.html){target="blank"}
- [`AmazonS3FullAccess`](https://docs.aws.amazon.com/AmazonS3/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-amazons3fullaccess){target="blank"}
- [`AmazonDynamoDBFullAccess`](https://docs.aws.amazon.com/aws-managed-policy/latest/reference/AmazonDynamoDBFullAccess.html){target="blank"}
- [`AWSIAMFullAccess`](https://docs.aws.amazon.com/aws-managed-policy/latest/reference/IAMFullAccess.html){target="blank"}

Once you have ensured that you have all permissions necessary to create the resources, follow the steps below to create a Cloud Configuration:

1. Fill in the following values :
   • Cloud Configuration Name: A name for your Cloud Configuration.
   • Metadata Storage Region: Fill this with the region where you want to store the metadata.

1. Click on Launch CloudFormation Template. This will open the AWS CloudFormation console in a new tab in the selected region.

   Important

   All the values are pre-filled in the CloudFormation template. Please do not change any values.

2. Click on "Create Stack" to create the stack. This will create the necessary resources in your AWS account.

!!! note
    The stack creation process may take a few minutes to complete. Please wait until the stack is created successfully.

1. You can check the status of the stack from Bodo Platform as shown below. Once the stack is created successfully, Cloud Configuration will be created.

2. With Access Keys

1. Follow the instructions from AWS Account and Access Keys guide to create/retrieve your AWS access key ID and secret access key.

2. Enter the Access Key ID and Secret created in the previous step.

3. Select the region the where the metadata will be stored and click on CREATE.

   

   Note

   This has been tested using access keys that have S3FullAccess, DynamoDBFullAccess and IAMFullAccess permissions. Access keys with limited permissions will not work.

   Note

   We will not save the provided Access Keys for security reasons.

3. Manual Process

Open the Cloud Configuration Form and note down the External ID.

We need to create 3 resources through the AWS Console and provide details about them in the Cloud Configuration Form.

Before that, Open the Cloud Configuration Form and note down the External ID.

Note

The S3 bucket and the Dynamo DB table should be created in the same region. Supported regions are: 'us-east-1', 'us-east-2', 'us-west-1' and 'us-west-2'.

Setup S3 Bucket

• Setup S3 Bucket

  1. In AWS console, go to S3 Management Console and click on Create Bucket.

  2. In the creation form, enter the Bucket Name and select the AWS Region. Note these down since you will need to enter them in the Cloud Configuration Form.

  3. All other fields can remain as it is by default and click on Create Bucket.

Setup Dynamo DB table

• Setup Dynamo DB table

  1. In AWS console, go to Dynamo DB page and click on Create Table.

  2. In the table creation form, enter the Table name. Note this down since you will need to enter it in the Cloud Configuration Form.

  3. Under Partition key, enter the partion key as LockID and select the type as String. This partion key must be created for Bodo Platform to work.

  4. All other fields can remain as it is by default and click on Create Table.

  5. Click on the table you have just created. Then click on Additional info under General Information tab. Note down the Amazon Resource Name (ARN).

  Replace this value whenever you need DynamoDB ARN during setup.

  

Setup IAM role

• IAM role

  1. Log in to the AWS Management Console and navigate to the IAM Service.

  2. Select the Roles tab in the sidebar, and click Create Role.

  3. In Select type of trusted entity, select Another AWS Account.

  4. Enter the Bodo Platform Account ID 481633624848 in the Account ID field.

  5. Check the Require external ID option.

     

     In the External ID field, copy over the External ID from the Cloud Configuration form on the Bodo Platform.

     

  6. Click the Next: Permissions button.

  7. Click the Next: Tags button.

  8. Click the Next: Review button.

  9. In the Role name field, enter a role name, e.g. BodoPlatformUser.

     

  10. Click Create Role. You will be taken back to the list of IAM Roles in your account.

  11. In the list of IAM Roles, click on the role you just created.

  12. Under Permissions tab, Click on Add Permissions and select Create inline policy from the dropdown.

      

  13. Click the JSON tab.

      

  14. Bodo Cloud Platform requires a specific set of AWS permissions which are documented in Bodo-Platform Policy. Paste the contents of the linked JSON file into the policy editor.

  15. $$BUCKET_NAME$$ and $$DYNAMO_ARN$$ placeholders needs to be updated in the Bodo Platform Policy with the S3 Bucket name and Dynamo DB ARN respectively.

  16. Click on Review policy.

  17. In the Name field, add a policy name, e.g. Bodo-Platform-User-Policy. Click on Create policy. You will be taken back to the Role Summary.

  18. From the role summary, copy the Role ARN. This is the value that you will enter into the Role ARN field on the Setting Page on the Bodo Platform.

      

Once you have generated an IAM Role using the steps described above, you can fill the remaining fields in the Cloud Configuration form on the Bodo Platform.

1. Enter the Name of the configuration.
2. Enter the S3 Bucket name.
3. Enter the Dynamo DB Table name.
4. Enter the Role ARN in the Role ARN field.
5. Select a Region from the dropdown list. This is the region of your S3 bucket and Dynamo DB table.
6. Click on Validate, and once you got the validation successful message, then click on Create.

Important

We highly recommend that you ensure sufficient limits on your AWS account to launch resources. See here for details on the resources required for Bodo Cloud Platform.

Resources Created in Your AWS Environment

Bodo deploys cluster/notebook resources in your own AWS environment to ensure security of your data. Below is a list of AWS resources that the Bodo Platform creates in your account to enable clusters and notebooks.

AWS Service	Purpose
EC2 Instances	Cluster/notebook workers
EFS	Shared file system for clusters
VPC, Subnets, NAT Gateway, Elastic IP, ENI, Security Groups, ...	Secure networking for clusters/notebooks
S3 and Dynamo DB	Resource states
AWS Systems Manager	Managing EC2 instances
KMS	Cluster secrets (e.g. SSH keys)
IAM Role for Clusters	Allow cluster workers to access resources above

Note

These resources incur additional AWS infrastructure charges and are not included in the Bodo Platform charges.

Using Bodo Platform

Please refer to the platform usage guides to explain the basics of using the Bodo Cloud Platform and associated concepts.

Billing

Users subscribed to the Bodo Platform through the AWS Marketplace will be charged for their use of the platform as part of their regular AWS bill. The platform charges are based on the type of instances deployed and the duration of their usage (to the nearest minute). The hourly rate for the supported instance types can be found on our website. For any cluster deployed through the platform, users are charged starting from when the cluster has been successfully deployed, until the time the user requests the cluster to be removed.

Note

Users are not charged in case of failures in cluster creation.

As mentioned previously, the AWS resources set up by the platform in your AWS environment incur additional AWS infrastructure charges, and are not included in the Bodo Platform charges.

Billing Alarms

You can set up AWS alarms to monitor usage using cloudwatch alarms on AWS.

Steps to create an alarm on your AWS account for all EC2 usage:

Steps to create an alarm on your AWS account for all EC2 usage:

1. Select the region from which you would like to create the alarm and click Create Alarm.

2. Click on the Select metric which would bring you to a search bar that allows you to search and select the metric of your choice. Make sure to click on the check box of the metric of your choice. In this example, we choose vCPU for monitoring EC2 usage.

3. Set a reasonable number for the threshold for an alarm to go off based on your usage expectations. If you do not have this you can use the history of the metric to get an estimate. The history can be viewed by clicking on the expand button on the graph. You can toggle the time range by clicking on the available options (e.g. 1w for 1 week) on the top panel. You can use the graph to set the desired threshold for your alarm. The default period for the alarm threshold is 5 minutes but can be altered based on your requirement. In this example above we set the alarm to become active, if the vCPU count is greater than 1000 for 5 minutes as the highest value found from the last week was ~850. Click Next at the bottom of the page after you have set the threshold and period.

4. You will now be asked to select the Simple Notification Service (SNS) Topic for this alarm.

   a. If you already have an existing SNS Topic you can choose it from the dropdown list by clicking on the Select an Existing SNS Topic radio button.

   b. If you do not have an SNS Topic, then create a new SNS Topic by clicking on the Create New Topic radio button. Fill in the form with an appropriate Topic Name and provide the emails (Those who should be alerted by the alarm) in the Email endpoints that will receive the notification tab.

   Once you have provided these details you can click on Next at the bottom of the page.

5. You will now be required to fill out the details of the alarm itself, fill the fields with the appropriate details and click Next at the bottom of the page.

6. Finally, preview your alarm before you click on Create Alarm at the bottom of the page to create the Alarm.