Docs. Moved to AWS CloudShell. Corrected formatting.

Author: vlasonfa

docs/setup-cloud9.md

@@ -1,3 +1,14 @@
+# AWS CloudShell
+
+To begin, ensure you login to your AWS account with permissions to create and modify resources in IAM, EC2, EBS, VPC, S3, KMS, and Secrets Manager. 
+
+From the AWS Management Console, open the [AWS CloudShell](https://docs.aws.amazon.com/cloudshell/latest/userguide/welcome.html), a web-based shell environment. If unfamiliar, review the [2-minute YouTube video](https://youtu.be/fz4rbjRaiQM) for an overview and check out [CloudShell with VPC environment](https://docs.aws.amazon.com/cloudshell/latest/userguide/creating-vpc-environment.html) that we'll use to test nodes API from internal IP address space.
+
+Once ready, you can execute the commands to deploy and test blueprints in the CloudShell.
+
+***
+# AWS Cloud 9 IS NO LONGER USED (the instructions below will be removed soon, use AWS CloudShell instead)
+***
 # AWS Cloud9 Setup
 
 Most steps in this repository will need to be performed from a Linux command prompt. An especially convenient way of doing this is to use AWS Cloud9, a cloud-based Integrated Development Environment (IDE). Cloud9 allows you to edit source files and execute commands from an easy-to-use web interface. It comes pre-configured with many of the tools needed for software development, and because it runs in the AWS Cloud, it can be an especially easy way to access other cloud services. One other handy feature is that your Cloud9 instances automatically stop running after a configurable period of inactivity, which helps reduce costs.

lib/bsc/README.md

@@ -74,16 +74,20 @@ This is the Well-Architected checklist for Ethereum nodes implementation of the
 
 ## Setup Instructions
 
-### Setup Cloud9
+### Open AWS CloudShell
 
-We will use AWS Cloud9 to execute the subsequent commands. Follow the instructions in [Cloud9 Setup](../../docs/setup-cloud9.md)
+To begin, ensure you login to your AWS account with permissions to create and modify resources in IAM, EC2, EBS, VPC, S3, KMS, and Secrets Manager. 
+
+From the AWS Management Console, open the [AWS CloudShell](https://docs.aws.amazon.com/cloudshell/latest/userguide/welcome.html), a web-based shell environment. If unfamiliar, review the [2-minute YouTube video](https://youtu.be/fz4rbjRaiQM) for an overview and check out [CloudShell with VPC environment](https://docs.aws.amazon.com/cloudshell/latest/userguide/creating-vpc-environment.html) that we'll use to test nodes API from internal IP address space.
+
+Once ready, you can run the commands to deploy and test blueprints in the CloudShell.
 
 ### Clone this repository and install dependencies
 
 ```bash
-   git clone https://github.com/alickwong/aws-blockchain-node-runners
-   cd aws-blockchain-node-runners
-   npm install
+git clone https://github.com/alickwong/aws-blockchain-node-runners
+cd aws-blockchain-node-runners
+npm install
 ```
 
 ### Deploy Single Node
@@ -92,69 +96,66 @@ We will use AWS Cloud9 to execute the subsequent commands. Follow the instructio
 
 2. If you have deleted or don't have the default VPC, create default VPC
 
-    ```bash
-    aws ec2 create-default-vpc
-    ```
+ ```bash
+aws ec2 create-default-vpc
+ ```
 
-   > NOTE:
-   > You may see the following error if the default VPC already exists: `An error occurred (DefaultVpcAlreadyExists) when calling the CreateDefaultVpc operation: A Default VPC already exists for this account in this region.`. That means you can just continue with the following steps.
+> **NOTE:** *You may see the following error if the default VPC already exists: `An error occurred (DefaultVpcAlreadyExists) when calling the CreateDefaultVpc operation: A Default VPC already exists for this account in this region.`. That means you can just continue with the following steps.*
 
 3. Configure your setup
 
     Create your own copy of `.env` file and edit it to update with your AWS Account ID and Region:
-    ```bash
-   # Make sure you are in aws-blockchain-node-runners/lib/scroll
-   cd lib/scroll
-   npm install
-   pwd
-   cp ./sample-configs/.env-sample-full .env
-   nano .env
-    ```
-   > NOTE:
-   > Example configuration parameters are set in the local `.env-sample` file. You can find more examples inside `sample-configs` directory.
+```bash
+# Make sure you are in aws-blockchain-node-runners/lib/scroll
+cd lib/scroll
+npm install
+pwd
+cp ./sample-configs/.env-sample-full .env
+nano .env
+```
+> **NOTE:** *Example configuration parameters are set in the local `.env-sample` file. You can find more examples inside `sample-configs` directory.*
 
 4. Deploy common components such as IAM role
 
-   ```bash
-   pwd
-   # Make sure you are in aws-blockchain-node-runners/lib/scroll
-   npx cdk deploy scroll-common
-   ```
+```bash
+pwd
+# Make sure you are in aws-blockchain-node-runners/lib/scroll
+npx cdk deploy scroll-common
+```
 
-   > IMPORTANT:
-   > All AWS CDK v2 deployments use dedicated AWS resources to hold data during deployment. Therefore, your AWS account and Region must be [bootstrapped](https://docs.aws.amazon.com/cdk/v2/guide/bootstrapping.html) to create these resources before you can deploy. If you haven't already bootstrapped, issue the following command:
-   > ```bash
-   > cdk bootstrap aws://ACCOUNT-NUMBER/REGION
-   > ```
+> **IMPORTANT:** *All AWS CDK v2 deployments use dedicated AWS resources to hold data during deployment. Therefore, your AWS account and Region must be [bootstrapped](https://docs.aws.amazon.com/cdk/v2/guide/bootstrapping.html) to create these resources before you can deploy. If you haven't already bootstrapped, issue the following command:*
+> ```bash
+> cdk bootstrap aws://ACCOUNT-NUMBER/REGION
+> ```
 
 5. Deploy Amazon Managed Blockchain (AMB) Access Ethereum node and wait about 35-70 minutes for the node to sync
 
-   ```bash
-   pwd
-   # Make sure you are in aws-blockchain-node-runners/lib/scroll
-   npx cdk deploy scroll-ethereum-l1-node --json --outputs-file scroll-ethereum-l1-node.json
-   ```
+```bash
+pwd
+# Make sure you are in aws-blockchain-node-runners/lib/scroll
+npx cdk deploy scroll-ethereum-l1-node --json --outputs-file scroll-ethereum-l1-node.json
+```
    To watch the progress, open the [AMB Web UI](https://console.aws.amazon.com/managedblockchain/home), click the name of your target network from the list (Mainnet, Goerly, etc.) and watch the status of the node to change from `Creating` to `Available`.
 
 6. Deploy Scroll Full Node and wait for another 10-20 minutes for it to sync
 
-   ```bash
-   pwd
-   # Make sure you are in aws-blockchain-node-runners/lib/scroll
-   npx cdk deploy scroll-single-node --json --outputs-file single-node-deploy.json
-   ```
+```bash
+pwd
+# Make sure you are in aws-blockchain-node-runners/lib/scroll
+npx cdk deploy scroll-single-node --json --outputs-file single-node-deploy.json
+```
    After starting the node you will need to wait for the initial synchronization process to finish.To see the progress, you may use SSM to connect into EC2 first and watch the log like this:
 
-   ```bash
-   export INSTANCE_ID=$(cat single-node-deploy.json | jq -r '..|.node-instance-id? | select(. != null)')
-   echo "INSTANCE_ID=" $INSTANCE_ID
-   export AWS_REGION=us-east-1
-   aws ssm start-session --target $INSTANCE_ID --region $AWS_REGION
-   tail -f /var/log/scroll/error.log
-   ```
+```bash
+export INSTANCE_ID=$(cat single-node-deploy.json | jq -r '..|.node-instance-id? | select(. != null)')
+echo "INSTANCE_ID=" $INSTANCE_ID
+export AWS_REGION=us-east-1
+aws ssm start-session --target $INSTANCE_ID --region $AWS_REGION
+tail -f /var/log/scroll/error.log
+```
 
    When the process complete, you will see `L1 message initial sync completed` in the log:
-   ```
+```bash
    INFO [12-13|08:25:46.095] Syncing L1 messages                      processed=18,683,700 confirmed=18,775,938 collected=77348 progress(%)=99.509
    INFO [12-13|08:25:56.165] Syncing L1 messages                      processed=18,699,700 confirmed=18,775,938 collected=78100 progress(%)=99.594
    INFO [12-13|08:26:06.122] Syncing L1 messages                      processed=18,709,300 confirmed=18,775,938 collected=79042 progress(%)=99.645
@@ -164,18 +165,19 @@ We will use AWS Cloud9 to execute the subsequent commands. Follow the instructio
    INFO [12-13|08:26:46.124] Syncing L1 messages                      processed=18,755,400 confirmed=18,775,938 collected=84176 progress(%)=99.891
    INFO [12-13|08:26:56.120] Syncing L1 messages                      processed=18,768,200 confirmed=18,775,938 collected=85240 progress(%)=99.959
    INFO [12-13|08:27:00.524] L1 message initial sync completed        latestProcessedBlock=18,775,938
-   ```
+```
 
 7. Test Scroll RPC API
    Use curl to query from within the node instance:
-   ```bash
-   export INSTANCE_ID=$(cat single-node-deploy.json | jq -r '..|.node-instance-id? | select(. != null)')
-   echo "INSTANCE_ID=" $INSTANCE_ID
-   export AWS_REGION=us-east-1
-   aws ssm start-session --target $INSTANCE_ID --region $AWS_REGION
 
-   curl -s -X POST -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"eth_blockNumber","params":[],"id":1}' http://localhost:8545
-   ```
+```bash
+export INSTANCE_ID=$(cat single-node-deploy.json | jq -r '..|.node-instance-id? | select(. != null)')
+echo "INSTANCE_ID=" $INSTANCE_ID
+export AWS_REGION=us-east-1
+aws ssm start-session --target $INSTANCE_ID --region $AWS_REGION
+
+curl -s -X POST -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"eth_blockNumber","params":[],"id":1}' http://localhost:8545
+```
 
 ### Monitoring
 A script on the Scroll node publishes current block and blocks behind metrics to CloudWatch metrics every 5 minutes. When the node is fully synced the blocks behind metric should get to 0, which might take about 1.5 days. To see the metrics:
@@ -185,83 +187,81 @@ A script on the Scroll node publishes current block and blocks behind metrics to
 
 ## Clear up and undeploy everything
 
-1. Undeploy all Nodes and Common stacks
+Destroy all Nodes and Common stacks
 
-   ```bash
-   # Setting the AWS account id and region in case local .env file is lost
-   export AWS_ACCOUNT_ID=<your_target_AWS_account_id>
-   export AWS_REGION=<your_target_AWS_region>
-
-   pwd
-   # Make sure you are in aws-blockchain-node-runners/lib/scroll
+```bash
+# Setting the AWS account id and region in case local .env file is lost
+export AWS_ACCOUNT_ID=<your_target_AWS_account_id>
+export AWS_REGION=<your_target_AWS_region>
 
-   # Undeploy Single Node
-   npx cdk destroy scroll-single-node
+pwd
+# Make sure you are in aws-blockchain-node-runners/lib/scroll
 
-   # Undeploy AMB Etheruem node
-   npx cdk destroy scroll-ethereum-l1-node
+# Destroy Single Node
+npx cdk destroy scroll-single-node
 
-   # Delete all common components like IAM role and Security Group
-   npx cdk destroy scroll-common
-   ```
+# Destroy AMB Etheruem node
+npx cdk destroy scroll-ethereum-l1-node
 
-2. Follow steps to delete the Cloud9 instance in [Cloud9 Setup](../../doc/setup-cloud9.md)
+# Delete all common components like IAM role and Security Group
+npx cdk destroy scroll-common
+```
 
 ## FAQ
 
 1. How to check the logs of the clients running on my Scroll node?
 
-   **Note:** In this tutorial we chose not to use SSH and use Session Manager instead. That allows you to log all sessions in AWS CloudTrail to see who logged into the server and when. If you receive an error similar to `SessionManagerPlugin is not found`, [install Session Manager plugin for AWS CLI](https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html)
-
-   ```bash
-   pwd
-   # Make sure you are in aws-blockchain-node-runners/lib/scroll
+> **NOTE:** *In this tutorial we chose not to use SSH and use Session Manager instead. That allows you to log all sessions in AWS CloudTrail to see who logged into the server and when. If you receive an error similar to `SessionManagerPlugin is not found`, [install Session Manager plugin for AWS CLI](https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html)*
 
-   export INSTANCE_ID=$(cat single-node-deploy.json | jq -r '..|.node-instance-id? | select(. != null)')
-   echo "INSTANCE_ID=" $INSTANCE_ID
-   export AWS_REGION=us-east-1
-   aws ssm start-session --target $INSTANCE_ID --region $AWS_REGION
-   sudo journalctl -o cat -fu scroll
-   ```
+```bash
+pwd
+# Make sure you are in aws-blockchain-node-runners/lib/scroll
+
+export INSTANCE_ID=$(cat single-node-deploy.json | jq -r '..|.node-instance-id? | select(. != null)')
+echo "INSTANCE_ID=" $INSTANCE_ID
+export AWS_REGION=us-east-1
+aws ssm start-session --target $INSTANCE_ID --region $AWS_REGION
+sudo journalctl -o cat -fu scroll
+```
 2. How to check the logs from the EC2 user-data script?
 
-   ```bash
-   pwd
-   # Make sure you are in aws-blockchain-node-runners/lib/scroll
-
-   export INSTANCE_ID=$(cat single-node-deploy.json | jq -r '..|.node-instance-id? | select(. != null)')
-   echo "INSTANCE_ID=" $INSTANCE_ID
-   export AWS_REGION=us-east-1
-   aws ssm start-session --target $INSTANCE_ID --region $AWS_REGION
-   sudo cat /var/log/cloud-init-output.log
-   ```
+```bash
+pwd
+# Make sure you are in aws-blockchain-node-runners/lib/scroll
+
+export INSTANCE_ID=$(cat single-node-deploy.json | jq -r '..|.node-instance-id? | select(. != null)')
+echo "INSTANCE_ID=" $INSTANCE_ID
+export AWS_REGION=us-east-1
+aws ssm start-session --target $INSTANCE_ID --region $AWS_REGION
+sudo cat /var/log/cloud-init-output.log
+```
 
 3. How can I restart the Scroll service?
 
-   ``` bash
-   export INSTANCE_ID=$(cat single-node-deploy.json | jq -r '..|.node-instance-id? | select(. != null)')
-   echo "INSTANCE_ID=" $INSTANCE_ID
-   export AWS_REGION=us-east-1
-   aws ssm start-session --target $INSTANCE_ID --region $AWS_REGION
-   sudo systemctl status scroll.service
-   sudo systemctl restart scroll.service
-   ```
+``` bash
+export INSTANCE_ID=$(cat single-node-deploy.json | jq -r '..|.node-instance-id? | select(. != null)')
+echo "INSTANCE_ID=" $INSTANCE_ID
+export AWS_REGION=us-east-1
+aws ssm start-session --target $INSTANCE_ID --region $AWS_REGION
+sudo systemctl status scroll.service
+sudo systemctl restart scroll.service
+```
 4. Where to find the key l2geth directories?
 
    - The directory with binaries is `/home/ubuntu/l2geth-source`.
    - The data directory of l2geth agent is `/home/ubuntu/l2geth-source/l2geth-datadir`
 
 5. You can now attach to l2geth?
 
-   ```bash
-   sudo - ubuntu
-   cd /home/ubuntu/l2geth-source/
-   alias l2geth=./build/bin/geth
-   l2geth attach "./l2geth-datadir/geth.ipc"
+```bash
+sudo - ubuntu
+cd /home/ubuntu/l2geth-source/
+alias l2geth=./build/bin/geth
+l2geth attach "./l2geth-datadir/geth.ipc"
 
-   > admin.peers.length
-   14
+> admin.peers.length
+14
 
-   > eth.blockNumber
-   10000
-   ```
+> eth.blockNumber
+10000
+```