Getting started with the Bodo Platform¶
This page provides a quick start guide to the Bodo platform and explains its important concepts briefly. We strongly recommend reading this page before getting started with the Bodo platform.
Basic Terminology¶
Notebooks¶
A Notebook is a simple instances of a JupyterLab Server. You can use a notebook to navigate the files in your workspace, define and execute your workflows on the clusters, etc.
Clusters¶
A Cluster provides your notebooks with necessary compute resources. Each cluster is tied to a specific Bodo version. A cluster also has additional configuration parameters such as the number of instances, auto-pause duration, etc. You can read more about creating a cluster here.
Workspaces¶
Workspaces are a basic unit of organization on Bodo platform. You can think of a workspace as a directory on a UNIX file system. Each Workspace contains zero or more Notebooks, Clusters, etc.
Setup the Bodo Platform¶
Follow the Bodo Platform Setup Guide.
If you sign up for Bodo through the AWS marketplace, you get a 14-day free trial. For the duration of your trial, you will only be charged for the underlying AWS resources created by your activity on the Bodo Platform. After the trial expires you will be charged according to our pay-as-you-go pricing
AWS CloudFormation Quick Start¶
If you are using AWS, you can follow the instructions below to get quickly onboarded to the Bodo Platform. First, you need to subscribe to Bodo through the AWS marketplace and complete registration on the Bodo Platform.
Then, navigate to the cloud configuration page.
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.
- Click on the "Create Cloud Configuration" button to create a new cloud configuration.
-
Then select "AWS" as the cloud provider, and click on "Manual" to enter the required information manually.
Important
Do not close the dialog box until you have completed all the steps following this one.
-
Fill in the following values :
- Cloud Configuration Name: A name for your cloud configuration.
- S3 Bucket: Fill this with the value
bodo-default-s3-bucket-<external_ID>
, where<external_ID>
is the external ID generated in the form right above this field. - Dynamo DB Table: Fill this with the value
bodo-default-dynamodb-<external_ID>
. - Role ARN: Fill this with the value
arn:aws:iam::<aws_account_id>:role/BodoPlatformUser
, where<aws_account_id>
is your AWS account ID. - Metadata Storage Region: Fill this with the region where you want to store the metadata.
-
Now navigate to this link: Bodo Platform AWS Setup. Fill in the required parameter values as indicated.
Important
- The
MetadataRegion
parameter should be the same as theMetadata Storage Region
you entered in the previous step. - The
BodoExternalId
parameter should be the same as theExternal ID
generated in the form in the previous step.
- The
Bodo Dashboard¶
- Once your cloud config has been created navigate to the Workspaces tab and click the Create Workspace button in the top right corner. Once your workspace has finished creating, you will be able to enter it.
Once inside the Workspace, navigate to the Notebooks tab.
That’s it, you’re all set to experience Bodo. Follow along one of our tutorials or go through the curated list of bodo-examples.
See bodo-examples
for a set of notebooks ready to be run in your free trial environment.