-
Notifications
You must be signed in to change notification settings - Fork 300
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: cndoit18 <[email protected]>
- Loading branch information
Showing
49 changed files
with
720 additions
and
567 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,4 +10,4 @@ Just run: | |
|
||
```shell | ||
./run.sh | ||
``` | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,4 +3,3 @@ | |
[English](en/README.md) | ||
|
||
[简体中文](zh-CN/README.md) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,80 +1,32 @@ | ||
# 蜻蜓文档 | ||
|
||
Dragonfly Document 是关于 Dragonfly 的介绍。对于一般对 Dragonfly 感兴趣的人,这个 repo 的 README.md 就足够了。对于最终用户来说,`/docs` 中包含的所有详细信息是最好的指南。而对于开发者来说,[开发者指南](#开发者指南)部分的内容才是最需要的。 | ||
Dragonfly Document 是关于 Dragonfly 的介绍。对于一般对 Dragonfly 感兴趣的人,这个 repo 的 README.md 就足够了。对于最终用户来说,`/docs` 中包含的所有详细信息是最好的指南。而对于开发者来说,[开发者指南](developer-guide/developer-guide.md)部分的内容才是最需要的。 | ||
|
||
文档文件组织如下: | ||
|
||
* [快速开始](#快速开始) | ||
* [用户指南](#用户指南) | ||
* [CLI参考](#CLI参考) | ||
* [dfget](cli-reference/dfget.md) | ||
* [cdn](cli-reference/cdn.md) | ||
* [scheduler](cli-reference/scheduler.md) | ||
* [manager](cli-reference/manager.md) | ||
* [问题排查](troubleshooting/README.md) | ||
* [API 参考](#API参考) | ||
* [生态](#生态) | ||
* [Kubernetes 集成](ecosystem/Kubernetes-with-Dragonfly.md) | ||
* [Harbor 集成](ecosystem/Harbor-with-Dragonfly.md) | ||
* [开发者指南](#开发者指南) | ||
* [设计文档](#设计文档) | ||
* [测试指南](#测试指南) | ||
|
||
## 如何贡献文档 | ||
|
||
在此页面中找到 `WIP` 或 `TODO` 并参考 [CONTRIBUTING](../../CONTRIBUTING.md)。 | ||
|
||
## 快速开始 | ||
|
||
[快速开始](user-guide/quick-start.md) 如果您想尝试 Dragonfly,这正是您所需要的。本文件包括您需要做什么准备工作, | ||
如何安装 Dragonfly 以及如何体验 Dragonfly 的使用。 | ||
|
||
## 用户指南 | ||
|
||
[用户指南](user-guide) 帮助用户体验 Dragonfly 所需的各种指南。不仅仅是非常简短的 [快速开始] | ||
(user-guide/quick-start.md),而且包括详细的安装和配置说明。此外,任何有助于用户更好地理解 Dragonfly 的概念也将包括在内。 | ||
|
||
## CLI参考 | ||
|
||
对于几乎所有用户,命令行是您可能需要的第一个参考。 [CLI Reference](cli-reference)目录下的文档是关于Dragonfly CLI的命令详细使用,包括`dfget`、`cdn`、`scheduler`和`manager`。您可以获得有关命令的介绍、概要、示例和选项。最后但同样重要的是,Dragonfly 可以保证命令行文档与 Dragonfly CLI 的源代码高度一致。更重要的是,所有命令行文档都是通过源代码自动生成的。 | ||
|
||
## API参考 | ||
|
||
命令行是体验 Dragonfly 能力的最简单方法。 API参考将为 Dragonfly 带来更多更进一步的体验。 Commandline只是API的一种组合用法,如果你想破解或利用Dragonfly的更多优势,请参见[API参考](/api/README.md)。与命令行文档一样,所有 API | ||
文档都是通过源代码自动生成的。 | ||
|
||
## 生态 | ||
|
||
生态文档显示了 Dragonfly 与云原生生态系统中流行的工具或系统之间的联系。他们指导最终用户如何体验云 | ||
使用 Dragonfly 的原生系统,例如其他 CNCF 项目 [Kubernetes](ecosystem/Kubernetes-with-Dragonfly.md) 和 [Harbor](ecosystem/Harbor-with-Dragonfly.md)。 | ||
|
||
## 开发者指南 | ||
|
||
[开发者指南](development/local.md) 帮助(潜在的)开发者/贡献者理解 Dragonfly 内部的理论而不是它公开的接口。和 | ||
更好地理解 Dragonfly 的设计方式,开发人员可以更轻松地学习 Dragonfly 的源代码,并知道如何调试、测试和破解。 | ||
|
||
### 设计文档 | ||
|
||
[设计文档](./design/architecture.md) 是关于 Dragonfly 设计的内容。它包括一开始就考虑到的所有事情,为 Dragonfly 中所有组件设计的架构,组件之间的交互工作流,Dragonfly 中的所有 API 以及其他一些技术内容。 | ||
|
||
### 测试指南 | ||
|
||
[测试指南](./test-guide/test-guide.md) 是帮助贡献者了解如何设置测试环境并进行操作的最佳参考。目前我们可以将 Dragonfly 的测试分为四个维度: | ||
|
||
* 单元测试; | ||
* API集成测试; | ||
* CLI集成测试; | ||
* 节点 e2e 测试。 | ||
|
||
更多详情请参考[测试](./test-guide/test-guide.md)。 | ||
|
||
## 写在后面 | ||
|
||
文件夹`/docs` 没有完全包含有关蜻蜓的所有文档,在此 repo 的其他路径中还有其他非常有用的文档,例如: | ||
|
||
* [TODO FAQ.md](./FAQ.md) | ||
* [CHANGELOG.md](../../CHANGELOG.md) | ||
* [TODO ROADMAP.md](./ROADMAP.md) | ||
* 其他。 | ||
|
||
如果您正在搜索某个文档但没有找到,请不要犹豫 [提交问题](https://github.com/dragonflyoss/Dragonfly2/issues/new/choose) 寻求帮助。另外,如果您发现文档中有一些不正确的地方或错别字,请发起 Pull Request 以更正。 | ||
* [快速开始](quick-start.md) | ||
* [部署](deployment/README.md) | ||
* [安装](deployment/installation) | ||
* [配置](deployment/configuration) | ||
* [故障排查](troubleshooting/README.md) | ||
* [CLI参考](cli-reference/README.md) | ||
* [dfget](cli-reference/dfget.md) | ||
* [cdn](cli-reference/cdn.md) | ||
* [scheduler](cli-reference/scheduler.md) | ||
* [manager](cli-reference/manager.md) | ||
* [预热](preheat/README.md) | ||
* [Console](preheat/console.md) | ||
* [Api](preheat/api.md) | ||
* [运行时集成](runtime-integration/README.md) | ||
* [containerd](runtime-integration/containerd/README.md) | ||
* [cri-o](runtime-integration/cri-o.md) | ||
* [docker](runtime-integration/docker.md) | ||
* [架构设计](design/README.md) | ||
* [整体架构](design/architecture.md) | ||
* [manager](design/manager.md) | ||
* [TODO scheduler](design/scheduler.md) | ||
* [TODO cdn](design/cdn.md) | ||
* [TODO dfdaemon](design/dfdaemon.md) | ||
* [开发者指南](developer-guide/developer-guide.md) | ||
* [测试指南](test-guide/test-guide.md) | ||
* [API 参考](api-reference/api-reference.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# CLI Reference | ||
|
||
对于几乎所有用户,命令行是您可能需要的第一个参考。 [CLI Reference](cli-reference)目录下的文档是关于Dragonfly CLI的命令详细使用,包括`dfget`、`cdn`、`scheduler`和`manager`。您可以获得有关命令的介绍、概要、示例和选项。最后但同样重要的是,Dragonfly 可以保证命令行文档与 Dragonfly CLI 的源代码高度一致。更重要的是,所有命令行文档都是通过源代码自动生成的。 | ||
|
||
内容列表: | ||
|
||
* [dfget](dfget.md) | ||
* [cdn](cdn.md) | ||
* [scheduler](scheduler.md) | ||
* [manager](manager.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
# 部署 | ||
|
||
内容: | ||
|
||
* [安装](installation/README.md) | ||
* [配置](configuration) | ||
|
||
## 安装 | ||
|
||
安装文档为您提供了几个可以用部署 Dragonfly 的方式,例如 [Kubernetes](installation/kubernetes/README.md) 和 [Docker](installation/docker/README.md)。 | ||
|
||
## 配置 | ||
|
||
[配置](configuration) 是关于定制 Dragonfly 的所有内容。它包括所有组件的配置信息及其相应的解释。 |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# 安装 | ||
|
||
内容: | ||
|
||
* [docker](docker/README.md) | ||
* [executable-files](executable-files/README.md) | ||
* [kubernetes](kubernetes/README.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# 安装 | ||
|
||
提供了有两种安装方法,建议使用 `docker-compose` 进行整体安装,或者按照模块分别安装。 | ||
|
||
安装选项: | ||
|
||
* [Docker Compose](docker-compose.md) | ||
* [Standalone](standalone/README.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# WIP Docker-Compose Support |
19 changes: 19 additions & 0 deletions
19
docs/zh-CN/deployment/installation/docker/standalone/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# 安装 | ||
|
||
有两种安装模式,推荐使用 Helm Charts 一次性整体安装,也可以各模块单独安装。 | ||
|
||
## 使用 Helm Charts 进行安装 | ||
|
||
> ArtifactHub 仓库链接为: https://artifacthub.io/packages/helm/dragonfly/dragonfly | ||
推荐使用 Helm Charts 进行安装,简单且快捷。参考文档 [Kubernetes-with-Dragonfly](../../kubernetes/README.md)。 | ||
|
||
## 按模块单独安装 | ||
|
||
* [install-dfdaemon](./dfdaemon.md) 是 dfdaemon 的安装指南 | ||
|
||
* [install-manager](./manager.md) 是 manager 的安装指南 | ||
|
||
* [install-scheduler](./scheduler.md) 是 scheduler 的安装指南 | ||
|
||
* [install-cdn](./cdn.md) 是 CDN 的安装指南 |
67 changes: 67 additions & 0 deletions
67
docs/zh-CN/deployment/installation/docker/standalone/cdn.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
# 安装 Dragonfly CDN | ||
|
||
本文档阐述如何安装并启动 Dragonfly CDN。 | ||
|
||
## 环境要求 | ||
|
||
使用 Docker 部署时,以下条件必须满足: | ||
|
||
所需软件 | 版本要求 | ||
---|--- | ||
Git|1.9.1+ | ||
Docker|1.12.0+ | ||
|
||
## 使用 Docker 部署 | ||
|
||
### 获取 CDN 镜像 | ||
|
||
您可以直接从 [DockerHub](https://hub.docker.com/) 获取 CDN 镜像。 | ||
|
||
1. 获取最新的 CDN 镜像 | ||
|
||
```sh | ||
docker pull dragonflyoss/cdn | ||
``` | ||
|
||
或者您可以构建自己的 CDN 镜像 | ||
|
||
1. 获取 Dragonfly 的源码 | ||
|
||
```sh | ||
git clone https://github.com/dragonflyoss/Dragonfly2.git | ||
``` | ||
|
||
2. 打开项目文件夹 | ||
|
||
```sh | ||
cd Dragonfly2 | ||
``` | ||
|
||
3. 构建 CDN 的 Docker 镜像 | ||
|
||
```sh | ||
TAG="2.0.0" | ||
make docker-build-cdn D7Y_VERSION=$TAG | ||
``` | ||
|
||
4. 获取最新的 CDN 镜像 ID | ||
|
||
```sh | ||
docker image ls | grep 'cdn' | awk '{print $3}' | head -n1 | ||
``` | ||
|
||
### 启动 cdn | ||
|
||
**注意:** 需要使用上述步骤获得的 ID 替换 ${cdnDockerImageId}。 | ||
|
||
```sh | ||
docker run -d --name cdn --restart=always -p 8001:8001 -p 8003:8003 -v /home/admin/ftp:/home/admin/ftp ${cdnDockerImageId} | ||
--download-port=8001 | ||
``` | ||
|
||
CDN 部署完成之后,运行以下命令以检查 Nginx 和 **cdn** 是否正在运行,以及 `8001` 和 `8003` 端口是否可用。 | ||
|
||
```sh | ||
telnet 127.0.0.1 8001 | ||
telnet 127.0.0.1 8003 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.