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

docs: libp2p resource management #9468

Merged
merged 8 commits into from
Dec 8, 2022
Merged

Conversation

BigLep
Copy link
Contributor

@BigLep BigLep commented Dec 7, 2022

In an attempt to address some of the resource manager integration concerns from #9442 , this is a start to docs dedicated on Kubo's integration with libp2p resource management. A lot of this information previously lived in the config docs, but since the scope was expanding beyond configuration, it was pulled into its own doc.

This isn't currently complete, but is hopefully a starting branch for others to expand and improve upon.

For anyone looking at this, these docs are assuming functionality that will land for 0.18 as being tracked in #9442

@BigLep BigLep changed the title Edit content for libp2p-resource-managent.md Add dedicated docs for libp2p resource management Dec 7, 2022
Copy link
Contributor Author

@BigLep BigLep left a comment

Choose a reason for hiding this comment

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

Note for reviewers: the first commit of libp2p-resource-management.md was a copy from config.md. You can see the changes I made on top with followup commits.

docs/libp2p-resource-management.md Outdated Show resolved Hide resolved
@BigLep
Copy link
Contributor Author

BigLep commented Dec 7, 2022

Mental reminder for when I return to this: remind users of stats command to see which resources are close to utilization.

@BigLep BigLep force-pushed the docs/libp2p-resource-manager branch from c7804b5 to d5cc846 Compare December 8, 2022 00:19
@BigLep
Copy link
Contributor Author

BigLep commented Dec 8, 2022

I added a changelog entry for the work.

@lidel : my default would be for you to review/merge, but feel free to say "skip" and we'll let @ajnavarro handle it.

@BigLep BigLep mentioned this pull request Dec 8, 2022
@lidel lidel self-assigned this Dec 8, 2022
@lidel lidel changed the title Add dedicated docs for libp2p resource management docs: libp2p resource management Dec 8, 2022
@lidel lidel force-pushed the docs/libp2p-resource-manager branch from 56bf611 to 1cfef6f Compare December 8, 2022 15:09
Copy link
Member

@lidel lidel left a comment

Choose a reason for hiding this comment

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

lgtm, pushed small editorial changes and fixed test.

core/node/libp2p/rcmgr_logging_test.go Show resolved Hide resolved
docs/config.md Show resolved Hide resolved
docs/libp2p-resource-management.md Show resolved Hide resolved
@lidel lidel enabled auto-merge (squash) December 8, 2022 15:13
@lidel lidel merged commit 01e0bfa into master Dec 8, 2022
@lidel lidel deleted the docs/libp2p-resource-manager branch December 8, 2022 15:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants