Skip to main content

AWS

The following guide gives detailed instructions on how to set up AWS infrastructure to run Marlin Oyster.

Step 1: Clone the Repository

Clone and enter the setup repository using:

git clone https://github.com/marlinprotocol/oyster-setup-aws oyster-setup-aws && cd oyster-setup-aws

Step 2: Set up AWS profiles

This step requires you to set up a named profile using AWS CLI. Ensure that you are using the latest version of the AWS CLI before proceeding, follow this guide to learn how to install or upgrade the AWS CLI.

Next, configure the AWS CLI and set up a named profile by following the "Configuring the AWS CLI" guide.

Install nodejs

This project requires Nodejs, for running Pulumi. To install it on Ubuntu/Debian-based systems, run:

sudo apt install nodejs npm

Instructions for other operating systems can be found on the official Nodejs website.

Install node dependencies

Install node dependencies using:

npm i

Install pulumi

Install pulumi on Ubuntu/Debian-based systems using:

curl -fsSL https://get.pulumi.com | sh && export PATH=$PATH:$HOME/.pulumi/bin

Instructions for other operating systems can be found on the official Pulumi website.

Note that the installation steps might involve adding Pulumi to your PATH as shown in the command above.

Set up Pulumi

Set Pulumi to use the local filesystem for stack files.

pulumi login --local

VPC setup

Set up dedicated VPCs and other components for running enclaves by running:

# replace <profile> with the named AWS profile created earlier
AWS_PROFILE=<profile> pulumi up

When prompted, create a new stack and name it. You may also set a passphrase.

When prompted with Do you want to perform this update?, review the changes and select yes.

This sets up a dedicated VPC, subnet, security group, etc. needed for running Oyster as a provider. All resources will be tagged with a project: oyster tag wherever possible.

tip

Your AWS account might not have all regions enabled by default. See https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-regions.html for more info.