Skip to content

Commit

Permalink
Docs: updated project readme (#13)
Browse files Browse the repository at this point in the history
* Docs: updated project readme

Signed-off-by: jason.jin <jason@linktime.cloud>
  • Loading branch information
jason-ltc authored Apr 2, 2024
1 parent 95f157d commit f0b7e78
Show file tree
Hide file tree
Showing 6 changed files with 98 additions and 26 deletions.
40 changes: 38 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
![KDP](https://linktime-public.oss-cn-qingdao.aliyuncs.com/linktime-homepage/kdp/kdp-logo-black.png)

![Tests](https://github.com/linktimecloud/kubernetes-data-platform/actions/workflows/unit-test.yml/badge.svg)
![Build](https://github.com/linktimecloud/kubernetes-data-platform/actions/workflows/ci-build.yml/badge.svg)
![GitHub Repo stars](https://img.shields.io/github/stars/linktimecloud/kubernetes-data-platform)
Expand All @@ -11,5 +13,39 @@
English | [简体中文](./README_zh.md)
<br>

## Quick Start
For quick start of KDP, please refer to [QuickStart](./docs/en/installation/quick-start.md)
## Introduction
KDP(Kubernetes Data Platform) delivers a modern, hybrid and cloud-native data platform based on Kubernetes. It leverages the cloud-native capabilities of Kubernetes to manage data platform effectively.

![KDP](https://linktime-public.oss-cn-qingdao.aliyuncs.com/linktime-homepage/kdp/kdp-archi-en.png)

## Highlights
* 开箱即用的 Kubernetes 大数据平台
* 主流大数据计算、存储引擎的 K8s 化改造及优化
* 大数据组件的标准化配置管理,简化了大数据组件配置依赖管理的复杂性
* 提供标准化的大数据应用集成框架
* 基于[OAM](https://oam.dev/)的应用交付引擎,简化大数据应用的交付和开发
* 可扩展的应用层运维能力:可观测性、弹性伸缩、灰度发布等
* 大数据集群及应用目录的模型概念
* 大数据集群:在K8s上以“集群”的形式管理大数据组件,提供同一个大数据集群下大数据应用统一的生命周期管理
* 应用目录:将相关的单体大数据组件组合成一个应用目录,提供从应用层到容器层的统一管理视图

## Getting Started
* [Overview](./docs/en/getting-started/overview.md)
* [Quick Start](./docs/en/getting-started/quick-start.md)
* [Advanced Installation](./docs/en/getting-started/advanced-install.md)

## Documentation
Full documentation is available at [KDP Website](https://linktimecloud.github.io/kubrenetes-data-platform)

## Community
We look forward to your contributions and suggestions! The easiest way to contribute is to participate in discussions on the Github Issues/Discussion.

Reach out with any questions you may have and we'll make sure to answer them as soon as possible.
* [DingTalk Group](https://www.dingtalk.com/en): `abcdefg`
* [Wechat Group](https://www.wechat.com/en): `abcdefg`

## Contributing
Check out [Deverloper Guide](docs/en/developer-guide/developer-guide.md) to see how to develop with KDP.

## Code of Conduct
KDP adopts [Contributor Covenant Code of Conduct](https://www.contributor-covenant.org/).
40 changes: 38 additions & 2 deletions README_zh.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
![KDP](https://linktime-public.oss-cn-qingdao.aliyuncs.com/linktime-homepage/kdp/kdp-logo-black.png)

![Tests](https://github.com/linktimecloud/kubernetes-data-platform/actions/workflows/unit-test.yml/badge.svg)
![Build](https://github.com/linktimecloud/kubernetes-data-platform/actions/workflows/ci-build.yml/badge.svg)
![GitHub Repo stars](https://img.shields.io/github/stars/linktimecloud/kubernetes-data-platform)
Expand All @@ -11,5 +13,39 @@
[English](./README.md) | 简体中文
<br>

## 快速启动
快速体验 KDP 请参考 [快速启动](./docs/zh/installation/quick-start.md)
## Introduction
KDP(Kubernetes Data Platform) 提供了一个基于 Kubernetes 的现代化混合云原生数据平台。它能够利用 Kubernetes 的云原生能力来有效地管理数据平台。

![KDP](https://linktime-public.oss-cn-qingdao.aliyuncs.com/linktime-homepage/kdp/kdp-archi.png)

## Highlights
* 开箱即用的 Kubernetes 大数据平台
* 主流大数据计算、存储引擎的 K8s 化改造及优化
* 大数据组件的标准化配置管理,简化了大数据组件配置依赖管理的复杂性
* 提供标准化的大数据应用集成框架
* 基于[OAM](https://oam.dev/)的应用交付引擎,简化大数据应用的交付和开发
* 可扩展的应用层运维能力:可观测性、弹性伸缩、灰度发布等
* 大数据集群及应用目录的模型概念
* 大数据集群:在K8s上以“集群”的形式管理大数据组件,提供同一个大数据集群下大数据应用统一的生命周期管理
* 应用目录:将相关的单体大数据组件组合成一个应用目录,提供从应用层到容器层的统一管理视图

## Getting Started
* [Overview](./docs/zh/getting-started/overview.md)
* [Quick Start](./docs/zh/getting-started/quick-start.md)
* [Advanced Installation](./docs/zh/getting-started/advanced-install.md)

## Documentation
完整的文档可访问 [KDP Website](https://linktimecloud.github.io/kubrenetes-data-platform)

## Community

我们期待您的贡献和建议!最简单的贡献方式是参与Github议题/讨论的讨论。
如果您有任何问题,请与我们联系,我们将确保尽快为您解答。
* [钉钉群](https://www.dingtalk.com/): `abcdefg`
* [微信群](https://www.wechat.com/): `abcdefg`

## Contributing
参考[开发者指南](docs/zh/developer-guide/developer-guide.md),了解如何开发及贡献 KDP。

## Code of Conduct
KDP 采纳了 [Contributor Covenant Code of Conduct](https://www.contributor-covenant.org/).
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,24 @@
## 前置准备

* 单机环境:
- 配置要求:推荐 16C/32G内存/100G磁盘 以上(低配置环境可运行基础平台和部分大数据组件,无法运行所有大数据组件)
- 配置要求:推荐 16C/32G内存/200G磁盘 以上(低配置环境可运行基础平台和部分大数据组件,无法运行所有大数据组件)
- 操作系统:Mac OS/主流 Linux 发行版
* 已安装以下软件:
- [Docker Engine(stable)](https://docs.docker.com/engine/install/)
- [Kind(v0.18.0)](https://github.com/kubernetes-sigs/kind/releases/tag/v0.18.0)
- [Docker Engine](https://docs.docker.com/engine/install/)
- [Kind](https://kind.sigs.k8s.io/docs/user/quick-start#installation) v0.18.0
- KDP CLI(以下安装方式二选一)
- 源码编译安装(go 1.21+):`go install`
- 源码编译安装:克隆项目到本地 (本地需要安装 [Go](https://go.dev/doc/install) 1.21+ 的环境),在项目根目录执行 `go install`
- 二进制安装:
```bash
# download kdp binary
sudo curl -o /usr/local/bin/kdp \
"https://registry.linktimecloud.com/repository/raw/kdp/latest/kdp-$(echo $(uname -s) | tr '[:upper:]' '[:lower:]')-amd64" \
&& sudo chmod +x /usr/local/bin/kdp
# download kdp CLI
mkdir -p $HOME/.local/bin && \
curl -o $HOME/.local/bin/kdp \
"https://registry.linktimecloud.com/repository/raw/kdp/latest/kdp-$(echo $(uname -s) | tr '[:upper:]' '[:lower:]')-amd64" && \
chmod +x $HOME/.local/bin/kdp

# you may add next line to ~/.bashrc
export PATH=$PATH:$HOME/.local/bin
source ~/.bash_profile

# check kdp help message
kdp help
Expand All @@ -26,8 +31,9 @@

* 使用KDP CLI安装基础平台:
```bash
## Common parameters:
## - storageConfig.storageClassMapping.localDisk=openebs-hostpath
## specify '--debug' to enable verbose logging
## specify '--set K=V' parameters on-demand:
## - storageConfig.storageClassMapping.localDisk={openebs-hostpath, ...}
## - mysqlArch={standalone|replication}
## - xtrabackup.enabled={true|false}
## - kong.enabled={true|false}
Expand All @@ -37,31 +43,25 @@
## - prometheus.enabled={true|false}
## - loki.enabled={true|false}
## specify '--set prometheus.enabled=false --set loki.enabled=false' to disable prometheus and loki on limited resources environment
## specify '--debug' to enable verbose logging
kdp install --local-mode --set dnsService.name=kube-dns
```

* 更新KDP基础平台配置参数:
```bash
kdp update --set mysqlDiskSize=20Gi
```

## 配置本地域名解析
```bash
# 如安装或更新指定了'--set ingress.domain=<your-domain>'的选项,
# 这里替换为'127.0.0.1 kdp-ux.<your-domain> grafana.<your-domain>'
# if specified '--set ingress.domain=<your-domain>' previously,
# replace below with '127.0.0.1 kdp-ux.<your-domain> grafana.<your-domain>'
sudo tee -a /etc/hosts <<EOF
127.0.0.1 kdp-ux.kdp-e2e.io grafana.kdp-e2e.io
EOF
```

## 访问KDP界面
使用默认配置安装完成后,KDP界面的地址为:http://kdp-ux.kdp-e2e.io ;
如安装或更新指定了'--set ingress.domain=<your-domain>'的选项,界面地址为:http://kdp-ux.<your-domain>
安装完成后,可访问 KDP 的界面,地址为:
- 默认配置:http://kdp-ux.kdp-e2e.io
- 指定'--set ingress.domain=<your-domain>'时:`http://kdp-ux.<your-domain>`

## 环境清理
```bash
Expand Down

0 comments on commit f0b7e78

Please sign in to comment.