Skip to content

Commit 431fe18

Browse files
authored
docs: update kusion server helm installation doc (#594)
1 parent b6d1be7 commit 431fe18

File tree

2 files changed

+36
-22
lines changed
  • docs_versioned_docs/version-v0.14/2-getting-started/3-getting-started-with-kusion-server
  • docs/kusion/2-getting-started/3-getting-started-with-kusion-server

2 files changed

+36
-22
lines changed

docs/kusion/2-getting-started/3-getting-started-with-kusion-server/0-installation.md

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,19 @@ The following tutorial will guide you to install Kusion using Helm, which will i
1515

1616
### Installation Options
1717

18-
> Note: A valid kubeconfig configuration is required for Kusion to function properly. You must either use the installation script, provide your own kubeconfig in values.yaml, or set it through the --set parameter
18+
> **Important:** Kusion requires a valid kubeconfig configuration to function properly. You can provide it via:
19+
> - Installation script (recommended)
20+
> - Custom values.yaml file
21+
> - Helm --set parameter
22+
23+
> **Note:** Default kubeconfig path is `/var/run/secrets/kubernetes.io/kubeconfigs/`
24+
> To use a different path, set `kubeconfig.kubeConfigVolumeMountPath` to your desired path.
1925
2026
You have several options to install Kusion:
2127

2228
#### 1. Using the installation script (recommended)
2329

24-
Download the installation script from the [KusionStack charts repository](https://github.com/KusionStack/charts/blob/master/scripts/install-kusion.sh)
30+
Download the [installation script](https://github.com/KusionStack/charts/blob/master/scripts/install-kusion.sh) from the KusionStack charts repository.
2531

2632
```shell
2733
curl -O https://raw.githubusercontent.com/KusionStack/charts/master/scripts/install-kusion.sh
@@ -53,21 +59,22 @@ Then install with your encoded kubeconfig:
5359

5460
```shell
5561
# Base64 encode your kubeconfig files
56-
KUBECONFIG_CONTENT1=$(base64 -w 0 /path/to/your/kubeconfig1)
57-
KUBECONFIG_CONTENT2=$(base64 -w 0 /path/to/your/kubeconfig2)
62+
KUBECONFIG_CONTENT0=$(cat /path/to/your/kubeconfig-0 | base64 | tr -d '\n')
63+
KUBECONFIG_CONTENT1=$(cat /path/to/your/kubeconfig-1 | base64 | tr -d '\n')
5864

59-
# Install with kubeconfig and optional configurations
65+
# Install with kubeconfig
6066
helm install kusion-release kusionstack/kusion \
61-
--set kubeconfig.kubeConfigs.kubeconfig0="$KUBECONFIG_CONTENT1" \
62-
--set kubeconfig.kubeConfigs.kubeconfig1="$KUBECONFIG_CONTENT2"
67+
--set kubeconfig.kubeConfigs.kubeconfig-0="$KUBECONFIG_CONTENT0" \
68+
--set kubeconfig.kubeConfigs.kubeconfig-1="$KUBECONFIG_CONTENT1"
6369
```
6470

6571
You may have to set your specific configurations if it is deployed into a production cluster, or you want to customize the chart configuration, such as `database`, `replicas`, `port` etc.
6672

6773
```shell
74+
# Install with kubeconfig and optional configurations
6875
helm install kusion-release kusionstack/kusion \
69-
--set kubeconfig.kubeConfigs.kubeconfig0="$KUBECONFIG_CONTENT1" \
70-
--set kubeconfig.kubeConfigs.kubeconfig1="$KUBECONFIG_CONTENT2" \
76+
--set kubeconfig.kubeConfigs.kubeconfig-0="$KUBECONFIG_CONTENT0" \
77+
--set kubeconfig.kubeConfigs.kubeconfig-1="$KUBECONFIG_CONTENT1" \
7178
--set server.port=8080 \
7279
--set server.replicas=3 \
7380
--set mysql.enabled=true \
@@ -215,8 +222,8 @@ The KubeConfig is used to store the KubeConfig files for the Kusion Server.
215222
```yaml
216223
# Example structure:
217224
kubeConfigs:
218-
kubeconfig0: |
225+
kubeconfig-0: |
219226
Please fill in your KubeConfig contents here.
220-
kubeconfig1: |
227+
kubeconfig-1: |
221228
Please fill in your KubeConfig contents here.
222229
```

docs_versioned_docs/version-v0.14/2-getting-started/3-getting-started-with-kusion-server/0-installation.md

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,19 @@ The following tutorial will guide you to install Kusion using Helm, which will i
1515

1616
### Installation Options
1717

18-
> Note: A valid kubeconfig configuration is required for Kusion to function properly. You must either use the installation script, provide your own kubeconfig in values.yaml, or set it through the --set parameter
18+
> **Important:** Kusion requires a valid kubeconfig configuration to function properly. You can provide it via:
19+
> - Installation script (recommended)
20+
> - Custom values.yaml file
21+
> - Helm --set parameter
22+
23+
> **Note:** Default kubeconfig path is `/var/run/secrets/kubernetes.io/kubeconfigs/`
24+
> To use a different path, set `kubeconfig.kubeConfigVolumeMountPath` to your desired path.
1925
2026
You have several options to install Kusion:
2127

2228
#### 1. Using the installation script (recommended)
2329

24-
Download the installation script from the [KusionStack charts repository](https://github.com/KusionStack/charts/blob/master/scripts/install-kusion.sh)
30+
Download the [installation script](https://github.com/KusionStack/charts/blob/master/scripts/install-kusion.sh) from the KusionStack charts repository.
2531

2632
```shell
2733
curl -O https://raw.githubusercontent.com/KusionStack/charts/master/scripts/install-kusion.sh
@@ -53,21 +59,22 @@ Then install with your encoded kubeconfig:
5359

5460
```shell
5561
# Base64 encode your kubeconfig files
56-
KUBECONFIG_CONTENT1=$(base64 -w 0 /path/to/your/kubeconfig1)
57-
KUBECONFIG_CONTENT2=$(base64 -w 0 /path/to/your/kubeconfig2)
62+
KUBECONFIG_CONTENT0=$(cat /path/to/your/kubeconfig-0 | base64 | tr -d '\n')
63+
KUBECONFIG_CONTENT1=$(cat /path/to/your/kubeconfig-1 | base64 | tr -d '\n')
5864

59-
# Install with kubeconfig and optional configurations
65+
# Install with kubeconfig
6066
helm install kusion-release kusionstack/kusion \
61-
--set kubeconfig.kubeConfigs.kubeconfig0="$KUBECONFIG_CONTENT1" \
62-
--set kubeconfig.kubeConfigs.kubeconfig1="$KUBECONFIG_CONTENT2"
67+
--set kubeconfig.kubeConfigs.kubeconfig-0="$KUBECONFIG_CONTENT0" \
68+
--set kubeconfig.kubeConfigs.kubeconfig-1="$KUBECONFIG_CONTENT1"
6369
```
6470

6571
You may have to set your specific configurations if it is deployed into a production cluster, or you want to customize the chart configuration, such as `database`, `replicas`, `port` etc.
6672

6773
```shell
74+
# Install with kubeconfig and optional configurations
6875
helm install kusion-release kusionstack/kusion \
69-
--set kubeconfig.kubeConfigs.kubeconfig0="$KUBECONFIG_CONTENT1" \
70-
--set kubeconfig.kubeConfigs.kubeconfig1="$KUBECONFIG_CONTENT2" \
76+
--set kubeconfig.kubeConfigs.kubeconfig-0="$KUBECONFIG_CONTENT0" \
77+
--set kubeconfig.kubeConfigs.kubeconfig-1="$KUBECONFIG_CONTENT1" \
7178
--set server.port=8080 \
7279
--set server.replicas=3 \
7380
--set mysql.enabled=true \
@@ -215,8 +222,8 @@ The KubeConfig is used to store the KubeConfig files for the Kusion Server.
215222
```yaml
216223
# Example structure:
217224
kubeConfigs:
218-
kubeconfig0: |
225+
kubeconfig-0: |
219226
Please fill in your KubeConfig contents here.
220-
kubeconfig1: |
227+
kubeconfig-1: |
221228
Please fill in your KubeConfig contents here.
222229
```

0 commit comments

Comments
 (0)