Skip to content

Commit

Permalink
feat: update reference docs for kusion (#589)
Browse files Browse the repository at this point in the history
  • Loading branch information
liu-hm19 authored Jan 21, 2025
1 parent 7be921a commit 01a91b7
Show file tree
Hide file tree
Showing 42 changed files with 546 additions and 225 deletions.
11 changes: 6 additions & 5 deletions docs/kusion/6-reference/1-commands/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,23 @@ Kusion is the Platform Orchestrator of Internal Developer Platform

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

### Synopsis
## Synopsis

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.

```
kusion [flags]
```

### Options
## Options

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

### SEE ALSO
## SEE ALSO

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

###### Auto generated by spf13/cobra on 26-Sep-2024
###### Auto generated by spf13/cobra on 21-Jan-2025
12 changes: 6 additions & 6 deletions docs/kusion/6-reference/1-commands/kusion-apply.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Apply the operational intent of various resources to multiple runtimes

### Synopsis
## Synopsis

Apply a series of resource changes within the stack.

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

### Examples
## Examples

```
# Apply with specified work directory
Expand Down Expand Up @@ -40,7 +40,7 @@ kusion apply [flags]
kusion apply --port-forward=8080
```

### Options
## Options

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

### Options inherited from parent commands
## Options inherited from parent commands

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

### SEE ALSO
## SEE ALSO

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

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

###### Auto generated by spf13/cobra on 26-Sep-2024
###### Auto generated by spf13/cobra on 21-Jan-2025
12 changes: 6 additions & 6 deletions docs/kusion/6-reference/1-commands/kusion-config-get.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,36 +2,36 @@

Get a config item

### Synopsis
## Synopsis

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

```
kusion config get
```

### Examples
## Examples

```
# Get a config item
kusion config get backends.current
```

### Options
## Options

```
-h, --help help for get
```

### Options inherited from parent commands
## Options inherited from parent commands

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

### SEE ALSO
## SEE ALSO

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

###### Auto generated by spf13/cobra on 26-Sep-2024
###### Auto generated by spf13/cobra on 21-Jan-2025
12 changes: 6 additions & 6 deletions docs/kusion/6-reference/1-commands/kusion-config-list.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,36 +2,36 @@

List all config items

### Synopsis
## Synopsis

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

```
kusion config list
```

### Examples
## Examples

```
# List config items
kusion config list
```

### Options
## Options

```
-h, --help help for list
```

### Options inherited from parent commands
## Options inherited from parent commands

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

### SEE ALSO
## SEE ALSO

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

###### Auto generated by spf13/cobra on 26-Sep-2024
###### Auto generated by spf13/cobra on 21-Jan-2025
12 changes: 6 additions & 6 deletions docs/kusion/6-reference/1-commands/kusion-config-set.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

Set a config item

### Synopsis
## Synopsis

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.

```
kusion config set
```

### Examples
## Examples

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

### Options
## Options

```
-h, --help help for set
```

### Options inherited from parent commands
## Options inherited from parent commands

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

### SEE ALSO
## SEE ALSO

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

###### Auto generated by spf13/cobra on 26-Sep-2024
###### Auto generated by spf13/cobra on 21-Jan-2025
12 changes: 6 additions & 6 deletions docs/kusion/6-reference/1-commands/kusion-config-unset.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,36 +2,36 @@

Unset a config item

### Synopsis
## Synopsis

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

```
kusion config unset
```

### Examples
## Examples

```
# Unset a config item
kusion config unset backends.s3-pre.configs.bucket
```

### Options
## Options

```
-h, --help help for unset
```

### Options inherited from parent commands
## Options inherited from parent commands

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

### SEE ALSO
## SEE ALSO

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

###### Auto generated by spf13/cobra on 26-Sep-2024
###### Auto generated by spf13/cobra on 21-Jan-2025
9 changes: 5 additions & 4 deletions docs/kusion/6-reference/1-commands/kusion-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,21 @@

Interact with the Kusion config

### Synopsis
## Synopsis

Config contains the operation of Kusion configurations.

```
kusion config [flags]
```

### Options
## Options

```
-h, --help help for config
```

### Options inherited from parent commands
## Options inherited from parent commands

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

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

* [kusion config get](kusion-config-get.md) - Get a config item
* [kusion config list](kusion-config-list.md) - List all config items
* [kusion config set](kusion-config-set.md) - Set a config item
* [kusion config unset](kusion-config-unset.md) - Unset a config item

###### Auto generated by spf13/cobra on 26-Sep-2024
###### Auto generated by spf13/cobra on 21-Jan-2025
12 changes: 6 additions & 6 deletions docs/kusion/6-reference/1-commands/kusion-destroy.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Destroy resources within the stack.

### Synopsis
## Synopsis

Destroy resources within the stack.

Expand All @@ -12,14 +12,14 @@ Destroy resources within the stack.
kusion destroy [flags]
```

### Examples
## Examples

```
# Delete resources of current stack
kusion destroy
```

### Options
## Options

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

### Options inherited from parent commands
## Options inherited from parent commands

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

### SEE ALSO
## SEE ALSO

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

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

###### Auto generated by spf13/cobra on 26-Sep-2024
###### Auto generated by spf13/cobra on 21-Jan-2025
14 changes: 7 additions & 7 deletions docs/kusion/6-reference/1-commands/kusion-generate.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@

Generate and print the resulting Spec resources of target Stack

### Synopsis
## Synopsis

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

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

```
kusion generate [flags]
```

### Examples
## Examples

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

### Options
## Options

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

### Options inherited from parent commands
## Options inherited from parent commands

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

### SEE ALSO
## SEE ALSO

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

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

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

0 comments on commit 01a91b7

Please sign in to comment.