Skip to content

Commit

Permalink
docs: update readme documents
Browse files Browse the repository at this point in the history
Signed-off-by: peefy <[email protected]>
  • Loading branch information
Peefy committed Aug 20, 2024
1 parent 1184d28 commit 22c25dd
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 16 deletions.
17 changes: 4 additions & 13 deletions README-zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,19 +25,10 @@ flux-kcl-controller 是一个组件,用于集成 [KCL](https://github.com/kcl-

## 创建测试用的 k8s 集群

使用`mycluster.yaml`创建集群:

```yaml
apiVersion: k3d.io/v1alpha2
kind: Simple
name: mycluster
servers: 1
agents: 2
```
通过如下命令创建集群:

```shell
k3d cluster create -c mycluster.yaml
k3d cluster create
```

## 下载 kcl-controller 并且安装到集群中
Expand All @@ -51,7 +42,7 @@ git clone https://github.com/kcl-lang/flux-kcl-controller.git
进入到本仓库的根目录:

```shell
cd kcl-controller
cd flux-kcl-controller
```

将 kcl-controller 安装到集群中:
Expand All @@ -62,7 +53,7 @@ make deploy

## 监控一个 git 仓库

我们以仓库 https://github.com/awesome-kusion/kcl-deployment 为例,该仓库中存储了一个 KCL 程序,该程序定义了一个 Deployment,我们将使用 kcl-controller 来部署该程序。
我们以仓库 https://github.com/awesome-kusion/kcl-deployment 为例,该仓库中存储了一个 KCL 程序,该程序定义了一个 Deployment,我们将使用 `flux-kcl-controller` 来部署该程序。

通过 `gitrepo.yaml` 文件,定义一个 `GitRepository` 对象,用来监控该仓库:

Expand Down Expand Up @@ -121,4 +112,4 @@ nginx-deployment 1/1 1 1 20m
nginx-deployment-1 1/1 1 0 4s
```

可以看到,kcl-controller 根据仓库中的 KCL 程序,创建了一个 nginx-deployment-1。
可以看到,`flux-kcl-controller` 根据仓库中的 KCL 程序,创建了一个 `nginx-deployment-1` 资源
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

# Introduction

The flux-kcl-controller is a component developed for the integration of [KCL](https://github.com/kcl-lang/kcl) and [Flux](https://github.com/fluxcd/flux2), designed to orchestrate continuous delivery pipelines for infrastructure and workloads defined with KCL based on the [source-controller](https://github.com/fluxcd/source-controller) to acquire the KCL program from repositories.
The `flux-kcl-controller` is a component developed for the integration of [KCL](https://github.com/kcl-lang/kcl) and [Flux](https://github.com/fluxcd/flux2), designed to orchestrate continuous delivery pipelines for infrastructure and workloads defined with KCL based on the [source-controller](https://github.com/fluxcd/source-controller), [kustomize-controller](https://github.com/fluxcd/kustomize-controller) and [helm-controller](https://github.com/fluxcd/helm-controller) to acquire the KCL program from repositories.

![kcl-flux](./docs/img/kcl-flux.png)

Expand Down Expand Up @@ -54,7 +54,7 @@ make deploy

## Monitor a git repository

Take the github repository https://github.com/awesome-kusion/kcl-deployment as an example. This repository stores a KCL program that defines a `Deployment`. We will use kcl-controller to deploy this program.
Take the GitHub repository https://github.com/awesome-kusion/kcl-deployment as an example. This repository stores a KCL program that defines a `Deployment`. We will use `flux-kcl-controller` to deploy this program.

Define a `GitRepository` object through the `gitrepo.yaml` file to monitor the repository:

Expand Down Expand Up @@ -111,4 +111,4 @@ nginx-deployment 1/1 1 1 20m
nginx-deployment-1 1/1 1 0 4s
```

kcl-controller creates a `nginx-deployment-1` according to the KCL program in the repository.
`flux-kcl-controller` creates a `nginx-deployment-1` according to the KCL program in the repository.

0 comments on commit 22c25dd

Please sign in to comment.