Dragonfly is an open source P2P-based file distribution and image acceleration system. It is hosted by the Cloud Native Computing Foundation (CNCF) as an Incubating Level Project.
Go to file
Gaius 9e5a720cf0
Add design document (#368)
* docs: add design docs

Signed-off-by: Gaius <gaius.qi@gmail.com>

* docs: change images path

Signed-off-by: Gaius <gaius.qi@gmail.com>

* docs: optimize markdown

Signed-off-by: Gaius <gaius.qi@gmail.com>

* docs: change design

Signed-off-by: Gaius <gaius.qi@gmail.com>

* docs: change design

Signed-off-by: Gaius <gaius.qi@gmail.com>
2023-06-28 17:27:58 +08:00
.github chore: update CI timeout (#328) 2023-06-28 17:22:42 +08:00
api fix(manager): modify to config from scheduler_config in swagger yaml (#317) 2023-06-28 17:22:41 +08:00
build chore: remove protoc.sh (#341) 2023-06-28 17:22:43 +08:00
cdnsystem Fix: infinite recursion in MkDirAll (#358) 2023-06-28 17:27:51 +08:00
client Fix: infinite recursion in MkDirAll (#358) 2023-06-28 17:27:51 +08:00
cmd Feature/code spec (#336) 2023-06-28 17:24:44 +08:00
deploy add installation.namespace config for helm chart (#301) 2023-06-28 17:22:40 +08:00
docs Add design document (#368) 2023-06-28 17:27:58 +08:00
hack chore: remove protoc.sh (#341) 2023-06-28 17:22:43 +08:00
internal Fix: infinite recursion in MkDirAll (#358) 2023-06-28 17:27:51 +08:00
manager Feature/code spec (#336) 2023-06-28 17:24:44 +08:00
pkg Fix: infinite recursion in MkDirAll (#358) 2023-06-28 17:27:51 +08:00
scheduler fix: scheduler panic (#356) 2023-06-28 17:24:52 +08:00
version Fix lint (#244) 2023-06-28 17:22:37 +08:00
.gitignore docs: add CHANGELOG.md 2023-06-28 17:22:40 +08:00
.golangci.yml Fix golang lint (#249) 2023-06-28 17:22:38 +08:00
.goreleaser.yml Add goreleaser NFPM (#313) 2023-06-28 17:22:41 +08:00
CHANGELOG.md feat: changelog (#326) 2023-06-28 17:22:42 +08:00
CODE_OF_CONDUCT.md chore: change manager swagger docs path and add makefile swagger command (#183) 2023-06-28 17:21:32 +08:00
CONTRIBUTING.md Improve CONTRIBUTING.md and makefile (#325) 2023-06-28 17:22:42 +08:00
LICENSE Merge branch main-rc to branch main 2023-06-28 17:20:20 +08:00
Makefile Fix: infinite recursion in MkDirAll (#358) 2023-06-28 17:27:51 +08:00
README.md feature: update docs (#307) 2023-06-28 17:22:41 +08:00
SECURITY.md chore: add SECURITY.md (#181) 2023-06-28 17:21:32 +08:00
codecov.yml Fix: use atomic to avoid data race in client (#254) 2023-06-28 17:22:38 +08:00
go.mod Support peer task data multiplex (#347) 2023-06-28 17:23:35 +08:00
go.sum Support peer task data multiplex (#347) 2023-06-28 17:23:35 +08:00

README.md

Dragonfly

alt

GitHub release CI Coverage Go Report Card Open Source Helpers TODOs Discussions Twitter GoDoc LICENSE

Provide efficient, stable, secure, low-cost file and image distribution services to be the best practice and standard solution in the related Cloud-Native area.

Features

  • Implement P2P files distribution with various storage types (HDFS, storage services from various cloud vendors, Maven, Yum, etc.) through a unified back-to-source adapter layer.
  • Support more distribution modes: active pull, active push, real-time synchronization, remote replication, automatic warm-up, cross-cloud transmission, etc.
  • Provide separation and decoupling between systems, scheduling and plug-in CDN. Support on-demand deployment with flexible types: light or heavy, inside or outside, to meet the actual needs of different scenarios.
  • Newly designed P2P protocol framework based on GRPC with improved efficiency and stability.
  • Perform encrypted transmission, account-based transmission authentication and rate limit, and multi-tenant isolation mechanism.
  • Bear more efficient IO methods: multithreaded IO, memory mapping, DMA, etc.
  • Advocate dynamic compression, in-memory file systems, and more efficient scheduling algorithms to improve distribution efficiency.
  • Client allows third-party software to natively integrate Dragonflys P2P capabilities through C/S mode.
  • Productivity: Support file uploading, task management of various distribution modes, data visualization, global control, etc.
  • Consistent internal and external versions, shared core features, and individual extensions of non-generic features.
  • Enhanced integration with ecology: Harbor, Nydus (on-demand image download), warehouse services for various cloud vendors, etc.

Architecture

alt

Manager: Used to manage the dynamic configuration that each module depends on, and provide keepalive and metrics functions.

Scheduler: The tracker and scheduler in the P2P network that choose appropriate downloading net-path for each peer.

CDN: A CDN server that caches downloaded data from source to avoid downloading same files repeatedly.

Daemon: It's a daemon of dfget client. It establishes a proxy between containerd/CRI-O and registry.

Dfget: The client of Dragonfly used for downloading files. It's similar to wget.

Getting Started

Documentation

You can find the Dragonfly documentation on the website.

Community

Welcome developers to actively participate in community discussions and contribute code to Dragonfly. We will remain concerned about the issues discussed in the community and respond quickly.

Contributing

You should check out our CONTRIBUTING and develop the project together.

Code of Conduct

Please refer to our Code of Conduct.