Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Peefy committed Oct 8, 2023
1 parent 3c35324 commit 30b09d4
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 101 deletions.
50 changes: 29 additions & 21 deletions README-zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,27 +14,35 @@ Konfig 是 KCL 配置中基础设施配置的单一存储库。Konfig 提供给

```bash
.
├── Makefile # 通过 Makefile 封装常用命令
├── README.md # 配置大库说明
├── appops # 应用运维目录,用来放置所有应用的 KCL 运维配置
│ ├── clickhouse-operator
│ ├── code-city
│ ├── guestbook
│ ├── http-echo
│ └── nginx-example
├── base # 模型库
│ ├── examples # 样例代码
│ │ ├── monitoring # 监控配置样例
│ │ ├── native # Kubernetes 资源配置样例
│ │ ├── provider # 基础资源配置样例
│ │ └── server # 云原生应用运维配置模型样例
│ └── pkg
│ ├── kusion_kubernetes # Kubernetes 底层模型库
│ ├── kusion_models # 核心模型库
│ ├── kusion_prometheus # Prometheus 底层模型库
│ └── kusion_provider # 基础资源 底层模型库
├── hack # 放置一些脚本
└── kcl.mod # 大库配置文件,通常用来标识大库根目录位置以及大库所需依赖
├── LICENSE
├── Makefile
├── README-zh.md
├── README.md
├── examples # konfig examples
├── kcl.mod # konfig package metadata file
├── kcl.mod.lock # konfig package metadata lock file
└── models
├── commons # Common models
├── kube # Cloud-native resource core models
│ ├── backend # Back-end models
│ ├── frontend # Front-end models
│ │ ├── common # Common front-end models
│ │ ├── configmap # ConfigMap
│ │ ├── container # Container
│ │ ├── ingress # Ingress
│ │ ├── resource # Resource
│ │ ├── secret # Secret
│ │ ├── service # Service
│ │ ├── sidecar # Sidecar
│ │ ├── strategy # strategy
│ │ ├── volume # Volume
│ │ └── server.k # The `Server` model
│ ├── metadata # Kubernetes metadata
│ ├── mixins # Mixin
│ ├── render # Front-to-back-end renderers.
│ ├── templates # Data template
│ └── utils
└── metadata # Common metadata
```

## 前置条件
Expand Down
105 changes: 25 additions & 80 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,86 +20,31 @@ The overall structure of the configuration library is as follows:
├── Makefile
├── README-zh.md
├── README.md
├── examples
├── kcl.mod
├── kcl.mod.lock
├── models
│ ├── commons
│ └── kube
│ ├── backend
│ │ ├── job_backend.k
│ │ └── server_backend.k
│ ├── frontend
│ │ ├── common
│ │ │ └── metadata.k
│ │ ├── configmap
│ │ │ └── configmap.k
│ │ ├── container
│ │ │ ├── container.k
│ │ │ ├── env
│ │ │ │ └── env.k
│ │ │ ├── lifecycle
│ │ │ │ └── lifecycle.k
│ │ │ ├── port
│ │ │ │ └── container_port.k
│ │ │ └── probe
│ │ │ └── probe.k
│ │ ├── ingress
│ │ │ └── ingress.k
│ │ ├── job.k
│ │ ├── rbac
│ │ │ ├── cluster_role.k
│ │ │ ├── cluster_role_binding.k
│ │ │ ├── role.k
│ │ │ └── role_binding.k
│ │ ├── resource
│ │ │ ├── resource.k
│ │ │ └── resource_requirements.k
│ │ ├── secret
│ │ │ └── secret.k
│ │ ├── server.k
│ │ ├── service
│ │ │ └── service.k
│ │ ├── serviceaccount
│ │ │ └── service_account.k
│ │ ├── sidecar
│ │ │ ├── sidecar.k
│ │ │ └── simple_sidecar.k
│ │ ├── storage
│ │ │ ├── database.k
│ │ │ └── objectstorage.k
│ │ ├── strategy
│ │ │ └── scheduling_strategy.k
│ │ └── volume
│ │ └── volume.k
│ ├── metadata
│ │ └── metadata.k
│ ├── mixins
│ │ ├── configmap_mixin.k
│ │ ├── ingress_mixin.k
│ │ ├── metadata_mixin.k
│ │ ├── namespace_mixin.k
│ │ ├── secret_mixin.k
│ │ ├── service_mixin.k
│ │ └── serviceaccount_mixin.k
│ ├── protocol
│ │ └── server_protocol.k
│ ├── render
│ │ └── render.k
│ ├── resource
│ │ ├── resource.k
│ │ └── resourceorder.k
│ ├── templates
│ │ └── resource.k
│ └── utils
│ ├── application_builder.k
│ ├── container_frontend2kube.k
│ ├── metadata_builder.k
│ ├── str2resource_requirements.k
│ ├── str2resource_requirements_test.k
│ └── volume_patch.k
└── scripts
└── test.sh
├── examples # konfig examples
├── kcl.mod # konfig package metadata file
├── kcl.mod.lock # konfig package metadata lock file
└── models
├── commons # Common models
├── kube # Cloud-native resource core models
│ ├── backend # Back-end models
│ ├── frontend # Front-end models
│ │ ├── common # Common front-end models
│ │ ├── configmap # ConfigMap
│ │ ├── container # Container
│ │ ├── ingress # Ingress
│ │ ├── resource # Resource
│ │ ├── secret # Secret
│ │ ├── service # Service
│ │ ├── sidecar # Sidecar
│ │ ├── strategy # strategy
│ │ ├── volume # Volume
│ │ └── server.k # The `Server` model
│ ├── metadata # Kubernetes metadata
│ ├── mixins # Mixin
│ ├── render # Front-to-back-end renderers.
│ ├── templates # Data template
│ └── utils
└── metadata # Common metadata
```

## Prerequisites
Expand Down

0 comments on commit 30b09d4

Please sign in to comment.