Skip to content

Commit e496ce1

Browse files
SparkYuanSparkYuan
authored
update readme (#136)
update readme
1 parent f0553fe commit e496ce1

File tree

4 files changed

+78
-78
lines changed

4 files changed

+78
-78
lines changed

‎README-zh.md‎

Lines changed: 38 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,67 @@
1-
## 简介
1+
<div align="center">
2+
<p></p><p></p>
3+
<p>
4+
<img src="docs/logo.png">
5+
</p>
6+
<h1>A Unified Programmable Configuration Tech Stack</h1>
7+
8+
[简体中文](https://github.com/KusionStack/kusion/blob/main/README-zh.md) | [English](https://github.com/KusionStack/kusion/blob/main/README.md)
9+
10+
[Konfig](https://github.com/KusionStack/konfig) | [KCLVM](https://github.com/KusionStack/KCLVM) | [Kusion](https://github.com/KusionStack/kusion) | [Website](https://kusionstack.io/)
211

312
[![GitHub release](https://img.shields.io/github/release/KusionStack/kusion.svg)](https://github.com/KusionStack/kusion/releases)
413
[![Go Report Card](https://goreportcard.com/badge/github.com/KusionStack/kusion)](https://goreportcard.com/report/github.com/KusionStack/kusion)
514
[![license](https://img.shields.io/github/license/KusionStack/kusion.svg)](https://github.com/KusionStack/kusion/blob/main/LICENSE)
615
[![Go Reference](https://pkg.go.dev/badge/github.com/KusionStack/kusion.svg)](https://pkg.go.dev/github.com/KusionStack/kusion)
716
[![Coverage Status](https://coveralls.io/repos/github/KusionStack/kusion/badge.svg)](https://coveralls.io/github/KusionStack/kusion)
17+
</div>
18+
19+
# Kusion
20+
Kusion 是 [KusionStack](https://github.com/KusionStack) 的引擎，用于解析用户在 [Konfig](https://github.com/KusionStack/konfig) 中描述的运维意图，并根据这些运维意图对真实的基础设执行相应的操作
21+
## 核心能力
22+
23+
- **应用全生命周期管理**: 结合 [Kusion](https://github.com/KusionStack/kusion) 与 [Konfig](https://github.com/KusionStack/konfig) 实现从应用第一行配置代码到生产可用的全生命周期管理
24+
- **多层级管理**: 原生支持多租户、多环境运维能力
25+
- **混合运行时**: 以统一的方式运维 Kubernetes 和 Terraform 等多种运行时的资源
26+
- **厂商无关**: 一次编写，动态渲染，多云运行
827

9-
> KusionStack 提供面向云原生生态的定义及最佳实践，提供静态类型配置语言及工具支持，在业务镜像外提供 **Compile to Cloud** 的技术栈。Kusion 使用 Golang 语言编写，并具有跨 Unix-like 平台属性。
28+
<div align="center">
1029

11-
## 📜 语言
30+
![arch](docs/arch.png)
31+
</div>
1232

13-
[English](https://github.com/KusionStack/kusion/blob/main/README.md) | [简体中文](https://github.com/KusionStack/kusion/blob/main/README-zh.md)
33+
## 快速开始
1434

15-
## ✨ 功能概述
35+
参考 [快速开始](https://kusionstack.io/docs/user_docs/getting-started/usecase) 通过一条 Kusion 命令拉起一个应用
1636

17-
Kusion 的众多功能采用子命令的形式完成，其中较为常用的子命令包括 `apply`、`init`、`destroy`、`ls`、`preview` 等。
37+
![apply](https://kusionstack.io/assets/images/compile-c47339757fc512ca096f3892a3059fce.gif)
1838

19-
- `kusion apply`：接受 KCL 语言编写的代码文件作为输入，其输出可以是 Yaml 文件、JSON 文件，甚至可以直接执行到 K8S Runtime；
20-
- `kusion init`：可以帮助用户快速新建一个 Kusion 项目；
21-
- `kusion destroy`：可以删除由 KCL 创建的 K8S 资源；
22-
- `kusion ls`：列出当前目录或指定目录中的所有 Project 和 Stack 信息；
23-
- `kusion preview`：预览 Stack 中的一系列资源更改；
2439

25-
完整的命令功能说明，详见 [Kusion 命令](docs/cmd/en/kusion.md)。
2640

27-
## 🛠️ 安装
41+
## 安装
2842

29-
### 二进制安装（跨平台: windows, linux, mac ...）
43+
### 二进制安装
3044

3145
从二进制安装，只需从 `kusion` 的 [发布页面](https://github.com/KusionStack/kusion/releases) 下载对应平台的二进制文件，然后将二进制文件放在命令行能访问到的目录中即可。
3246

3347
### Kusinoup
3448

3549
你可以通过 `kusionup` 安装多个 `kusion` 版本，默认会安装最新版。
3650

51+
#### 安装 Kusionup
3752
```
53+
# Homebrew
3854
brew install KusionStack/tap/kusionup
39-
kusionup install
4055
```
41-
42-
### 从源码构建
43-
44-
使用 Go 1.16+ 版本，你可以通过 `make` 指令从源码构建适应于不同平台的完整 `kusion` 发布包：
45-
4656
```
47-
# Build all platforms (darwin, linux, windows)
48-
make build-all
49-
50-
# Build kusion & kcl tool chain for macOS
51-
# make build-local-darwin-all
52-
# Build kusion & kcl tool chain for linux
53-
# make build-local-linux-all
54-
# Build kusion & kcl tool chain for windows
55-
# make build-local-windows-all
57+
# cURL
58+
curl -sSf https://raw.githubusercontent.com/KusionStack/kusionup/main/scripts/install.sh | bash
59+
```
60+
#### 安装 Kusion
61+
```
62+
# visit https://github.com/KusionStack/kusionup for more details
63+
kusionup install
5664
```
57-
5865
### Docker
5966

6067
Docker 用户可以用以下命令拉取 `kusion` 的镜像：
@@ -63,11 +70,7 @@ Docker 用户可以用以下命令拉取 `kusion` 的镜像：
6370
docker pull kusionstack/kusion:latest
6471
```
6572

66-
## ⚡ 快速开始
67-
68-
访问[快速开始](docs/getting-started.md)了解如何快速创建并应用一个 Kusion 项目。
69-
70-
## 🎖︎ 贡献指南
73+
# 🎖︎ 贡献指南
7174

7275
Kusion 仍处在初级阶段，有很多能力需要补全，所以我们欢迎所有人参与进来与我们一起共建。
7376
访问[贡献指南](docs/contributing.md)了解如何参与到贡献 Kusion 项目中。

‎README.md‎

Lines changed: 40 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,66 @@
1-
## Introduction
1+
<div align="center">
2+
<p></p><p></p>
3+
<p>
4+
<img src="docs/logo.png">
5+
</p>
6+
<h1>A Unified Programmable Configuration Tech Stack</h1>
7+
8+
[简体中文](https://github.com/KusionStack/kusion/blob/main/README-zh.md) | [English](https://github.com/KusionStack/kusion/blob/main/README.md)
9+
10+
[Konfig](https://github.com/KusionStack/konfig) | [KCLVM](https://github.com/KusionStack/KCLVM) | [Kusion](https://github.com/KusionStack/kusion) | [Website](https://kusionstack.io/)
211

312
[![GitHub release](https://img.shields.io/github/release/KusionStack/kusion.svg)](https://github.com/KusionStack/kusion/releases)
413
[![Go Report Card](https://goreportcard.com/badge/github.com/KusionStack/kusion)](https://goreportcard.com/report/github.com/KusionStack/kusion)
514
[![license](https://img.shields.io/github/license/KusionStack/kusion.svg)](https://github.com/KusionStack/kusion/blob/main/LICENSE)
615
[![Go Reference](https://pkg.go.dev/badge/github.com/KusionStack/kusion.svg)](https://pkg.go.dev/github.com/KusionStack/kusion)
716
[![Coverage Status](https://coveralls.io/repos/github/KusionStack/kusion/badge.svg)](https://coveralls.io/github/KusionStack/kusion)
17+
</div>
18+
19+
# Kusion
20+
21+
Kusion is the engine of [KusionStack](https://github.com/KusionStack) for parsing user's intentions described in [Konfig](https://github.com/KusionStack/konfig) and making them effect in infrastructures.
822

9-
> KusionStack provides the definition and best practice for the native ecology of the cloud, provides the statically typed language and tool support, and provides **Compile to Cloud** technology stack outside the business mirror. Kusion is written in Golang and has attributes of crossing Unix-Like platform.
23+
## Key Features
1024

11-
## 📜 Language
25+
- **App Whole Lifecycle Management**: Manage App from the first code to production-ready with [Kusion](https://github.com/KusionStack/kusion) and [Konfig](https://github.com/KusionStack/konfig)
26+
- **Multiple Hierarchies**: Native support multi-tenant and multi-environment operations
27+
- **Hybrid Runtime**: Orchestrate hybrid runtime resources like Terraform and Kubernetes in an unified way
28+
- **Vendor Agnostic**: Write once, render dynamically, deliver to any cloud
1229

13-
[English](https://github.com/KusionStack/kusion/blob/main/README.md) | [简体中文](https://github.com/KusionStack/kusion/blob/main/README-zh.md)
30+
<div align="center">
1431

15-
## ✨ Functional Overview
32+
![arch](docs/arch.png)
33+
</div>
1634

17-
Kusion's many functions are completed in the form of subcommands. Among them, the more commonly used subcommands include `apply`,`init`, `destroy`,`ls`, `preview`, etc.
35+
## Quick Start
36+
Visit [Quick Start](https://kusionstack.io/docs/user_docs/getting-started/usecase) to deliver an App with one Kusion command
1837

19-
- `kusion apply`: Accept the code file written by the KCL language as the input. The output can be YAML files, JSON files, or even execute directly to the K8S Runtime
20-
- `kusion init`: Initialize KCL file structure and base codes for a new project
21-
- `kusion destroy`: Destroy a configuration stack to resource(s) by work directory
22-
- `kusion ls`: List all project and stack information
23-
- `kusion preview`: Preview a series of resource changes within the stack
38+
![apply](https://kusionstack.io/assets/images/compile-c47339757fc512ca096f3892a3059fce.gif)
2439

25-
For a complete command function description, please refer to the [Kusion Command](docs/cmd/en/kusion.md)。
2640

27-
## 🛠️ Installation
41+
## Installation
2842

29-
### Binary (Cross-platform: windows, linux, mac ...)
43+
### Binary
3044

31-
To get the binary just download the latest release for your OS/Arch from the [release page](https://github.com/KusionStack/kusion/releases) and put the binary somewhere convenient.
45+
Download the latest release for your OS/Arch from the [release page](https://github.com/KusionStack/kusion/releases) and put the binary somewhere convenient.
3246

3347
### Kusionup
3448

3549
You can install multiple versions of `kusion` with `kusionup`, and the latest version is installed by default.
36-
50+
#### Install Kusionup
3751
```
38-
# First, install kusionup, multiple ways:
39-
# - brew install KusionStack/tap/kusionup
40-
# - curl -sSf https://raw.githubusercontent.com/KusionStack/kusionup/main/scripts/install.sh | bash
41-
# - For other ways, please refer to: https://github.com/KusionStack/kusionup#%EF%B8%8F-installation
42-
43-
# Second, install kusion by kusionup
44-
kusionup install
52+
# Homebrew
53+
brew install KusionStack/tap/kusionup
4554
```
46-
47-
### Build from Source
48-
49-
Starting with Go 1.16+, you can use the `make` command to build a complete `kusion` distribution package suitable for different platforms from the source code.
50-
5155
```
52-
# Build all platforms (darwin, linux, windows)
53-
make build-all
54-
55-
# Build kusion & kcl tool chain for macOS
56-
# make build-local-darwin-all
57-
# Build kusion & kcl tool chain for linux
58-
# make build-local-linux-all
59-
# Build kusion & kcl tool chain for windows
60-
# make build-local-windows-all
56+
# cURL
57+
curl -sSf https://raw.githubusercontent.com/KusionStack/kusionup/main/scripts/install.sh | bash
58+
```
59+
#### Install Kusion
60+
```
61+
# visit https://github.com/KusionStack/kusionup for more details
62+
kusionup install
6163
```
62-
6364
### Docker
6465

6566
Docker users can use the following commands to pull the latest image of the `kusion`:
@@ -68,10 +69,6 @@ Docker users can use the following commands to pull the latest image of the `kus
6869
docker pull kusionstack/kusion:latest
6970
```
7071

71-
## ⚡ Quick Start
72-
73-
Visit [Quick Start](docs/getting-started.md) to understand how to quickly create and apply a KusionStack project.
74-
75-
## 🎖︎ Contribution Guide
72+
# 🎖︎ Contribution Guide
7673

7774
Kusion is still in the initial stage, and there are many capabilities that need to be made up, so we welcome everyone to participate in construction with us. Visit the [Contribution Guide](docs/contributing.md) to understand how to participate in the contribution KusionStack project. If you have any questions, please [Submit the Issue](https://github.com/KusionStack/kusion/issues).

‎docs/arch.png‎

50.4 KB
Loading

‎docs/logo.png‎

30.9 KB
Loading

0 commit comments

Comments
 (0)