Skip to content

Commit

Permalink
update installation guide (KusionStack#199)
Browse files Browse the repository at this point in the history
  • Loading branch information
@howieyuen
howieyuen authored Jan 9, 2023
1 parent 870d636 commit 5833cb8
Show file tree
Hide file tree
Showing 3 changed files with 65 additions and 252 deletions.
49 changes: 47 additions & 2 deletions docs/reference/cli/kusionup/index.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Kusionup Tools

[Kusionup](https://github.com/KusionStack/kusionup) is a version management tool for kusion and KCL. It is heavily inspired by `goup`.
[Kusionup](https://github.com/KusionStack/kusionup) is a multi-version management tool for Kusion and KCL. It is heavily inspired by [goup](https://github.com/owenthereal/goup).

After `kusionup init` is finished, a `$HOME/.kusionup` directory will be created, and contains these files:

Expand All @@ -9,6 +12,48 @@ After `kusionup init` is finished, a `$HOME/.kusionup` directory will be created
- `$HOME/.kusionup/current` is a soft link to the currently active `kusion` tools
- `$HOME/.kusionup/$VERSION` are directories of different versions of `kusion` tools. For example, the latest version will be installed by default to the `$HOME/.kusionup/latest` directory

## Installation

```mdx-code-block
<Tabs>
<TabItem value="MacOS" >
```

```bash
brew install KusionStack/tap/kusionup
```

```mdx-code-block
</TabItem>
<TabItem value="Linux">
```

```bash
curl -sSf https://raw.githubusercontent.com/KusionStack/kusionup/main/scripts/install.sh | bash
```

```mdx-code-block
</TabItem>
<TabItem value="Go Install">
```

```bash
go install github.com/KusionStack/kusionup@latest
```

```mdx-code-block
</TabItem>
</Tabs>
```

## Initialization

After `kusionup` is installed, execute the one-click initialization command to complete the installation of the latest version of Kusion and the supporting KCL:

```bash
kusionup init --skip-prompt && source $HOME/.kusionup/env
```

## Install the specified version

The command `kusionup init --skip-prompt` will install the latest version of `kusion` and the supporting KCL.
Expand Down Expand Up @@ -76,7 +121,7 @@ INFO[0061] Success: latest downloaded in /root/.kusionup/kusion@latest
INFO[0061] Default Kusion is set to 'latest'
```

Run `kusionup show` to check of all the installed versions and spot the active version:
Run `kusionup show` to check all the installed versions and spot the active version:

```bash
kusionup show
Expand Down
136 changes: 10 additions & 126 deletions docs/user_docs/getting-started/install.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,68 +13,27 @@ KusionStack consists of "three major pieces", namely:
- Konfig: Konfig is the mono repository of the infra configuration in KCL.

The first two are binary tools that need to be downloaded and installed, and the third is a Git repository.
For binary tools, KusionStack provides two installation methods: one-click installation and manual installation.
The one-click installation implements multi-version management through the `kusionup` tool.
For binary tools, KusionStack provides a one-click installation for everybody.

## One-click installation

Firstly, install `kusionup`, you can choose different installation methods according to different operating systems and working environments.

### Install Kusionup
The preferred method for installing on Mac and Linux is to use the brew package manager.
You can also run `go install` if your environment is available for golang.

```mdx-code-block
<Tabs>
<TabItem value="MacOS" >
<TabItem value="MacOS&Linux" >
```

```bash
brew install KusionStack/tap/kusionup
```

```mdx-code-block
</TabItem>
<TabItem value="Linux">
```

```bash
curl -sSf https://raw.githubusercontent.com/KusionStack/kusionup/main/scripts/install.sh | bash
brew install KusionStack/tap/kusion
```

```mdx-code-block
</TabItem>
<TabItem value="Go Install">
```

```bash
go install github.com/KusionStack/kusionup@latest
```

```mdx-code-block
</TabItem>
</Tabs>
```

### Initialization

After `kusionup` is installed, execute the one-click initialization command to complete the installation of the latest version of kusion and the supporting KCL:

```bash
kusionup init --skip-prompt && source $HOME/.kusionup/env
```

:::info
More details of kusionup, please refer to [Kusionup Tools](/docs/reference/cli/kusionup/).
:::

## Manual Installation

### Install Kusion

```mdx-code-block
<Tabs>
<TabItem value="Go Install" >
```

```bash
go install github.com/KusionStack/kusion@latest
```
Expand All @@ -84,86 +43,11 @@ go install github.com/KusionStack/kusion@latest
</Tabs>
```

### Install KCL

```mdx-code-block
<Tabs>
<TabItem value="MacOS" >
```

```bash
curl -fsSL https://kcl-lang.io/script/install.sh | /bin/bash
```

```mdx-code-block
</TabItem>
<TabItem value="Linux">
```

```bash
wget -q https://kcl-lang.io/script/install.sh -O - | /bin/bash
```

```mdx-code-block
</TabItem>
<TabItem value="Windows">
```

```bash
powershell -Command "iwr -useb https://kcl-lang.io/script/install.ps1 | iex"
```

```mdx-code-block
</TabItem>
<TabItem value="Go Install">
```

```bash
go install kusionstack.io/kclvm-go/cmds/kcl-go@main && alias kcl='kcl-go kcl'
```

```mdx-code-block
</TabItem>
</Tabs>
```
KCL is embedded in Kusion, so you don't need to install it again. If you are interested in other versions of KCL, please refer to [KCL Installation](https://kcl-lang.io/docs/user_docs/getting-started/install/).

:::info
More details of KCL installation, please refer to [KCL Installation](https://kcl-lang.io/docs/user_docs/getting-started/install/).
:::tip
If you need a multi-version management tool for Kusion and KCL, please refer to [Kusionup Tools](/docs/reference/cli/kusionup/).
:::

### Set Environment Variables

```mdx-code-block
<Tabs>
<TabItem value=".zshrc" >
```

```bash
mkdir -p $HOME/.kusionup/current
cat > ~/.zshrc <<EOF
export KUSION_PATH=$HOME/.kusionup/current
EOF
source ~/.zshrc
```

```mdx-code-block
</TabItem>
<TabItem value=".bash_profile">
```

```bash
mkdir -p $HOME/.kusionup/current
cat > ~/.bash_profile <<EOF
export KUSION_PATH=$HOME/.kusionup/current
EOF
source ~/.bash_profile
```

```mdx-code-block
</TabItem>
</Tabs>
```

## No Installation

If the upper installation doesn't support your environment, you can use the docker image of Kusion instead. First, prepare the [Docker](https://www.docker.com/) service and start it. Then use the `docker pull` command to get an available Kusion image.
Expand All @@ -172,8 +56,8 @@ If the upper installation doesn't support your environment, you can use the dock
docker pull kusionstack/kusion:latest
```

:::info
KusionStack image: https://hub.docker.com/r/kusionstack/kusion
:::tip
Kusion image repository: https://hub.docker.com/r/kusionstack/kusion
:::

Next, run Kusion in an interactive mode:
Expand Down
Loading

0 comments on commit 5833cb8

Please sign in to comment.