-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
5362977
commit 94a73e1
Showing
2 changed files
with
94 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
# Konfig | ||
|
||
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fkcl-lang%2Fkonfig?ref=badge_shield) | ||
|
||
[English](README.md) | [Chinese](README-zh.md) | ||
|
||
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. | ||
|
||
For more details, please refer to: [Model Overview](https://kcl-lang.io/docs/user_docs/guides/working-with-konfig/overview) | ||
|
||
## Directory Structure | ||
|
||
The overall structure of the configuration library is as follows: | ||
|
||
```bash | ||
. | ||
├── 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 | ||
``` | ||
|
||
## Prerequisites | ||
|
||
Install [KCL](https://kcl-lang.io/docs/user_docs/getting-started/install) | ||
|
||
## Quick Start | ||
|
||
See [here](https://kcl-lang.io/docs/user_docs/guides/working-with-konfig/guide) | ||
|
||
## Resources | ||
|
||
- More examples can be found [here](https://github.com/kcl-lang/konfig/blob/main/examples/README.md) | ||
- Konfig schema reference document can be found [here](https://github.com/kcl-lang/konfig/blob/main/docs/konfig.md) | ||
|
||
## License | ||
|
||
Apache License Version 2.0 | ||
|
||
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fkcl-lang%2Fkonfig?ref=badge_large) |
29 changes: 29 additions & 0 deletions
29
.integration/artifacthub/konfig/0.8.0/artifacthub-pkg.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
version: 0.8.0 | ||
name: konfig | ||
displayName: konfig | ||
createdAt: "2024-09-11T03:57:58Z" | ||
description: 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. | ||
links: | ||
- name: KCL homepage | ||
url: https://kcl-lang.io/ | ||
- name: KCL repo | ||
url: https://github.com/kcl-lang/kcl | ||
install: | | ||
#### Add `konfig` with tag `0.8.0` as dependency | ||
``` | ||
kcl mod add konfig:0.8.0 | ||
``` | ||
#### Pull `konfig` with tag `0.8.0` to local | ||
``` | ||
kcl mod pull konfig:0.8.0 | ||
``` | ||
maintainers: | ||
- name: kcl-lang.io | ||
email: [email protected] | ||
provider: | ||
name: kcl-lang.io |