|
| 1 | +# Konfig |
| 2 | + |
| 3 | +[](https://app.fossa.com/projects/git%2Bgithub.com%2Fkcl-lang%2Fkonfig?ref=badge_shield) |
| 4 | + |
| 5 | +[English](README.md) | [Chinese](README-zh.md) |
| 6 | + |
| 7 | +Konfig provides users with an out-of-the-box, highly abstract configuration interface. The original starting point of the model library is to improve the efficiency and experience of YAML users. We hope to simplify the writing of user-side configuration code by abstracting and encapsulating the model with more complex code into a unified model. |
| 8 | + |
| 9 | +For more details, please refer to: [Model Overview](https://kcl-lang.io/docs/user_docs/guides/working-with-konfig/overview) |
| 10 | + |
| 11 | +## Directory Structure |
| 12 | + |
| 13 | +The overall structure of the configuration library is as follows: |
| 14 | + |
| 15 | +```bash |
| 16 | +. |
| 17 | +├── LICENSE |
| 18 | +├── Makefile |
| 19 | +├── README-zh.md |
| 20 | +├── README.md |
| 21 | +├── examples # konfig examples |
| 22 | +├── kcl.mod # konfig package metadata file |
| 23 | +├── kcl.mod.lock # konfig package metadata lock file |
| 24 | +└── models |
| 25 | + ├── commons # Common models |
| 26 | + ├── kube # Cloud-native resource core models |
| 27 | + │ ├── backend # Back-end models |
| 28 | + │ ├── frontend # Front-end models |
| 29 | + │ │ ├── common # Common front-end models |
| 30 | + │ │ ├── configmap # ConfigMap |
| 31 | + │ │ ├── container # Container |
| 32 | + │ │ ├── ingress # Ingress |
| 33 | + │ │ ├── resource # Resource |
| 34 | + │ │ ├── secret # Secret |
| 35 | + │ │ ├── service # Service |
| 36 | + │ │ ├── sidecar # Sidecar |
| 37 | + │ │ ├── strategy # strategy |
| 38 | + │ │ ├── volume # Volume |
| 39 | + │ │ └── server.k # The `Server` model |
| 40 | + │ ├── metadata # Kubernetes metadata |
| 41 | + │ ├── mixins # Mixin |
| 42 | + │ ├── render # Front-to-back-end renderers. |
| 43 | + │ ├── templates # Data template |
| 44 | + │ └── utils |
| 45 | + └── metadata # Common metadata |
| 46 | +``` |
| 47 | + |
| 48 | +## Prerequisites |
| 49 | + |
| 50 | +Install [KCL](https://kcl-lang.io/docs/user_docs/getting-started/install) |
| 51 | + |
| 52 | +## Quick Start |
| 53 | + |
| 54 | +See [here](https://kcl-lang.io/docs/user_docs/guides/working-with-konfig/guide) |
| 55 | + |
| 56 | +## Resources |
| 57 | + |
| 58 | +- More examples can be found [here](https://github.com/kcl-lang/konfig/blob/main/examples/README.md) |
| 59 | +- Konfig schema reference document can be found [here](https://github.com/kcl-lang/konfig/blob/main/docs/konfig.md) |
| 60 | + |
| 61 | +## License |
| 62 | + |
| 63 | +Apache License Version 2.0 |
| 64 | + |
| 65 | +[](https://app.fossa.com/projects/git%2Bgithub.com%2Fkcl-lang%2Fkonfig?ref=badge_large) |
0 commit comments