Skip to content

Commit

Permalink
chore: remove kubernetes (#62)
Browse files Browse the repository at this point in the history
Signed-off-by: Gaius <[email protected]>
  • Loading branch information
gaius-qi authored Mar 31, 2022
1 parent 3ec9c73 commit 5058293
Show file tree
Hide file tree
Showing 14 changed files with 52 additions and 85 deletions.
2 changes: 1 addition & 1 deletion docs/concepts/terminology/manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ and provide keepalive and metrics functions.
- CDN cluster and CDN instance have a `1:N` relationship
- Scheduler cluster and Scheduler instance have a `1:N` relationship

## Manage multiple P2P networks
## Manage multiple P2P networks {#manage-multiple-p2p-networks}

Manager can manage multiple P2P networks.
Usually, a P2P network includes a scheduler cluster, a cdn clsuter and many dfdaemons.
Expand Down
26 changes: 17 additions & 9 deletions docs/getting-started/quick-start/docker-compose.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ slug: /getting-started/quick-start/docker-compose/

In order to facilitate you to quickly set up the Dragonfly environment,
this article uses [Docker-Compose](https://docs.docker.com/compose/) Take kubernetes as an example to explain,
if you need kubernetes related content, you can refer to [Quick Start: kubernetes](../../setup/install/kubernetes.md)
if you need kubernetes related content, you can refer to [Quick Start: Helm Charts](../../setup/install/helm-charts.md)

If you want to use Dragonfly to complete production-level image and file distribution in the production environment,
please refer to the detailed production-level configuration parameters of supernode and dfget. If it is kubernetes,
Expand Down Expand Up @@ -76,20 +76,28 @@ docker exec dfdaemon grep "peer task done" /var/log/dragonfly/daemon/core.log
If the above command has something like

```json
{"level":"info","ts":"2022-02-23 06:06:21.506","caller":"peer/peertask_conductor.go:1167","msg":"peer task done, cost: 16052ms","peer":"172.17.189.172-1-249fa302-f107-444d-b03e-103f54b2fa4f","task":"708fff474e9885df7a9efa95b607618478912367f70a1aeb2753cfb00dfb28f7","component":"PeerTask"}
{
"level": "info",
"ts": "2022-02-23 06:06:21.506",
"caller": "peer/peertask_conductor.go:1167",
"msg": "peer task done, cost: 16052ms",
"peer": "172.17.189.172-1-249fa302-f107-444d-b03e-103f54b2fa4f",
"task": "708fff474e9885df7a9efa95b607618478912367f70a1aeb2753cfb00dfb28f7",
"component": "PeerTask"
}
```

similar after formatting

```json
{
"level": "info",
"ts": "2022-02-23 06:06:21.506",
"caller": "peer/peertask_conductor.go:1167",
"msg": "peer task done, cost: 16052ms",
"peer": "172.17.189.172-1-249fa302-f107-444d-b03e-103f54b2fa4f",
"task": "708fff474e9885df7a9efa95b607618478912367f70a1aeb2753cfb00dfb28f7",
"component": "PeerTask"
"level": "info",
"ts": "2022-02-23 06:06:21.506",
"caller": "peer/peertask_conductor.go:1167",
"msg": "peer task done, cost: 16052ms",
"peer": "172.17.189.172-1-249fa302-f107-444d-b03e-103f54b2fa4f",
"task": "708fff474e9885df7a9efa95b607618478912367f70a1aeb2753cfb00dfb28f7",
"component": "PeerTask"
}
```

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/quick-start/kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Dragonfly Quick Start document aims to help you to
quick start Dragonfly journey. This experiment is quite easy and
simplified.

You can have a quick start following [Kubernetes-with-Dragonfly](../../setup/install/kubernetes.md).
You can have a quick start following [Helm Charts](../../setup/install/helm-charts.md).
We recommend to use `Containerd with CRI` and `CRI-O` client.

This table describes some container runtimes version and documents.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
---
id: helm
title: Helm
slug: /setup/install/kubernetes/helm
id: helm-charts
title: Helm Charts
---

Now we can deploy all components of Dragonfly in
Kubernetes cluster. We deploy scheduler and cdn as `StatefulSets`,
daemon as `DaemonSets`, manager as `Deployments`.

## Runtime Configuration Guide for Dragonfly Helm Chart {#runtime-configuration-guide-for-dragonfly-helm-chart}

When enable runtime configuration in dragonfly,
Expand Down Expand Up @@ -47,8 +50,8 @@ containerRuntime:
# When use certs and inject hosts in docker, no necessary to restart docker daemon.
injectHosts: true
registryDomains:
- "harbor.example.com"
- "harbor.example.net"
- 'harbor.example.com'
- 'harbor.example.net'
```
<!-- markdownlint-restore -->
Expand Down Expand Up @@ -85,8 +88,8 @@ containerRuntime:
# If did not want restart docker daemon, keep containerRuntime.docker.restart=false and containerRuntime.docker.injectHosts=true.
restart: true
skipHosts:
- "127.0.0.1"
- "docker.io" # Dragonfly use this image registry to upgrade itself, so we need skip it. Change it in real environment.
- '127.0.0.1'
- 'docker.io' # Dragonfly use this image registry to upgrade itself, so we need skip it. Change it in real environment.
```

<!-- markdownlint-restore -->
Expand Down Expand Up @@ -184,9 +187,9 @@ containerRuntime:
enable: true
# Registries full urls
registries:
- "https://ghcr.io"
- "https://quay.io"
- "https://harbor.example.com:8443"
- 'https://ghcr.io'
- 'https://quay.io'
- 'https://harbor.example.com:8443'
```

## Prepare Kubernetes Cluster {#prepare-kubernetes-cluster}
Expand Down Expand Up @@ -267,7 +270,7 @@ manager:
externalManager:
enable: true
host: "dragonfly-manager.dragonfly-system.svc.cluster.local"
host: 'dragonfly-manager.dragonfly-system.svc.cluster.local'
restPort: 8080
grpcPort: 65003
Expand Down Expand Up @@ -299,13 +302,13 @@ If you need to bind Ingress, you can refer to
[configuration options](https://artifacthub.io/packages/helm/dragonfly/dragonfly#values)
of Helm Charts, or create it manually.

Console features preview reference document [console preview](../../../reference/manage-console.md).
Console features preview reference document [console preview](../../reference/manage-console.md).

## Configure Runtime Manually {#configure-runtime-manually}

Use Containerd with CRI as example, more runtimes can be found [here](../../../getting-started/quick-start/kubernetes.md)
Use Containerd with CRI as example, more runtimes can be found [here](../../getting-started/quick-start/kubernetes.md)

> This example is for single registry, multiple registries configuration is [here](../../../setup/runtime/containerd.md)
> This example is for single registry, multiple registries configuration is [here](../../setup/runtime/containerd.md)

For private registry:

Expand Down
13 changes: 0 additions & 13 deletions docs/setup/install/kubernetes.md

This file was deleted.

2 changes: 1 addition & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ const config = {
},
{
label: 'Setup',
to: '/docs/setup/install/kubernetes',
to: '/docs/setup/install/helm-charts',
},
{
label: 'Reference',
Expand Down
4 changes: 0 additions & 4 deletions i18n/zh/docusaurus-plugin-content-docs/current.json
Original file line number Diff line number Diff line change
Expand Up @@ -59,10 +59,6 @@
"message": "快速开始",
"description": "The label for category Quick Start in sidebar docs"
},
"sidebar.docs.category.Kubernetes": {
"message": "Kubernetes",
"description": "The label for category Kubernetes in sidebar docs"
},
"sidebar.docs.category.Containerd": {
"message": "Containerd",
"description": "The label for category Containerd in sidebar docs"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: quick-start
title: 快速开始:以docker-compose为例
description: 文档的目标是帮助您快速开始使用 Dragonfly
title: 快速开始
description: 该文档帮助您快速开始使用 Dragonfly
slug: /getting-started/quick-start/
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ slug: /getting-started/quick-start/docker-compose/
---

为了方便您快速搭建起 Dragonfly 环境,本文以 [Docker-Compose](https://docs.docker.com/compose/) 为例进行讲解,
如果需要 kubernetes 相关内容,可以参考 [快速开始: 以kubernetes为例](../../setup/install/kubernetes.md)
如果需要 kubernetes 相关内容,可以参考 [快速开始: Helm Charts](../../setup/install/helm-charts.md)

如需在生产环境使用 Dragonfly 完成生产级别的镜像与文件分发,请参考 supernode 和 dfget 的详细生产级别配置参数,如果是 kubernetes , 可以使用
<https://github.com/dragonflyoss/helm-charts> 项目。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ slug: /getting-started/quick-start/kubernetes/

文档的目标是帮助您快速开始使用 Dragonfly。

您可以根据 [Kubernetes-with-Dragonfly](../../setup/install/kubernetes.md)
您可以根据 [Helm Charts](../../setup/install/helm-charts.md)
文档中的内容快速搭建 Dragonfly 的 Kubernetes 集群。
我们推荐使用 `Containerd with CRI``CRI-O` 客户端。

Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
---
id: helm
title: Helm
slug: /setup/install/kubernetes/helm
id: helm-charts
title: Helm Charts
---

下面会解释如何在 Kubernetes 集群内部署 Dragonfly。
Dragonfly 部署具体模块包括 4 部分: scheduler 和 cdn 会作为 `StatefulSets` 部署,
dfdaemon 会作为 `DaemonSets` 部署, manager 会作为 `Deployments` 部署。

## Helm Chart 运行时配置

当使用 Helm Chart 运行时配置时,可以忽略 [运行时配置](#运行时配置) 章节。
Expand Down Expand Up @@ -266,13 +269,13 @@ kubectl -n dragonfly-system wait --for=condition=ready --all --timeout=10m pod
[Helm Charts 配置选项](https://artifacthub.io/packages/helm/dragonfly/dragonfly#values),
或者手动自行创建 Ingress。

控制台功能预览参考文档 [console preview](../../../reference/manage-console.md)。
控制台功能预览参考文档 [console preview](../../reference/manage-console.md)。

## 运行时配置

以 Containerd 和 CRI 为例,更多运行时[文档](../../../getting-started/quick-start.md)
以 Containerd 和 CRI 为例,更多运行时[文档](../../getting-started/quick-start.md)

> 例子为单镜像仓库配置,多镜像仓库配置参考[文档](../../../setup/runtime/containerd.md)
> 例子为单镜像仓库配置,多镜像仓库配置参考[文档](../../setup/runtime/containerd.md)

私有仓库:

Expand Down

This file was deleted.

2 changes: 1 addition & 1 deletion i18n/zh/docusaurus-theme-classic/footer.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
},
"link.item.label.Setup": {
"message": "安装",
"description": "The label of footer link with label=Setup linking to /docs/setup/install/kubernetes"
"description": "The label of footer link with label=Setup linking to /docs/setup/install/helm-charts"
},
"link.item.label.Reference": {
"message": "参考",
Expand Down
19 changes: 1 addition & 18 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -41,24 +41,7 @@ module.exports = {
{
type: 'category',
label: 'Install',
items: [
{
type: 'category',
label: 'Kubernetes',
link: {
type: 'doc',
id: 'setup/install/kubernetes',
},
items: [
{
type: 'autogenerated',
dirName: 'setup/install/kubernetes',
},
],
},
'getting-started/quick-start/docker-compose',
'setup/install/source',
],
items: ['setup/install/helm-charts', 'getting-started/quick-start/docker-compose', 'setup/install/source'],
},
{
type: 'category',
Expand Down

0 comments on commit 5058293

Please sign in to comment.