kubevela
/
kubevela.github.io
mirror of https://github.com/kubevela/kubevela.github.io.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Rewrite installation doc for more detailed guide (#958)

This commit is contained in:
qiaozp 2022-09-14 16:55:33 +08:00 committed by GitHub
parent c170dc4124
commit 7b08696eaa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
25 changed files with 2487 additions and 1216 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/end-user/quick-start-cli.md
View File

@ -6,7 +6,7 @@ Welcome to KubeVela! In this guide, we'll walk you through how to install KubeVe
## Installation
Make sure you have finished and verified KubeVela installation following [this guide](../install.mdx).
Make sure you have finished and verified KubeVela installation following [this guide](../install).
## A Simple Application

168
docs/install.mdx
View File

@ -1,154 +1,24 @@
---
title: Installation
title: Installation Overview
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
Here are two installation methods available according to your environment:
- For Installation from existing Kubernetes Cluster, please read the [advanced installation guide](./platform-engineers/advanced-install#install-kubevela-with-existing-kubernetes-cluster).
### Don't have Kubernetes cluster yet?
For those who are new to KubeVela and Kubernetes, installing KubeVela in standalone mode is the best choice. It doesn't require you to have any Kubernetes knowledge to experience KubeVela features.
We developed [VelaD](https://github.com/kubevela/velad) for this purpose, which packages KubeVela along its dependencies including Kubernetes into a single binary.
Please follow the document linked below to install KubeVela.
- [Standalone Installation](./installation/standalone): Install KubeVela on a local machine or a remote server(Public Cloud or On-premise) based on Linux, macOS or Windows operating system.
:::info
VelaD suits great for local development and quick demos, it leverages [K3s](https://github.com/k3s-io/k3s) to manage Kubernetes. We strongly recommend you to [install KubeVela with managed Kubernetes services](./installation/kubernetes) for production usage.
:::
### Already have Kubernetes cluster
- [Kubernetes Cluster](./installation/kubernetes): Install KubeVela in existing Kubernetes cluster.
:::tip
- For upgrading from existing KubeVela control plane, please read the [upgrade guide](./platform-engineers/advanced-install#upgrade).
## 1. Install VelaD
[VelaD](https://github.com/kubevela/velad) packages KubeVela with all dependencies that enables you to run KubeVela on any of docker compatible environments or linux system.
- VelaD provides Kubernetes by leveraging [K3s](https://rancher.com/docs/k3s/latest/en/quick-start/) on linux or [k3d](https://k3d.io/) on docker environment.
- KubeVela along with all related images, and `vela` command line are packaged together that enables air-gapped installation.
- **VelaD suits great for local development and quick demos, while we strongly recommend you to [install KubeVela with managed Kubernetes services](./platform-engineers/advanced-install#install-kubevela-with-existing-kubernetes-cluster) for production usage**.
### Prerequisites
- Docker v20.10.5+ (runc >= v1.0.0-rc93) **or** Linux system
### Download VelaD
It will download and place the binary in your system `PATH`,
so you may be required for root privilege during the installation process.
If you don't need the automation with root access, you can download from the [release page](https://github.com/kubevela/velad/releases) and uncompress manually.
- ** MacOS/Linux **
```shell
curl -fsSl https://static.kubevela.net/script/install-velad.sh | bash
```
- **Windows**
> Only the official release version is supported.
Run following command in powershell:
```shell
powershell -Command "iwr -useb https://static.kubevela.net/script/install-velad.ps1 | iex"
```
Check `velad` and `vela` command line tools are exist in `/usr/local/bin/` for MacOS/Linux or `C:\vela\` for Windows.
### Setup
```shell
velad install
```
<details>
<summary>expected output</summary>
```
Preparing K3s images...
Successfully prepare k3s image: /Users/sunjianbo/.vela/velad/k3s/k3s-airgap-images-amd64.tgz
Successfully prepare k3d images
...snip...
KubeVela control plane has been successfully set up on your cluster.
If you want to enable dashboard, please run "vela addon enable /Users/sunjianbo/.vela/addons/velaux"
Keep the token below if you want to restart the control plane
K1075e7f6c77555e6ebdaf4854e4a2f39ae4287cfad23f27cdac5b33608d44633fe::server:zSpzbdbGzVxOwfBvvjgT
🚀 Successfully install KubeVela control plane
🔭 See available commands with `vela help`
```
</details>
**Export the Kubernetes config **
```
export KUBECONFIG=$(velad kubeconfig --host)
vela comp
```
<details>
<summary>expected output</summary>
```
NAME DEFINITION DESCRIPTION
kustomize autodetects.core.oam.dev kustomize can fetching, building, updating and applying
Kustomize manifests from git repo.
helm autodetects.core.oam.dev helm release is a group of K8s resources from either git
repository or helm repo
config-helm-repository autodetects.core.oam.dev Config information to authenticate helm chart repository
yurt-helm autodetects.core.oam.dev helm release is a group of K8s resources from either git
repository or helm repo
daemon daemonsets.apps Describes daemonset services in Kubernetes.
cron-task cronjobs.batch Describes cron jobs that run code or a script to completion.
worker deployments.apps Describes long-running, scalable, containerized services
that running at backend. They do NOT have network endpoint
to receive external network traffic.
task jobs.batch Describes jobs that run code or a script to completion.
webservice deployments.apps Describes long-running, scalable, containerized services
that have a stable network endpoint to receive external
network traffic from customers.
clickhouse autodetects.core.oam.dev Clickhouse Component provision a clickhouse cluster.
config-image-registry autodetects.core.oam.dev Config information to authenticate image registry
k8s-objects autodetects.core.oam.dev K8s-objects allow users to specify raw K8s objects in
properties
raw autodetects.core.oam.dev Raw allow users to specify raw K8s object in properties.
This definition is DEPRECATED, please use 'k8s-objects'
instead.
ref-objects autodetects.core.oam.dev Ref-objects allow users to specify ref objects to use.
Notice that this component type have special handle logic.
```
</details>
## 2. Install VelaUX
> This is optional if you don't use UI console of KubeVela.
VelaUX is a dashboard including UI console and API services.
```shell script
vela addon enable ~/.vela/addons/velaux
```
<details>
<summary>expected output</summary>
```
Addon: velaux enabled Successfully.
```
</details>
By default, velaux didn't have any exposed port, If there is the browser in local, you can view it by:
```
vela port-forward addon-velaux -n vela-system 8080:80
```
Choose `> local | velaux | velaux` for visit.
If you are installing it in a remote environment such as a virtual machine, you can refer to [VelaUX addon](./reference/addons/velaux) document to expose an endpoint or other advanced installation arguments.
VelaUX needs authentication. The default username is `admin` and the password is **`VelaUX12345`**.
It requires you to override with a new password for the first login, please make sure to remember the new password.
## 3. Cleanup
```
velad uninstall
```
This command will clean up KubeVela controllers along with the Kubernetes cluster, refer to [the advanced guide](./platform-engineers/advanced-install#uninstall) for more detailed steps.
:::

172
docs/installation/kubernetes.mdx Normal file
View File

@ -0,0 +1,172 @@
---
title: Install KubeVela on Kubernetes
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
### 1. Kubernetes Requirements:
- Kubernetes version >= v1.19 && <= v1.23
KubeVela relies on Kubernetes as a control plane. The control plane could be any managed Kubernetes offering or your own clusters, such as:
- Alibaba Cloud [ACK Service](https://www.aliyun.com/product/kubernetes)
- AWS [EKS Service](https://aws.amazon.com/cn/eks)
- Azure [AKS Service](https://azure.microsoft.com/en-us/services/kubernetes-service)
- Google [GKE Service](https://cloud.google.com/kubernetes-engine)
- Rancher [K3s](https://rancher.com/docs/k3s/latest/en/quick-start/) or [RKE](https://github.com/rancher/rke/releases)
### 2. Install KubeVela CLI {#install-vela-cli}
KubeVela CLI provides an easy to engage and manage your application delivery in command lines.
<Tabs
className="unique-tabs"
defaultValue="script"
values={[
{label: 'Script', value: 'script'},
{label: 'Homebrew', value: 'homebrew'},
{label: 'Download directly from releases', value: 'download'},
{label: 'Docker', value: 'docker'},
]}>
<TabItem value="script">
** MacOS/Linux **
```shell script
curl -fsSl https://kubevela.net/script/install.sh | bash
```
**Windows**
:::note
Only the official release version is supported.
:::
```shell script
powershell -Command "iwr -useb https://kubevela.net/script/install.ps1 | iex"
```
</TabItem>
<TabItem value="homebrew">
**macOS/Linux**
Update your brew first. Please note that the brew method only supports the installation of the official release version.
```shell script
brew update
```
Then install KubeVela CLI
```shell script
brew install kubevela
```
</TabItem>
<TabItem value="download">
- Download the latest `vela` binary file via [release log](https://github.com/kubevela/kubevela/releases).
- Unzip the binary file, and configure the environment variables in `$PATH`, and you're done.
```shell script
sudo mv ./vela /usr/local/bin/vela
```
:::note
- [Installation Tips](https://github.com/kubevela/kubevela/issues/625):
- If you are using a Mac system, it will pop up a warning that "vela" cannot be opened because the package from the developer cannot be verified.
- MacOS imposes stricter restrictions on the software that can run in the system. You can temporarily solve this problem by opening `System Preference ->Security & Privacy -> General` and clicking on `Allow Anyway`.
:::
</TabItem>
<TabItem value="docker">
If you have docker environment, you can easily run CLI with the vela CLI docker image called `oamdev/vela-cli`:
```
$ docker run --rm -it -v ~/.kube:/root/.kube oamdev/vela-cli version
CLI Version: master
Core Version: v1.3.4
GitRevision: git-1d823780
GolangVersion: go1.17.10
```
Refer to [using Vela CLI docker image](../platform-engineers/system-operation/vela-cli-image) for more usage.
</TabItem>
</Tabs>
### 3. Install KubeVela Core
<Tabs
className="unique-tabs"
defaultValue="vela"
values={[
{label: 'Default', value: 'vela'},
{label: 'Helm', value: 'helm'},
]}>
<TabItem value="vela">
```shell script
$ vela install
```
<details>
<summary> check out the outcome </summary>
```shell
...
Watching for changes to Job kubevela-vela-core-cluster-gateway-tls-secret-patch with timeout of 18m0s
Add/Modify event for kubevela-vela-core-cluster-gateway-tls-secret-patch: ADDED
kubevela-vela-core-cluster-gateway-tls-secret-patch: Jobs active: 0, jobs failed: 0, jobs succeeded: 0
Add/Modify event for kubevela-vela-core-cluster-gateway-tls-secret-patch: MODIFIED
kubevela-vela-core-cluster-gateway-tls-secret-patch: Jobs active: 1, jobs failed: 0, jobs succeeded: 0
Add/Modify event for kubevela-vela-core-cluster-gateway-tls-secret-patch: MODIFIED
kubevela-vela-core-cluster-gateway-tls-secret-patch: Jobs active: 1, jobs failed: 0, jobs succeeded: 0
Add/Modify event for kubevela-vela-core-cluster-gateway-tls-secret-patch: MODIFIED
Starting delete for "kubevela-vela-core-admission" ServiceAccount
Starting delete for "kubevela-vela-core-admission" ClusterRole
Starting delete for "kubevela-vela-core-admission" ClusterRoleBinding
Starting delete for "kubevela-vela-core-admission" Role
Starting delete for "kubevela-vela-core-admission" RoleBinding
Starting delete for "kubevela-vela-core-admission-patch" Job
Starting delete for "kubevela-vela-core-cluster-gateway-admission" ServiceAccount
Starting delete for "kubevela-vela-core-cluster-gateway-admission" Role
Starting delete for "kubevela-vela-core-cluster-gateway-admission" RoleBinding
Starting delete for "kubevela-vela-core-cluster-gateway-tls-secret-patch" Job
KubeVela control plane has been successfully set up on your cluster.
If you want to enable dashboard, please run "vela addon enable velaux"
```
</details>
</TabItem>
<TabItem value="helm">
If you are helm user, you can also use helm to install KubeVela core:
:::note
helm v3.2.0+ required
:::
```
helm repo add kubevela https://charts.kubevela.net/core
helm repo update
helm install --create-namespace -n vela-system kubevela kubevela/vela-core --wait
```
</TabItem>
</Tabs>
### 4. Install VelaUX
VelaUX is a dashboard for KubeVela. It is a web application that runs in your cluster. You can access it with your browser.
This is optional if you don't use UI console of KubeVela.
Please refer to [VelaUX Guide](../reference/addons/velaux).
### 5. Custom Installation or Upgrade
Please refer [advanced installation](../platform-engineers/advanced-install)

421
docs/installation/standalone.mdx Normal file
View File

@ -0,0 +1,421 @@
---
title: Standalone Installation
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
## Overview
This documents will show you how to install KubeVela in standalone mode. There are two options:
1. [Local machine](#local): Install on a local machine based on Linux, macOS or Windows operating system.
2. [Remote Linux server](#remote): Install on a remote Linux server with accessible IP address.
:::tip
Install KubeVela on a remote server with non-linux operating system is not fully tested.
:::
### About VelaD
We'll use [VelaD](https://github.com/kubevela/velad) to install KubeVela in standalone mode. VelaD is a CLI tool that
packages KubeVela with all dependencies for minimal installation and VelaUX.
VelaD enables you to run KubeVela on any of docker compatible environments or Linux system.
- VelaD leverages [K3s](https://rancher.com/docs/k3s/latest/en/quick-start/) and [k3d](https://k3d.io/) to manage Kubernetes automatically. Users needn't care the details about Kubernetes.
- KubeVela along with all related images, and `vela` command line are packaged together that enables air-gapped installation of KubeVela and VelaUX.
:::caution
Installation with standalone mode is suited for development and testing purpose best that you don't even aware of the Kubernetes inside. If you want to use it in production, you need to understand and maintain the K3s for Kubernetes management well.
:::
## Install in a local machine {#local}
### 1. Prepare environment
VelaD support installing KubeVela on machines based on these OS: Linux, macOS, Windows.
**Requirements**
1. If you are using Linux or macOS, make sure your machine have `curl` installed.
2. If you are using macOS or Windows, make sure you've already installed [Docker](https://www.docker.com/products/docker-desktop).
### 2. Install VelaD and Setup KubeVela
#### Download VelaD
It will download and place the binary in your system `PATH`,
<Tabs className="unique-tabs" groupId="os">
<TabItem label="Linux/macOS" value="unix">
You may be required for root privilege during the installation process if not using root.
If you don't need the automation with root access, you can download from the [release page](https://github.com/kubevela/velad/releases) and uncompress manually.
```shell
curl -fsSl https://static.kubevela.net/script/install-velad.sh | bash
```
Check `velad` installed in `/usr/local/bin/`
</TabItem>
<TabItem label="Windows" value="win">
Run following command in powershell with administrator privilege.
```powershell
powershell -Command "iwr -useb https://static.kubevela.net/script/install-velad.ps1 | iex"
```
Check `velad` installed in `C:\vela\`
:::info
VelaD helps install Vela CLI, which requires administrator privilege.
:::
<details>
<summary>Start powershell as administrator</summary>
1. Click on the 'Start' button to open the Start menu.
2. Scroll to the Windows PowerShell shortcut folder then, right click on the Windows Powershell option and select 'Run as administrator'.
</details>
</TabItem>
</Tabs>
#### Setup KubeVela
```shell
velad install
```
<details>
<summary>expected output</summary>
```
Preparing K3s images...
Successfully prepare k3s image: /Users/sunjianbo/.vela/velad/k3s/k3s-airgap-images-amd64.tgz
Successfully prepare k3d images
...snip...
KubeVela control plane has been successfully set up on your cluster.
If you want to enable dashboard, please run "vela addon enable /Users/sunjianbo/.vela/addons/velaux"
Keep the token below if you want to restart the control plane
K1075e7f6c77555e6ebdaf4854e4a2f39ae4287cfad23f27cdac5b33608d44633fe::server:zSpzbdbGzVxOwfBvvjgT
🚀 Successfully install KubeVela control plane
🔭 See available commands with `vela help`
```
</details>
#### Verify Installation
Export kubeconfig and list all built-in ComponentDefinition:
<Tabs className="unique-tabs" groupId="os">
<TabItem label="Linux/macOS" value="unix">
```shell
export KUBECONFIG=$(velad kubeconfig --host)
vela comp
```
</TabItem>
<TabItem label="Windows" value="win">
```powershell
$env:PATH += ";$HOME\.vela\bin;"
$env:KUBECONFIG = $(velad kubeconfig --host)
vela comp
```
</TabItem>
</Tabs>
:::tip
- When executing `velad install`, vela CLI (`vela`) is already installed and add to `PATH` automatically. So you can use it directly.
- A file uesd to configure access to clusters is called *kubeconfig file*
:::
<details>
<summary>expected output</summary>
```
NAME DEFINITION DESCRIPTION
config-helm-repository autodetects.core.oam.dev Config information to authenticate helm chart repository
daemon daemonsets.apps Describes daemonset services in Kubernetes.
cron-task cronjobs.batch Describes cron jobs that run code or a script to completion.
worker deployments.apps Describes long-running, scalable, containerized services
that running at backend. They do NOT have network endpoint
to receive external network traffic.
task jobs.batch Describes jobs that run code or a script to completion.
webservice deployments.apps Describes long-running, scalable, containerized services
that have a stable network endpoint to receive external
network traffic from customers.
config-image-registry autodetects.core.oam.dev Config information to authenticate image registry
k8s-objects autodetects.core.oam.dev K8s-objects allow users to specify raw K8s objects in
properties
raw autodetects.core.oam.dev Raw allow users to specify raw K8s object in properties.
This definition is DEPRECATED, please use 'k8s-objects'
instead.
ref-objects autodetects.core.oam.dev Ref-objects allow users to specify ref objects to use.
Notice that this component type have special handle logic.
```
</details>
Export kubeconfig and list all built-in ComponentDefinition:
### 3. Install VelaUX
VelaUX is a dashboard for KubeVela. It is a web application that runs in your cluster. You can access it with your browser.
This is optional if you don't use UI console of KubeVela.
<Tabs className="unique-tabs" groupId="os">
<TabItem label="Linux/macOS" value="unix">
```shell script
vela addon enable ~/.vela/addons/velaux
```
</TabItem>
<TabItem label="Windows" value="win">
```powershell
vela addon enable $HOME\.vela\addons\velaux
```
</TabItem>
</Tabs>
<details>
<summary>expected output</summary>
```
Addon: velaux enabled Successfully.
```
</details>
By default, velaux don't have any exposed port, you can view it by:
```shell
vela port-forward addon-velaux -n vela-system 8080:80
```
Choose `> local | velaux | velaux` for visit.
:::note
For more VelaUX options, refer to [VelaUX addon](../reference/addons/velaux) document for other advanced installation arguments.
:::
VelaUX needs authentication. The default username is `admin` and the password is **`VelaUX12345`**.
It requires you to override with a new password for the first login, please make sure to remember the new password.
### 4. Cleanup
This command will clean up KubeVela controllers along with the Kubernetes cluster, refer to [the advanced guide](../platform-engineers/advanced-install#uninstall) for more detailed steps.
```
velad uninstall
```
## Install on a remote Linux server {#remote}
This documents show you how to install KubeVela on a remote Linux server (e.g. aws EC2 or aliyun ECS) in standalone mode.
### 1. Prepare a machine
Prepare a Linux server, make sure it meets the following requirements:
**Requirements**
1. Make sure your machine have `curl` installed.
2. This server has a public IP, or you can access the server's IP if it's a on-premise server.
3. If you are using a cloud server, make sure you have opened the port 6443 in secure group.
### 2. Install VelaD and Setup KubeVela
#### Download VelaD
Following script will download and place the binary in your system `PATH`,
so you may be required for root privilege during the installation process.
If you don't need the automation with root access, you can download from the [release page](https://github.com/kubevela/velad/releases) and uncompress manually.
```shell
curl -fsSl https://static.kubevela.net/script/install-velad.sh | bash
```
Check `velad` installed in `/usr/local/bin/`
#### Setup KubeVela
Run the following command and replace the `$SERVER_PUBLIC_IP` with your server's public IP.
```shell
velad install --bind-ip=$SERVER_PUBLIC_IP
```
<details>
<summary>expected output</summary>
```
Preparing K3s images...
Successfully prepare k3s image: /Users/sunjianbo/.vela/velad/k3s/k3s-airgap-images-amd64.tgz
Successfully prepare k3d images
...snip...
KubeVela control plane has been successfully set up on your cluster.
If you want to enable dashboard, please run "vela addon enable /Users/sunjianbo/.vela/addons/velaux"
Keep the token below if you want to restart the control plane
K1075e7f6c77555e6ebdaf4854e4a2f39ae4287cfad23f27cdac5b33608d44633fe::server:zSpzbdbGzVxOwfBvvjgT
🚀 Successfully install KubeVela control plane
🔭 See available commands with `vela help`
🔑 To access the cluster, set KUBECONFIG:
export KUBECONFIG=$(velad kubeconfig --name default --host)
```
</details>
#### Verify Installation
Export kubeconfig and list all built-in ComponentDefinition:
```shell
export KUBECONFIG=$(velad kubeconfig --host)
vela comp
```
:::tip
- When executing `velad install`, vela CLI (`vela`) is already installed and add to `PATH` automatically. So you can use it directly.
Later we will access KubeVela on local machine, we will install vela CLI on local machine again.
- A file uesd to configure access to clusters is called *kubeconfig file*. Vela CLI also use this file to access KubeVela.
:::
<details>
<summary>expected output</summary>
```
NAME DEFINITION DESCRIPTION
config-helm-repository autodetects.core.oam.dev Config information to authenticate helm chart repository
daemon daemonsets.apps Describes daemonset services in Kubernetes.
cron-task cronjobs.batch Describes cron jobs that run code or a script to completion.
worker deployments.apps Describes long-running, scalable, containerized services
that running at backend. They do NOT have network endpoint
to receive external network traffic.
task jobs.batch Describes jobs that run code or a script to completion.
webservice deployments.apps Describes long-running, scalable, containerized services
that have a stable network endpoint to receive external
network traffic from customers.
config-image-registry autodetects.core.oam.dev Config information to authenticate image registry
k8s-objects autodetects.core.oam.dev K8s-objects allow users to specify raw K8s objects in
properties
raw autodetects.core.oam.dev Raw allow users to specify raw K8s object in properties.
This definition is DEPRECATED, please use 'k8s-objects'
instead.
ref-objects autodetects.core.oam.dev Ref-objects allow users to specify ref objects to use.
Notice that this component type have special handle logic.
```
</details>
### 3. Install VelaUX
VelaUX is a dashboard for KubeVela. It is a web application that runs in your cluster. You can access it with your browser.
Run this command on remote server.
```shell
vela addon enable ~/.vela/addons/velaux serviceType=NodePort
```
<details>
<summary>expected output</summary>
```
Addon: velaux enabled Successfully.
...
I0907 12:03:11.462606 98769 utils.go:156] find cluster gateway service vela-system/kubevela-cluster-gateway-service:9443
Please access addon-velaux from the following endpoints:
+---------+-----------+-------------------------------+----------------------------+-------+
| CLUSTER | COMPONENT | REF(KIND/NAMESPACE/NAME) | ENDPOINT | INNER |
+---------+-----------+-------------------------------+----------------------------+-------+
| local | apiserver | Service/vela-system/apiserver | apiserver.vela-system:8000 | true |
| local | velaux | Service/vela-system/velaux | http://47.252.17.47:30000 | false |
+---------+-----------+-------------------------------+----------------------------+-------+
```
</details>
By adding `serviceType=NodePort`, we are telling VelaUX to expose service with K8s
[NodePort](https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport) type.
Check the endpoint of VelaUX with following command:
```shell
vela status addon-velaux -n vela-system --endpoint
```
It will show URL like `http://PUBLIC-IP:PORT` access that URL with your browser.
:::caution open the port
If you are using a cloud server, please open this port in secure group.
:::
:::note
For more VelaUX options, refer to [VelaUX addon](../reference/addons/velaux) document for other advanced installation arguments.
:::
VelaUX needs authentication. The default username is `admin` and the password is **`VelaUX12345`**.
It requires you to override with a new password for the first login, please make sure to remember the new password.
### 4. Access cluster From Local (Optional)
You can access KubeVela with your local machine. Make sure you add `--bind-ip` when executing `velad install` command in the last step on the server.
#### Copy KubeConfig
Following command will print the kubeconfig for your cluster. `--external` means printed kubeconfig can be used from other
machine (like your local machine).
```shell
cat $(velad kubeconfig --external)
```
Then you need to copy this kubeconfig to your local machine. Let's say you saving a file in `~/.kube/velad-config` in your local machine.
#### Install Vela CLI in Local
To access the cluster, you also need to install `vela` CLI in your local machine.
```shell
curl -fsSl https://static.kubevela.net/script/install.sh | bash
```
#### Access KubeVela
Export KUBECONFIG environment variable and list all built-in ComponentDefinition:
```shell
export KUBECONFIG=~/.kube/velad-config
vela comp
```
### 5. Cleanup
Run following command on remote server.
This command will clean up KubeVela controllers along with the Kubernetes cluster, refer to [the advanced guide](../platform-engineers/advanced-install#uninstall) for more detailed steps.
```shell
velad uninstall
```

160
docs/platform-engineers/advanced-install.mdx
View File

@ -5,166 +5,6 @@ title: Custom Installation/Upgrade
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
## Install KubeVela with Existing Kubernetes cluster
### 1. Prerequisites:
- Kubernetes cluster >= v1.19 && <= v1.23
KubeVela relies on Kubernetes as a control plane. The control plane could be any managed Kubernetes offering or your own clusters, such as:
- Alibaba Cloud [ACK Service](https://www.aliyun.com/product/kubernetes)
- AWS [EKS Service](https://aws.amazon.com/cn/eks)
- Azure [AKS Service](https://azure.microsoft.com/en-us/services/kubernetes-service)
- Google [GKE Service](https://cloud.google.com/kubernetes-engine)
- Rancher [K3s](https://rancher.com/docs/k3s/latest/en/quick-start/) or [RKE](https://github.com/rancher/rke/releases)
> Please make sure one of the [ingress controllers](https://kubernetes.github.io/ingress-nginx/deploy/) is available in your Kubernetes cluster.
### 2. Install KubeVela CLI
KubeVela CLI provides an easy to engage and manage your application delivery in command lines.
<Tabs
className="unique-tabs"
defaultValue="script"
values={[
{label: 'Script', value: 'script'},
{label: 'Homebrew', value: 'homebrew'},
{label: 'Download directly from releases', value: 'download'},
{label: 'Docker', value: 'docker'},
]}>
<TabItem value="script">
** MacOS/Linux **
```shell script
curl -fsSl https://kubevela.net/script/install.sh | bash
```
**Windows**
> Only the official release version is supported.
```shell script
powershell -Command "iwr -useb https://kubevela.net/script/install.ps1 | iex"
```
</TabItem>
<TabItem value="homebrew">
**macOS/Linux**
Update your brew first. Please note that the brew method only supports the installation of the official release version.
```shell script
brew update
```
Then install KubeVela CLI
```shell script
brew install kubevela
```
</TabItem>
<TabItem value="download">
- Download the latest `vela` binary file via [release log](https://github.com/kubevela/kubevela/releases).
- Unzip the binary file, and configure the environment variables in `$PATH`, and you're done.
```shell script
sudo mv ./vela /usr/local/bin/vela
```
> [Installation Tips](https://github.com/kubevela/kubevela/issues/625):
> If you are using a Mac system, it will pop up a warning that "vela" cannot be opened because the package from the developer cannot be verified.
>
> MacOS imposes stricter restrictions on the software that can run in the system. You can temporarily solve this problem by opening `System Preference ->Security & Privacy -> General` and clicking on `Allow Anyway`.
</TabItem>
<TabItem value="docker">
If you have docker environment, you can easily run CLI with the vela CLI docker image called `oamdev/vela-cli`:
```
$ docker run --rm -it -v ~/.kube:/root/.kube oamdev/vela-cli version
CLI Version: master
Core Version: v1.3.4
GitRevision: git-1d823780
GolangVersion: go1.17.10
```
Refer to [using Vela CLI docker image](./system-operation/vela-cli-image) for more usage.
</TabItem>
</Tabs>
### 3. Install KubeVela Core
<Tabs
className="unique-tabs"
defaultValue="vela"
values={[
{label: 'Default', value: 'vela'},
{label: 'Helm', value: 'helm'},
]}>
<TabItem value="vela">
```shell script
$ vela install
```
<details> <summary> check out the outcome </summary>
```shell
...
Watching for changes to Job kubevela-vela-core-cluster-gateway-tls-secret-patch with timeout of 18m0s
Add/Modify event for kubevela-vela-core-cluster-gateway-tls-secret-patch: ADDED
kubevela-vela-core-cluster-gateway-tls-secret-patch: Jobs active: 0, jobs failed: 0, jobs succeeded: 0
Add/Modify event for kubevela-vela-core-cluster-gateway-tls-secret-patch: MODIFIED
kubevela-vela-core-cluster-gateway-tls-secret-patch: Jobs active: 1, jobs failed: 0, jobs succeeded: 0
Add/Modify event for kubevela-vela-core-cluster-gateway-tls-secret-patch: MODIFIED
kubevela-vela-core-cluster-gateway-tls-secret-patch: Jobs active: 1, jobs failed: 0, jobs succeeded: 0
Add/Modify event for kubevela-vela-core-cluster-gateway-tls-secret-patch: MODIFIED
Starting delete for "kubevela-vela-core-admission" ServiceAccount
Starting delete for "kubevela-vela-core-admission" ClusterRole
Starting delete for "kubevela-vela-core-admission" ClusterRoleBinding
Starting delete for "kubevela-vela-core-admission" Role
Starting delete for "kubevela-vela-core-admission" RoleBinding
Starting delete for "kubevela-vela-core-admission-patch" Job
Starting delete for "kubevela-vela-core-cluster-gateway-admission" ServiceAccount
Starting delete for "kubevela-vela-core-cluster-gateway-admission" Role
Starting delete for "kubevela-vela-core-cluster-gateway-admission" RoleBinding
Starting delete for "kubevela-vela-core-cluster-gateway-tls-secret-patch" Job
KubeVela control plane has been successfully set up on your cluster.
If you want to enable dashboard, please run "vela addon enable velaux"
```
</details>
</TabItem>
<TabItem value="helm">
If you are helm user, you can also use helm to install kubevela core:
> helm v3.2.0+ required
```
helm repo add kubevela https://charts.kubevela.net/core
helm repo update
helm install --create-namespace -n vela-system kubevela kubevela/vela-core --wait
```
</TabItem>
</Tabs>
### 4 Install VelaUX
Please refer to [VelaUX Guide](../reference/addons/velaux).
## Upgrade
> If you're trying to upgrade from a big version later (e.g. from 1.2.x to 1.4.x), please refer to [version migration](./system-operation/migration-from-old-version) for more guides.

2
docs/platform-engineers/components/component-terraform.md
View File

@ -10,7 +10,7 @@ Here is the guide to create Terraform typed ComponentDefinitions of cloud resour
# Prerequisites
- [`vela` binary](../../install.mdx)
- [`vela` binary](../advanced-install#install-vela-cli)
## Develop a Terraform resource or module

2
docs/quick-start.md
View File

@ -2,7 +2,7 @@
title: Deploy First Application
---
> Before starting, please confirm that you've installed KubeVela and enabled the VelaUX addon according to [the installation guide](./install.mdx).
> Before starting, please confirm that you've installed KubeVela and enabled the VelaUX addon according to [the installation guide](./install).
Welcome to KubeVela! This section will guide you to deliver your first app.

2
docusaurus.config.js
View File

@ -153,7 +153,7 @@ module.exports = {
},
prism: {
theme: require('prism-react-renderer/themes/dracula'),
additionalLanguages: ['cue'],
additionalLanguages: ['cue','powershell'],
},
zoom: {
selector: '.markdown :not(em) > img',

9
i18n/zh/docusaurus-plugin-content-docs/current.json
View File

@ -321,5 +321,14 @@
},
"sidebar.docs.category.Multi Cluster Delivery": {
"message": "多集群交付"
},
"sidebar.docs.doc.Standalone": {
"message": "无依赖独立安装"
},
"sidebar.docs.category.Installation": {
"message": "安装"
},
"sidebar.docs.doc.Kubernetes": {
"message": "基于 Kubernetes 安装"
}
}

152
i18n/zh/docusaurus-plugin-content-docs/current/install.mdx
View File

@ -1,146 +1,24 @@
---
title: 快速安装
title: 安装概览
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
我们根据你的环境和使用方式提供了两种不同的 KubeVela 安装方式：
- 在 Kubernetes 集群上安装，请参考 [高级安装](./platform-engineers/advanced-install#install-kubevela-with-existing-kubernetes-cluster).
- 升级 KubeVela 请参考 [升级文档](./platform-engineers/advanced-install#upgrade).
### 没有 Kubernetes 集群？
## 1. 安装 VelaD
对于第一次接触 KubeVela 和 Kubernetes 的用户来说，使用独立模式安装 KubeVela 是最好的选择。独立安装模式无需了解 Kubernetes 知识即可尝试 KubeVela 的特性。
我们为此开发了 [VelaD](https://github.com/kubevela/velad)，把安装 KubeVela 以及其所需的 Kubernetes 等依赖打包为一个单独的可执行文件。
请跟随下面的文档链接完成安装：
[VelaD](https://github.com/kubevela/velad) 作为 KubeVela 的快速安装工具，帮助你在具有 Docker 的环境中快速一键完成安装。
- [独立安装](./installation/standalone): 在本地计算机上或一个远端的服务器（公有云或自己部署的）安装，支持 Linux，macOS 和 Windows。
- VelaD 继承了 [K3s](https://rancher.com/docs/k3s/latest/en/quick-start/) 和 [k3d](https://k3d.io/) 的能力，同时将 KubeVela 所需的制品整体打包。
- VelaD 可以帮助你在离线环境中完成安装。
- VelaD 目前仅适用于快速体验和测试开发， [生成环境安装请参考高级安装文档](./platform-engineers/advanced-install#install-kubevela-with-existing-kubernetes-cluster)。
:::info
VelaD 非常适合测试开发和快速体验，它利用 K3s 来提供集群。但是我们强烈建议在生产使用时，使用一个生产级别的 Kubernetes 集群安装 KubeVela，参考[集群安装](./installation/kubernetes)。
:::
### 前提条件
### 已有 Kubernetes 集群
- [集群安装](./installation/kubernetes): 在 Kubernetes 集群中安装 KubeVela
- Docker v20.10.5+ (runc >= v1.0.0-rc93) **or** Linux system
### 下载 VelaD
- ** MacOS/Linux **
```shell
curl -fsSl https://static.kubevela.net/script/install-velad.sh | bash
```
- **Windows**
```shell
powershell -Command "iwr -useb https://static.kubevela.net/script/install.ps1 | iex"
```
`velad` 和 `vela` 命令行工具将存储于 `/usr/local/bin/`，对于 Windows，存储于 `C:\vela\`。
### 一键安装
```shell
velad install
```
<details>
<summary>期望输出</summary>
```
Preparing K3s images...
Successfully prepare k3s image: /Users/sunjianbo/.vela/velad/k3s/k3s-airgap-images-amd64.tgz
Successfully prepare k3d images
...snip...
KubeVela control plane has been successfully set up on your cluster.
If you want to enable dashboard, please run "vela addon enable /Users/sunjianbo/.vela/addons/velaux"
Keep the token below if you want to restart the control plane
K1075e7f6c77555e6ebdaf4854e4a2f39ae4287cfad23f27cdac5b33608d44633fe::server:zSpzbdbGzVxOwfBvvjgT
🚀 Successfully install KubeVela control plane
🔭 See available commands with `vela help`
```
</details>
### 设置 KubeConfig
```
export KUBECONFIG=$(velad kubeconfig --host)
vela comp
```
<details>
<summary>期望输出</summary>
```
NAME DEFINITION DESCRIPTION
kustomize autodetects.core.oam.dev kustomize can fetching, building, updating and applying
Kustomize manifests from git repo.
helm autodetects.core.oam.dev helm release is a group of K8s resources from either git
repository or helm repo
config-helm-repository autodetects.core.oam.dev Config information to authenticate helm chart repository
yurt-helm autodetects.core.oam.dev helm release is a group of K8s resources from either git
repository or helm repo
daemon daemonsets.apps Describes daemonset services in Kubernetes.
cron-task cronjobs.batch Describes cron jobs that run code or a script to completion.
worker deployments.apps Describes long-running, scalable, containerized services
that running at backend. They do NOT have network endpoint
to receive external network traffic.
task jobs.batch Describes jobs that run code or a script to completion.
webservice deployments.apps Describes long-running, scalable, containerized services
that have a stable network endpoint to receive external
network traffic from customers.
clickhouse autodetects.core.oam.dev Clickhouse Component provision a clickhouse cluster.
config-image-registry autodetects.core.oam.dev Config information to authenticate image registry
k8s-objects autodetects.core.oam.dev K8s-objects allow users to specify raw K8s objects in
properties
raw autodetects.core.oam.dev Raw allow users to specify raw K8s object in properties.
This definition is DEPRECATED, please use 'k8s-objects'
instead.
ref-objects autodetects.core.oam.dev Ref-objects allow users to specify ref objects to use.
Notice that this component type have special handle logic.
```
</details>
## 2. 安装 VelaUX
VelaUX 是面向企业的应用交付控制台和可视化平台。
```shell script
vela addon enable ~/.vela/addons/velaux
```
<details>
<summary>期望输出</summary>
```
Addon: velaux enabled Successfully.
```
</details>
如果你是在本地执行安装，你可以通过以下方式快速访问到 VelaUX:
```
vela port-forward addon-velaux -n vela-system 8080:80
```
Choose `> local | velaux | velaux` for visit.
如果你是在远程主机安装或希望使用更稳固的访问方式，请参考 [VelaUX 高级安装说明](./reference/addons/velaux)。
VelaUX 是需要登陆认证的，默认管理员账号为 `admin` 密码为 **`VelaUX12345`**。请首次登陆成功后修改管理员密码并谨记。
## 3. 卸载
```
velad uninstall
```
此命令将删除 VelaD 安装的环境, 其他自定义方式安装的请参考 [KubeVela 卸载文档](./platform-engineers/advanced-install#uninstall)。
## 下一步
- [部署第一个应用](./quick-start)。
:::tip
- 要升级已有的 KubeVela，参考[升级文档](./platform-engineers/advanced-install#upgrade)。
:::

168
i18n/zh/docusaurus-plugin-content-docs/current/installation/kubernetes.mdx Normal file
View File

@ -0,0 +1,168 @@
---
title: 在 Kubernetes 中安装 KubeVela
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
### 1. 安装条件:
- Kubernetes cluster >= v1.19 && <= v1.23
KubeVela 依赖 Kubernetes 作为管控平面，你需要自行搭建生产可用的 Kubernetes 集群，支持的方式包括：
- Alibaba Cloud [ACK Service](https://www.aliyun.com/product/kubernetes)
- AWS [EKS Service](https://aws.amazon.com/cn/eks)
- Azure [AKS Service](https://azure.microsoft.com/en-us/services/kubernetes-service)
- Google [GKE Service](https://cloud.google.com/kubernetes-engine)
- Rancher [K3s](https://rancher.com/docs/k3s/latest/en/quick-start/) or [RKE](https://github.com/rancher/rke/releases)
### 2. 安装 KubeVela 命令行 {#install-vela-cli}
KubeVela CLI 提供了常用的集群和应用管理能力。
<Tabs
className="unique-tabs"
defaultValue="script"
values={[
{label: 'Script', value: 'script'},
{label: 'Homebrew', value: 'homebrew'},
{label: 'Download directly from releases', value: 'download'},
{label: 'Docker', value: 'docker'},
]}>
<TabItem value="script">
** MacOS/Linux **
```shell script
curl -fsSl https://kubevela.net/script/install.sh | bash
```
**Windows**
```shell script
powershell -Command "iwr -useb https://kubevela.net/script/install.ps1 | iex"
```
</TabItem>
<TabItem value="homebrew">
**macOS/Linux**
首先更新你的 Homebrew。注意，使用 Homebrew 安装只支持安装正式 release 的版本。
```shell
brew update
```
安装 Vela CLI。
```shell
brew install kubevela
```
</TabItem>
<TabItem value="download">
- 通过 [release log](https://github.com/kubevela/kubevela/releases) 下载二进制压缩文件。
- 解压文件并将二进制文件移动到 $PATH 路径下。
```shell script
sudo mv ./vela /usr/local/bin/vela
```
> [安装提示](https://github.com/kubevela/kubevela/issues/625):
> 如果你使用的是 macOS，会弹出因为开发者的包无法验证，“vela”无法打开的警告。
>
> macOS 对可以在系统中运行的软件施加了更严格的限制。您可以通过打开“系统偏好设置 -> 安全和隐私 -> 常规”，并选择“从任何位置下载的程序”来临时解决此问题。
</TabItem>
<TabItem value="docker">
如果你需要在容器环境中使用 Vela CLI，我们提供了 CLI 镜像 `oamdev/vela-cli`:
```
$ docker run --rm -it -v ~/.kube:/root/.kube oamdev/vela-cli version
CLI Version: master
Core Version: v1.3.4
GitRevision: git-1d823780
GolangVersion: go1.17.10
```
参考 [使用 Vela CLI 镜像文档](../platform-engineers/system-operation/vela-cli-image) 获取更多用法。
</TabItem>
</Tabs>
### 3. 安装 KubeVela Core
<Tabs
className="unique-tabs"
defaultValue="vela"
values={[
{label: 'Default', value: 'vela'},
{label: 'Helm', value: 'helm'},
]}>
<TabItem value="vela">
```shell script
$ vela install
```
<details> <summary> 正常安装出现下述日志 </summary>
```shell
...
Watching for changes to Job kubevela-vela-core-cluster-gateway-tls-secret-patch with timeout of 18m0s
Add/Modify event for kubevela-vela-core-cluster-gateway-tls-secret-patch: ADDED
kubevela-vela-core-cluster-gateway-tls-secret-patch: Jobs active: 0, jobs failed: 0, jobs succeeded: 0
Add/Modify event for kubevela-vela-core-cluster-gateway-tls-secret-patch: MODIFIED
kubevela-vela-core-cluster-gateway-tls-secret-patch: Jobs active: 1, jobs failed: 0, jobs succeeded: 0
Add/Modify event for kubevela-vela-core-cluster-gateway-tls-secret-patch: MODIFIED
kubevela-vela-core-cluster-gateway-tls-secret-patch: Jobs active: 1, jobs failed: 0, jobs succeeded: 0
Add/Modify event for kubevela-vela-core-cluster-gateway-tls-secret-patch: MODIFIED
Starting delete for "kubevela-vela-core-admission" ServiceAccount
Starting delete for "kubevela-vela-core-admission" ClusterRole
Starting delete for "kubevela-vela-core-admission" ClusterRoleBinding
Starting delete for "kubevela-vela-core-admission" Role
Starting delete for "kubevela-vela-core-admission" RoleBinding
Starting delete for "kubevela-vela-core-admission-patch" Job
Starting delete for "kubevela-vela-core-cluster-gateway-admission" ServiceAccount
Starting delete for "kubevela-vela-core-cluster-gateway-admission" Role
Starting delete for "kubevela-vela-core-cluster-gateway-admission" RoleBinding
Starting delete for "kubevela-vela-core-cluster-gateway-tls-secret-patch" Job
KubeVela control plane has been successfully set up on your cluster.
If you want to enable dashboard, please run "vela addon enable velaux"
```
</details>
</TabItem>
<TabItem value="helm">
如果你是 Helm 用户，你可以通过 Helm 命令完成 VelaCore 的安装和升级：
> helm v3.2.0+ required
```
helm repo add kubevela https://charts.kubevela.net/core
helm repo update
helm install --create-namespace -n vela-system kubevela kubevela/vela-core --wait
```
</TabItem>
</Tabs>
### 4 安装 VelaUX
VelaUX 是 KubeVela 的仪表板。 它是在你的集群中运行的 Web 应用程序。 你可以使用浏览器访问它。
如果你不使用 KubeVela 的 UI 控制台，这是可选的。
请参考 [VelaUX 插件文档](../reference/addons/velaux).
### 5. 自定义安装或升级
请参考[升级和高级安装选项](../platform-engineers/advanced-install)

407
i18n/zh/docusaurus-plugin-content-docs/current/installation/standalone.mdx Normal file
View File

@ -0,0 +1,407 @@
---
title: 独立安装 KubeVela
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
## 概览
本文档将向你展示如何以独立模式安装 KubeVela。 有两种选择：
1. [本地机器](#local)：在本地机器中安装，支持 Linux，macOS 和 Windows。
2. [远程 Linux 服务器](#remote)：在具有可访问IP地址的远程 Linux 服务器中安装
:::tip
在非 Linux 系统的远程服务器中安装 KubeVela 尚未经过完全测试。
:::
### VelaD 简介
以上两种选项中，我们都将使用 [VelaD](https://github.com/kubevela/velad) 来以独立模式安装 KubeVela。它是一个命令行工具，
将 KubeVela 最小安装以及使用 VelaUX 的一切依赖打包为一个可执行文件。你可以使用 VelaD 在安装有 Docker 的 macOS/Windows 中或 Linux 中安装 KubeVela。
- VelaD 集成了 [K3s](https://rancher.com/docs/k3s/latest/en/quick-start/) 和 [k3d](https://k3d.io/) 用于自动化管理 Kubernetes 集群，用户无需关心 Kubernetes 集群管理的细节。
- VelaD 打包了镜像等依赖，可以在没有网络的环境中最小化安装 KubeVela 以及其 VelaUX 插件。
:::caution
以独立模式安装仅适用于开发和测试目的，这时你无需了解其中的 Kubernetes。但是当你想要在生产中使用它时，你需要能够理解和维护 K3s，即承担管理 Kubernetes 的工作。
:::
## 在本地机器上安装 {#local}
### 1. 准备环境
VelaD 支持在这些操作系统中安装 KubeVela：Linux, macOS, Windows。
**要求**
1. 如果你在使用 Linux 或者 macOS，确保你的机器上安装了 `curl`。
2. 如果你在使用 macOS or Windows, 确保你已经安装 [Docker Desktop](https://www.docker.com/products/docker-desktop)。
### 2. 安装 VelaD 和 KubeVela
#### 下载 VelaD
下面等脚本将下载二进制文件并将其放置在你的系统“PATH”中，
<Tabs className="unique-tabs">
<TabItem value="Linux">
在安装过程中你可能需要 root 权限。 如果你不需要 root 权限和自动化，你可以从[发布页面](https://github.com/kubevela/velad/releases)下载并手动解压缩。
```shell
curl -fsSl https://static.kubevela.net/script/install-velad.sh | bash
```
检查 `velad` 安装到 `/usr/local/bin/`
</TabItem>
<TabItem value="Windows">
以管理员身份启动 PowerShell 并执行如下命令:
```shell
powershell -Command "iwr -useb https://static.kubevela.net/script/install-velad.ps1 | iex"
```
检查 `velad` 安装到 `C:\vela\`
:::info
VelaD 会帮助安装 Vela CLI，这要求管理员权限。
:::
<details>
<summary>如何以管理员身份启动 PowerShell</summary>
1. 点击"开始"按钮打开开始菜单。
2. 在开始菜单中，向下滚动找到"Windows PowerShell"目录，右键点击其中的"Windows Powershell"选项，并选择"以管理员身份运行"。
</details>
</TabItem>
</Tabs>
#### 安装 KubeVela
```shell
velad install
```
<details>
<summary>期望输出</summary>
```
Preparing K3s images...
Successfully prepare k3s image: /Users/sunjianbo/.vela/velad/k3s/k3s-airgap-images-amd64.tgz
Successfully prepare k3d images
...snip...
KubeVela control plane has been successfully set up on your cluster.
If you want to enable dashboard, please run "vela addon enable /Users/sunjianbo/.vela/addons/velaux"
Keep the token below if you want to restart the control plane
K1075e7f6c77555e6ebdaf4854e4a2f39ae4287cfad23f27cdac5b33608d44633fe::server:zSpzbdbGzVxOwfBvvjgT
🚀 Successfully install KubeVela control plane
🔭 See available commands with `vela help`
```
</details>
#### 验证安装结果
设置 kubeconfig 并列出所有内置的组件定义:
<Tabs className="unique-tabs" groupId="os">
<TabItem label="Linux/macOS" value="unix">
```shell
export KUBECONFIG=$(velad kubeconfig --host)
vela comp
```
</TabItem>
<TabItem label="Windows" value="win">
```powershell
$env:PATH += ";$HOME\.vela\bin;"
$env:KUBECONFIG = $(velad kubeconfig --host)
vela comp
```
</TabItem>
</Tabs>
:::tip
- 在macOS/Linux中，执行 `velad install` 时，已经安装了 vela CLI (`vela`) 并自动添加到 `PATH`。 所以你可以直接使用它。
- 用于配置对集群的访问的文件称为 *kubeconfig 文件*
:::
<details>
<summary>期望输出</summary>
```
NAME DEFINITION DESCRIPTION
config-helm-repository autodetects.core.oam.dev Config information to authenticate helm chart repository
daemon daemonsets.apps Describes daemonset services in Kubernetes.
cron-task cronjobs.batch Describes cron jobs that run code or a script to completion.
worker deployments.apps Describes long-running, scalable, containerized services
that running at backend. They do NOT have network endpoint
to receive external network traffic.
task jobs.batch Describes jobs that run code or a script to completion.
webservice deployments.apps Describes long-running, scalable, containerized services
that have a stable network endpoint to receive external
network traffic from customers.
config-image-registry autodetects.core.oam.dev Config information to authenticate image registry
k8s-objects autodetects.core.oam.dev K8s-objects allow users to specify raw K8s objects in
properties
raw autodetects.core.oam.dev Raw allow users to specify raw K8s object in properties.
This definition is DEPRECATED, please use 'k8s-objects'
instead.
ref-objects autodetects.core.oam.dev Ref-objects allow users to specify ref objects to use.
Notice that this component type have special handle logic.
```
</details>
### 3. 安装 VelaUX
VelaUX 是 KubeVela 的仪表板。 它是在你的集群中运行的 Web 应用程序。 你可以使用浏览器访问它。
如果你不使用 KubeVela 的 UI 控制台，这是可选的。
<Tabs className="unique-tabs" groupId="os">
<TabItem label="Linux/macOS" value="unix">
```shell script
vela addon enable ~/.vela/addons/velaux
```
</TabItem>
<TabItem label="Windows" value="win">
```powershell
vela addon enable $HOME\.vela\addons\velaux
```
</TabItem>
</Tabs>
<details>
<summary>期望输出</summary>
```
Addon: velaux enabled Successfully.
```
</details>
默认情况下，velaux 没有任何暴露的端口，你可以通过以下方式查看：
```shell
vela port-forward addon-velaux -n vela-system 8080:80
```
选择 `> local | velaux | velaux` 来访问 VelaUX
:::note
如需更多 VelaUX 选项，请参阅 [VelaUX 插件](../reference/addons/velaux) 文档了解其他高级安装参数。
:::
VelaUX 需要身份验证。 默认用户名是 `admin`，密码是 **`VelaUX12345`**。首次登录时需要使用新密码覆盖，请务必记住新密码。
### 4. 清理
此命令将清理 KubeVela 控制器以及 Kubernetes 集群，有关更详细的步骤，请参阅 [高级指南](../platform-engineers/advanced-install#uninstall)。
```
velad uninstall
```
## 在远程服务器上安装 KubeVela
下面向你展示如何在远程服务器（如 aws EC2 或 阿里云 ECS）上以独立模式安装 KubeVela。
### 1.准备一台机器
准备一台 Linux 系统的远程服务器，对机器有如下要求
**要求**
1. 确保你的机器安装了 `curl`。
2. 此服务器有一个公网 IP，或者在企业内网中你可以访问该服务器的 IP。
3. 如果你使用的是云服务器，请确保你在安全组中打开了 6443 端口。
### 2. 安装 VelaD 和 KubeVela
#### 下载 VelaD
下面等脚本将下载二进制文件并将其放置在你的系统“PATH”中，
因此在安装过程中你可能需要 root 权限。
如果你不需要root权限和自动化，你可以从[发布页面](https://github.com/kubevela/velad/releases)下载并手动解压缩。
```shell
curl -fsSl https://static.kubevela.net/script/install-velad.sh | bash
```
检查 `velad` 已经安装到 `/usr/local/bin/`
#### 安装 KubeVela
运行以下命令并将`$SERVER_PUBLIC_IP`替换为服务器的公共 IP。
```shell
velad install --bind-ip=$SERVER_PUBLIC_IP
```
<details>
<summary>期望输出</summary>
```
Preparing K3s images...
Successfully prepare k3s image: /Users/sunjianbo/.vela/velad/k3s/k3s-airgap-images-amd64.tgz
Successfully prepare k3d images
...snip...
KubeVela control plane has been successfully set up on your cluster.
If you want to enable dashboard, please run "vela addon enable /Users/sunjianbo/.vela/addons/velaux"
Keep the token below if you want to restart the control plane
K1075e7f6c77555e6ebdaf4854e4a2f39ae4287cfad23f27cdac5b33608d44633fe::server:zSpzbdbGzVxOwfBvvjgT
🚀 Successfully install KubeVela control plane
🔭 See available commands with `vela help`
🔑 To access the cluster, set KUBECONFIG:
export KUBECONFIG=$(velad kubeconfig --name default --host)
```
</details>
#### 验证安装结果
设置 kubeconfig 并列出所有内置的组件定义:
```shell
export KUBECONFIG=$(velad kubeconfig --host)
vela comp
```
:::tip
- 执行 `velad install` 时，已经安装了 vela CLI (`vela`) 并自动添加到 `PATH`。 所以你可以直接使用它。
稍后我们将在本地机器上访问 KubeVela，我们将再次在本地机器上安装 vela CLI。
- 用于配置对集群的访问的文件称为 *kubeconfig 文件*，vela CLI也使用该文件访问 KubeVela。
:::
<details>
<summary>期望输出</summary>
```
NAME DEFINITION DESCRIPTION
config-helm-repository autodetects.core.oam.dev Config information to authenticate helm chart repository
daemon daemonsets.apps Describes daemonset services in Kubernetes.
cron-task cronjobs.batch Describes cron jobs that run code or a script to completion.
worker deployments.apps Describes long-running, scalable, containerized services
that running at backend. They do NOT have network endpoint
to receive external network traffic.
task jobs.batch Describes jobs that run code or a script to completion.
webservice deployments.apps Describes long-running, scalable, containerized services
that have a stable network endpoint to receive external
network traffic from customers.
config-image-registry autodetects.core.oam.dev Config information to authenticate image registry
k8s-objects autodetects.core.oam.dev K8s-objects allow users to specify raw K8s objects in
properties
raw autodetects.core.oam.dev Raw allow users to specify raw K8s object in properties.
This definition is DEPRECATED, please use 'k8s-objects'
instead.
ref-objects autodetects.core.oam.dev Ref-objects allow users to specify ref objects to use.
Notice that this component type have special handle logic.
```
</details>
### 3. 安装 VelaUX
VelaUX 是 KubeVela 的仪表板。 它是在你的集群中运行的 Web 应用程序。 你可以使用浏览器访问它。
如果你不使用 KubeVela 的 UI 控制台，可以跳过。
```shell script
vela addon enable ~/.vela/addons/velaux
```
<details>
<summary>期望输出</summary>
```
Addon: velaux enabled Successfully.
...
I0907 12:03:11.462606 98769 utils.go:156] find cluster gateway service vela-system/kubevela-cluster-gateway-service:9443
Please access addon-velaux from the following endpoints:
+---------+-----------+-------------------------------+----------------------------+-------+
| CLUSTER | COMPONENT | REF(KIND/NAMESPACE/NAME) | ENDPOINT | INNER |
+---------+-----------+-------------------------------+----------------------------+-------+
| local | apiserver | Service/vela-system/apiserver | apiserver.vela-system:8000 | true |
| local | velaux | Service/vela-system/velaux | http://47.252.17.47:30000 | false |
+---------+-----------+-------------------------------+----------------------------+-------+
```
</details>
通过添加 `serviceType=NodePort` 参数，我们告诉 VelaUX 通过 K8s
[NodePort](https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport) 的方式暴露服务。
使用以下命令查询 VelaUX 的端点：
```shell
vela status addon-velaux -n vela-system --endpoint
```
它将显示类似 `http://PUBLIC-IP:PORT` 的 URL。 你可以使用浏览器访问该 URL。
:::caution 开启端口
如果你使用的是云服务器，请在安全组中打开此端口。
:::
:::note
如需更多 VelaUX 选项，请参阅 [VelaUX 插件](../reference/addons/velaux) 文档了解其他高级安装参数。
:::
VelaUX 需要身份验证。 默认用户名是 `admin`，密码是 **`VelaUX12345`**。首次登录时需要使用新密码覆盖，请务必记住新密码。
### 4. 从本地访问 KubeVela (可选)
你可以使用本地计算机访问 KubeVela。 请确认在上一步服务器上执行 `velad install` 时加了 `--bind-ip` 参数。
#### 复制 kubeconfig
在远程服务器上执行如下命令，它将打印集群的 kubeconfig。 `--external` 表示打印的 kubeconfig 可以从其他机器使用（如你的本地机器）。
```shell
cat $(velad kubeconfig --external)
```
然后你需要手动把这个 kubeconfig 内容复制到你的本地机器的一个文件里。 假设你将这个文件保存在本地机器的 `~/.kube/velad-config` 中。
#### 在本地机器中安装 vela CLI
要访问集群，还需要在本地机器上安装 vela CLI (`vela`)。
```shell
curl -fsSl https://static.kubevela.net/script/install.sh | bash
```
#### 验证安装
设置 kubeconfig 并列出所有内置的组件定义:
```shell
export KUBECONFIG=$(velad kubeconfig --host)
vela comp
```
### 5. 清理
在远程服务器上运行如下命令。此命令将清理 KubeVela 控制器以及 Kubernetes 集群，有关更详细的步骤，请参阅 [高级指南](../platform-engineers/advanced-install#uninstall)。
```shell
velad uninstall
```

160
i18n/zh/docusaurus-plugin-content-docs/current/platform-engineers/advanced-install.mdx
View File

@ -1,166 +1,10 @@
---
title: 自定义安装和升级
title: 升级和高级安装选项
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
## 安装 KubeVela 生产环境
### 1. 安装条件:
- Kubernetes cluster >= v1.19 && <= v1.23
KubeVela 依赖 Kubernetes 作为管控平面，你需要自行搭建生产可用的 Kubernetes 集群，支持的方式包括：
- Alibaba Cloud [ACK Service](https://www.aliyun.com/product/kubernetes)
- AWS [EKS Service](https://aws.amazon.com/cn/eks)
- Azure [AKS Service](https://azure.microsoft.com/en-us/services/kubernetes-service)
- Google [GKE Service](https://cloud.google.com/kubernetes-engine)
- Rancher [K3s](https://rancher.com/docs/k3s/latest/en/quick-start/) or [RKE](https://github.com/rancher/rke/releases)
### 2. 安装 KubeVela 命令行
KubeVela CLI 提供了常用的集群和应用管理能力。
<Tabs
className="unique-tabs"
defaultValue="script"
values={[
{label: 'Script', value: 'script'},
{label: 'Homebrew', value: 'homebrew'},
{label: 'Download directly from releases', value: 'download'},
{label: 'Docker', value: 'docker'},
]}>
<TabItem value="script">
** MacOS/Linux **
```shell script
curl -fsSl https://kubevela.net/script/install.sh | bash
```
**Windows**
```shell script
powershell -Command "iwr -useb https://kubevela.net/script/install.ps1 | iex"
```
</TabItem>
<TabItem value="homebrew">
**macOS/Linux**
Update your brew first. Please note that the brew method only supports the installation of the official release version.
```shell script
brew update
```
Then install KubeVela CLI
```shell script
brew install kubevela
```
</TabItem>
<TabItem value="download">
- 通过 [release log](https://github.com/kubevela/kubevela/releases) 下载二进制压缩文件。
- 解压文件并将二进制文件移动到 $PATH 路径下。
```shell script
sudo mv ./vela /usr/local/bin/vela
```
> [Installation Tips](https://github.com/kubevela/kubevela/issues/625):
> If you are using a Mac system, it will pop up a warning that "vela" cannot be opened because the package from the developer cannot be verified.
>
> MacOS imposes stricter restrictions on the software that can run in the system. You can temporarily solve this problem by opening `System Preference ->Security & Privacy -> General` and clicking on `Allow Anyway`.
</TabItem>
<TabItem value="docker">
如果你需要在容器环境中使用 Vela CLI，我们提供了 CLI 镜像 `oamdev/vela-cli`:
```
$ docker run --rm -it -v ~/.kube:/root/.kube oamdev/vela-cli version
CLI Version: master
Core Version: v1.3.4
GitRevision: git-1d823780
GolangVersion: go1.17.10
```
参考 [使用 Vela CLI 镜像文档](./system-operation/vela-cli-image) 获取更多用法。
</TabItem>
</Tabs>
### 3. Install KubeVela Core
<Tabs
className="unique-tabs"
defaultValue="vela"
values={[
{label: 'Default', value: 'vela'},
{label: 'Helm', value: 'helm'},
]}>
<TabItem value="vela">
```shell script
$ vela install
```
<details> <summary> 正常安装出现下述日志 </summary>
```shell
...
Watching for changes to Job kubevela-vela-core-cluster-gateway-tls-secret-patch with timeout of 18m0s
Add/Modify event for kubevela-vela-core-cluster-gateway-tls-secret-patch: ADDED
kubevela-vela-core-cluster-gateway-tls-secret-patch: Jobs active: 0, jobs failed: 0, jobs succeeded: 0
Add/Modify event for kubevela-vela-core-cluster-gateway-tls-secret-patch: MODIFIED
kubevela-vela-core-cluster-gateway-tls-secret-patch: Jobs active: 1, jobs failed: 0, jobs succeeded: 0
Add/Modify event for kubevela-vela-core-cluster-gateway-tls-secret-patch: MODIFIED
kubevela-vela-core-cluster-gateway-tls-secret-patch: Jobs active: 1, jobs failed: 0, jobs succeeded: 0
Add/Modify event for kubevela-vela-core-cluster-gateway-tls-secret-patch: MODIFIED
Starting delete for "kubevela-vela-core-admission" ServiceAccount
Starting delete for "kubevela-vela-core-admission" ClusterRole
Starting delete for "kubevela-vela-core-admission" ClusterRoleBinding
Starting delete for "kubevela-vela-core-admission" Role
Starting delete for "kubevela-vela-core-admission" RoleBinding
Starting delete for "kubevela-vela-core-admission-patch" Job
Starting delete for "kubevela-vela-core-cluster-gateway-admission" ServiceAccount
Starting delete for "kubevela-vela-core-cluster-gateway-admission" Role
Starting delete for "kubevela-vela-core-cluster-gateway-admission" RoleBinding
Starting delete for "kubevela-vela-core-cluster-gateway-tls-secret-patch" Job
KubeVela control plane has been successfully set up on your cluster.
If you want to enable dashboard, please run "vela addon enable velaux"
```
</details>
</TabItem>
<TabItem value="helm">
如果你是 Helm 用户，你可以通过 Helm 命令完成 VelaCore 的安装和升级：
> helm v3.2.0+ required
```
helm repo add kubevela https://charts.kubevela.net/core
helm repo update
helm install --create-namespace -n vela-system kubevela kubevela/vela-core --wait
```
</TabItem>
</Tabs>
### 4 安装 VelaUX
请参考 [VelaUX 插件文档](../reference/addons/velaux).
## 升级
### 1. 升级 CLI
@ -249,7 +93,7 @@ vela install
vela addon enable velaux
```
## Uninstall
## 卸载
在卸载 KubeVela 之前，请确保已删除所有应用和禁用所有插件。

2
i18n/zh/docusaurus-plugin-content-docs/current/platform-engineers/components/component-terraform.md
View File

@ -13,7 +13,7 @@ Terraform 使用任意的云资源。
# 依赖
- [`vela` 命令行](../../install.mdx)
- [`vela` 命令行](../advanced-install#install-vela-cli)
## 开发 Terraform 资源或模块

9
i18n/zh/docusaurus-plugin-content-docs/version-v1.5.json
View File

@ -321,5 +321,14 @@
},
"sidebar.docs.category.Multi Cluster Delivery": {
"message": "多集群交付"
},
"sidebar.docs.doc.Standalone": {
"message": "无依赖独立安装"
},
"sidebar.docs.category.Installation": {
"message": "安装"
},
"sidebar.docs.doc.Kubernetes": {
"message": "基于 Kubernetes 安装"
}
}

152
i18n/zh/docusaurus-plugin-content-docs/version-v1.5/install.mdx
View File

@ -1,146 +1,24 @@
---
title: 快速安装
title: 安装概览
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
我们根据你的环境和使用方式提供了两种不同的 KubeVela 安装方式：
- 在 Kubernetes 集群上安装，请参考 [高级安装](./platform-engineers/advanced-install#install-kubevela-with-existing-kubernetes-cluster).
- 升级 KubeVela 请参考 [升级文档](./platform-engineers/advanced-install#upgrade).
### 没有 Kubernetes 集群？
## 1. 安装 VelaD
对于第一次接触 KubeVela 和 Kubernetes 的用户来说，使用独立模式安装 KubeVela 是最好的选择。独立安装模式无需了解 Kubernetes 知识即可尝试 KubeVela 的特性。
我们为此开发了 [VelaD](https://github.com/kubevela/velad)，把安装 KubeVela 以及其所需的 Kubernetes 等依赖打包为一个单独的可执行文件。
请跟随下面的文档链接完成安装：
[VelaD](https://github.com/kubevela/velad) 作为 KubeVela 的快速安装工具，帮助你在具有 Docker 的环境中快速一键完成安装。
- [独立安装](./installation/standalone): 在本地计算机上或一个远端的服务器（公有云或自己部署的）安装，支持 Linux，macOS 和 Windows。
- VelaD 继承了 [K3s](https://rancher.com/docs/k3s/latest/en/quick-start/) 和 [k3d](https://k3d.io/) 的能力，同时将 KubeVela 所需的制品整体打包。
- VelaD 可以帮助你在离线环境中完成安装。
- VelaD 目前仅适用于快速体验和测试开发， [生成环境安装请参考高级安装文档](./platform-engineers/advanced-install#install-kubevela-with-existing-kubernetes-cluster)。
:::info
VelaD 非常适合测试开发和快速体验，它利用 K3s 来提供集群。但是我们强烈建议在生产使用时，使用一个生产级别的 Kubernetes 集群安装 KubeVela，参考[集群安装](./installation/kubernetes)。
:::
### 前提条件
### 已有 Kubernetes 集群
- [集群安装](./installation/kubernetes): 在 Kubernetes 集群中安装 KubeVela
- Docker v20.10.5+ (runc >= v1.0.0-rc93) **or** Linux system
### 下载 VelaD
- ** MacOS/Linux **
```shell
curl -fsSl https://static.kubevela.net/script/install-velad.sh | bash
```
- **Windows**
```shell
powershell -Command "iwr -useb https://static.kubevela.net/script/install.ps1 | iex"
```
`velad` 和 `vela` 命令行工具将存储于 `/usr/local/bin/`，对于 Windows，存储于 `C:\vela\`。
### 一键安装
```shell
velad install
```
<details>
<summary>期望输出</summary>
```
Preparing K3s images...
Successfully prepare k3s image: /Users/sunjianbo/.vela/velad/k3s/k3s-airgap-images-amd64.tgz
Successfully prepare k3d images
...snip...
KubeVela control plane has been successfully set up on your cluster.
If you want to enable dashboard, please run "vela addon enable /Users/sunjianbo/.vela/addons/velaux"
Keep the token below if you want to restart the control plane
K1075e7f6c77555e6ebdaf4854e4a2f39ae4287cfad23f27cdac5b33608d44633fe::server:zSpzbdbGzVxOwfBvvjgT
🚀 Successfully install KubeVela control plane
🔭 See available commands with `vela help`
```
</details>
### 设置 KubeConfig
```
export KUBECONFIG=$(velad kubeconfig --host)
vela comp
```
<details>
<summary>期望输出</summary>
```
NAME DEFINITION DESCRIPTION
kustomize autodetects.core.oam.dev kustomize can fetching, building, updating and applying
Kustomize manifests from git repo.
helm autodetects.core.oam.dev helm release is a group of K8s resources from either git
repository or helm repo
config-helm-repository autodetects.core.oam.dev Config information to authenticate helm chart repository
yurt-helm autodetects.core.oam.dev helm release is a group of K8s resources from either git
repository or helm repo
daemon daemonsets.apps Describes daemonset services in Kubernetes.
cron-task cronjobs.batch Describes cron jobs that run code or a script to completion.
worker deployments.apps Describes long-running, scalable, containerized services
that running at backend. They do NOT have network endpoint
to receive external network traffic.
task jobs.batch Describes jobs that run code or a script to completion.
webservice deployments.apps Describes long-running, scalable, containerized services
that have a stable network endpoint to receive external
network traffic from customers.
clickhouse autodetects.core.oam.dev Clickhouse Component provision a clickhouse cluster.
config-image-registry autodetects.core.oam.dev Config information to authenticate image registry
k8s-objects autodetects.core.oam.dev K8s-objects allow users to specify raw K8s objects in
properties
raw autodetects.core.oam.dev Raw allow users to specify raw K8s object in properties.
This definition is DEPRECATED, please use 'k8s-objects'
instead.
ref-objects autodetects.core.oam.dev Ref-objects allow users to specify ref objects to use.
Notice that this component type have special handle logic.
```
</details>
## 2. 安装 VelaUX
VelaUX 是面向企业的应用交付控制台和可视化平台。
```shell script
vela addon enable ~/.vela/addons/velaux
```
<details>
<summary>期望输出</summary>
```
Addon: velaux enabled Successfully.
```
</details>
如果你是在本地执行安装，你可以通过以下方式快速访问到 VelaUX:
```
vela port-forward addon-velaux -n vela-system 8080:80
```
Choose `> local | velaux | velaux` for visit.
如果你是在远程主机安装或希望使用更稳固的访问方式，请参考 [VelaUX 高级安装说明](./reference/addons/velaux)。
VelaUX 是需要登陆认证的，默认管理员账号为 `admin` 密码为 **`VelaUX12345`**。请首次登陆成功后修改管理员密码并谨记。
## 3. 卸载
```
velad uninstall
```
此命令将删除 VelaD 安装的环境, 其他自定义方式安装的请参考 [KubeVela 卸载文档](./platform-engineers/advanced-install#uninstall)。
## 下一步
- [部署第一个应用](./quick-start)。
:::tip
- 要升级已有的 KubeVela，参考[升级文档](./platform-engineers/advanced-install#upgrade)。
:::

168
i18n/zh/docusaurus-plugin-content-docs/version-v1.5/installation/kubernetes.mdx Normal file
View File

@ -0,0 +1,168 @@
---
title: 在 Kubernetes 中安装 KubeVela
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
### 1. 安装条件:
- Kubernetes cluster >= v1.19 && <= v1.23
KubeVela 依赖 Kubernetes 作为管控平面，你需要自行搭建生产可用的 Kubernetes 集群，支持的方式包括：
- Alibaba Cloud [ACK Service](https://www.aliyun.com/product/kubernetes)
- AWS [EKS Service](https://aws.amazon.com/cn/eks)
- Azure [AKS Service](https://azure.microsoft.com/en-us/services/kubernetes-service)
- Google [GKE Service](https://cloud.google.com/kubernetes-engine)
- Rancher [K3s](https://rancher.com/docs/k3s/latest/en/quick-start/) or [RKE](https://github.com/rancher/rke/releases)
### 2. 安装 KubeVela 命令行 {#install-vela-cli}
KubeVela CLI 提供了常用的集群和应用管理能力。
<Tabs
className="unique-tabs"
defaultValue="script"
values={[
{label: 'Script', value: 'script'},
{label: 'Homebrew', value: 'homebrew'},
{label: 'Download directly from releases', value: 'download'},
{label: 'Docker', value: 'docker'},
]}>
<TabItem value="script">
** MacOS/Linux **
```shell script
curl -fsSl https://kubevela.net/script/install.sh | bash
```
**Windows**
```shell script
powershell -Command "iwr -useb https://kubevela.net/script/install.ps1 | iex"
```
</TabItem>
<TabItem value="homebrew">
**macOS/Linux**
首先更新你的 Homebrew。注意，使用 Homebrew 安装只支持安装正式 release 的版本。
```shell
brew update
```
安装 Vela CLI。
```shell
brew install kubevela
```
</TabItem>
<TabItem value="download">
- 通过 [release log](https://github.com/kubevela/kubevela/releases) 下载二进制压缩文件。
- 解压文件并将二进制文件移动到 $PATH 路径下。
```shell script
sudo mv ./vela /usr/local/bin/vela
```
> [安装提示](https://github.com/kubevela/kubevela/issues/625):
> 如果你使用的是 macOS，会弹出因为开发者的包无法验证，“vela”无法打开的警告。
>
> macOS 对可以在系统中运行的软件施加了更严格的限制。您可以通过打开“系统偏好设置 -> 安全和隐私 -> 常规”，并选择“从任何位置下载的程序”来临时解决此问题。
</TabItem>
<TabItem value="docker">
如果你需要在容器环境中使用 Vela CLI，我们提供了 CLI 镜像 `oamdev/vela-cli`:
```
$ docker run --rm -it -v ~/.kube:/root/.kube oamdev/vela-cli version
CLI Version: master
Core Version: v1.3.4
GitRevision: git-1d823780
GolangVersion: go1.17.10
```
参考 [使用 Vela CLI 镜像文档](../platform-engineers/system-operation/vela-cli-image) 获取更多用法。
</TabItem>
</Tabs>
### 3. 安装 KubeVela Core
<Tabs
className="unique-tabs"
defaultValue="vela"
values={[
{label: 'Default', value: 'vela'},
{label: 'Helm', value: 'helm'},
]}>
<TabItem value="vela">
```shell script
$ vela install
```
<details> <summary> 正常安装出现下述日志 </summary>
```shell
...
Watching for changes to Job kubevela-vela-core-cluster-gateway-tls-secret-patch with timeout of 18m0s
Add/Modify event for kubevela-vela-core-cluster-gateway-tls-secret-patch: ADDED
kubevela-vela-core-cluster-gateway-tls-secret-patch: Jobs active: 0, jobs failed: 0, jobs succeeded: 0
Add/Modify event for kubevela-vela-core-cluster-gateway-tls-secret-patch: MODIFIED
kubevela-vela-core-cluster-gateway-tls-secret-patch: Jobs active: 1, jobs failed: 0, jobs succeeded: 0
Add/Modify event for kubevela-vela-core-cluster-gateway-tls-secret-patch: MODIFIED
kubevela-vela-core-cluster-gateway-tls-secret-patch: Jobs active: 1, jobs failed: 0, jobs succeeded: 0
Add/Modify event for kubevela-vela-core-cluster-gateway-tls-secret-patch: MODIFIED
Starting delete for "kubevela-vela-core-admission" ServiceAccount
Starting delete for "kubevela-vela-core-admission" ClusterRole
Starting delete for "kubevela-vela-core-admission" ClusterRoleBinding
Starting delete for "kubevela-vela-core-admission" Role
Starting delete for "kubevela-vela-core-admission" RoleBinding
Starting delete for "kubevela-vela-core-admission-patch" Job
Starting delete for "kubevela-vela-core-cluster-gateway-admission" ServiceAccount
Starting delete for "kubevela-vela-core-cluster-gateway-admission" Role
Starting delete for "kubevela-vela-core-cluster-gateway-admission" RoleBinding
Starting delete for "kubevela-vela-core-cluster-gateway-tls-secret-patch" Job
KubeVela control plane has been successfully set up on your cluster.
If you want to enable dashboard, please run "vela addon enable velaux"
```
</details>
</TabItem>
<TabItem value="helm">
如果你是 Helm 用户，你可以通过 Helm 命令完成 VelaCore 的安装和升级：
> helm v3.2.0+ required
```
helm repo add kubevela https://charts.kubevela.net/core
helm repo update
helm install --create-namespace -n vela-system kubevela kubevela/vela-core --wait
```
</TabItem>
</Tabs>
### 4 安装 VelaUX
VelaUX 是 KubeVela 的仪表板。 它是在你的集群中运行的 Web 应用程序。 你可以使用浏览器访问它。
如果你不使用 KubeVela 的 UI 控制台，这是可选的。
请参考 [VelaUX 插件文档](../reference/addons/velaux).
### 5. 自定义安装或升级
请参考[升级和高级安装选项](../platform-engineers/advanced-install)

407
i18n/zh/docusaurus-plugin-content-docs/version-v1.5/installation/standalone.mdx Normal file
View File

@ -0,0 +1,407 @@
---
title: 独立安装 KubeVela
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
## 概览
本文档将向你展示如何以独立模式安装 KubeVela。 有两种选择：
1. [本地机器](#local)：在本地机器中安装，支持 Linux，macOS 和 Windows。
2. [远程 Linux 服务器](#remote)：在具有可访问IP地址的远程 Linux 服务器中安装
:::tip
在非 Linux 系统的远程服务器中安装 KubeVela 尚未经过完全测试。
:::
### VelaD 简介
以上两种选项中，我们都将使用 [VelaD](https://github.com/kubevela/velad) 来以独立模式安装 KubeVela。它是一个命令行工具，
将 KubeVela 最小安装以及使用 VelaUX 的一切依赖打包为一个可执行文件。你可以使用 VelaD 在安装有 Docker 的 macOS/Windows 中或 Linux 中安装 KubeVela。
- VelaD 集成了 [K3s](https://rancher.com/docs/k3s/latest/en/quick-start/) 和 [k3d](https://k3d.io/) 用于自动化管理 Kubernetes 集群，用户无需关心 Kubernetes 集群管理的细节。
- VelaD 打包了镜像等依赖，可以在没有网络的环境中最小化安装 KubeVela 以及其 VelaUX 插件。
:::caution
以独立模式安装仅适用于开发和测试目的，这时你无需了解其中的 Kubernetes。但是当你想要在生产中使用它时，你需要理解并维护 K3的维护。
:::
## 在本地机器上安装 {#local}
### 1. 准备环境
VelaD 支持在这些操作系统中安装 KubeVela：Linux, macOS, Windows。
**要求**
1. 如果你在使用 Linux 或者 macOS，确保你的机器上安装了 `curl`。
2. 如果你在使用 macOS or Windows, 确保你已经安装 [Docker Desktop](https://www.docker.com/products/docker-desktop)。
### 2. 安装 VelaD 和 KubeVela
#### 下载 VelaD
下面等脚本将下载二进制文件并将其放置在你的系统“PATH”中，
<Tabs className="unique-tabs">
<TabItem value="Linux">
在安装过程中你可能需要 root 权限。 如果你不需要 root 权限和自动化，你可以从[发布页面](https://github.com/kubevela/velad/releases)下载并手动解压缩。
```shell
curl -fsSl https://static.kubevela.net/script/install-velad.sh | bash
```
检查 `velad` 安装到 `/usr/local/bin/`
</TabItem>
<TabItem value="Windows">
以管理员身份启动 PowerShell 并执行如下命令:
```shell
powershell -Command "iwr -useb https://static.kubevela.net/script/install-velad.ps1 | iex"
```
检查 `velad` 安装到 `C:\vela\`
:::info
VelaD 会帮助安装 Vela CLI，这要求管理员权限。
:::
<details>
<summary>如何以管理员身份启动 PowerShell</summary>
1. 点击"开始"按钮打开开始菜单。
2. 在开始菜单中，向下滚动找到"Windows PowerShell"目录，右键点击其中的"Windows Powershell"选项，并选择"以管理员身份运行"。
</details>
</TabItem>
</Tabs>
#### 安装 KubeVela
```shell
velad install
```
<details>
<summary>期望输出</summary>
```
Preparing K3s images...
Successfully prepare k3s image: /Users/sunjianbo/.vela/velad/k3s/k3s-airgap-images-amd64.tgz
Successfully prepare k3d images
...snip...
KubeVela control plane has been successfully set up on your cluster.
If you want to enable dashboard, please run "vela addon enable /Users/sunjianbo/.vela/addons/velaux"
Keep the token below if you want to restart the control plane
K1075e7f6c77555e6ebdaf4854e4a2f39ae4287cfad23f27cdac5b33608d44633fe::server:zSpzbdbGzVxOwfBvvjgT
🚀 Successfully install KubeVela control plane
🔭 See available commands with `vela help`
```
</details>
#### 验证安装结果
设置 kubeconfig 并列出所有内置的组件定义:
<Tabs className="unique-tabs" groupId="os">
<TabItem label="Linux/macOS" value="unix">
```shell
export KUBECONFIG=$(velad kubeconfig --host)
vela comp
```
</TabItem>
<TabItem label="Windows" value="win">
```powershell
$env:PATH += ";$HOME\.vela\bin;"
$env:KUBECONFIG = $(velad kubeconfig --host)
vela comp
```
</TabItem>
</Tabs>
:::tip
- 在macOS/Linux中，执行 `velad install` 时，已经安装了 vela CLI (`vela`) 并自动添加到 `PATH`。 所以你可以直接使用它。
- 用于配置对集群的访问的文件称为 *kubeconfig 文件*
:::
<details>
<summary>期望输出</summary>
```
NAME DEFINITION DESCRIPTION
config-helm-repository autodetects.core.oam.dev Config information to authenticate helm chart repository
daemon daemonsets.apps Describes daemonset services in Kubernetes.
cron-task cronjobs.batch Describes cron jobs that run code or a script to completion.
worker deployments.apps Describes long-running, scalable, containerized services
that running at backend. They do NOT have network endpoint
to receive external network traffic.
task jobs.batch Describes jobs that run code or a script to completion.
webservice deployments.apps Describes long-running, scalable, containerized services
that have a stable network endpoint to receive external
network traffic from customers.
config-image-registry autodetects.core.oam.dev Config information to authenticate image registry
k8s-objects autodetects.core.oam.dev K8s-objects allow users to specify raw K8s objects in
properties
raw autodetects.core.oam.dev Raw allow users to specify raw K8s object in properties.
This definition is DEPRECATED, please use 'k8s-objects'
instead.
ref-objects autodetects.core.oam.dev Ref-objects allow users to specify ref objects to use.
Notice that this component type have special handle logic.
```
</details>
### 3. 安装 VelaUX
VelaUX 是 KubeVela 的仪表板。 它是在你的集群中运行的 Web 应用程序。 你可以使用浏览器访问它。
如果你不使用 KubeVela 的 UI 控制台，这是可选的。
<Tabs className="unique-tabs" groupId="os">
<TabItem label="Linux/macOS" value="unix">
```shell script
vela addon enable ~/.vela/addons/velaux
```
</TabItem>
<TabItem label="Windows" value="win">
```powershell
vela addon enable $HOME\.vela\addons\velaux
```
</TabItem>
</Tabs>
<details>
<summary>期望输出</summary>
```
Addon: velaux enabled Successfully.
```
</details>
默认情况下，velaux 没有任何暴露的端口，你可以通过以下方式查看：
```shell
vela port-forward addon-velaux -n vela-system 8080:80
```
选择 `> local | velaux | velaux` 来访问 VelaUX
:::note
如需更多 VelaUX 选项，请参阅 [VelaUX 插件](../reference/addons/velaux) 文档了解其他高级安装参数。
:::
VelaUX 需要身份验证。 默认用户名是 `admin`，密码是 **`VelaUX12345`**。首次登录时需要使用新密码覆盖，请务必记住新密码。
### 4. 清理
此命令将清理 KubeVela 控制器以及 Kubernetes 集群，有关更详细的步骤，请参阅 [高级指南](../platform-engineers/advanced-install#uninstall)。
```
velad uninstall
```
## 在远程服务器上安装 KubeVela
下面向你展示如何在远程服务器（如 aws EC2 或 阿里云 ECS）上以独立模式安装 KubeVela。
### 1.准备一台机器
准备一台 Linux 系统的远程服务器，对机器有如下要求
**要求**
1. 确保你的机器安装了 `curl`。
2. 此服务器有一个公网 IP，或者在企业内网中你可以访问该服务器的 IP。
3. 如果你使用的是云服务器，请确保你在安全组中打开了 6443 端口。
### 2. 安装 VelaD 和 KubeVela
#### 下载 VelaD
下面等脚本将下载二进制文件并将其放置在你的系统“PATH”中，
因此在安装过程中你可能需要 root 权限。
如果你不需要root权限和自动化，你可以从[发布页面](https://github.com/kubevela/velad/releases)下载并手动解压缩。
```shell
curl -fsSl https://static.kubevela.net/script/install-velad.sh | bash
```
检查 `velad` 已经安装到 `/usr/local/bin/`
#### 安装 KubeVela
运行以下命令并将`$SERVER_PUBLIC_IP`替换为服务器的公共 IP。
```shell
velad install --bind-ip=$SERVER_PUBLIC_IP
```
<details>
<summary>期望输出</summary>
```
Preparing K3s images...
Successfully prepare k3s image: /Users/sunjianbo/.vela/velad/k3s/k3s-airgap-images-amd64.tgz
Successfully prepare k3d images
...snip...
KubeVela control plane has been successfully set up on your cluster.
If you want to enable dashboard, please run "vela addon enable /Users/sunjianbo/.vela/addons/velaux"
Keep the token below if you want to restart the control plane
K1075e7f6c77555e6ebdaf4854e4a2f39ae4287cfad23f27cdac5b33608d44633fe::server:zSpzbdbGzVxOwfBvvjgT
🚀 Successfully install KubeVela control plane
🔭 See available commands with `vela help`
🔑 To access the cluster, set KUBECONFIG:
export KUBECONFIG=$(velad kubeconfig --name default --host)
```
</details>
#### 验证安装结果
设置 kubeconfig 并列出所有内置的组件定义:
```shell
export KUBECONFIG=$(velad kubeconfig --host)
vela comp
```
:::tip
- 执行 `velad install` 时，已经安装了 vela CLI (`vela`) 并自动添加到 `PATH`。 所以你可以直接使用它。
稍后我们将在本地机器上访问 KubeVela，我们将再次在本地机器上安装 vela CLI。
- 用于配置对集群的访问的文件称为 *kubeconfig 文件*，vela CLI也使用该文件访问 KubeVela。
:::
<details>
<summary>期望输出</summary>
```
NAME DEFINITION DESCRIPTION
config-helm-repository autodetects.core.oam.dev Config information to authenticate helm chart repository
daemon daemonsets.apps Describes daemonset services in Kubernetes.
cron-task cronjobs.batch Describes cron jobs that run code or a script to completion.
worker deployments.apps Describes long-running, scalable, containerized services
that running at backend. They do NOT have network endpoint
to receive external network traffic.
task jobs.batch Describes jobs that run code or a script to completion.
webservice deployments.apps Describes long-running, scalable, containerized services
that have a stable network endpoint to receive external
network traffic from customers.
config-image-registry autodetects.core.oam.dev Config information to authenticate image registry
k8s-objects autodetects.core.oam.dev K8s-objects allow users to specify raw K8s objects in
properties
raw autodetects.core.oam.dev Raw allow users to specify raw K8s object in properties.
This definition is DEPRECATED, please use 'k8s-objects'
instead.
ref-objects autodetects.core.oam.dev Ref-objects allow users to specify ref objects to use.
Notice that this component type have special handle logic.
```
</details>
### 3. 安装 VelaUX
VelaUX 是 KubeVela 的仪表板。 它是在你的集群中运行的 Web 应用程序。 你可以使用浏览器访问它。
如果你不使用 KubeVela 的 UI 控制台，可以跳过。
```shell script
vela addon enable ~/.vela/addons/velaux
```
<details>
<summary>期望输出</summary>
```
Addon: velaux enabled Successfully.
...
I0907 12:03:11.462606 98769 utils.go:156] find cluster gateway service vela-system/kubevela-cluster-gateway-service:9443
Please access addon-velaux from the following endpoints:
+---------+-----------+-------------------------------+----------------------------+-------+
| CLUSTER | COMPONENT | REF(KIND/NAMESPACE/NAME) | ENDPOINT | INNER |
+---------+-----------+-------------------------------+----------------------------+-------+
| local | apiserver | Service/vela-system/apiserver | apiserver.vela-system:8000 | true |
| local | velaux | Service/vela-system/velaux | http://47.252.17.47:30000 | false |
+---------+-----------+-------------------------------+----------------------------+-------+
```
</details>
通过添加 `serviceType=NodePort` 参数，我们告诉 VelaUX 通过 K8s
[NodePort](https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport) 的方式暴露服务。
使用以下命令查询 VelaUX 的端点：
```shell
vela status addon-velaux -n vela-system --endpoint
```
它将显示类似 `http://PUBLIC-IP:PORT` 的 URL。 你可以使用浏览器访问该 URL。
:::caution 开启端口
如果你使用的是云服务器，请在安全组中打开此端口。
:::
:::note
如需更多 VelaUX 选项，请参阅 [VelaUX 插件](../reference/addons/velaux) 文档了解其他高级安装参数。
:::
VelaUX 需要身份验证。 默认用户名是 `admin`，密码是 **`VelaUX12345`**。首次登录时需要使用新密码覆盖，请务必记住新密码。
### 4. 从本地访问 KubeVela (可选)
你可以使用本地计算机访问 KubeVela。 请确认在上一步服务器上执行 `velad install` 时加了 `--bind-ip` 参数。
#### 复制 kubeconfig
在远程服务器上执行如下命令，它将打印集群的 kubeconfig。 `--external` 表示打印的 kubeconfig 可以从其他机器使用（如你的本地机器）。
```shell
cat $(velad kubeconfig --external)
```
然后你需要手动把这个 kubeconfig 内容复制到你的本地机器的一个文件里。 假设你将这个文件保存在本地机器的 `~/.kube/velad-config` 中。
#### 在本地机器中安装 vela CLI
要访问集群，还需要在本地机器上安装 vela CLI (`vela`)。
```shell
curl -fsSl https://static.kubevela.net/script/install.sh | bash
```
#### 验证安装
设置 kubeconfig 并列出所有内置的组件定义:
```shell
export KUBECONFIG=$(velad kubeconfig --host)
vela comp
```
### 5. 清理
在远程服务器上运行如下命令。此命令将清理 KubeVela 控制器以及 Kubernetes 集群，有关更详细的步骤，请参阅 [高级指南](../platform-engineers/advanced-install#uninstall)。
```shell
velad uninstall
```

156
i18n/zh/docusaurus-plugin-content-docs/version-v1.5/platform-engineers/advanced-install.mdx
View File

@ -5,162 +5,6 @@ title: 自定义安装和升级
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
## 安装 KubeVela 生产环境
### 1. 安装条件:
- Kubernetes cluster >= v1.19 && <= v1.23
KubeVela 依赖 Kubernetes 作为管控平面，你需要自行搭建生产可用的 Kubernetes 集群，支持的方式包括：
- Alibaba Cloud [ACK Service](https://www.aliyun.com/product/kubernetes)
- AWS [EKS Service](https://aws.amazon.com/cn/eks)
- Azure [AKS Service](https://azure.microsoft.com/en-us/services/kubernetes-service)
- Google [GKE Service](https://cloud.google.com/kubernetes-engine)
- Rancher [K3s](https://rancher.com/docs/k3s/latest/en/quick-start/) or [RKE](https://github.com/rancher/rke/releases)
### 2. 安装 KubeVela 命令行
KubeVela CLI 提供了常用的集群和应用管理能力。
<Tabs
className="unique-tabs"
defaultValue="script"
values={[
{label: 'Script', value: 'script'},
{label: 'Homebrew', value: 'homebrew'},
{label: 'Download directly from releases', value: 'download'},
{label: 'Docker', value: 'docker'},
]}>
<TabItem value="script">
** MacOS/Linux **
```shell script
curl -fsSl https://kubevela.net/script/install.sh | bash
```
**Windows**
```shell script
powershell -Command "iwr -useb https://kubevela.net/script/install.ps1 | iex"
```
</TabItem>
<TabItem value="homebrew">
**macOS/Linux**
Update your brew first. Please note that the brew method only supports the installation of the official release version.
```shell script
brew update
```
Then install KubeVela CLI
```shell script
brew install kubevela
```
</TabItem>
<TabItem value="download">
- 通过 [release log](https://github.com/kubevela/kubevela/releases) 下载二进制压缩文件。
- 解压文件并将二进制文件移动到 $PATH 路径下。
```shell script
sudo mv ./vela /usr/local/bin/vela
```
> [Installation Tips](https://github.com/kubevela/kubevela/issues/625):
> If you are using a Mac system, it will pop up a warning that "vela" cannot be opened because the package from the developer cannot be verified.
>
> MacOS imposes stricter restrictions on the software that can run in the system. You can temporarily solve this problem by opening `System Preference ->Security & Privacy -> General` and clicking on `Allow Anyway`.
</TabItem>
<TabItem value="docker">
如果你需要在容器环境中使用 Vela CLI，我们提供了 CLI 镜像 `oamdev/vela-cli`:
```
$ docker run --rm -it -v ~/.kube:/root/.kube oamdev/vela-cli version
CLI Version: master
Core Version: v1.3.4
GitRevision: git-1d823780
GolangVersion: go1.17.10
```
参考 [使用 Vela CLI 镜像文档](./system-operation/vela-cli-image) 获取更多用法。
</TabItem>
</Tabs>
### 3. Install KubeVela Core
<Tabs
className="unique-tabs"
defaultValue="vela"
values={[
{label: 'Default', value: 'vela'},
{label: 'Helm', value: 'helm'},
]}>
<TabItem value="vela">
```shell script
$ vela install
```
<details> <summary> 正常安装出现下述日志 </summary>
```shell
...
Watching for changes to Job kubevela-vela-core-cluster-gateway-tls-secret-patch with timeout of 18m0s
Add/Modify event for kubevela-vela-core-cluster-gateway-tls-secret-patch: ADDED
kubevela-vela-core-cluster-gateway-tls-secret-patch: Jobs active: 0, jobs failed: 0, jobs succeeded: 0
Add/Modify event for kubevela-vela-core-cluster-gateway-tls-secret-patch: MODIFIED
kubevela-vela-core-cluster-gateway-tls-secret-patch: Jobs active: 1, jobs failed: 0, jobs succeeded: 0
Add/Modify event for kubevela-vela-core-cluster-gateway-tls-secret-patch: MODIFIED
kubevela-vela-core-cluster-gateway-tls-secret-patch: Jobs active: 1, jobs failed: 0, jobs succeeded: 0
Add/Modify event for kubevela-vela-core-cluster-gateway-tls-secret-patch: MODIFIED
Starting delete for "kubevela-vela-core-admission" ServiceAccount
Starting delete for "kubevela-vela-core-admission" ClusterRole
Starting delete for "kubevela-vela-core-admission" ClusterRoleBinding
Starting delete for "kubevela-vela-core-admission" Role
Starting delete for "kubevela-vela-core-admission" RoleBinding
Starting delete for "kubevela-vela-core-admission-patch" Job
Starting delete for "kubevela-vela-core-cluster-gateway-admission" ServiceAccount
Starting delete for "kubevela-vela-core-cluster-gateway-admission" Role
Starting delete for "kubevela-vela-core-cluster-gateway-admission" RoleBinding
Starting delete for "kubevela-vela-core-cluster-gateway-tls-secret-patch" Job
KubeVela control plane has been successfully set up on your cluster.
If you want to enable dashboard, please run "vela addon enable velaux"
```
</details>
</TabItem>
<TabItem value="helm">
如果你是 Helm 用户，你可以通过 Helm 命令完成 VelaCore 的安装和升级：
> helm v3.2.0+ required
```
helm repo add kubevela https://charts.kubevela.net/core
helm repo update
helm install --create-namespace -n vela-system kubevela kubevela/vela-core --wait
```
</TabItem>
</Tabs>
### 4 安装 VelaUX
请参考 [VelaUX 插件文档](../reference/addons/velaux).
## 升级
### 1. 升级 CLI

31
sidebars.js
View File

@ -1,4 +1,4 @@
const { Component } = require('react');
const {Component} = require('react');
module.exports = {
docs: [
@ -6,7 +6,34 @@ module.exports = {
type: 'category',
label: 'Getting Started',
collapsed: false,
items: ['getting-started/introduction', 'install', 'quick-start'],
items: [{
type: "doc",
id: 'getting-started/introduction'
}, {
type: "category",
collapsed: true,
label: "Installation",
link: {
type: "doc",
id: 'install'
},
items: [
{
type: "doc",
label: "Standalone",
id: 'installation/standalone'
},
{
type: "doc",
label: "Kubernetes",
id: 'installation/kubernetes'
}
]
}, {
type: "doc",
id: 'quick-start'
}
],
},
{
type: 'category',

168
versioned_docs/version-v1.5/install.mdx
View File

@ -1,154 +1,24 @@
---
title: Installation
title: Installation Overview
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
Here are two installation methods available according to your environment:
- For Installation from existing Kubernetes Cluster, please read the [advanced installation guide](./platform-engineers/advanced-install#install-kubevela-with-existing-kubernetes-cluster).
### Don't have Kubernetes cluster yet?
For those who are new to KubeVela and Kubernetes, installing KubeVela in standalone mode is the best choice. It doesn't require you to have any Kubernetes knowledge to experience KubeVela features.
We developed [VelaD](https://github.com/kubevela/velad) for this purpose, which packages KubeVela along its dependencies including Kubernetes into a single binary.
Please follow the document linked below to install KubeVela.
- [Standalone Installation](./installation/standalone): Install KubeVela on a local machine or a remote server(Public Cloud or On-premise) based on Linux, macOS or Windows operating system.
:::info
VelaD suits great for local development and quick demos, it leverages [K3s](https://github.com/k3s-io/k3s) to manage Kubernetes. We strongly recommend you to [install KubeVela with managed Kubernetes services](./installation/kubernetes) for production usage.
:::
### Already have Kubernetes cluster
- [Kubernetes Cluster](./installation/kubernetes): Install KubeVela in existing Kubernetes cluster.
:::tip
- For upgrading from existing KubeVela control plane, please read the [upgrade guide](./platform-engineers/advanced-install#upgrade).
## 1. Install VelaD
[VelaD](https://github.com/kubevela/velad) packages KubeVela with all dependencies that enables you to run KubeVela on any of docker compatible environments or linux system.
- VelaD provides Kubernetes by leveraging [K3s](https://rancher.com/docs/k3s/latest/en/quick-start/) on linux or [k3d](https://k3d.io/) on docker environment.
- KubeVela along with all related images, and `vela` command line are packaged together that enables air-gapped installation.
- **VelaD suits great for local development and quick demos, while we strongly recommend you to [install KubeVela with managed Kubernetes services](./platform-engineers/advanced-install#install-kubevela-with-existing-kubernetes-cluster) for production usage**.
### Prerequisites
- Docker v20.10.5+ (runc >= v1.0.0-rc93) **or** Linux system
### Download VelaD
It will download and place the binary in your system `PATH`,
so you may be required for root privilege during the installation process.
If you don't need the automation with root access, you can download from the [release page](https://github.com/kubevela/velad/releases) and uncompress manually.
- ** MacOS/Linux **
```shell
curl -fsSl https://static.kubevela.net/script/install-velad.sh | bash
```
- **Windows**
> Only the official release version is supported.
Run following command in powershell:
```shell
powershell -Command "iwr -useb https://static.kubevela.net/script/install-velad.ps1 | iex"
```
Check `velad` and `vela` command line tools are exist in `/usr/local/bin/` for MacOS/Linux or `C:\vela\` for Windows.
### Setup
```shell
velad install
```
<details>
<summary>expected output</summary>
```
Preparing K3s images...
Successfully prepare k3s image: /Users/sunjianbo/.vela/velad/k3s/k3s-airgap-images-amd64.tgz
Successfully prepare k3d images
...snip...
KubeVela control plane has been successfully set up on your cluster.
If you want to enable dashboard, please run "vela addon enable /Users/sunjianbo/.vela/addons/velaux"
Keep the token below if you want to restart the control plane
K1075e7f6c77555e6ebdaf4854e4a2f39ae4287cfad23f27cdac5b33608d44633fe::server:zSpzbdbGzVxOwfBvvjgT
🚀 Successfully install KubeVela control plane
🔭 See available commands with `vela help`
```
</details>
**Export the Kubernetes config **
```
export KUBECONFIG=$(velad kubeconfig --host)
vela comp
```
<details>
<summary>expected output</summary>
```
NAME DEFINITION DESCRIPTION
kustomize autodetects.core.oam.dev kustomize can fetching, building, updating and applying
Kustomize manifests from git repo.
helm autodetects.core.oam.dev helm release is a group of K8s resources from either git
repository or helm repo
config-helm-repository autodetects.core.oam.dev Config information to authenticate helm chart repository
yurt-helm autodetects.core.oam.dev helm release is a group of K8s resources from either git
repository or helm repo
daemon daemonsets.apps Describes daemonset services in Kubernetes.
cron-task cronjobs.batch Describes cron jobs that run code or a script to completion.
worker deployments.apps Describes long-running, scalable, containerized services
that running at backend. They do NOT have network endpoint
to receive external network traffic.
task jobs.batch Describes jobs that run code or a script to completion.
webservice deployments.apps Describes long-running, scalable, containerized services
that have a stable network endpoint to receive external
network traffic from customers.
clickhouse autodetects.core.oam.dev Clickhouse Component provision a clickhouse cluster.
config-image-registry autodetects.core.oam.dev Config information to authenticate image registry
k8s-objects autodetects.core.oam.dev K8s-objects allow users to specify raw K8s objects in
properties
raw autodetects.core.oam.dev Raw allow users to specify raw K8s object in properties.
This definition is DEPRECATED, please use 'k8s-objects'
instead.
ref-objects autodetects.core.oam.dev Ref-objects allow users to specify ref objects to use.
Notice that this component type have special handle logic.
```
</details>
## 2. Install VelaUX
> This is optional if you don't use UI console of KubeVela.
VelaUX is a dashboard including UI console and API services.
```shell script
vela addon enable ~/.vela/addons/velaux
```
<details>
<summary>expected output</summary>
```
Addon: velaux enabled Successfully.
```
</details>
By default, velaux didn't have any exposed port, If there is the browser in local, you can view it by:
```
vela port-forward addon-velaux -n vela-system 8080:80
```
Choose `> local | velaux | velaux` for visit.
If you are installing it in a remote environment such as a virtual machine, you can refer to [VelaUX addon](./reference/addons/velaux) document to expose an endpoint or other advanced installation arguments.
VelaUX needs authentication. The default username is `admin` and the password is **`VelaUX12345`**.
It requires you to override with a new password for the first login, please make sure to remember the new password.
## 3. Cleanup
```
velad uninstall
```
This command will clean up KubeVela controllers along with the Kubernetes cluster, refer to [the advanced guide](./platform-engineers/advanced-install#uninstall) for more detailed steps.
:::

172
versioned_docs/version-v1.5/installation/kubernetes.mdx Normal file
View File

@ -0,0 +1,172 @@
---
title: Install KubeVela on Kubernetes
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
### 1. Kubernetes Requirements:
- Kubernetes version >= v1.19 && <= v1.23
KubeVela relies on Kubernetes as a control plane. The control plane could be any managed Kubernetes offering or your own clusters, such as:
- Alibaba Cloud [ACK Service](https://www.aliyun.com/product/kubernetes)
- AWS [EKS Service](https://aws.amazon.com/cn/eks)
- Azure [AKS Service](https://azure.microsoft.com/en-us/services/kubernetes-service)
- Google [GKE Service](https://cloud.google.com/kubernetes-engine)
- Rancher [K3s](https://rancher.com/docs/k3s/latest/en/quick-start/) or [RKE](https://github.com/rancher/rke/releases)
### 2. Install KubeVela CLI {#install-vela-cli}
KubeVela CLI provides an easy to engage and manage your application delivery in command lines.
<Tabs
className="unique-tabs"
defaultValue="script"
values={[
{label: 'Script', value: 'script'},
{label: 'Homebrew', value: 'homebrew'},
{label: 'Download directly from releases', value: 'download'},
{label: 'Docker', value: 'docker'},
]}>
<TabItem value="script">
** MacOS/Linux **
```shell script
curl -fsSl https://kubevela.net/script/install.sh | bash
```
**Windows**
:::note
Only the official release version is supported.
:::
```shell script
powershell -Command "iwr -useb https://kubevela.net/script/install.ps1 | iex"
```
</TabItem>
<TabItem value="homebrew">
**macOS/Linux**
Update your brew first. Please note that the brew method only supports the installation of the official release version.
```shell script
brew update
```
Then install KubeVela CLI
```shell script
brew install kubevela
```
</TabItem>
<TabItem value="download">
- Download the latest `vela` binary file via [release log](https://github.com/kubevela/kubevela/releases).
- Unzip the binary file, and configure the environment variables in `$PATH`, and you're done.
```shell script
sudo mv ./vela /usr/local/bin/vela
```
:::note
- [Installation Tips](https://github.com/kubevela/kubevela/issues/625):
- If you are using a Mac system, it will pop up a warning that "vela" cannot be opened because the package from the developer cannot be verified.
- MacOS imposes stricter restrictions on the software that can run in the system. You can temporarily solve this problem by opening `System Preference ->Security & Privacy -> General` and clicking on `Allow Anyway`.
:::
</TabItem>
<TabItem value="docker">
If you have docker environment, you can easily run CLI with the vela CLI docker image called `oamdev/vela-cli`:
```
$ docker run --rm -it -v ~/.kube:/root/.kube oamdev/vela-cli version
CLI Version: master
Core Version: v1.3.4
GitRevision: git-1d823780
GolangVersion: go1.17.10
```
Refer to [using Vela CLI docker image](../platform-engineers/system-operation/vela-cli-image) for more usage.
</TabItem>
</Tabs>
### 3. Install KubeVela Core
<Tabs
className="unique-tabs"
defaultValue="vela"
values={[
{label: 'Default', value: 'vela'},
{label: 'Helm', value: 'helm'},
]}>
<TabItem value="vela">
```shell script
$ vela install
```
<details>
<summary> check out the outcome </summary>
```shell
...
Watching for changes to Job kubevela-vela-core-cluster-gateway-tls-secret-patch with timeout of 18m0s
Add/Modify event for kubevela-vela-core-cluster-gateway-tls-secret-patch: ADDED
kubevela-vela-core-cluster-gateway-tls-secret-patch: Jobs active: 0, jobs failed: 0, jobs succeeded: 0
Add/Modify event for kubevela-vela-core-cluster-gateway-tls-secret-patch: MODIFIED
kubevela-vela-core-cluster-gateway-tls-secret-patch: Jobs active: 1, jobs failed: 0, jobs succeeded: 0
Add/Modify event for kubevela-vela-core-cluster-gateway-tls-secret-patch: MODIFIED
kubevela-vela-core-cluster-gateway-tls-secret-patch: Jobs active: 1, jobs failed: 0, jobs succeeded: 0
Add/Modify event for kubevela-vela-core-cluster-gateway-tls-secret-patch: MODIFIED
Starting delete for "kubevela-vela-core-admission" ServiceAccount
Starting delete for "kubevela-vela-core-admission" ClusterRole
Starting delete for "kubevela-vela-core-admission" ClusterRoleBinding
Starting delete for "kubevela-vela-core-admission" Role
Starting delete for "kubevela-vela-core-admission" RoleBinding
Starting delete for "kubevela-vela-core-admission-patch" Job
Starting delete for "kubevela-vela-core-cluster-gateway-admission" ServiceAccount
Starting delete for "kubevela-vela-core-cluster-gateway-admission" Role
Starting delete for "kubevela-vela-core-cluster-gateway-admission" RoleBinding
Starting delete for "kubevela-vela-core-cluster-gateway-tls-secret-patch" Job
KubeVela control plane has been successfully set up on your cluster.
If you want to enable dashboard, please run "vela addon enable velaux"
```
</details>
</TabItem>
<TabItem value="helm">
If you are helm user, you can also use helm to install KubeVela core:
:::note
helm v3.2.0+ required
:::
```
helm repo add kubevela https://charts.kubevela.net/core
helm repo update
helm install --create-namespace -n vela-system kubevela kubevela/vela-core --wait
```
</TabItem>
</Tabs>
### 4. Install VelaUX
VelaUX is a dashboard for KubeVela. It is a web application that runs in your cluster. You can access it with your browser.
This is optional if you don't use UI console of KubeVela.
Please refer to [VelaUX Guide](../reference/addons/velaux).
### 5. Custom Installation or Upgrade
Please refer [advanced installation](../platform-engineers/advanced-install)

421
versioned_docs/version-v1.5/installation/standalone.mdx Normal file
View File

@ -0,0 +1,421 @@
---
title: Standalone Installation
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
## Overview
This documents will show you how to install KubeVela in standalone mode. There are two options:
1. [Local machine](#local): Install on a local machine based on Linux, macOS or Windows operating system.
2. [Remote Linux server](#remote): Install on a remote Linux server with accessible IP address.
:::tip
Install KubeVela on a remote server with non-linux operating system is not fully tested.
:::
### About VelaD
We'll use [VelaD](https://github.com/kubevela/velad) to install KubeVela in standalone mode. VelaD is a CLI tool that
packages KubeVela with all dependencies for minimal installation and VelaUX.
VelaD enables you to run KubeVela on any of docker compatible environments or Linux system.
- VelaD leverages [K3s](https://rancher.com/docs/k3s/latest/en/quick-start/) and [k3d](https://k3d.io/) to manage Kubernetes automatically. Users needn't care the details about Kubernetes.
- KubeVela along with all related images, and `vela` command line are packaged together that enables air-gapped installation of KubeVela and VelaUX.
:::caution
Installation with standalone mode is suited for development and testing purpose best that you don't even aware of the Kubernetes inside. If you want to use it in production, you need to understand and maintain the K3s for Kubernetes management well.
:::
## Install in a local machine {#local}
### 1. Prepare environment
VelaD support installing KubeVela on machines based on these OS: Linux, macOS, Windows.
**Requirements**
1. If you are using Linux or macOS, make sure your machine have `curl` installed.
2. If you are using macOS or Windows, make sure you've already installed [Docker](https://www.docker.com/products/docker-desktop).
### 2. Install VelaD and Setup KubeVela
#### Download VelaD
It will download and place the binary in your system `PATH`,
<Tabs className="unique-tabs" groupId="os">
<TabItem label="Linux/macOS" value="unix">
You may be required for root privilege during the installation process if not using root.
If you don't need the automation with root access, you can download from the [release page](https://github.com/kubevela/velad/releases) and uncompress manually.
```shell
curl -fsSl https://static.kubevela.net/script/install-velad.sh | bash
```
Check `velad` installed in `/usr/local/bin/`
</TabItem>
<TabItem label="Windows" value="win">
Run following command in powershell with administrator privilege.
```powershell
powershell -Command "iwr -useb https://static.kubevela.net/script/install-velad.ps1 | iex"
```
Check `velad` installed in `C:\vela\`
:::info
VelaD helps install Vela CLI, which requires administrator privilege.
:::
<details>
<summary>Start powershell as administrator</summary>
1. Click on the 'Start' button to open the Start menu.
2. Scroll to the Windows PowerShell shortcut folder then, right click on the Windows Powershell option and select 'Run as administrator'.
</details>
</TabItem>
</Tabs>
#### Setup KubeVela
```shell
velad install
```
<details>
<summary>expected output</summary>
```
Preparing K3s images...
Successfully prepare k3s image: /Users/sunjianbo/.vela/velad/k3s/k3s-airgap-images-amd64.tgz
Successfully prepare k3d images
...snip...
KubeVela control plane has been successfully set up on your cluster.
If you want to enable dashboard, please run "vela addon enable /Users/sunjianbo/.vela/addons/velaux"
Keep the token below if you want to restart the control plane
K1075e7f6c77555e6ebdaf4854e4a2f39ae4287cfad23f27cdac5b33608d44633fe::server:zSpzbdbGzVxOwfBvvjgT
🚀 Successfully install KubeVela control plane
🔭 See available commands with `vela help`
```
</details>
#### Verify Installation
Export kubeconfig and list all built-in ComponentDefinition:
<Tabs className="unique-tabs" groupId="os">
<TabItem label="Linux/macOS" value="unix">
```shell
export KUBECONFIG=$(velad kubeconfig --host)
vela comp
```
</TabItem>
<TabItem label="Windows" value="win">
```powershell
$env:PATH += ";$HOME\.vela\bin;"
$env:KUBECONFIG = $(velad kubeconfig --host)
vela comp
```
</TabItem>
</Tabs>
:::tip
- When executing `velad install`, vela CLI (`vela`) is already installed and add to `PATH` automatically. So you can use it directly.
- A file uesd to configure access to clusters is called *kubeconfig file*
:::
<details>
<summary>expected output</summary>
```
NAME DEFINITION DESCRIPTION
config-helm-repository autodetects.core.oam.dev Config information to authenticate helm chart repository
daemon daemonsets.apps Describes daemonset services in Kubernetes.
cron-task cronjobs.batch Describes cron jobs that run code or a script to completion.
worker deployments.apps Describes long-running, scalable, containerized services
that running at backend. They do NOT have network endpoint
to receive external network traffic.
task jobs.batch Describes jobs that run code or a script to completion.
webservice deployments.apps Describes long-running, scalable, containerized services
that have a stable network endpoint to receive external
network traffic from customers.
config-image-registry autodetects.core.oam.dev Config information to authenticate image registry
k8s-objects autodetects.core.oam.dev K8s-objects allow users to specify raw K8s objects in
properties
raw autodetects.core.oam.dev Raw allow users to specify raw K8s object in properties.
This definition is DEPRECATED, please use 'k8s-objects'
instead.
ref-objects autodetects.core.oam.dev Ref-objects allow users to specify ref objects to use.
Notice that this component type have special handle logic.
```
</details>
Export kubeconfig and list all built-in ComponentDefinition:
### 3. Install VelaUX
VelaUX is a dashboard for KubeVela. It is a web application that runs in your cluster. You can access it with your browser.
This is optional if you don't use UI console of KubeVela.
<Tabs className="unique-tabs" groupId="os">
<TabItem label="Linux/macOS" value="unix">
```shell script
vela addon enable ~/.vela/addons/velaux
```
</TabItem>
<TabItem label="Windows" value="win">
```powershell
vela addon enable $HOME\.vela\addons\velaux
```
</TabItem>
</Tabs>
<details>
<summary>expected output</summary>
```
Addon: velaux enabled Successfully.
```
</details>
By default, velaux don't have any exposed port, you can view it by:
```shell
vela port-forward addon-velaux -n vela-system 8080:80
```
Choose `> local | velaux | velaux` for visit.
:::note
For more VelaUX options, refer to [VelaUX addon](../reference/addons/velaux) document for other advanced installation arguments.
:::
VelaUX needs authentication. The default username is `admin` and the password is **`VelaUX12345`**.
It requires you to override with a new password for the first login, please make sure to remember the new password.
### 4. Cleanup
This command will clean up KubeVela controllers along with the Kubernetes cluster, refer to [the advanced guide](../platform-engineers/advanced-install#uninstall) for more detailed steps.
```
velad uninstall
```
## Install on a remote Linux server {#remote}
This documents show you how to install KubeVela on a remote Linux server (e.g. aws EC2 or aliyun ECS) in standalone mode.
### 1. Prepare a machine
Prepare a Linux server, make sure it meets the following requirements:
**Requirements**
1. Make sure your machine have `curl` installed.
2. This server has a public IP, or you can access the server's IP if it's a on-premise server.
3. If you are using a cloud server, make sure you have opened the port 6443 in secure group.
### 2. Install VelaD and Setup KubeVela
#### Download VelaD
Following script will download and place the binary in your system `PATH`,
so you may be required for root privilege during the installation process.
If you don't need the automation with root access, you can download from the [release page](https://github.com/kubevela/velad/releases) and uncompress manually.
```shell
curl -fsSl https://static.kubevela.net/script/install-velad.sh | bash
```
Check `velad` installed in `/usr/local/bin/`
#### Setup KubeVela
Run the following command and replace the `$SERVER_PUBLIC_IP` with your server's public IP.
```shell
velad install --bind-ip=$SERVER_PUBLIC_IP
```
<details>
<summary>expected output</summary>
```
Preparing K3s images...
Successfully prepare k3s image: /Users/sunjianbo/.vela/velad/k3s/k3s-airgap-images-amd64.tgz
Successfully prepare k3d images
...snip...
KubeVela control plane has been successfully set up on your cluster.
If you want to enable dashboard, please run "vela addon enable /Users/sunjianbo/.vela/addons/velaux"
Keep the token below if you want to restart the control plane
K1075e7f6c77555e6ebdaf4854e4a2f39ae4287cfad23f27cdac5b33608d44633fe::server:zSpzbdbGzVxOwfBvvjgT
🚀 Successfully install KubeVela control plane
🔭 See available commands with `vela help`
🔑 To access the cluster, set KUBECONFIG:
export KUBECONFIG=$(velad kubeconfig --name default --host)
```
</details>
#### Verify Installation
Export kubeconfig and list all built-in ComponentDefinition:
```shell
export KUBECONFIG=$(velad kubeconfig --host)
vela comp
```
:::tip
- When executing `velad install`, vela CLI (`vela`) is already installed and add to `PATH` automatically. So you can use it directly.
Later we will access KubeVela on local machine, we will install vela CLI on local machine again.
- A file uesd to configure access to clusters is called *kubeconfig file*. Vela CLI also use this file to access KubeVela.
:::
<details>
<summary>expected output</summary>
```
NAME DEFINITION DESCRIPTION
config-helm-repository autodetects.core.oam.dev Config information to authenticate helm chart repository
daemon daemonsets.apps Describes daemonset services in Kubernetes.
cron-task cronjobs.batch Describes cron jobs that run code or a script to completion.
worker deployments.apps Describes long-running, scalable, containerized services
that running at backend. They do NOT have network endpoint
to receive external network traffic.
task jobs.batch Describes jobs that run code or a script to completion.
webservice deployments.apps Describes long-running, scalable, containerized services
that have a stable network endpoint to receive external
network traffic from customers.
config-image-registry autodetects.core.oam.dev Config information to authenticate image registry
k8s-objects autodetects.core.oam.dev K8s-objects allow users to specify raw K8s objects in
properties
raw autodetects.core.oam.dev Raw allow users to specify raw K8s object in properties.
This definition is DEPRECATED, please use 'k8s-objects'
instead.
ref-objects autodetects.core.oam.dev Ref-objects allow users to specify ref objects to use.
Notice that this component type have special handle logic.
```
</details>
### 3. Install VelaUX
VelaUX is a dashboard for KubeVela. It is a web application that runs in your cluster. You can access it with your browser.
Run this command on remote server.
```shell
vela addon enable ~/.vela/addons/velaux serviceType=NodePort
```
<details>
<summary>expected output</summary>
```
Addon: velaux enabled Successfully.
...
I0907 12:03:11.462606 98769 utils.go:156] find cluster gateway service vela-system/kubevela-cluster-gateway-service:9443
Please access addon-velaux from the following endpoints:
+---------+-----------+-------------------------------+----------------------------+-------+
| CLUSTER | COMPONENT | REF(KIND/NAMESPACE/NAME) | ENDPOINT | INNER |
+---------+-----------+-------------------------------+----------------------------+-------+
| local | apiserver | Service/vela-system/apiserver | apiserver.vela-system:8000 | true |
| local | velaux | Service/vela-system/velaux | http://47.252.17.47:30000 | false |
+---------+-----------+-------------------------------+----------------------------+-------+
```
</details>
By adding `serviceType=NodePort`, we are telling VelaUX to expose service with K8s
[NodePort](https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport) type.
Check the endpoint of VelaUX with following command:
```shell
vela status addon-velaux -n vela-system --endpoint
```
It will show URL like `http://PUBLIC-IP:PORT` access that URL with your browser.
:::caution open the port
If you are using a cloud server, please open this port in secure group.
:::
:::note
For more VelaUX options, refer to [VelaUX addon](../reference/addons/velaux) document for other advanced installation arguments.
:::
VelaUX needs authentication. The default username is `admin` and the password is **`VelaUX12345`**.
It requires you to override with a new password for the first login, please make sure to remember the new password.
### 4. Access cluster From Local (Optional)
You can access KubeVela with your local machine. Make sure you add `--bind-ip` when executing `velad install` command in the last step on the server.
#### Copy KubeConfig
Following command will print the kubeconfig for your cluster. `--external` means printed kubeconfig can be used from other
machine (like your local machine).
```shell
cat $(velad kubeconfig --external)
```
Then you need to copy this kubeconfig to your local machine. Let's say you saving a file in `~/.kube/velad-config` in your local machine.
#### Install Vela CLI in Local
To access the cluster, you also need to install `vela` CLI in your local machine.
```shell
curl -fsSl https://static.kubevela.net/script/install.sh | bash
```
#### Access KubeVela
Export KUBECONFIG environment variable and list all built-in ComponentDefinition:
```shell
export KUBECONFIG=~/.kube/velad-config
vela comp
```
### 5. Cleanup
Run following command on remote server.
This command will clean up KubeVela controllers along with the Kubernetes cluster, refer to [the advanced guide](../platform-engineers/advanced-install#uninstall) for more detailed steps.
```shell
velad uninstall
```

160
versioned_docs/version-v1.5/platform-engineers/advanced-install.mdx
View File

@ -5,166 +5,6 @@ title: Custom Installation/Upgrade
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
## Install KubeVela with Existing Kubernetes cluster
### 1. Prerequisites:
- Kubernetes cluster >= v1.19 && <= v1.23
KubeVela relies on Kubernetes as a control plane. The control plane could be any managed Kubernetes offering or your own clusters, such as:
- Alibaba Cloud [ACK Service](https://www.aliyun.com/product/kubernetes)
- AWS [EKS Service](https://aws.amazon.com/cn/eks)
- Azure [AKS Service](https://azure.microsoft.com/en-us/services/kubernetes-service)
- Google [GKE Service](https://cloud.google.com/kubernetes-engine)
- Rancher [K3s](https://rancher.com/docs/k3s/latest/en/quick-start/) or [RKE](https://github.com/rancher/rke/releases)
> Please make sure one of the [ingress controllers](https://kubernetes.github.io/ingress-nginx/deploy/) is available in your Kubernetes cluster.
### 2. Install KubeVela CLI
KubeVela CLI provides an easy to engage and manage your application delivery in command lines.
<Tabs
className="unique-tabs"
defaultValue="script"
values={[
{label: 'Script', value: 'script'},
{label: 'Homebrew', value: 'homebrew'},
{label: 'Download directly from releases', value: 'download'},
{label: 'Docker', value: 'docker'},
]}>
<TabItem value="script">
** MacOS/Linux **
```shell script
curl -fsSl https://kubevela.net/script/install.sh | bash
```
**Windows**
> Only the official release version is supported.
```shell script
powershell -Command "iwr -useb https://kubevela.net/script/install.ps1 | iex"
```
</TabItem>
<TabItem value="homebrew">
**macOS/Linux**
Update your brew first. Please note that the brew method only supports the installation of the official release version.
```shell script
brew update
```
Then install KubeVela CLI
```shell script
brew install kubevela
```
</TabItem>
<TabItem value="download">
- Download the latest `vela` binary file via [release log](https://github.com/kubevela/kubevela/releases).
- Unzip the binary file, and configure the environment variables in `$PATH`, and you're done.
```shell script
sudo mv ./vela /usr/local/bin/vela
```
> [Installation Tips](https://github.com/kubevela/kubevela/issues/625):
> If you are using a Mac system, it will pop up a warning that "vela" cannot be opened because the package from the developer cannot be verified.
>
> MacOS imposes stricter restrictions on the software that can run in the system. You can temporarily solve this problem by opening `System Preference ->Security & Privacy -> General` and clicking on `Allow Anyway`.
</TabItem>
<TabItem value="docker">
If you have docker environment, you can easily run CLI with the vela CLI docker image called `oamdev/vela-cli`:
```
$ docker run --rm -it -v ~/.kube:/root/.kube oamdev/vela-cli version
CLI Version: master
Core Version: v1.3.4
GitRevision: git-1d823780
GolangVersion: go1.17.10
```
Refer to [using Vela CLI docker image](./system-operation/vela-cli-image) for more usage.
</TabItem>
</Tabs>
### 3. Install KubeVela Core
<Tabs
className="unique-tabs"
defaultValue="vela"
values={[
{label: 'Default', value: 'vela'},
{label: 'Helm', value: 'helm'},
]}>
<TabItem value="vela">
```shell script
$ vela install
```
<details> <summary> check out the outcome </summary>
```shell
...
Watching for changes to Job kubevela-vela-core-cluster-gateway-tls-secret-patch with timeout of 18m0s
Add/Modify event for kubevela-vela-core-cluster-gateway-tls-secret-patch: ADDED
kubevela-vela-core-cluster-gateway-tls-secret-patch: Jobs active: 0, jobs failed: 0, jobs succeeded: 0
Add/Modify event for kubevela-vela-core-cluster-gateway-tls-secret-patch: MODIFIED
kubevela-vela-core-cluster-gateway-tls-secret-patch: Jobs active: 1, jobs failed: 0, jobs succeeded: 0
Add/Modify event for kubevela-vela-core-cluster-gateway-tls-secret-patch: MODIFIED
kubevela-vela-core-cluster-gateway-tls-secret-patch: Jobs active: 1, jobs failed: 0, jobs succeeded: 0
Add/Modify event for kubevela-vela-core-cluster-gateway-tls-secret-patch: MODIFIED
Starting delete for "kubevela-vela-core-admission" ServiceAccount
Starting delete for "kubevela-vela-core-admission" ClusterRole
Starting delete for "kubevela-vela-core-admission" ClusterRoleBinding
Starting delete for "kubevela-vela-core-admission" Role
Starting delete for "kubevela-vela-core-admission" RoleBinding
Starting delete for "kubevela-vela-core-admission-patch" Job
Starting delete for "kubevela-vela-core-cluster-gateway-admission" ServiceAccount
Starting delete for "kubevela-vela-core-cluster-gateway-admission" Role
Starting delete for "kubevela-vela-core-cluster-gateway-admission" RoleBinding
Starting delete for "kubevela-vela-core-cluster-gateway-tls-secret-patch" Job
KubeVela control plane has been successfully set up on your cluster.
If you want to enable dashboard, please run "vela addon enable velaux"
```
</details>
</TabItem>
<TabItem value="helm">
If you are helm user, you can also use helm to install kubevela core:
> helm v3.2.0+ required
```
helm repo add kubevela https://charts.kubevela.net/core
helm repo update
helm install --create-namespace -n vela-system kubevela kubevela/vela-core --wait
```
</TabItem>
</Tabs>
### 4 Install VelaUX
Please refer to [VelaUX Guide](../reference/addons/velaux).
## Upgrade
> If you're trying to upgrade from a big version later (e.g. from 1.2.x to 1.4.x), please refer to [version migration](./system-operation/migration-from-old-version) for more guides.

32
versioned_sidebars/version-v1.5-sidebars.json
View File

@ -5,9 +5,35 @@
"label": "Getting Started",
"collapsed": false,
"items": [
"getting-started/introduction",
"install",
"quick-start"
{
"type": "doc",
"id": "getting-started/introduction"
},
{
"type": "category",
"collapsed": true,
"label": "Installation",
"link": {
"type": "doc",
"id": "install"
},
"items": [
{
"type": "doc",
"label": "Standalone",
"id": "installation/standalone"
},
{
"type": "doc",
"label": "Kubernetes",
"id": "installation/kubernetes"
}
]
},
{
"type": "doc",
"id": "quick-start"
}
]
},
{