Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

AWS Blockchain Node Runners #1681

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

Conversation

varnarmat
Copy link

@varnarmat varnarmat commented Aug 30, 2024

Description

  • I added documentation (and two complimentary architectures) for how to deploy Besu Teku Ethereum Nodes via AWS Blockchain Node Runners Blueprint for Ethereum in order to showcase a self managed way in which you can deploy your Ethereum Nodes on AWS (without using Amazon Managed Blockchain). AWS Blockchain Node Runners is an open-source project that provides developers with a set of TypeScript CDK blueprints. These blueprints can be used to deploy nodes for various blockchain protocols, including Ethereum, on AWS infrastructure.

Issue(s) fixed

No issues

Fixes #

Preview

Signed-off-by: Varsha Narmat <[email protected]>
Signed-off-by: Varsha Narmat <[email protected]>
@varnarmat varnarmat requested a review from a team as a code owner August 30, 2024 21:17
Copy link

vercel bot commented Aug 30, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
besu-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 16, 2024 1:41am

@joaniefromtheblock
Copy link
Contributor

joaniefromtheblock commented Sep 6, 2024

@macfarla or @siladu Would you be able to verify/ approve the changes made in this PR? Should these be added to the docs?

Signed-off-by: Joan E <[email protected]>
Signed-off-by: Joan E <[email protected]>
Signed-off-by: Alexandra Tran <[email protected]>
Copy link
Contributor

@alexandratran alexandratran left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added major edits to the content to meet documentation standards. LGTM but will seek additional review.

Copy link
Contributor

@bgravenorst bgravenorst left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added some feedback


This single node setup is for small-scale development environments.
It deploys a single EC2 instance with both consensus and execution clients.
The RPC port is exposed only to internal IP range of the VPC, while P2P ports allow external access to keep the clients synced.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The RPC port is exposed only to internal IP range of the VPC, while P2P ports allow external access to keep the clients synced.
The RPC port is exposed only to the internal IP range of the VPC, while P2P ports allow external access to keep the clients synced.

</tr>
<tr>
<td colspan="2" align="center">Estimate costs</td>
<td>One sync node with m7g.2xlarge for geth-Lighthouse configuration (2048 GB SSD) will cost around $430 per month in the US East region. Additional charges apply if you deploy RPC nodes with a load balancer.</td>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any chance theres a link to the pricing? so we don't need to maintain it if it changes drastically

</tr>
<tr>
<td colspan="2" align="center">How are workload resources monitored?</td>
<td>Resources are monitored using Amazon CloudWatch dashboards. Amazon CloudWatch custom metrics are pushed via CloudWatch Agent.</td>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<td>Resources are monitored using Amazon CloudWatch dashboards. Amazon CloudWatch custom metrics are pushed via CloudWatch Agent.</td>
<td>Resources are monitored using Amazon CloudWatch dashboards. Amazon CloudWatch custom metrics are pushed through CloudWatch Agent.</td>

Comment on lines +219 to +220
This means that he default VPC must have at least two public subnets in different Availability
Zones, and public subnet must set `Auto-assign public IPv4 address` to `YES`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This means that he default VPC must have at least two public subnets in different Availability
Zones, and public subnet must set `Auto-assign public IPv4 address` to `YES`.
This means that the default VPC must have at least two public subnets in different availability
zones, and public subnet must set `Auto-assign public IPv4 address` to `YES`.

The following example uses a sample configuration from the repository for a Besu and Teku node deployment:

```bash
# Make sure you are in aws-blockchain-node-runners/lib/ethereum
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Make sure you are in aws-blockchain-node-runners/lib/ethereum
# Ensure you're in aws-blockchain-node-runners/lib/ethereum

```

### 3. Deploy nodes

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we perhaps add a sentence introducing the 2 options, so that users can decide up front which option to take?

:::

1. After starting the node, wait for the initial synchronization process to finish.
It can take from half a day to approximately 6-10 days, depending on the client combination and
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
It can take from half a day to approximately 6-10 days, depending on the client combination and
It can take half a day to approximately 6-10 days, depending on the client combination and

Comment on lines +275 to +276
- Navigate to [CloudWatch service](https://console.aws.amazon.com/cloudwatch/) (make sure you are
in the region you have specified for `AWS_REGION`).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Navigate to [CloudWatch service](https://console.aws.amazon.com/cloudwatch/) (make sure you are
in the region you have specified for `AWS_REGION`).
- Navigate to [CloudWatch service](https://console.aws.amazon.com/cloudwatch/) (ensure you're
in the region you specified for `AWS_REGION`).

1. Once the initial synchronization is done, you can access the RPC API of that node from within the
same VPC.
The RPC port is not exposed to the Internet.
Turn the following query against the private IP of the single RPC node you deployed:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Turn the following query against the private IP of the single RPC node you deployed:
Run the following query against the private IP of the single RPC node you deployed:

To clear and undeploy the RPC nodes, sync nodes, and common components, use the following commands:

```bash
# Set the AWS account ID and region in case the local .env file is lost.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These comments should probably be steps.

@macfarla
Copy link
Contributor

@macfarla or @siladu Would you be able to verify/ approve the changes made in this PR? Should these be added to the docs?

@varnarmat thanks for your contrib - super detailed! I'm actually reluctant to add this level of detail to the docs directly. Maybe it's better as a guide in wiki or similar? @siladu - thoughts?

@siladu
Copy link
Contributor

siladu commented Nov 25, 2024

Thanks for the contribution @varnarmat. No strong opinion on docs vs wiki, but I'd be fine with it as part of the docs.

I think this page is better suited under the Tutorials section, alongside Deploy Besu using Kubernetes.

I am curious what the intended audience/users are for this? Presumably public/mainnet Ethereum, but what sort of node operator, individuals or institutions for example?

@varnarmat
Copy link
Author

Thanks for the contribution @varnarmat. No strong opinion on docs vs wiki, but I'd be fine with it as part of the docs.

I think this page is better suited under the Tutorials section, alongside Deploy Besu using Kubernetes.

I am curious what the intended audience/users are for this? Presumably public/mainnet Ethereum, but what sort of node operator, individuals or institutions for example?

Thank you. I am open to where we would to put the AWS Blockchain Node Runners (Node Runners) documentation. Node Runners is experimental in nature and is intended for non-production use in proof of connects and pilots.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants