Skip to content

Commit

Permalink
feat: archive v2.2.0 and add v2.3.0 roadmap and v2.4.0 roadmap (#205)
Browse files Browse the repository at this point in the history
Signed-off-by: Gaius <[email protected]>
  • Loading branch information
gaius-qi authored Dec 30, 2024
1 parent 684bcb8 commit d8fb3d9
Show file tree
Hide file tree
Showing 180 changed files with 10,934 additions and 17 deletions.
4 changes: 1 addition & 3 deletions docs/operations/integrations/container-runtime/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,4 @@ title: Docker
slug: /operations/integrations/container-runtime/docker/
---

Documentation for setting Dragonfly's container runtime to Docker.

Dragonfly v2.2.0 drops support for `Docker`. If you want to integrate Docker, please refer to [container-runtime-docker](../../../../versioned_docs/version-v2.1.x/operations/integrations/container-runtime/docker.md).
Documentation for setting Dragonfly's container runtime to Docker. Dragonfly v2.2.0 drops support for `Docker`.
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,4 @@ id: singularity
title: Singularity/Apptainer
---

Documentation for setting Dragonfly's container runtime to Singularity/Apptainer.

Dragonfly v2.2.0 drops support for `Singularity/Apptainer`. If you want to integrate Singularity/Apptainer,
please refer to [container-runtime-singularity/apptainer](../../../../versioned_docs/version-v2.1.x/operations/integrations/container-runtime/singularity.md).
Documentation for setting Dragonfly's container runtime to Singularity/Apptainer. Dragonfly v2.2.0 drops support for `Singularity/Apptainer`.
8 changes: 0 additions & 8 deletions docs/roadmap/v2.2.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,24 +6,16 @@ slug: /roadmap-v2.2/

Manager:

- Peer features are configurable. For example, you can make the peer can not be uploaded and can only be downloaded.
- Configure the weight of the scheduling.
- Add clearing P2P task cache.
- Display P2P traffic distribution.
- Peer information display, including CPU, Memory, etc.

Scheduler:

- Provide metadata storage to support file writing and seeding.
- Optimize scheduling algorithm and improve bandwidth utilization in the P2P network.

Client:

- Client written in Rust, reduce CPU usage and Memory usage.
- Supports RDMA for faster network transmission in the P2P network.
It can better support the loading of AI inference models into memory.
- Supports file writing and seeding, it can be accessed in the P2P cluster without uploading to other storage.
Helps AI models and AI datasets to be read and written faster in the P2P network.

Others:

Expand Down
43 changes: 43 additions & 0 deletions docs/roadmap/v2.3.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
id: roadmap-v2.3
title: v2.3
slug: /roadmap-v2.3/
---

Manager:

- Configure scheduling weights.
- Support scopes for Personal Access Tokens (PATs).
- Regularly clean up inactive schedulers and seed peers.
- Display more Peer information in the console, such as CPU and memory usage.
- Display persistent cache information of peers in the console.
- Add management of sync peers in the console.

Scheduler:

- Optimize the scheduling algorithm to improve bandwidth utilization in the P2P network.

Client:

- Support RDMA/QUIC for faster network transmission in the P2P network, enhancing the loading of
AI inference models into memory.
- Define a codable protocol for data transmission, providing faster encoding/decoding.
- Support persistent cache, allowing access within the P2P cluster without uploading to other storage,
facilitating faster read/write of AI models and datasets.
- Allow peers to get the QoS of parents and select the optimal parents for downloading.
- Preheat files in the memory cache to improve download speed.

Others:

- Add more performance tests in the dfbench command.
- Add more E2E tests and unit tests.

Documentation:

- Restructure the documentation to make it easier for users to navigate.
- Enhance the landing page UI.

AI Infrastructure:

- Optimize large file distribution within the infrastructure.
- Optimize handling of a large number of small I/Os for Nydus.
36 changes: 36 additions & 0 deletions docs/roadmap/v2.4.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
id: roadmap-v2.4
title: v2.4
slug: /roadmap-v2.4/
---

Manager

- Optimize memory and CPU usage.
- Add more features to the console.
- Provide more open APIs for the console.

Scheduler

- Optimize the scheduling algorithm to improve bandwidth utilization in the P2P network.

Client

- Support P2P for RDMA-based memory storage.
- Add distributed addressing, allowing deployment without relying on the manager and scheduler.
- Optimize file transfer speed in the P2P network.

Others

- Add more performance tests in the `dfbench` command.
- Add more E2E tests and unit tests.

Documentation

- Restructure the documentation to make it easier for users to navigate.
- Enhance the landing page UI.

AI Infrastructure

- Optimize large file distribution within the infrastructure.
- Optimize handling of a large number of small I/Os for Nydus.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "d7y-io",
"version": "0.1.2",
"version": "2.2.0",
"private": true,
"scripts": {
"docusaurus": "docusaurus",
Expand Down
41 changes: 41 additions & 0 deletions versioned_docs/version-v2.2.0/FAQ.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
id: faq
title: FAQ
slug: /faq/
---

## Change log level {#change-log-level}

Send `SIGUSR1` signal to dragonfly process to change log level

```shell
kill -s SIGUSR1 <pid of dfdaemon, scheduler or manager>
```

stdout:

```text
change log level to debug
change log level to fatal
change log level to panic
change log level to dpanic
change log level to error
change log level to warn
change log level to info
```

> The change log level event will print in stdout and `core.log` file, but if the level is greater than `info`, stdout only.
## 500 Internal Server Error {#500-internal-server-error}

**1.** Check error logs in /var/log/dragonfly/dfdaemon/

**2.** Check source connectivity(dns error or certificate error)

Example:

```shell
curl https://example.harbor.local/
```

When curl says error, please check the details in output.
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
id: personal-access-tokens
title: Personal Access Tokens
slug: /advanced-guides/personal-access-tokens/
---

You can use a personal access token to call open API.

In this article, you will learn how to create, use, modify and delete personal access token.

## About personal access tokens

Only users with `root` role can list all personal access tokens.

![tokens](../resource/advanced-guides/personal-access-tokens/tokens.png)

## Create personal access token

Click the `ADD PERSONAL ACCESS TOKENS` button to create personal access token.

**Name**: Set your token a descriptive name.

**Description**: Set a description.

**Expiration**: Set your token an expiration.

**Scopes**: Select the access permissions for the token.

![create-token](../resource/advanced-guides/personal-access-tokens/create-token.png)

Click `SAVE` and copy the token and store it. For your security, it doesn't display again.

![copy-token](../resource/advanced-guides/personal-access-tokens/copy-token.png)

## Update personal access token

Click `personal access token name` and update your personal access token.

![update-token](../resource/advanced-guides/personal-access-tokens/update-token.png)

## Delete personal access token

Click `DELETE` and delete your personal access token.

![delete-token](../resource/advanced-guides/personal-access-tokens/delete-token.png)

## Use personal access token

**Step 1:** Open Postman, and import [postman_collection.json](https://github.com/gaius-qi/dragonfly-docs/blob/main/manager/postman/Dragonfly.postman_collection.json).

**Step 2:** Click **Open API** in the sidebar.

**Step 3:** Click **Authorization** and select **Bearer Token**, paste `personal access token` in `Token`.

![add-token-to-open-api](../resource/advanced-guides/personal-access-tokens/add-token-to-open-api.png)

**Step 4:** Click **Headers**, check whether `Authorization` is added to Headers.

![verify-headers](../resource/advanced-guides/personal-access-tokens/verify-headers.png)

**Step 5:** Click **Send** button to initiate a request.

**Step 6:** If successful, it means that the call to the open API is completed through the personal access token.

![verify-open-api](../resource/advanced-guides/personal-access-tokens/verify-request.png)
Loading

0 comments on commit d8fb3d9

Please sign in to comment.