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 c7d02ef8be
docs: add metrics document (#1075)
* docs: add metrics document

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

* docs: format docs

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

* chore: change markdownlint rules

Signed-off-by: Gaius <gaius.qi@gmail.com>
2023-06-28 17:32:57 +08:00
.github chore: enable range feature gate in e2e (#1059) 2023-06-28 17:32:56 +08:00
api feat: add scopes validation (#856) 2023-06-28 17:32:40 +08:00
build chore: use buildx to build docker images in e2e (#1018) 2023-06-28 17:32:54 +08:00
cdn cdn returns begin piece (#1045) 2023-06-28 17:32:56 +08:00
client feat: add client request log (#1069) 2023-06-28 17:32:57 +08:00
cmd feat: support change console log level (#1055) 2023-06-28 17:32:56 +08:00
deploy feat: change compatibility version to v2.0.2-rc.0 (#1017) 2023-06-28 17:32:53 +08:00
docs docs: add metrics document (#1075) 2023-06-28 17:32:57 +08:00
hack chore: use buildx to build docker images in e2e (#1018) 2023-06-28 17:32:54 +08:00
internal Feature: prefetch ranged requests (#1053) 2023-06-28 17:32:56 +08:00
manager correct plugin typo (#1060) 2023-06-28 17:32:57 +08:00
pkg Feature: prefetch ranged requests (#1053) 2023-06-28 17:32:56 +08:00
scheduler correct plugin typo (#1060) 2023-06-28 17:32:57 +08:00
test chore: enable range feature gate in e2e (#1059) 2023-06-28 17:32:56 +08:00
version chore: add version metric (#954) 2023-06-28 17:32:48 +08:00
.gitignore feat: support create container without docker-compose (#915) 2023-06-28 17:32:45 +08:00
.gitmodules feat: add console submodule (#549) 2023-06-28 17:31:36 +08:00
.golangci.yml feat: support change console log level (#1055) 2023-06-28 17:32:56 +08:00
.goreleaser.yml chore: remove goreleaser go generate (#409) 2023-06-28 17:28:02 +08:00
.markdownlint.yml docs: add metrics document (#1075) 2023-06-28 17:32:57 +08:00
CHANGELOG.md fix typo in CHANGELOG.md (#976) 2023-06-28 17:32:49 +08:00
CODE_OF_CONDUCT.md Fix typos in docs (#1071) 2023-06-28 17:32:57 +08:00
CONTRIBUTING.md Fix typos in docs (#1071) 2023-06-28 17:32:57 +08:00
LICENSE Merge branch main-rc to branch main 2023-06-28 17:20:20 +08:00
MAINTAINERS.md chore: change zzy987 maintainers email (#649) 2023-06-28 17:31:48 +08:00
Makefile chore: enable range feature gate in e2e (#1059) 2023-06-28 17:32:56 +08:00
README.md Fix typos in docs (#1071) 2023-06-28 17:32:57 +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 Feature: support e2e feature gates (#1056) 2023-06-28 17:32:56 +08:00
go.sum Feature: support e2e feature gates (#1056) 2023-06-28 17:32:56 +08:00

README.md

Dragonfly

alt

GitHub release Artifact Hub 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.

Introduction

Dragonfly is an open source intelligent P2P based image and file distribution system. Its goal is to tackle all distribution problems in cloud native scenarios. Currently Dragonfly focuses on being:

  • Simple: well-defined user-facing API (HTTP), non-invasive to all container engines;
  • Efficient: CDN support, P2P based file distribution to save enterprise bandwidth;
  • Intelligent: host-level speed limit, intelligent flow control due to host detection;
  • Secure: block transmission encryption, HTTPS connection support.

Dragonfly is now hosted by the Cloud Native Computing Foundation (CNCF) as an Incubating Level Project. Originally it was born to solve all kinds of distribution at very large scales, such as application distribution, cache distribution, log distribution, image distribution, and so on.

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 chooses appropriate downloading net-path for each peer.

CDN: A CDN server that caches downloaded data from source to avoid downloading the 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.

Documentation

You can find the full documentation on the repo.

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.