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

Add tutorial on integrating kubo with index-provider #372

Merged
merged 14 commits into from
May 31, 2023

Conversation

ischasny
Copy link
Contributor

No description provided.

@codecov-commenter
Copy link

Codecov Report

Patch coverage has no change and project coverage change: +0.24 🎉

Comparison is base (648d6ea) 51.17% compared to head (564bb52) 51.42%.

❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #372      +/-   ##
==========================================
+ Coverage   51.17%   51.42%   +0.24%     
==========================================
  Files          61       61              
  Lines        4875     4875              
==========================================
+ Hits         2495     2507      +12     
+ Misses       2076     2065      -11     
+ Partials      304      303       -1     

see 4 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

Copy link
Member

@masih masih left a comment

Choose a reason for hiding this comment

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

Thank you for adding this @ischasny 🍻

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated
@@ -117,6 +117,116 @@ Delegated Routing server is off by default. To enable it, add the following conf
}
```

#### Configuring Kubo and index-provider to use IPNI

Kubo supports HTTP delegated routing as of v0.20.0. The following section contains configuration examples and a few tips to enable Kubo to advertise its CIDs to
Copy link
Member

Choose a reason for hiding this comment

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

Was this not supported since 0.18.0?

Also link to release notes of Kubo?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

True - fixed the version and added the link. Thanks for review!

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
ischasny and others added 13 commits May 31, 2023 11:04
Co-authored-by: Masih H. Derkani <m@derkani.org>
Co-authored-by: Masih H. Derkani <m@derkani.org>
Co-authored-by: Masih H. Derkani <m@derkani.org>
Co-authored-by: Masih H. Derkani <m@derkani.org>
Co-authored-by: Masih H. Derkani <m@derkani.org>
Co-authored-by: Masih H. Derkani <m@derkani.org>
Co-authored-by: Masih H. Derkani <m@derkani.org>
Co-authored-by: Masih H. Derkani <m@derkani.org>
Co-authored-by: Masih H. Derkani <m@derkani.org>
Co-authored-by: Masih H. Derkani <m@derkani.org>
Co-authored-by: Masih H. Derkani <m@derkani.org>
Co-authored-by: Masih H. Derkani <m@derkani.org>
@ischasny ischasny merged commit 7e76f92 into main May 31, 2023
@ischasny ischasny deleted the ivan/add-kubo-tutorial branch May 31, 2023 10:11
@lidel
Copy link

lidel commented Jun 1, 2023

Hi all, FYSA these docs encourage use of PUT /routing/v1 feature which has no finalized spec / API (IPIP-378 is wip), no official support in Kubo, but we already have confused users fill bugs caused by your use case and docs, see ipfs/kubo#9823 (comment)

As this is not ready on the Kubo end, nor we have bandwidth to tackle yet another work stream with the skeleton crew,
you need to make a decision: either you contribute time to fix the bug, and all future ones, or remove the docs. 🙏

@ischasny
Copy link
Contributor Author

ischasny commented Jun 1, 2023

Hi all, FYSA these docs encourage use of PUT /routing/v1 feature which has no finalized spec / API (IPIP-378 is wip), no official support in Kubo, but we already have confused users fill bugs caused by your use case and docs, see ipfs/kubo#9823 (comment)

As this is not ready on the Kubo end, nor we have bandwidth to tackle yet another work stream with the skeleton crew, you need to make a decision: either you contribute time to fix the bug, and all future ones, or remove the docs. 🙏

Hi @lidel. Would you be happy if we explicitly mark it as an ☠️Unsupported experimental feature, use it at your own risk ☠️ kind of marker? The reason I’m asking is because we have users who used to use reframe so at least we can provide them with some path.

@ischasny
Copy link
Contributor Author

ischasny commented Jun 1, 2023

#373

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants