From e405c875e91f43601d4abc0044f124d3c965d7cd Mon Sep 17 00:00:00 2001 From: liuhaoming Date: Thu, 26 Sep 2024 18:01:03 +0800 Subject: [PATCH] docs: update kusion references --- docs/kusion/6-reference/1-commands/index.md | 4 +- .../6-reference/1-commands/kusion-apply.md | 8 ++- .../1-commands/kusion-config-get.md | 2 +- .../1-commands/kusion-config-list.md | 2 +- .../1-commands/kusion-config-set.md | 2 +- .../1-commands/kusion-config-unset.md | 2 +- .../6-reference/1-commands/kusion-config.md | 2 +- .../6-reference/1-commands/kusion-destroy.md | 4 +- .../6-reference/1-commands/kusion-generate.md | 4 +- .../6-reference/1-commands/kusion-init.md | 4 +- .../6-reference/1-commands/kusion-mod-add.md | 4 +- .../6-reference/1-commands/kusion-mod-init.md | 2 +- .../6-reference/1-commands/kusion-mod-list.md | 4 +- .../6-reference/1-commands/kusion-mod-push.md | 4 +- .../6-reference/1-commands/kusion-mod.md | 3 +- .../6-reference/1-commands/kusion-options.md | 2 +- .../6-reference/1-commands/kusion-preview.md | 6 +- .../1-commands/kusion-project-create.md | 2 +- .../1-commands/kusion-project-list.md | 51 +++++++++++++++++ .../6-reference/1-commands/kusion-project.md | 3 +- .../1-commands/kusion-release-list.md | 45 +++++++++++++++ .../1-commands/kusion-release-show.md | 56 +++++++++++++++++++ .../1-commands/kusion-release-unlock.md | 47 ++++++++++++++++ .../6-reference/1-commands/kusion-release.md | 35 ++++++++++++ .../1-commands/kusion-resource-graph.md | 54 ++++++++++++++++++ .../6-reference/1-commands/kusion-resource.md | 33 +++++++++++ .../1-commands/kusion-stack-create.md | 2 +- .../6-reference/1-commands/kusion-stack.md | 2 +- .../6-reference/1-commands/kusion-version.md | 2 +- .../1-commands/kusion-workspace-create.md | 2 +- .../1-commands/kusion-workspace-delete.md | 2 +- .../1-commands/kusion-workspace-list.md | 2 +- .../1-commands/kusion-workspace-show.md | 2 +- .../1-commands/kusion-workspace-switch.md | 2 +- .../1-commands/kusion-workspace-update.md | 2 +- .../1-commands/kusion-workspace.md | 2 +- 36 files changed, 372 insertions(+), 33 deletions(-) create mode 100644 docs/kusion/6-reference/1-commands/kusion-project-list.md create mode 100644 docs/kusion/6-reference/1-commands/kusion-release-list.md create mode 100644 docs/kusion/6-reference/1-commands/kusion-release-show.md create mode 100644 docs/kusion/6-reference/1-commands/kusion-release-unlock.md create mode 100644 docs/kusion/6-reference/1-commands/kusion-release.md create mode 100644 docs/kusion/6-reference/1-commands/kusion-resource-graph.md create mode 100644 docs/kusion/6-reference/1-commands/kusion-resource.md diff --git a/docs/kusion/6-reference/1-commands/index.md b/docs/kusion/6-reference/1-commands/index.md index 55ecc938..dd782a3e 100644 --- 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 index 57442b29..032fe3dc 100644 --- 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 index 5116ceda..4d50b615 100644 --- 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 index 39e1ad34..95d9620c 100644 --- 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 index 886a170c..cf3d3213 100644 --- 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 index c39f90b9..538668fe 100644 --- 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 index 70670944..e8264ee8 100644 --- 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 index 87a3d2e6..6881a3ce 100644 --- 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 index 04c8f122..3514b3ee 100644 --- 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 index 2fa87051..2d24082f 100644 --- 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 index 65d76d73..a0530340 100644 --- 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 index 6abca2bb..c94b9653 100644 --- 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 index 7803b990..0ea4e426 100644 --- 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 index 0649dc36..2f0d0a72 100644 --- 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 # 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 + kusion mod push /path/to/my-module oci://ghcr.io/org --os-arch=darwin/arm64 --creds # Push a module to an OCI Registry using a credentials in : format. kusion mod push /path/to/my-module oci://ghcr.io/org --creds : @@ -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 index d623a334..4ba93969 100644 --- 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 index 56b47123..d7fbc13d 100644 --- 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 index 43d24428..61103f19 100644 --- 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 index 5df9006c..5f914717 100644 --- 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 new file mode 100644 index 00000000..c42f05e4 --- /dev/null +++ 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 index 3da7737c..6866aedf 100644 --- 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 new file mode 100644 index 00000000..36aafa28 --- /dev/null +++ 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 new file mode 100644 index 00000000..b5773b68 --- /dev/null +++ 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 new file mode 100644 index 00000000..471fbafc --- /dev/null +++ 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 diff --git a/docs/kusion/6-reference/1-commands/kusion-release.md b/docs/kusion/6-reference/1-commands/kusion-release.md new file mode 100644 index 00000000..47557d34 --- /dev/null +++ b/docs/kusion/6-reference/1-commands/kusion-release.md @@ -0,0 +1,35 @@ +# kusion release + +Manage Kusion release files + +### Synopsis + +Commands for managing Kusion release files. + + These commands help you manage the lifecycle of Kusion release files. + +``` +kusion release +``` + +### Options + +``` + -h, --help help for release +``` + +### 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](index.md) - Kusion is the Platform Orchestrator of Internal Developer Platform +* [kusion release list](kusion-release-list.md) - List all releases of the current stack +* [kusion release show](kusion-release-show.md) - Show details of a release of the current or specified stack +* [kusion release unlock](kusion-release-unlock.md) - Unlock the latest release file of the current stack + +###### Auto generated by spf13/cobra on 26-Sep-2024 diff --git a/docs/kusion/6-reference/1-commands/kusion-resource-graph.md b/docs/kusion/6-reference/1-commands/kusion-resource-graph.md new file mode 100644 index 00000000..d222e3c9 --- /dev/null +++ b/docs/kusion/6-reference/1-commands/kusion-resource-graph.md @@ -0,0 +1,54 @@ +# kusion resource graph + +Display a graph of all the resources' information of the target project and target workspaces + +### Synopsis + +Display information of all the resources of a project. + + This command displays information of all the resources of a project in the current or specified workspaces. + +``` +kusion resource graph [flags] +``` + +### Examples + +``` + # Display information of all the resources of a project in the current workspace. + kusion resource graph --project quickstart + + # Display information of all the resources of a project in specified workspaces. + kusion resource graph --project quickstart --workspace=dev,default + + # Display information of all the resource of a project in all the workspaces that has been deployed. + kusion resource graph --project quickstart --all + kusion resource graph --project quickstart -a + + # Display information of all the resource of a project with in specified workspaces with json format result. + kusion resource graph --project quickstart --workspace dev -o json +``` + +### Options + +``` + -a, --all Display all the resources of all the workspaces + --backend string The backend to use, supports 'local', 'oss' and 's3' + -h, --help help for graph + -o, --output string Specify the output format, json only + --project string The name of the target project + --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 resource](kusion-resource.md) - Observe Kusion resource information + +###### Auto generated by spf13/cobra on 26-Sep-2024 diff --git a/docs/kusion/6-reference/1-commands/kusion-resource.md b/docs/kusion/6-reference/1-commands/kusion-resource.md new file mode 100644 index 00000000..9ac6ba50 --- /dev/null +++ b/docs/kusion/6-reference/1-commands/kusion-resource.md @@ -0,0 +1,33 @@ +# kusion resource + +Observe Kusion resource information + +### Synopsis + +Commands for observing Kusion resources. + + These commands help you observe the information of Kusion resources within a project. + +``` +kusion resource +``` + +### Options + +``` + -h, --help help for resource +``` + +### 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](index.md) - Kusion is the Platform Orchestrator of Internal Developer Platform +* [kusion resource graph](kusion-resource-graph.md) - Display a graph of all the resources' information of the target project and target workspaces + +###### Auto generated by spf13/cobra on 26-Sep-2024 diff --git a/docs/kusion/6-reference/1-commands/kusion-stack-create.md b/docs/kusion/6-reference/1-commands/kusion-stack-create.md index 934e3815..ec0d0fef 100644 --- a/docs/kusion/6-reference/1-commands/kusion-stack-create.md +++ b/docs/kusion/6-reference/1-commands/kusion-stack-create.md @@ -46,4 +46,4 @@ kusion stack create * [kusion stack](kusion-stack.md) - Stack is a folder that contains a stack.yaml file within the corresponding project directory -###### 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-stack.md b/docs/kusion/6-reference/1-commands/kusion-stack.md index edc6d2bf..41fcbef2 100644 --- a/docs/kusion/6-reference/1-commands/kusion-stack.md +++ b/docs/kusion/6-reference/1-commands/kusion-stack.md @@ -30,4 +30,4 @@ kusion stack [flags] * [kusion](index.md) - Kusion is the Platform Orchestrator of Internal Developer Platform * [kusion stack create](kusion-stack-create.md) - Create a new stack -###### 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-version.md b/docs/kusion/6-reference/1-commands/kusion-version.md index 8a5aff3e..d2011a26 100644 --- a/docs/kusion/6-reference/1-commands/kusion-version.md +++ b/docs/kusion/6-reference/1-commands/kusion-version.md @@ -35,4 +35,4 @@ kusion version [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-workspace-create.md b/docs/kusion/6-reference/1-commands/kusion-workspace-create.md index e4ddf333..473570e5 100644 --- a/docs/kusion/6-reference/1-commands/kusion-workspace-create.md +++ b/docs/kusion/6-reference/1-commands/kusion-workspace-create.md @@ -43,4 +43,4 @@ kusion workspace create * [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-workspace-delete.md b/docs/kusion/6-reference/1-commands/kusion-workspace-delete.md index 933e008f..a465fe4a 100644 --- a/docs/kusion/6-reference/1-commands/kusion-workspace-delete.md +++ b/docs/kusion/6-reference/1-commands/kusion-workspace-delete.md @@ -41,4 +41,4 @@ kusion workspace delete * [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-workspace-list.md b/docs/kusion/6-reference/1-commands/kusion-workspace-list.md index 202bd49d..97787e16 100644 --- a/docs/kusion/6-reference/1-commands/kusion-workspace-list.md +++ b/docs/kusion/6-reference/1-commands/kusion-workspace-list.md @@ -38,4 +38,4 @@ kusion workspace list * [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-workspace-show.md b/docs/kusion/6-reference/1-commands/kusion-workspace-show.md index dc558f4f..dab0bcbd 100644 --- a/docs/kusion/6-reference/1-commands/kusion-workspace-show.md +++ b/docs/kusion/6-reference/1-commands/kusion-workspace-show.md @@ -41,4 +41,4 @@ kusion workspace show * [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-workspace-switch.md b/docs/kusion/6-reference/1-commands/kusion-workspace-switch.md index 376c69d2..111127a4 100644 --- a/docs/kusion/6-reference/1-commands/kusion-workspace-switch.md +++ b/docs/kusion/6-reference/1-commands/kusion-workspace-switch.md @@ -38,4 +38,4 @@ kusion workspace switch * [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-workspace-update.md b/docs/kusion/6-reference/1-commands/kusion-workspace-update.md index 1c404664..f868cc86 100644 --- a/docs/kusion/6-reference/1-commands/kusion-workspace-update.md +++ b/docs/kusion/6-reference/1-commands/kusion-workspace-update.md @@ -43,4 +43,4 @@ kusion workspace update * [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-workspace.md b/docs/kusion/6-reference/1-commands/kusion-workspace.md index 8a84d511..a3eba89d 100644 --- a/docs/kusion/6-reference/1-commands/kusion-workspace.md +++ b/docs/kusion/6-reference/1-commands/kusion-workspace.md @@ -35,4 +35,4 @@ kusion workspace [flags] * [kusion workspace switch](kusion-workspace-switch.md) - Switch the current workspace * [kusion workspace update](kusion-workspace-update.md) - Update a workspace configuration -###### Auto generated by spf13/cobra on 12-Jun-2024 +###### Auto generated by spf13/cobra on 26-Sep-2024