docs: update kusion references

KusionStack · Sep 26, 2024 · e405c87 · e405c87
1 parent 070f099
commit e405c87
Show file tree

Hide file tree

Showing 36 changed files with 372 additions and 33 deletions.
diff --git a/docs/kusion/6-reference/1-commands/index.md b/docs/kusion/6-reference/1-commands/index.md
@@ -31,8 +31,10 @@ 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 resource](kusion-resource.md)	 - Observe Kusion resource information
 * [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 12-Jun-2024
+###### Auto generated by spf13/cobra on 26-Sep-2024
diff --git a/docs/kusion/6-reference/1-commands/kusion-apply.md b/docs/kusion/6-reference/1-commands/kusion-apply.md
@@ -21,6 +21,9 @@ kusion apply [flags]
   # Apply with specified arguments
   kusion apply -D name=test -D age=18
   
+  # Apply with specifying spec file
+  kusion apply --spec-file spec.yaml
+  
   # Skip interactive approval of preview details before applying
   kusion apply --yes
   
@@ -50,6 +53,7 @@ kusion apply [flags]
       --no-style                no-style sets to RawOutput mode and disables all of styling
   -o, --output string           Specify the output format
       --port-forward int        Forward the specified port from local to service
+      --spec-file string        Specify the spec file path as input, and the spec file must be located in the working directory or its subdirectories
       --timeout int             The timeout duration for kusion apply command, measured in second(s)
       --watch                   After creating/updating/deleting the requested object, watch for changes (default true)
   -w, --workdir string          The work directory to run Kusion CLI.
@@ -67,5 +71,7 @@ kusion apply [flags]
 ### 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 12-Jun-2024
+###### Auto generated by spf13/cobra on 26-Sep-2024
diff --git a/docs/kusion/6-reference/1-commands/kusion-config-get.md b/docs/kusion/6-reference/1-commands/kusion-config-get.md
@@ -34,4 +34,4 @@ kusion config get
 
 * [kusion config](kusion-config.md)	 - Interact with the Kusion config
 
-###### Auto generated by spf13/cobra on 12-Jun-2024
+###### Auto generated by spf13/cobra on 26-Sep-2024
diff --git a/docs/kusion/6-reference/1-commands/kusion-config-list.md b/docs/kusion/6-reference/1-commands/kusion-config-list.md
@@ -34,4 +34,4 @@ kusion config list
 
 * [kusion config](kusion-config.md)	 - Interact with the Kusion config
 
-###### Auto generated by spf13/cobra on 12-Jun-2024
+###### Auto generated by spf13/cobra on 26-Sep-2024
diff --git a/docs/kusion/6-reference/1-commands/kusion-config-set.md b/docs/kusion/6-reference/1-commands/kusion-config-set.md
@@ -37,4 +37,4 @@ kusion config set
 
 * [kusion config](kusion-config.md)	 - Interact with the Kusion config
 
-###### Auto generated by spf13/cobra on 12-Jun-2024
+###### Auto generated by spf13/cobra on 26-Sep-2024
diff --git a/docs/kusion/6-reference/1-commands/kusion-config-unset.md b/docs/kusion/6-reference/1-commands/kusion-config-unset.md
@@ -34,4 +34,4 @@ kusion config unset
 
 * [kusion config](kusion-config.md)	 - Interact with the Kusion config
 
-###### Auto generated by spf13/cobra on 12-Jun-2024
+###### Auto generated by spf13/cobra on 26-Sep-2024
diff --git a/docs/kusion/6-reference/1-commands/kusion-config.md b/docs/kusion/6-reference/1-commands/kusion-config.md
@@ -31,4 +31,4 @@ kusion config [flags]
 * [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 12-Jun-2024
+###### Auto generated by spf13/cobra on 26-Sep-2024
diff --git a/docs/kusion/6-reference/1-commands/kusion-destroy.md b/docs/kusion/6-reference/1-commands/kusion-destroy.md
@@ -41,5 +41,7 @@ kusion destroy [flags]
 ### 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 12-Jun-2024
+###### Auto generated by spf13/cobra on 26-Sep-2024
diff --git a/docs/kusion/6-reference/1-commands/kusion-generate.md b/docs/kusion/6-reference/1-commands/kusion-generate.md
@@ -47,5 +47,7 @@ kusion generate [flags]
 ### 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 12-Jun-2024
+###### Auto generated by spf13/cobra on 26-Sep-2024
diff --git a/docs/kusion/6-reference/1-commands/kusion-init.md b/docs/kusion/6-reference/1-commands/kusion-init.md
@@ -40,5 +40,7 @@ kusion init [flags]
 ### 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 12-Jun-2024
+###### Auto generated by spf13/cobra on 26-Sep-2024
diff --git a/docs/kusion/6-reference/1-commands/kusion-mod-add.md b/docs/kusion/6-reference/1-commands/kusion-mod-add.md
@@ -1,4 +1,4 @@
-## kusion mod add
+# kusion mod add
 
 Add a module from a workspace
 
@@ -36,4 +36,4 @@ kusion mod add MODULE_NAME [--workspace WORKSPACE] [flags]
 
 * [kusion mod](kusion-mod.md)	 - Manage Kusion modules
 
-###### Auto generated by spf13/cobra on 12-Jun-2024
+###### Auto generated by spf13/cobra on 26-Sep-2024
diff --git a/docs/kusion/6-reference/1-commands/kusion-mod-init.md b/docs/kusion/6-reference/1-commands/kusion-mod-init.md
@@ -37,4 +37,4 @@ kusion mod init MODULE_NAME PATH [flags]
 
 * [kusion mod](kusion-mod.md)	 - Manage Kusion modules
 
-###### Auto generated by spf13/cobra on 12-Jun-2024
+###### Auto generated by spf13/cobra on 26-Sep-2024
diff --git a/docs/kusion/6-reference/1-commands/kusion-mod-list.md b/docs/kusion/6-reference/1-commands/kusion-mod-list.md
@@ -1,4 +1,4 @@
-## kusion mod list
+# kusion mod list
 
 List kusion modules in a workspace 
 
@@ -36,4 +36,4 @@ kusion mod list [--workspace WORKSPACE] [flags]
 
 * [kusion mod](kusion-mod.md)	 - Manage Kusion modules
 
-###### Auto generated by spf13/cobra on 12-Jun-2024
+###### Auto generated by spf13/cobra on 26-Sep-2024
diff --git a/docs/kusion/6-reference/1-commands/kusion-mod-push.md b/docs/kusion/6-reference/1-commands/kusion-mod-push.md
@@ -17,7 +17,7 @@ kusion mod push MODULE_PATH OCI_REPOSITORY_URL [--creds CREDENTIALS]
   kusion mod push /path/to/my-module oci://ghcr.io/org --creds <YOUR_TOKEN>
   
   # Push a module of specific OS arch to an OCI Registry using a token
-  kusion mod push /path/to/my-module oci://ghcr.io/org --os-arch==darwin/arm64 --creds <YOUR_TOKEN>
+  kusion mod push /path/to/my-module oci://ghcr.io/org --os-arch=darwin/arm64 --creds <YOUR_TOKEN>
   
   # Push a module to an OCI Registry using a credentials in <YOUR_USERNAME>:<YOUR_TOKEN> format.
   kusion mod push /path/to/my-module oci://ghcr.io/org --creds <YOUR_USERNAME>:<YOUR_TOKEN>
@@ -59,4 +59,4 @@ kusion mod push MODULE_PATH OCI_REPOSITORY_URL [--creds CREDENTIALS]
 
 * [kusion mod](kusion-mod.md)	 - Manage Kusion modules
 
-###### Auto generated by spf13/cobra on 12-Jun-2024
+###### Auto generated by spf13/cobra on 26-Sep-2024
diff --git a/docs/kusion/6-reference/1-commands/kusion-mod.md b/docs/kusion/6-reference/1-commands/kusion-mod.md
@@ -33,5 +33,4 @@ kusion mod
 * [kusion mod list](kusion-mod-list.md)	 - List kusion modules in a workspace 
 * [kusion mod push](kusion-mod-push.md)	 - Push a module to OCI registry
 
-
-###### Auto generated by spf13/cobra on 12-Jun-2024
+###### Auto generated by spf13/cobra on 26-Sep-2024
diff --git a/docs/kusion/6-reference/1-commands/kusion-options.md b/docs/kusion/6-reference/1-commands/kusion-options.md
@@ -34,4 +34,4 @@ kusion options [flags]
 
 * [kusion](index.md)	 - Kusion is the Platform Orchestrator of Internal Developer Platform
 
-###### Auto generated by spf13/cobra on 12-Jun-2024
+###### Auto generated by spf13/cobra on 26-Sep-2024
diff --git a/docs/kusion/6-reference/1-commands/kusion-preview.md b/docs/kusion/6-reference/1-commands/kusion-preview.md
@@ -21,6 +21,9 @@ kusion preview [flags]
   # Preview with specified arguments
   kusion preview -D name=test -D age=18
   
+  # Preview with specifying spec file
+  kusion preview --spec-file spec.yaml
+  
   # Preview with ignored fields
   kusion preview --ignore-fields="metadata.generation,metadata.managedFields"
   
@@ -42,6 +45,7 @@ kusion preview [flags]
       --ignore-fields strings   Ignore differences of target fields
       --no-style                no-style sets to RawOutput mode and disables all of styling
   -o, --output string           Specify the output format
+      --spec-file string        Specify the spec file path as input, and the spec file must be located in the working directory or its subdirectories
   -w, --workdir string          The work directory to run Kusion CLI.
       --workspace string        The name of target workspace to operate in.
 ```
@@ -57,4 +61,4 @@ kusion preview [flags]
 
 * [kusion](index.md)	 - Kusion is the Platform Orchestrator of Internal Developer Platform
 
-###### Auto generated by spf13/cobra on 12-Jun-2024
+###### Auto generated by spf13/cobra on 26-Sep-2024
diff --git a/docs/kusion/6-reference/1-commands/kusion-project-create.md b/docs/kusion/6-reference/1-commands/kusion-project-create.md
@@ -41,4 +41,4 @@ kusion project create
 
 * [kusion project](kusion-project.md)	 - Project is a folder that contains a project.yaml file and is linked to a Git repository
 
-###### Auto generated by spf13/cobra on 12-Jun-2024
+###### Auto generated by spf13/cobra on 26-Sep-2024
diff --git a/docs/kusion/6-reference/1-commands/kusion-project-list.md b/docs/kusion/6-reference/1-commands/kusion-project-list.md
@@ -0,0 +1,51 @@
+# kusion project list
+
+List the applied projects
+
+### Synopsis
+
+This command lists all the applied projects in the target backend and target workspace.
+
+ By default list the projects in the current backend and current workspace.
+
+```
+kusion project list
+```
+
+### Examples
+
+```
+  # List the applied project in the current backend and current workspace
+  kusion project list
+  
+  # List the applied project in a specified backend and current workspace
+  kusion project list --backend default
+  
+  # List the applied project in a specified backend and specified workspaces
+  kusion project list --backend default --workspace dev,default
+
+  # List the applied project in a specified backend and all the workspaces
+  kusion project list --backend default --all
+```
+
+### Options
+
+```
+  -a, --all                 List all the projects in all the workspaces
+      --backend string      The backend to use, supports 'local', 'oss' and 's3'
+  -h, --help                help for list
+      --workspace strings   The name of the target workspace
+```
+
+### 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
+
+* [kusion project](kusion-project.md)	 - Project is a folder that contains a project.yaml file and is linked to a Git repository
+
+###### Auto generated by spf13/cobra on 26-Sep-2024
diff --git a/docs/kusion/6-reference/1-commands/kusion-project.md b/docs/kusion/6-reference/1-commands/kusion-project.md
@@ -29,5 +29,6 @@ kusion project [flags]
 
 * [kusion](index.md)	 - Kusion is the Platform Orchestrator of Internal Developer Platform
 * [kusion project create](kusion-project-create.md)	 - Create a new project
+* [kusion project list](kusion-project-list.md)	 - List the applied projects
 
-###### Auto generated by spf13/cobra on 12-Jun-2024
+###### Auto generated by spf13/cobra on 26-Sep-2024
diff --git a/docs/kusion/6-reference/1-commands/kusion-release-list.md b/docs/kusion/6-reference/1-commands/kusion-release-list.md
@@ -0,0 +1,45 @@
+# kusion release list
+
+List all releases of the current stack
+
+### Synopsis
+
+List all releases of the current stack.
+
+ This command displays information about all releases of the current stack in the current or a specified workspace, including their revision, phase, and creation time.
+
+```
+kusion release list [flags]
+```
+
+### Examples
+
+```
+  # List all releases of the current stack in current workspace
+  kusion release list
+  
+  # List all releases of the current stack in a specified workspace
+  kusion release list --workspace=dev
+```
+
+### Options
+
+```
+      --backend string     The backend to use, supports 'local', 'oss' and 's3'.
+  -h, --help               help for list
+  -w, --workdir string     The work directory to run Kusion CLI.
+      --workspace string   The name of target workspace to operate in.
+```
+
+### 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
+
+* [kusion release](kusion-release.md)	 - Manage Kusion release files
+
+###### Auto generated by spf13/cobra on 26-Sep-2024
diff --git a/docs/kusion/6-reference/1-commands/kusion-release-show.md b/docs/kusion/6-reference/1-commands/kusion-release-show.md
@@ -0,0 +1,56 @@
+# kusion release show
+
+Show details of a release of the current or specified stack
+
+### Synopsis
+
+Show details of a release of the current or specified stack.
+
+ This command displays detailed information about a release of the current project in the current or a specified workspace
+
+```
+kusion release show [flags]
+```
+
+### Examples
+
+```
+  # Show details of the latest release of the current project in the current workspace
+  kusion release show
+  
+  # Show details of a specific release of the current project in the current workspace
+  kusion release show --revision=1
+  
+  # Show details of a specific release of the specified project in the specified workspace
+  kusion release show --revision=1 --project=hoangndst --workspace=dev
+  
+  # Show details of the latest release with specified backend
+  kusion release show --backend=local
+  
+  # Show details of the latest release with specified output format
+  kusion release show --output=json
+```
+
+### Options
+
+```
+      --backend string     The backend to use, supports 'local', 'oss' and 's3'
+  -h, --help               help for show
+  -o, --output string      Specify the output format
+      --project string     The project name
+      --revision uint      The revision number of the release
+      --workspace string   The workspace name
+```
+
+### 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
+
+* [kusion release](kusion-release.md)	 - Manage Kusion release files
+
+###### Auto generated by spf13/cobra on 26-Sep-2024
diff --git a/docs/kusion/6-reference/1-commands/kusion-release-unlock.md b/docs/kusion/6-reference/1-commands/kusion-release-unlock.md
@@ -0,0 +1,47 @@
+# kusion release unlock
+
+Unlock the latest release file of the current stack
+
+### Synopsis
+
+Unlock the latest release file of the current stack.
+
+ The phase of the latest release file of the current stack in the current or a specified workspace will be set to 'failed' if it was in the stages of 'generating', 'previewing', 'applying' or 'destroying'.
+
+ Please note that using the 'kusion release unlock' command may cause unexpected concurrent read-write issues with release files, so please use it with caution.
+
+```
+kusion release unlock [flags]
+```
+
+### Examples
+
+```
+  # Unlock the latest release file of the current stack in the current workspace.
+  kusion release unlock
+  
+  # Unlock the latest release file of the current stack in a specified workspace.
+  kusion release unlock --workspace=dev
+```
+
+### Options
+
+```
+      --backend string     The backend to use, supports 'local', 'oss' and 's3'.
+  -h, --help               help for unlock
+  -w, --workdir string     The work directory to run Kusion CLI.
+      --workspace string   The name of target workspace to operate in.
+```
+
+### 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
+
+* [kusion release](kusion-release.md)	 - Manage Kusion release files
+
+###### Auto generated by spf13/cobra on 26-Sep-2024
Original file line number	Diff line number	Diff line change
Expand Up		@@ -34,4 +34,4 @@ kusion config get

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

		###### Auto generated by spf13/cobra on 12-Jun-2024
		###### Auto generated by spf13/cobra on 26-Sep-2024
Original file line number	Diff line number	Diff line change
Expand Up		@@ -34,4 +34,4 @@ kusion config list

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

		###### Auto generated by spf13/cobra on 12-Jun-2024
		###### Auto generated by spf13/cobra on 26-Sep-2024
Original file line number	Diff line number	Diff line change
Expand Up		@@ -37,4 +37,4 @@ kusion config set

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

		###### Auto generated by spf13/cobra on 12-Jun-2024
		###### Auto generated by spf13/cobra on 26-Sep-2024
Original file line number	Diff line number	Diff line change
Expand Up		@@ -34,4 +34,4 @@ kusion config unset

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

		###### Auto generated by spf13/cobra on 12-Jun-2024
		###### Auto generated by spf13/cobra on 26-Sep-2024
Original file line number	Diff line number	Diff line change
Expand Up		@@ -37,4 +37,4 @@ kusion mod init MODULE_NAME PATH [flags]

		* [kusion mod](kusion-mod.md) - Manage Kusion modules

		###### Auto generated by spf13/cobra on 12-Jun-2024
		###### Auto generated by spf13/cobra on 26-Sep-2024
Original file line number	Diff line number	Diff line change
Expand Up		@@ -34,4 +34,4 @@ kusion options [flags]

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

		###### Auto generated by spf13/cobra on 12-Jun-2024
		###### Auto generated by spf13/cobra on 26-Sep-2024
Original file line number	Diff line number	Diff line change
Expand Up		@@ -41,4 +41,4 @@ kusion project create

		* [kusion project](kusion-project.md) - Project is a folder that contains a project.yaml file and is linked to a Git repository

		###### Auto generated by spf13/cobra on 12-Jun-2024
		###### Auto generated by spf13/cobra on 26-Sep-2024