Add polybft consensus support to edge

[epikichi]

Description

• Adding PolyBFT Consensus option to Docker compose
• Adding --docker modes to the scripts/cluster script
• Adding README to docker and scripts folder
• Changed log-level to debug for all containers

How to use

• scripts/cluster ibft --docker - run docker environment with ibft consensus
• scripts/cluster polybft --docker run docker environment with polybft consensus
• scripts/cluster (ibft or polybft) --docker destroy - destroy docker environment (volumes will also be deleted)
• scripts/cluster (ibft or polybft) --docker stop - stop docker environment

[codecov]

Codecov Report

❗ No coverage uploaded for pull request base (feature/v3-parity@cafd3ac). Click here to learn what that means.
The diff coverage is n/a.

❗ Current head e6e116d differs from pull request most recent head d048e64. Consider uploading reports for the commit d048e64 to get more accurate results

@@                 Coverage Diff                  @@
##             feature/v3-parity    #1051   +/-   ##
====================================================
  Coverage                     ?   54.50%           
====================================================
  Files                        ?      172           
  Lines                        ?    22871           
  Branches                     ?        0           
====================================================
  Hits                         ?    12466           
  Misses                       ?     9427           
  Partials                     ?      978           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[vcastellm]

IMO Makefile is not the place to manage the lifecycle of local env, it's not building any aspect of the binary, this belongs to a docker script in scripts folder

[ZeljkoBenovic]

This local env var determines which consensus mechanism is to be used. It acts as a kind of a switch statement.
The docker-compose file passes it to the Dockerfile as a second argument, which is used by the entrypoint script to create genesis for a specific consensus.
It must be set before the init container spins up, as it needs to know which consensus is being used.

The alternative to this approach is to have separate files for each consensus.
We would than need to have dedicated docker-compose, Dockerfile and entrypoint script for each consensus.

IMHO, this is much simpler approach, as we're using the same files and the users can easily make consensus selection just by setting EDGE_CONSENSUS env var.

But if you disagree with this, we can easily split this logic.

[ZeljkoBenovic]

@vcastellm updated readme file with the instruction on how to run with make or directly with docker-compose.
Kept the same logic, as we're using existing docker files, but just switching the consensus with EDGE_CONSENSUS env var. This keeps the scripts simple and lean.
Also added in some customization options for the chain.

[vcastellm]

My proposal is to remove all the run-local stuff out from Makefile to a docker script in scripts, the fact that it's driven by env variables it's not related to using Makefile, it can be also improved by adding an option to the cluster script for running under docker, scripts/cluster polybft --docker should be the UI

[ZeljkoBenovic]

@vcastellm I see now that we already have dedicated scripts folder. Edited the cluster script to accommodate ibft and polybft docker environments.
Let me know if this works for you and the rest of the team.

Will change the PR description, but there are README.md files in both docker and scripts folder with some explanation how to use the script.

[Stefan-Ethernal]

Tnx for effort. Leaving some comments and doubts to consider.

[Stefan-Ethernal]

LGTM 🚀

[vcastellm]

See #1051 (comment)

[vcastellm]

I don't want to block this for just the scripts thing, LGTM if we agree as a team that Makefile is the place

I don't want to block this for just the scripts thing, LGTM if we agree as a team that Makefile is the place

[vcastellm]

LGTM