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

feat(algocfg): add development profile and profile descriptions. #5164

Merged
merged 6 commits into from
Mar 10, 2023

Conversation

winder
Copy link
Contributor

@winder winder commented Feb 27, 2023

Summary

Update algocfg profile command:

  • Update CLI documentation.
  • Add profile descriptions to list subcommand.
  • Add conduit profile.
  • Remove archival profile.

Descriptions:

~$ algocfg profile list
participation  Participate in consensus or simply ensure chain health by validating blocks.
conduit        Provide data for the Conduit tool.
relay          Relay consensus messages across the network and support catchup.
development    Build on Algorand.

Documentation

~$  algocfg profile -h
Initialize algod config.json files based on a usage profile.

The config file generated by these profiles can be used as a starting point
for a nodes configuration. The defaults for a given profile should be treated
as supplemental to the documentation, you should review the documentation to
understand what the settings are doing.

For more details about configuration settings refer to the developer portal:
https://developer.algorand.org/docs/run-a-node/reference/config/

Profiles are subject to change or removal.

Usage:
  algocfg profile [flags]
  algocfg profile [command]

Available Commands:
  list        A list of valid config profiles and a short description.
  set         Create config.json file from a profile.

Flags:
  -h, --help   help for profile

Global Flags:
  -d, --datadir stringArray   Data directory for the node

Use "algocfg profile [command] --help" for more information about a command.

@codecov
Copy link

codecov bot commented Feb 27, 2023

Codecov Report

Merging #5164 (619984b) into master (a525804) will decrease coverage by 0.04%.
The diff coverage is 0.00%.

@@            Coverage Diff             @@
##           master    #5164      +/-   ##
==========================================
- Coverage   53.63%   53.59%   -0.04%     
==========================================
  Files         437      437              
  Lines       54934    54947      +13     
==========================================
- Hits        29463    29451      -12     
- Misses      23191    23210      +19     
- Partials     2280     2286       +6     
Impacted Files Coverage Δ
cmd/algocfg/profileCommand.go 7.54% <0.00%> (-2.46%) ⬇️

... and 6 files with indirect coverage changes

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

@winder winder marked this pull request as ready for review February 27, 2023 19:20
@winder winder requested a review from shiqizng March 1, 2023 18:05
shiqizng
shiqizng previously approved these changes Mar 6, 2023
@winder winder requested review from onetechnical, algoanne and jsgranados and removed request for cce March 6, 2023 18:30
Comment on lines 63 to 64
cfg.MaxAcctLookback = 16
cfg.CatchupParallelBlocks = 16
Copy link
Contributor

Choose a reason for hiding this comment

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

In our perf tests, I've been using the following:

cfg.CatchupParallelBlocks = 64
cfg.EnableFollowMode = true
cfg.MaxAcctLookback = 64

Also worth noting that the test script sets

cfg. CatchupBlockValidateMode = 3

which will probably speed up catchup, but has some trust implications obviously.

@winder winder requested a review from jsgranados March 9, 2023 21:32
Copy link
Contributor

@jsgranados jsgranados left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Contributor

@onetechnical onetechnical left a comment

Choose a reason for hiding this comment

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

PR description no longer matches, but seems good otherwise.

@winder winder merged commit 8bc462a into algorand:master Mar 10, 2023
@winder winder deleted the will/profiles branch March 10, 2023 15:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants