Skip to content

Commit 01a91b7

Browse files
authored
feat: update reference docs for kusion (#589)
1 parent 7be921a commit 01a91b7

Some content is hidden

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

42 files changed

+546
-225
lines changed

docs/kusion/6-reference/1-commands/index.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,23 @@ Kusion is the Platform Orchestrator of Internal Developer Platform
44

55
Find more information at: https://www.kusionstack.io
66

7-
### Synopsis
7+
## Synopsis
88

99
As a Platform Orchestrator, Kusion delivers user intentions to Kubernetes, Clouds and On-Premise resources. Also enables asynchronous cooperation between the development and the platform team and drives the separation of concerns.
1010

1111
```
1212
kusion [flags]
1313
```
1414

15-
### Options
15+
## Options
1616

1717
```
1818
-h, --help help for kusion
1919
--profile string Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) (default "none")
2020
--profile-output string Name of the file to write the profile to (default "profile.pprof")
2121
```
2222

23-
### SEE ALSO
23+
## SEE ALSO
2424

2525
* [kusion apply](kusion-apply.md) - Apply the operational intent of various resources to multiple runtimes
2626
* [kusion config](kusion-config.md) - Interact with the Kusion config
@@ -31,10 +31,11 @@ kusion [flags]
3131
* [kusion options](kusion-options.md) - Print the list of flags inherited by all commands
3232
* [kusion preview](kusion-preview.md) - Preview a series of resource changes within the stack
3333
* [kusion project](kusion-project.md) - Project is a folder that contains a project.yaml file and is linked to a Git repository
34-
* [kusion release](kusion-release.md) - Manage Kusion release files
34+
* [kusion release](kusion-release.md) - Observe and operate Kusion release files
3535
* [kusion resource](kusion-resource.md) - Observe Kusion resource information
36+
* [kusion server](kusion-server.md) - Start kusion server
3637
* [kusion stack](kusion-stack.md) - Stack is a folder that contains a stack.yaml file within the corresponding project directory
3738
* [kusion version](kusion-version.md) - Print the Kusion version information for the current context
3839
* [kusion workspace](kusion-workspace.md) - Workspace is a logical concept representing a target that stacks will be deployed to
3940

40-
###### Auto generated by spf13/cobra on 26-Sep-2024
41+
###### Auto generated by spf13/cobra on 21-Jan-2025

docs/kusion/6-reference/1-commands/kusion-apply.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Apply the operational intent of various resources to multiple runtimes
44

5-
### Synopsis
5+
## Synopsis
66

77
Apply a series of resource changes within the stack.
88

@@ -12,7 +12,7 @@ Apply a series of resource changes within the stack.
1212
kusion apply [flags]
1313
```
1414

15-
### Examples
15+
## Examples
1616

1717
```
1818
# Apply with specified work directory
@@ -40,7 +40,7 @@ kusion apply [flags]
4040
kusion apply --port-forward=8080
4141
```
4242

43-
### Options
43+
## Options
4444

4545
```
4646
-a, --all --detail Automatically show all preview details, combined use with flag --detail
@@ -61,17 +61,17 @@ kusion apply [flags]
6161
-y, --yes Automatically approve and perform the update after previewing it
6262
```
6363

64-
### Options inherited from parent commands
64+
## Options inherited from parent commands
6565

6666
```
6767
--profile string Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) (default "none")
6868
--profile-output string Name of the file to write the profile to (default "profile.pprof")
6969
```
7070

71-
### SEE ALSO
71+
## SEE ALSO
7272

7373
* [kusion](index.md) - Kusion is the Platform Orchestrator of Internal Developer Platform
7474

7575
Find more information at: https://www.kusionstack.io
7676

77-
###### Auto generated by spf13/cobra on 26-Sep-2024
77+
###### Auto generated by spf13/cobra on 21-Jan-2025

docs/kusion/6-reference/1-commands/kusion-config-get.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,36 +2,36 @@
22

33
Get a config item
44

5-
### Synopsis
5+
## Synopsis
66

77
This command gets the value of a specified kusion config item, where the config item must be registered.
88

99
```
1010
kusion config get
1111
```
1212

13-
### Examples
13+
## Examples
1414

1515
```
1616
# Get a config item
1717
kusion config get backends.current
1818
```
1919

20-
### Options
20+
## Options
2121

2222
```
2323
-h, --help help for get
2424
```
2525

26-
### Options inherited from parent commands
26+
## Options inherited from parent commands
2727

2828
```
2929
--profile string Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) (default "none")
3030
--profile-output string Name of the file to write the profile to (default "profile.pprof")
3131
```
3232

33-
### SEE ALSO
33+
## SEE ALSO
3434

3535
* [kusion config](kusion-config.md) - Interact with the Kusion config
3636

37-
###### Auto generated by spf13/cobra on 26-Sep-2024
37+
###### Auto generated by spf13/cobra on 21-Jan-2025

docs/kusion/6-reference/1-commands/kusion-config-list.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,36 +2,36 @@
22

33
List all config items
44

5-
### Synopsis
5+
## Synopsis
66

77
This command lists all the kusion config items and their values.
88

99
```
1010
kusion config list
1111
```
1212

13-
### Examples
13+
## Examples
1414

1515
```
1616
# List config items
1717
kusion config list
1818
```
1919

20-
### Options
20+
## Options
2121

2222
```
2323
-h, --help help for list
2424
```
2525

26-
### Options inherited from parent commands
26+
## Options inherited from parent commands
2727

2828
```
2929
--profile string Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) (default "none")
3030
--profile-output string Name of the file to write the profile to (default "profile.pprof")
3131
```
3232

33-
### SEE ALSO
33+
## SEE ALSO
3434

3535
* [kusion config](kusion-config.md) - Interact with the Kusion config
3636

37-
###### Auto generated by spf13/cobra on 26-Sep-2024
37+
###### Auto generated by spf13/cobra on 21-Jan-2025

docs/kusion/6-reference/1-commands/kusion-config-set.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22

33
Set a config item
44

5-
### Synopsis
5+
## Synopsis
66

77
This command sets the value of a specified kusion config item, where the config item must be registered, and the value must be in valid type.
88

99
```
1010
kusion config set
1111
```
1212

13-
### Examples
13+
## Examples
1414

1515
```
1616
# Set a config item with string type value
@@ -20,21 +20,21 @@ kusion config set
2020
kusion config set backends.s3-pre.configs '{"bucket":"kusion"}'
2121
```
2222

23-
### Options
23+
## Options
2424

2525
```
2626
-h, --help help for set
2727
```
2828

29-
### Options inherited from parent commands
29+
## Options inherited from parent commands
3030

3131
```
3232
--profile string Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) (default "none")
3333
--profile-output string Name of the file to write the profile to (default "profile.pprof")
3434
```
3535

36-
### SEE ALSO
36+
## SEE ALSO
3737

3838
* [kusion config](kusion-config.md) - Interact with the Kusion config
3939

40-
###### Auto generated by spf13/cobra on 26-Sep-2024
40+
###### Auto generated by spf13/cobra on 21-Jan-2025

docs/kusion/6-reference/1-commands/kusion-config-unset.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,36 +2,36 @@
22

33
Unset a config item
44

5-
### Synopsis
5+
## Synopsis
66

77
This command unsets a specified kusion config item, where the config item must be registered.
88

99
```
1010
kusion config unset
1111
```
1212

13-
### Examples
13+
## Examples
1414

1515
```
1616
# Unset a config item
1717
kusion config unset backends.s3-pre.configs.bucket
1818
```
1919

20-
### Options
20+
## Options
2121

2222
```
2323
-h, --help help for unset
2424
```
2525

26-
### Options inherited from parent commands
26+
## Options inherited from parent commands
2727

2828
```
2929
--profile string Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) (default "none")
3030
--profile-output string Name of the file to write the profile to (default "profile.pprof")
3131
```
3232

33-
### SEE ALSO
33+
## SEE ALSO
3434

3535
* [kusion config](kusion-config.md) - Interact with the Kusion config
3636

37-
###### Auto generated by spf13/cobra on 26-Sep-2024
37+
###### Auto generated by spf13/cobra on 21-Jan-2025

docs/kusion/6-reference/1-commands/kusion-config.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,21 @@
22

33
Interact with the Kusion config
44

5-
### Synopsis
5+
## Synopsis
66

77
Config contains the operation of Kusion configurations.
88

99
```
1010
kusion config [flags]
1111
```
1212

13-
### Options
13+
## Options
1414

1515
```
1616
-h, --help help for config
1717
```
1818

19-
### Options inherited from parent commands
19+
## Options inherited from parent commands
2020

2121
```
2222
--profile string Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) (default "none")
@@ -26,9 +26,10 @@ kusion config [flags]
2626
### SEE ALSO
2727

2828
* [kusion](index.md) - Kusion is the Platform Orchestrator of Internal Developer Platform
29+
2930
* [kusion config get](kusion-config-get.md) - Get a config item
3031
* [kusion config list](kusion-config-list.md) - List all config items
3132
* [kusion config set](kusion-config-set.md) - Set a config item
3233
* [kusion config unset](kusion-config-unset.md) - Unset a config item
3334

34-
###### Auto generated by spf13/cobra on 26-Sep-2024
35+
###### Auto generated by spf13/cobra on 21-Jan-2025

docs/kusion/6-reference/1-commands/kusion-destroy.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Destroy resources within the stack.
44

5-
### Synopsis
5+
## Synopsis
66

77
Destroy resources within the stack.
88

@@ -12,14 +12,14 @@ Destroy resources within the stack.
1212
kusion destroy [flags]
1313
```
1414

15-
### Examples
15+
## Examples
1616

1717
```
1818
# Delete resources of current stack
1919
kusion destroy
2020
```
2121

22-
### Options
22+
## Options
2323

2424
```
2525
--backend string The backend to use, supports 'local', 'oss' and 's3'.
@@ -31,17 +31,17 @@ kusion destroy [flags]
3131
-y, --yes Automatically approve and perform the update after previewing it
3232
```
3333

34-
### Options inherited from parent commands
34+
## Options inherited from parent commands
3535

3636
```
3737
--profile string Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) (default "none")
3838
--profile-output string Name of the file to write the profile to (default "profile.pprof")
3939
```
4040

41-
### SEE ALSO
41+
## SEE ALSO
4242

4343
* [kusion](index.md) - Kusion is the Platform Orchestrator of Internal Developer Platform
4444

4545
Find more information at: https://www.kusionstack.io
4646

47-
###### Auto generated by spf13/cobra on 26-Sep-2024
47+
###### Auto generated by spf13/cobra on 21-Jan-2025

docs/kusion/6-reference/1-commands/kusion-generate.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22

33
Generate and print the resulting Spec resources of target Stack
44

5-
### Synopsis
5+
## Synopsis
66

77
This command generates Spec resources with given values, then write the resulting Spec resources to specific output file or stdout.
88

9-
The nearest parent folder containing a stack.yaml file is loaded from the project in the current directory.
9+
The nearest parent folder containing a stack.yaml file is loaded from the project in the current directory.
1010

1111
```
1212
kusion generate [flags]
1313
```
1414

15-
### Examples
15+
## Examples
1616

1717
```
1818
# Generate and write Spec resources to specific output file
@@ -25,7 +25,7 @@ kusion generate [flags]
2525
kusion generate -D name=test -D age=18
2626
```
2727

28-
### Options
28+
## Options
2929

3030
```
3131
-D, --argument stringArray Specify arguments on the command line
@@ -37,17 +37,17 @@ kusion generate [flags]
3737
--workspace string The name of target workspace to operate in.
3838
```
3939

40-
### Options inherited from parent commands
40+
## Options inherited from parent commands
4141

4242
```
4343
--profile string Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) (default "none")
4444
--profile-output string Name of the file to write the profile to (default "profile.pprof")
4545
```
4646

47-
### SEE ALSO
47+
## SEE ALSO
4848

4949
* [kusion](index.md) - Kusion is the Platform Orchestrator of Internal Developer Platform
5050

5151
Find more information at: https://www.kusionstack.io
5252

53-
###### Auto generated by spf13/cobra on 26-Sep-2024
53+
###### Auto generated by spf13/cobra on 21-Jan-2025

0 commit comments

Comments
 (0)