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

chore(kurtosis): kurtosis setup, convenience tasks, and docs #1202

Merged
merged 12 commits into from
Jul 9, 2024

Conversation

rodrigo-o
Copy link
Collaborator

@rodrigo-o rodrigo-o commented Jul 5, 2024

Motivation

Being able to easily test validators behavior through Kurtosis and add documentation about the process of setting up and starting it.

Description

  • Add convenient make tasks for setting up and running kurtosis
  • Add an initial document section about how to use kurtosis
  • Set up sensible defaults to avoid the node being shutdown due to OOM
  • Modify and test the Dockerfile to allow a simple node connection to the running instance
    • Maintain backwards compatibility without really changing the way it was previously built, just added IEX_ARGS as a build variable
  • Add make tasks for easy connections
  • Configure and test metrics working as expected for the node

Isues: #1197 & #1198

TO DO

This task spawn a couple of issues outside of the current scope:

  • To be able to appear in the Kurtosis predefined dashboards for the Beacon clients we need to adhere to the metrics specified for consensus clients, which should be the following: https://github.com/ethereum/beacon-metrics/blob/master/metrics.md
  • From our custom Dashboard, only the Node one is working right now, both BEAM & ERTS memory allocators appear to be empty. Given that I didn't see them working outside of kurtosis neither, it appears to be a previous issue so I'll leave it for a follow-up.

@rodrigo-o rodrigo-o changed the title docs: Kurtosis setup convenience tasks and docs docs: kurtosis setup convenience tasks and docs Jul 5, 2024
@rodrigo-o rodrigo-o changed the title docs: kurtosis setup convenience tasks and docs docs: kurtosis setup, convenience tasks, and docs Jul 5, 2024
@rodrigo-o rodrigo-o changed the title docs: kurtosis setup, convenience tasks, and docs chores(kurtosis): kurtosis setup, convenience tasks, and docs Jul 8, 2024
@rodrigo-o rodrigo-o changed the title chores(kurtosis): kurtosis setup, convenience tasks, and docs chore(kurtosis): kurtosis setup, convenience tasks, and docs Jul 8, 2024
@rodrigo-o rodrigo-o marked this pull request as ready for review July 8, 2024 22:28
@rodrigo-o rodrigo-o requested a review from a team as a code owner July 8, 2024 22:28
Copy link
Collaborator

@Arkenan Arkenan left a comment

Choose a reason for hiding this comment

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

LGTM

…me extra instructions in the cleanup section
@rodrigo-o rodrigo-o merged commit 49665b6 into main Jul 9, 2024
19 checks passed
@rodrigo-o rodrigo-o deleted the kurtosis-setup-and-docs branch July 9, 2024 16:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

2 participants