From fdc721b76da993372820f8d55cef77c9a5507f2b Mon Sep 17 00:00:00 2001 From: Marwan Zouinkhi Date: Thu, 6 Jun 2024 11:50:35 -0400 Subject: [PATCH] fix doc formatting --- docs/source/aws.rst | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/docs/source/aws.rst b/docs/source/aws.rst index fb09487ee..518f3bb64 100644 --- a/docs/source/aws.rst +++ b/docs/source/aws.rst @@ -3,7 +3,7 @@ .. contents:: :depth: 1 :local: - + AWS EC2 Setup Guide =================== @@ -15,25 +15,32 @@ Running Docker Image on AWS EC2 To run your Docker image on an AWS EC2 instance, follow these steps: 1. **Create Key Pair** (if you don't have one already): + .. code-block:: bash + aws ec2 create-key-pair --key-name MyKeyPair --query 'KeyMaterial' --output text > MyKeyPair.pem chmod 400 MyKeyPair.pem 2. **Create a Security Group** (if you don't have one already): + .. code-block:: bash + aws ec2 create-security-group --group-name my-security-group --description "My security group" 3. **Authorize Inbound Traffic for the Security Group**: + .. code-block:: bash aws ec2 authorize-security-group-ingress --group-name my-security-group --protocol tcp --port 22 --cidr 0.0.0.0/0 aws ec2 authorize-security-group-ingress --group-name my-security-group --protocol tcp --port 80 --cidr 0.0.0.0/0 4. **Run EC2 Instance with Docker Image**: + Use the following script to launch an EC2 instance, pull your Docker image from DockerHub, and run it with port forwarding: .. code-block:: bash + aws ec2 run-instances --image-id ami-0b8956f13d7bdfe7b --count 1 --instance-type p3.2xlarge --key-name --security-groups --user-data '#!/bin/bash yum update -y amazon-linux-extras install docker -y @@ -42,7 +49,7 @@ To run your Docker image on an AWS EC2 instance, follow these steps: docker run -d -p 80:8000 mzouink/dacapo:0.3.0' - Replace `` with the name of your key pair and `` with the name of your security group. +Replace `` with the name of your key pair and `` with the name of your security group. S3 Access Configuration ----------------------- @@ -52,6 +59,7 @@ You can work locally using S3 data by setting the `AWS_ACCESS_KEY_ID` and `AWS_S To configure AWS CLI, use the following command: .. code-block:: bash + aws configure @@ -61,6 +69,7 @@ Storing Checkpoints and Experiments Data in S3 To store checkpoints and experiments data in S3, modify the `dacapo.yaml` file to include the following: .. code-block:: yaml + runs_base_dir: "s3://dacapotest"