Skip to content

docs: report on storage changes and decisions. #2596

Merged
jmalicevic merged 32 commits intomainfrom
jasmina/storage_report
Mar 15, 2024
Merged

docs: report on storage changes and decisions. #2596
jmalicevic merged 32 commits intomainfrom
jasmina/storage_report

Conversation

@jmalicevic
Copy link
Collaborator

@jmalicevic jmalicevic commented Mar 12, 2024

Rendered

Closes #1044


PR checklist

  • Tests written/updated
  • Changelog entry added in .changelog (we use unclog to manage our changelog)
  • Updated relevant documentation (docs/ or spec/) and code comments
  • Title follows the Conventional Commits spec

@jmalicevic jmalicevic added documentation Improvements or additions to documentation P:storage-optimization Priority: Give operators greater control over storage and storage optimization backport-to-v1.x labels Mar 12, 2024
@jmalicevic jmalicevic self-assigned this Mar 12, 2024
@jmalicevic jmalicevic marked this pull request as ready for review March 13, 2024 11:54
@jmalicevic jmalicevic requested a review from a team as a code owner March 13, 2024 11:54
@jmalicevic jmalicevic requested a review from a team March 13, 2024 11:54
@jmalicevic
Copy link
Collaborator Author

I wonder whether in the report we can include a link to the branch that does migration from v1 to v2 to incentivise users to use it: https://github.com/cometbft/cometbft/blob/migrate_db/cmd/cometbft/commands/migrate_db.go . I am not sure it should be merged into main though.

Copy link
Collaborator

@melekes melekes left a comment

Choose a reason for hiding this comment

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

love this ❤️

@melekes
Copy link
Collaborator

melekes commented Mar 14, 2024

I wonder whether in the report we can include a link to the branch that does migration from v1 to v2 to incentivise users to use it: https://github.com/cometbft/cometbft/blob/migrate_db/cmd/cometbft/commands/migrate_db.go

I think it should be in the experimental_key_layout docs.

Copy link
Contributor

@adizere adizere left a comment

Choose a reason for hiding this comment

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

Left a bunch of suggestions that mainly helped improve my own understanding. Feel free to dismiss any suggestion that is unclear or incorrect.

Probably the most important thing is to add a top-level summary of Q1 results. I have left a suggestion for that also.

@adizere
Copy link
Contributor

adizere commented Mar 14, 2024

Two more things:

  • we should say which exact version of Comet did we use (except for Injective results) to get these results. It's v1-alpha.1 or something from main ?
  • we should add a mention to docs/references/README.md about this new file we're introducing. I did that in 20ec389 hope it's ok.

Co-authored-by: Adi Seredinschi <adizere@gmail.com>
@jmalicevic
Copy link
Collaborator Author

Two more things:

  • we should say which exact version of Comet did we use (except for Injective results) to get these results. It's v1-alpha.1 or something from main ?

Done

@jmalicevic jmalicevic added this pull request to the merge queue Mar 15, 2024
Merged via the queue into main with commit 4fc0288 Mar 15, 2024
@jmalicevic jmalicevic deleted the jasmina/storage_report branch March 15, 2024 07:39
mergify bot pushed a commit that referenced this pull request Mar 15, 2024
[Rendered](https://github.com/cometbft/cometbft/tree/jasmina/storage_report/docs/references/storage)

Closes #1044

<!--

Please add a reference to the issue that this PR addresses and indicate
which
files are most critical to review. If it fully addresses a particular
issue,
please include "Closes #XXX" (where "XXX" is the issue number).

If this PR is non-trivial/large/complex, please ensure that you have
either
created an issue that the team's had a chance to respond to, or had some
discussion with the team prior to submitting substantial pull requests.
The team
can be reached via GitHub Discussions or the Cosmos Network Discord
server in
the #cometbft channel. GitHub Discussions is preferred over Discord as
it
allows us to keep track of conversations topically.
https://github.com/cometbft/cometbft/discussions

If the work in this PR is not aligned with the team's current
priorities, please
be advised that it may take some time before it is merged - especially
if it has
not yet been discussed with the team.

See the project board for the team's current priorities:
https://github.com/orgs/cometbft/projects/1

-->

---

#### PR checklist

- [x] Tests written/updated
- [x] Changelog entry added in `.changelog` (we use
[unclog](https://github.com/informalsystems/unclog) to manage our
changelog)
- [x] Updated relevant documentation (`docs/` or `spec/`) and code
comments
- [x] Title follows the [Conventional
Commits](https://www.conventionalcommits.org/en/v1.0.0/) spec

---------

Co-authored-by: Adi Seredinschi <a@seredinschi.net>
Co-authored-by: Adi Seredinschi <adizere@gmail.com>
(cherry picked from commit 4fc0288)
melekes added a commit that referenced this pull request Mar 19, 2024
[Rendered](https://github.com/cometbft/cometbft/tree/jasmina/storage_report/docs/references/storage)

Closes #1044 



---

#### PR checklist

- [x] Tests written/updated
- [x] Changelog entry added in `.changelog` (we use
[unclog](https://github.com/informalsystems/unclog) to manage our
changelog)
- [x] Updated relevant documentation (`docs/` or `spec/`) and code
comments
- [x] Title follows the [Conventional
Commits](https://www.conventionalcommits.org/en/v1.0.0/) spec
<hr>This is an automatic backport of pull request #2596 done by
[Mergify](https://mergify.com).

Co-authored-by: Jasmina Malicevic <jasmina.dustinac@gmail.com>
Co-authored-by: Anton Kaliaev <anton.kalyaev@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation P:storage-optimization Priority: Give operators greater control over storage and storage optimization

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Benchmark current storage improvements

3 participants