Skip to content

Commit ae3e229

Browse files
committed
chore: bump kusion and kusion_models to kcl and k8s
1 parent f47aaba commit ae3e229

File tree

216 files changed

+474
-521
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

216 files changed

+474
-521
lines changed

actions

Lines changed: 0 additions & 1 deletion
This file was deleted.

cheatsheet/cheatsheet.tex

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -185,13 +185,13 @@
185185
\hspace*{1mm}\raisebox{0.5pt}{\tiny$\bullet$}~\textbf{Docker}
186186

187187
\begin{lstlisting}
188-
docker pull kusionstack/kclvm
188+
docker pull kcllang/kcl
189189
\end{lstlisting}
190190

191191
\hspace*{1mm}\raisebox{0.5pt}{\tiny$\bullet$}~\textbf{macOS}
192192

193193
\begin{lstlisting}
194-
brew install kcl-lang/tap/kclvm
194+
brew install kcl-lang/tap/kcl
195195
\end{lstlisting}
196196

197197
\hspace*{1mm}\raisebox{0.5pt}{\tiny$\bullet$}~\textbf{Linux}

docs/community/contribute/git-guideline.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,9 +72,9 @@ Where `{breaking_change_description}` and `{linked issue}` can be omitted if the
7272
For example, the commit created by Alice in branch 'alice: fix output fmt bug'.
7373

7474
```
75-
fix(kclvm-printer): fix an output format bug in kclvm-printer
75+
fix(kcl-printer): fix an output format bug in kcl-printer
7676
77-
There is an output format bug in kclvm-printer because ...,
77+
There is an output format bug in kcl-printer because ...,
7878
So, The calling of method "XXX" is replaced by "HHHH"...,
7979
...
8080
@@ -106,7 +106,7 @@ We suggest that the PR title be consistent with the branch name and the commit m
106106
For example, Alice creates the PR name `fix/alice/fix_output_fmt_bug` for one branch.
107107

108108
```
109-
fix(kclvm-printer): fix an output format bug in kclvm-printer.
109+
fix(kcl-printer): fix an output format bug in kcl-printer.
110110
```
111111

112112
## 5. Supported PR Types

docs/reference/lang/codelab/schema.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -574,7 +574,7 @@ However, usually, the actual situation is more complicated, and the deployment m
574574
For example, we want to support a persistent volume claim based on an existing schema, as a reusable Kubernetes schema. In this case, we can just wrapper it with a `mixin` and a `protocol` as follows:
575575

576576
```python
577-
import kusion_kubernetes.api.core.v1
577+
import k8spkg.api.core.v1
578578
579579
protocol PVCProtocol:
580580
pvc?: {str:}

docs/reference/lang/tour.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1878,15 +1878,15 @@ schema Server:
18781878
workloadType : str, default is Deployment
18791879
Use this attribute to specify which kind of long-running service you want.
18801880
Valid values: Deployment, CafeDeployment.
1881-
See also: kusion_models/core/v1/workload_metadata.k.
1881+
See also: k8s/core/v1/workload_metadata.k.
18821882
name : str, default is None
18831883
A Server-level attribute.
18841884
The name of the long-running service.
1885-
See also: kusion_models/core/v1/metadata.k.
1885+
See also: k8s/core/v1/metadata.k.
18861886
labels : {str:str}, optional, default is None
18871887
A Server-level attribute.
18881888
The labels of the long-running service.
1889-
See also: kusion_models/core/v1/metadata.k.
1889+
See also: k8s/core/v1/metadata.k.
18901890
18911891
Examples
18921892
----------------------
@@ -2937,7 +2937,7 @@ kcl_cli_configs:
29372937
output: ./stdout.golden
29382938
kcl_options:
29392939
- key: image
2940-
value: docker.io/kusion:latest
2940+
value: docker.io/kcllang/kcl:latest
29412941
```
29422942
29432943
KCL CLI -Y parameters also support multi-file configuration, and support separate writing and merging of compilation parameters and option top level arguments parameter configuration.
@@ -2965,7 +2965,7 @@ kcl_cli_configs:
29652965
```yaml
29662966
kcl_options:
29672967
- key: image
2968-
value: docker.io/kusion:latest
2968+
value: docker.io/kcllang/kcl:latest
29692969
```
29702970

29712971
We can use the following command line to get the meaning of each configuration parameter or see KCL Quick Start

docs/reference/plugin/overview.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@ Using the KCL Python plugin requires the presence of `Python 3.7+` in your `PATH
1414

1515
## 1. Hello Plugin
1616

17-
KCL plugins are installed in the `plugins` subdirectory of KCL (usually installed in the `$HOME/.kusion/kclvm/plugins` directory), or set through the `$KCL_PLUGINS_ROOT` environment variable. Besides, the `plugins` directory could also be placed at the `pwd` path. KCL plugins are managed in the Git repository: [https://github.com/kcl-lang/kcl-plugin](https://github.com/kcl-lang/kcl-plugin), we can clone the repository for development.
17+
KCL plugins are installed in the `plugins` subdirectory of KCL (usually installed in the `$HOME/.kcl/plugins` directory), or set through the `$KCL_PLUGINS_ROOT` environment variable. Besides, the `plugins` directory could also be placed at the `pwd` path. KCL plugins are managed in the Git repository: [https://github.com/kcl-lang/kcl-plugin](https://github.com/kcl-lang/kcl-plugin), we can clone the repository for development.
1818

1919
Enter the `kcl-plugin info` command to view the plugin directory (replace `/Users/kcl_user` with the local `$HOME` path):
2020

2121
```shell
2222
$ kcl-plugin info
23-
# plugin_root: /Users/kcl_user/.kusion/kclvm/plugins
23+
# plugin_root: /Users/kcl_user/.kcl/plugins
2424
```
2525

2626
View the list of plugins with the `kcl-plugin list` subcommand:
@@ -103,8 +103,8 @@ The information of the plugin mainly includes the name and version information o
103103
The directory structure of the plugin is as follows (replace `/Users/kcl_user` with the local `$HOME` path):
104104

105105
```shell
106-
$ tree /Users/kcl_user/.kusion/kclvm/plugins/
107-
/Users/kcl_user/.kusion/kclvm/plugins/
106+
$ tree /Users/kcl_user/.kcl/plugins/
107+
/Users/kcl_user/.kcl/plugins/
108108
├── _examples
109109
├── _test
110110
└── hello
@@ -150,14 +150,14 @@ The `kcl-plugin init` command will construct a new plugin from the built-in temp
150150

151151
## 6. Remove Plugin
152152

153-
KCL plugins are located in the `plugins` subdirectory of KCL (usually installed in the `$HOME/.kusion/kclvm/plugins` directory).
153+
KCL plugins are located in the `plugins` subdirectory of KCL (usually installed in the `$HOME/.kcl/plugins` directory).
154154
We can query the plugin installation directory with the command `kcl-plugin info`.
155155

156156
```shell
157157
$ kcl-plugin info
158-
/Users/kcl_user/.kusion/kclvm/plugins/
159-
$ tree /Users/kcl_user/.kusion/kclvm/plugins/
160-
/Users/kcl_user/.kusion/kclvm/plugins/
158+
/Users/kcl_user/.kcl/plugins/
159+
$ tree /Users/kcl_user/.kcl/plugins/
160+
/Users/kcl_user/.kcl/plugins/
161161
├── _examples
162162
├── _test
163163
└── hello -- Delete this directory to delete the hello plugin
@@ -179,7 +179,7 @@ $ kcl-plugin test hello
179179
platform darwin -- Python 3.7.6+, pytest-5.3.5, py-1.9.0, pluggy-0.13.1
180180
rootdir: /Users/kcl_user
181181
collected 5 items
182-
.kusion/kclvm/plugins/hello/plugin_test.py ..... [100%]
182+
.kcl/plugins/hello/plugin_test.py ..... [100%]
183183
============================== 5 passed in 0.03s ===============================
184184
$
185185
```

docs/tools/cli/kcl/docgen.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -127,15 +127,15 @@ As shown before, by default, the documentation extracted by the documentation ge
127127
workloadType : str, default is "Deployment", required
128128
Use this attribute to specify which kind of long-running service you want.
129129
Valid values: Deployment, CafeDeployment.
130-
See also: kusion_models/core/v1/workload_metadata.k.
130+
See also: k8s/core/v1/workload_metadata.k.
131131
name : str, required
132132
A Server-level attribute.
133133
The name of the long-running service.
134-
See also: kusion_models/core/v1/metadata.k.
134+
See also: k8s/core/v1/metadata.k.
135135
labels : {str:str}, optional
136136
A Server-level attribute.
137137
The labels of the long-running service.
138-
See also: kusion_models/core/v1/metadata.k.
138+
See also: k8s/core/v1/metadata.k.
139139

140140
Examples
141141
----------------------
@@ -170,7 +170,7 @@ As shown before, by default, the documentation extracted by the documentation ge
170170
doc: |
171171
Use this attribute to specify which kind of long-running service you want.
172172
Valid values: Deployment, CafeDeployment.
173-
See also: kusion_models/core/v1/workload_metadata.k.
173+
See also: k8s/core/v1/workload_metadata.k.
174174
type:
175175
type_str: str
176176
type_category: BUILTIN
@@ -181,7 +181,7 @@ As shown before, by default, the documentation extracted by the documentation ge
181181
doc: |
182182
A Server-level attribute.
183183
The name of the long-running service.
184-
See also: kusion_models/core/v1/metadata.k.
184+
See also: k8s/core/v1/metadata.k.
185185
type:
186186
type_str: str
187187
type_category: BUILTIN
@@ -192,7 +192,7 @@ As shown before, by default, the documentation extracted by the documentation ge
192192
doc: |
193193
A Server-level attribute.
194194
The labels of the long-running service.
195-
See also: kusion_models/core/v1/metadata.k.
195+
See also: k8s/core/v1/metadata.k.
196196
type:
197197
type_str: '{str: str}'
198198
type_category: DICT
@@ -228,7 +228,7 @@ As shown before, by default, the documentation extracted by the documentation ge
228228
- name: workloadType
229229
doc: |
230230
workloadType 属性定义了服务的类型,是服务级别的属性。合法的取值有:Deployment, CafeDeployment.
231-
另请查看:kusion_models/core/v1/workload_metadata.k.
231+
另请查看:k8s/core/v1/workload_metadata.k.
232232
type:
233233
type_str: str
234234
type_category: BUILTIN
@@ -238,7 +238,7 @@ As shown before, by default, the documentation extracted by the documentation ge
238238
- name: name
239239
doc: |
240240
name 为服务的名称,是服务级别的属性。
241-
另请查看:kusion_models/core/v1/metadata.k.
241+
另请查看:k8s/core/v1/metadata.k.
242242
type:
243243
type_str: str
244244
type_category: BUILTIN
@@ -248,7 +248,7 @@ As shown before, by default, the documentation extracted by the documentation ge
248248
- name: labels
249249
doc: |
250250
labels 为服务的标签,是服务级别的属性。
251-
另请查看:kusion_models/core/v1/metadata.k.
251+
另请查看:k8s/core/v1/metadata.k.
252252
type:
253253
type_str: '{str: str}'
254254
type_category: DICT
@@ -285,9 +285,9 @@ As shown before, by default, the documentation extracted by the documentation ge
285285
### Attributes
286286
|Name and Description|Type|Default Value|Required|
287287
|--------------------|----|-------------|--------|
288-
|**workloadType**<br />workloadType 属性定义了服务的类型,是服务级别的属性。合法的取值有:Deployment, CafeDeployment.<br />另请查看:kusion_models/core/v1/workload_metadata.k.|str|"Deployment"|**required**|
289-
|**name**<br />name 为服务的名称,是服务级别的属性。<br />另请查看:kusion_models/core/v1/metadata.k.|str|Undefined|**required**|
290-
|**labels**<br />labels 为服务的标签,是服务级别的属性。<br />另请查看:kusion_models/core/v1/metadata.k.|{str: str}|Undefined|optional|
288+
|**workloadType**<br />workloadType 属性定义了服务的类型,是服务级别的属性。合法的取值有:Deployment, CafeDeployment.<br />另请查看:k8s/core/v1/workload_metadata.k.|str|"Deployment"|**required**|
289+
|**name**<br />name 为服务的名称,是服务级别的属性。<br />另请查看:k8s/core/v1/metadata.k.|str|Undefined|**required**|
290+
|**labels**<br />labels 为服务的标签,是服务级别的属性。<br />另请查看:k8s/core/v1/metadata.k.|{str: str}|Undefined|optional|
291291
### Examples
292292
```
293293
myCustomApp = AppConfiguration {

docs/user_docs/guides/package-management/4-share_your_pkg.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Share Your Package
22

3-
[kpm](https://github.com/KusionStack/kpm) is a tool for managing kcl packages. This article will guide you on how to use kpm to push your kcl package to an OCI Registry for publication. kpm uses [ghcr.io](https://ghcr.io) as the default OCI Registry, and you can change the default OCI Registry by modifying the kpm configuration file. For information on how to modify the kpm configuration file, see [kpm oci registry](https://github.com/kcl-lang/kpm/blob/main/docs/kpm_oci.md#kpm-registry)
3+
[kpm](https://github.com/kcl-lang/kpm) is a tool for managing kcl packages. This article will guide you on how to use kpm to push your kcl package to an OCI Registry for publication. kpm uses [ghcr.io](https://ghcr.io) as the default OCI Registry, and you can change the default OCI Registry by modifying the kpm configuration file. For information on how to modify the kpm configuration file, see [kpm oci registry](https://github.com/kcl-lang/kpm/blob/main/docs/kpm_oci.md#kpm-registry)
44

55
Here is a simple step-by-step guide on how to use kpm to push your kcl package to ghcr.io.
66

docs/user_docs/support/faq-kcl.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2242,7 +2242,7 @@ data_type_list:
22422242

22432243
## 49. How to develop a KCL plugin?
22442244

2245-
KCL plugins are installed in the plugins subdirectory of KCL (usually installed in the `$HOME/.kusion/kclvm/plugins` directory), or set through the `$KCL_PLUGINS_ROOT` environment variable. Besides, the `plugins` directory could also be placed at the `pwd` path. For plugin developers, plugins are managed in the [Git repository](https://github.com/kcl-lang/kcl-plugin), and the plugin repository can be cloned to this directory for development.
2245+
KCL plugins are installed in the plugins subdirectory of KCL (usually installed in the `$HOME/.kcl/plugins` directory), or set through the `$KCL_PLUGINS_ROOT` environment variable. Besides, the `plugins` directory could also be placed at the `pwd` path. For plugin developers, plugins are managed in the [Git repository](https://github.com/kcl-lang/kcl-plugin), and the plugin repository can be cloned to this directory for development.
22462246

22472247
KCL has built-in kcl-plugin scaffolding command to assist users to write KCL plug-ins in Python language, so that the corresponding plug-ins can be called in the KCL file to enhance the KCL language itself, such as accessing the network, reading and writing IO, CMDB query and encryption and decryption functions.
22482248

examples/codelab/schema/k8spkg/api/admissionregistration/v1/mutating_webhook.k

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""
2-
This is the mutating_webhook module in kusion_kubernetes.api.admissionregistration.v1 package.
2+
This is the mutating_webhook module in k8spkg.api.admissionregistration.v1 package.
33
This file was generated by the KCL auto-gen tool. DO NOT EDIT.
44
Editing this file might prove futile when you re-run the KCL auto-gen generate command.
55
"""

0 commit comments

Comments
 (0)