Chore: install the latest version (#868)

Signed-off-by: barnettZQG <barnett.zqg@gmail.com>
This commit is contained in:
barnettZQG 2022-07-21 15:47:15 +08:00 committed by GitHub
parent 88e56298bf
commit 166d65dda8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
16 changed files with 312 additions and 81 deletions

View File

@ -29,7 +29,7 @@ If you don't need the automation with root access, you can download from the [re
- ** MacOS/Linux **
```shell
curl -fsSl https://static.kubevela.net/script/install-velad.sh | bash -s 1.4.6
curl -fsSl https://static.kubevela.net/script/install-velad.sh | bash
```
- **Windows**

View File

@ -39,7 +39,7 @@ KubeVela CLI provides an easy to engage and manage your application delivery in
** MacOS/Linux **
```shell script
curl -fsSl https://kubevela.net/script/install.sh | bash -s 1.4.6
curl -fsSl https://kubevela.net/script/install.sh | bash
```
**Windows**
@ -112,7 +112,7 @@ Refer to [using Vela CLI docker image](./system-operation/vela-cli-image) for mo
<TabItem value="vela">
```shell script
$ vela install --version v1.4.6
$ vela install
```
<details> <summary> check out the outcome </summary>
@ -155,7 +155,7 @@ If you are helm user, you can also use helm to install kubevela core:
```
helm repo add kubevela https://charts.kubevela.net/core
helm repo update
helm install --create-namespace -n vela-system kubevela kubevela/vela-core --version 1.4.6 --wait
helm install --create-namespace -n vela-system kubevela kubevela/vela-core --wait
```
</TabItem>
@ -185,7 +185,7 @@ Please refer to [VelaUX Guide](../reference/addons/velaux).
** MacOS/Linux **
```shell script
curl -fsSl https://kubevela.io/script/install.sh | bash -s 1.4.6
curl -fsSl https://kubevela.io/script/install.sh | bash
```
**Windows**
@ -243,16 +243,16 @@ docker pull oamdev/vela-cli:latest
### 2. Upgrade Vela Core
> Please make sure you already upgraded the Vela CLI to 1.4.1.
> Please make sure you already upgraded the Vela CLI to latest stable version.
```shell
vela install --version v1.4.6
vela install
```
### 3. Upgrade VelaUX
```shell
vela addon enable velaux version=v1.4.6
vela addon enable velaux
```
> If you set custom parameters during installation, be sure to include the corresponding parameters.

View File

@ -5,7 +5,7 @@ title: VelaUX
## Install
```shell script
vela addon enable velaux --version=v1.4.6
vela addon enable velaux
```
expected output:
@ -89,14 +89,87 @@ If you enabled the traefik addon, you can set the `gatewayDriver` parameter to u
vela addon enable velaux domain=example.doamin.com gatewayDriver=traefik
```
If you want to enable VelaUX with SSL:
1. Create the certificate configuration:
```shell
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
annotations:
config.oam.dev/alias: "VelaUX SSL Certificate"
labels:
app.oam.dev/source-of-truth: from-inner-system
config.oam.dev/catalog: velacore-config
config.oam.dev/type: config-tls-certificate
name: velaux-cert
namespace: vela-system
spec:
components:
- name: velaux
properties:
cert: <CERT_BASE64>
key: <KEY_BASE64>
type: config-tls-certificate
```
Please make sure the certificate matches the domain.
2. Enable VelaUX with domain
```shell
vela addon enable velaux domain=example.doamin.com gatewayDriver=traefik secretName=velaux-cert
```
## Setup with MongoDB database
VelaUX supports the Kubernetes and MongoDB as the database. the default is Kubernetes. We strongly advise using the MongoDB database to power your production environment.
VelaUX supports Kubernetes and MongoDB as the database. the default is Kubernetes. We strongly advise using the MongoDB database to power your production environment.
```shell script
vela addon enable velaux dbType=mongodb dbURL=mongodb://<MONGODB_USER>:<MONGODB_PASSWORD>@<MONGODB_URL>
```
You can also deploy the MongoDB with this application configuration:
> Your cluster must have a default storage class.
```yaml
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: velaux-db
namespace: vela-system
spec:
components:
- name: velaux-db
properties:
chart: mongodb
repoType: helm
url: https://charts.bitnami.com/bitnami
values:
persistence:
size: 20Gi
version: 12.1.12
type: helm
policies:
- name: vela-system
properties:
clusters:
- local
namespace: vela-system
type: topology
workflow:
steps:
- name: vela-system
properties:
policies:
- vela-system
type: deploy
```
After deployed, let's get the root password from the secret `vela-system/velaux-db-mongodb`.
## Specify the addon image
By default the image repo is docker hub, you can specify the image repo by the `repo` parameter:

View File

@ -25,7 +25,8 @@ module.exports = {
announcementBar: {
id: 'start',
content:
'⭐️ If you like KubeVela, give it a star on <a target="_blank" rel="noopener noreferrer" href="https://github.com/kubevela/kubevela">GitHub</a>! ⭐️',
'⭐️ If you like KubeVela, give it a star on <a target="_blank" rel="noopener noreferrer" href="https://github.com/kubevela/kubevela">GitHub</a>!⭐️' +
'<span style="color:#1b58f4">KubeVela v1.4.8 is already released.(2022-07-20)</span> <a target="_blank" rel="noopener noreferrer" href="https://github.com/kubevela/kubevela/releases/v1.4.8">Read Release Note</a>',
},
algolia: {
appId: 'PXMFHFWUGZ',
@ -56,25 +57,25 @@ module.exports = {
position: 'left',
},
{
to: "videos/best-practice/jenkins",
activeBasePath: "videos",
label: "Videos",
position: "left",
to: 'videos/best-practice/jenkins',
activeBasePath: 'videos',
label: 'Videos',
position: 'left',
},
{
href: "https://github.com/kubevela/community",
label: "Community",
position: "left",
href: 'https://github.com/kubevela/community',
label: 'Community',
position: 'left',
},
{
href: "https://github.com/kubevela/samples",
label: "Examples",
position: "left",
href: 'https://github.com/kubevela/samples',
label: 'Examples',
position: 'left',
},
{
href: "https://kubevela.net",
label: "Mirror",
position: "right",
href: 'https://kubevela.net',
label: 'Mirror',
position: 'right',
},
{
type: 'localeDropdown',
@ -156,9 +157,9 @@ module.exports = {
config: {
background: {
light: 'rgb(255, 255, 255)',
dark: 'rgb(50, 50, 50)'
}
}
dark: 'rgb(50, 50, 50)',
},
},
},
},
presets: [
@ -180,8 +181,8 @@ module.exports = {
anonymizeIP: false,
},
blog: {
blogSidebarTitle: "All posts",
blogSidebarCount: "ALL",
blogSidebarTitle: 'All posts',
blogSidebarCount: 'ALL',
showReadingTime: true,
editUrl: 'https://github.com/kubevela/kubevela.io/tree/main/',
},
@ -195,16 +196,16 @@ module.exports = {
[
'@docusaurus/plugin-content-docs',
{
id: "videos",
path: "videos",
routeBasePath: "videos",
include: ["**/*.md"],
sidebarPath: require.resolve("./sidebar-videos.js"),
id: 'videos',
path: 'videos',
routeBasePath: 'videos',
include: ['**/*.md'],
sidebarPath: require.resolve('./sidebar-videos.js'),
showLastUpdateAuthor: true,
showLastUpdateTime: true
showLastUpdateTime: true,
},
],
'./src/plugins/faviconCustomPlugin',
require.resolve("docusaurus-plugin-image-zoom"),
require.resolve('docusaurus-plugin-image-zoom'),
],
};

View File

@ -41,13 +41,13 @@ rm -rf versions.json.bak
success "update versions.json"
# 4 update docusaurus.config.js
sed -i.bak "/${version}/d" docusaurus.config.js
success "update docusaurus.config.js"
# sed -i.bak "/${version}/d" docusaurus.config.js
# success "update docusaurus.config.js"
# 5 generate versioned docs
yarn run docusaurus docs:version "${version}"
rm -rf docusaurus.config.js
mv docusaurus.config.js.bak docusaurus.config.js
# rm -rf docusaurus.config.js
# mv docusaurus.config.js.bak docusaurus.config.js
success "generate versioned docs"
# 6 update i18n docs

View File

@ -25,7 +25,7 @@ import TabItem from '@theme/TabItem';
- ** MacOS/Linux **
```shell
curl -fsSl https://static.kubevela.net/script/install-velad.sh | bash -s 1.4.6
curl -fsSl https://static.kubevela.net/script/install-velad.sh | bash
```
- **Windows**

View File

@ -37,7 +37,7 @@ KubeVela CLI 提供了常用的集群和应用管理能力。
** MacOS/Linux **
```shell script
curl -fsSl https://kubevela.net/script/install.sh | bash -s 1.4.6
curl -fsSl https://kubevela.net/script/install.sh | bash
```
**Windows**
@ -108,7 +108,7 @@ GolangVersion: go1.17.10
<TabItem value="vela">
```shell script
$ vela install --version v1.4.6
$ vela install
```
<details> <summary> 正常安装出现下述日志 </summary>
@ -179,7 +179,7 @@ helm install --create-namespace -n vela-system kubevela kubevela/vela-core --ver
** MacOS/Linux **
```shell script
curl -fsSl https://kubevela.io/script/install.sh | bash -s 1.4.6
curl -fsSl https://kubevela.io/script/install.sh | bash
```
**Windows**
@ -237,16 +237,16 @@ docker pull oamdev/vela-cli:latest
### 2. 升级 Vela Core
> 请先升级 Vela CLI 到 1.4.1+ 版本。
> 请先升级 Vela CLI 到最新的稳定版本,默认情况下将安装与 CLI 匹配的 Vela Core 版本。
```shell
vela install --version v1.4.6
vela install
```
### 3. 升级 VelaUX
```shell
vela addon enable velaux version=v1.4.6
vela addon enable velaux
```
## Uninstall

View File

@ -5,7 +5,7 @@ title: VelaUX 控制台
## 安装插件
```shell script
vela addon enable velaux --version=v1.4.6
vela addon enable velaux
```
期望得到的输出如下:

View File

@ -25,7 +25,7 @@ import TabItem from '@theme/TabItem';
- ** MacOS/Linux **
```shell
curl -fsSl https://static.kubevela.net/script/install-velad.sh | bash -s 1.4.6
curl -fsSl https://static.kubevela.net/script/install-velad.sh | bash
```
- **Windows**

View File

@ -37,7 +37,7 @@ KubeVela CLI 提供了常用的集群和应用管理能力。
** MacOS/Linux **
```shell script
curl -fsSl https://kubevela.net/script/install.sh | bash -s 1.4.6
curl -fsSl https://kubevela.net/script/install.sh | bash
```
**Windows**
@ -108,7 +108,7 @@ GolangVersion: go1.17.10
<TabItem value="vela">
```shell script
$ vela install --version v1.4.6
$ vela install
```
<details> <summary> 正常安装出现下述日志 </summary>
@ -179,7 +179,7 @@ helm install --create-namespace -n vela-system kubevela kubevela/vela-core --ver
** MacOS/Linux **
```shell script
curl -fsSl https://kubevela.io/script/install.sh | bash -s 1.4.6
curl -fsSl https://kubevela.io/script/install.sh | bash
```
**Windows**
@ -237,16 +237,16 @@ docker pull oamdev/vela-cli:latest
### 2. 升级 Vela Core
> 请先升级 Vela CLI 到 1.4.1+ 版本。
> 请先升级 Vela CLI 到最新的稳定版本,默认情况下将安装与 CLI 匹配的 Vela Core 版本。
```shell
vela install --version v1.4.6
vela install
```
### 3. 升级 VelaUX
```shell
vela addon enable velaux version=v1.4.6
vela addon enable velaux
```
## Uninstall

View File

@ -5,7 +5,7 @@ title: VelaUX 控制台
## 安装插件
```shell script
vela addon enable velaux --version=v1.4.6
vela addon enable velaux
```
期望得到的输出如下:

View File

@ -469,10 +469,9 @@ kustomize-strategy-merge trait provide strategy merge patch for kustomize compon
#### patchesStrategicMerge
+-----------+-------------+--------------------------------------------------------+----------+---------+
| NAME | DESCRIPTION | TYPE | REQUIRED | DEFAULT |
+-----------+-------------+--------------------------------------------------------+----------+---------+
| undefined | | map[string]{null|bool|string|bytes|{...}|[...]|number} | true | |
| NAME | DESCRIPTION | TYPE | REQUIRED | DEFAULT |
| --------- | ----------- | ------------------------------------------------------------ | -------- | ------- |
| undefined | | map[string]{null\|bool\|string\|bytes\|{...}\|[...]\|number} | true | |
### Examples
@ -624,14 +623,12 @@ The `sidecar` trait allows you to attach a sidecar container to the component.
### Parameters
+---------+-----------------------------------------+-----------------------+----------+---------+
| NAME | DESCRIPTION | TYPE | REQUIRED | DEFAULT |
+---------+-----------------------------------------+-----------------------+----------+---------+
| NAME | DESCRIPTION | TYPE | REQUIRED | DEFAULT |
| ------- | --------------------------------------- | --------------------- | -------- | ------- |
| name | Specify the name of sidecar container | string | true | |
| cmd | Specify the commands run in the sidecar | []string | false | |
| image | Specify the image of sidecar container | string | true | |
| volumes | Specify the shared volume path | [[]volumes](#volumes) | false | |
+---------+-----------------------------------------+-----------------------+----------+---------+
## volumes
@ -679,10 +676,3 @@ spec:
- name: varlog
path: /var/log
```

View File

@ -29,7 +29,7 @@ If you don't need the automation with root access, you can download from the [re
- ** MacOS/Linux **
```shell
curl -fsSl https://static.kubevela.net/script/install-velad.sh | bash -s 1.4.6
curl -fsSl https://static.kubevela.net/script/install-velad.sh | bash
```
- **Windows**

View File

@ -39,7 +39,7 @@ KubeVela CLI provides an easy to engage and manage your application delivery in
** MacOS/Linux **
```shell script
curl -fsSl https://kubevela.net/script/install.sh | bash -s 1.4.6
curl -fsSl https://kubevela.net/script/install.sh | bash
```
**Windows**
@ -112,7 +112,7 @@ Refer to [using Vela CLI docker image](./system-operation/vela-cli-image) for mo
<TabItem value="vela">
```shell script
$ vela install --version v1.4.6
$ vela install
```
<details> <summary> check out the outcome </summary>
@ -155,7 +155,7 @@ If you are helm user, you can also use helm to install kubevela core:
```
helm repo add kubevela https://charts.kubevela.net/core
helm repo update
helm install --create-namespace -n vela-system kubevela kubevela/vela-core --version 1.4.6 --wait
helm install --create-namespace -n vela-system kubevela kubevela/vela-core --wait
```
</TabItem>
@ -185,7 +185,7 @@ Please refer to [VelaUX Guide](../reference/addons/velaux).
** MacOS/Linux **
```shell script
curl -fsSl https://kubevela.io/script/install.sh | bash -s 1.4.6
curl -fsSl https://kubevela.io/script/install.sh | bash
```
**Windows**
@ -243,16 +243,16 @@ docker pull oamdev/vela-cli:latest
### 2. Upgrade Vela Core
> Please make sure you already upgraded the Vela CLI to 1.4.1.
> Please make sure you already upgraded the Vela CLI to latest stable version.
```shell
vela install --version v1.4.6
vela install
```
### 3. Upgrade VelaUX
```shell
vela addon enable velaux version=v1.4.6
vela addon enable velaux
```
> If you set custom parameters during installation, be sure to include the corresponding parameters.

View File

@ -0,0 +1,94 @@
---
title: netlify
---
# About this workload
- Netlify is a SaaS platform that can serve website especially for frontend service, it provides free allowances that was pretty cool to be used for demo and test. We can create an addon which provides a netlify component type for frontend service.
- This workload will launch a K8s job for deploying a fronten service to https://app.netlify.com/.
# Quick start
- Copy the following yaml to netlify-app.yaml, then vela up -f netlify-app.yaml
- The token can be got from https://app.netlify.com/user/applications/personal, and just like the following picture show
- https://user-images.githubusercontent.com/2173670/168455109-b6de6fcf-6e99-48c8-928c-03ff9f47d632.png
```shell
# Properties
+---------------+-----------------------------------------------------------------------------------------------+--------+----------+------------------------------------------------+
| NAME | DESCRIPTION | TYPE | REQUIRED | DEFAULT |
+---------------+-----------------------------------------------------------------------------------------------+--------+----------+------------------------------------------------+
| token | Specify the token got from app.netlify.com | string | true | |
| backofflimit | Specify the backofflimit of the job for deploying the website by netlify | int | true | |
| completions | Specify the completions of the job for deploying the website by netlify | int | true | |
| reponame | Specify the direcotry name for saving the resources from git or other repo supporting git-cli | string | true | |
| gitrepo | Specify the repo address your resources of the frontend service store | string | true | |
| restartPolicy | Specify the restartPolicy of the job for deploying the website by netlify | string | true | |
| sitname | Specify the website name on app.netlify.com | string | true | |
+---------------+-----------------------------------------------------------------------------------------------+--------+----------+------------------------------------------------+
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: netlify-app
namespace: default
spec:
components:
- name: netlify-comp
type: netlify
properties:
backofflimit: 5
completions: 1
reponame: <github reponame>
gitrepo: <github repo address>
restartPolicy: OnFailure
sitename: <sitename>
token: <Here needs your own token from https://app.netlify.com/user/applications/personal which you should base64 >
```
- Check the app status
```shell
vela ls netlify-app
APP COMPONENT TYPE TRAITS PHASE HEALTHY STATUS CREATED-TIME
netlify-app netlify-comp netlify running healthy 2022-06-14 23:42:43 +0800 CST
```
```shell
vela status netlify-app
About:
Name: netlify-app
Namespace: default
Created at: 2022-06-14 23:42:43 +0800 CST
Status: running
Workflow:
mode: DAG
finished: true
Suspend: false
Terminated: false
Steps
- id:k25g896t2o
name:netlify-comp
type:apply-component
phase:succeeded
message:
Services:
- Name: netlify-comp
Cluster: local Namespace: default
Type: netlify
Healthy
No trait applied
```
- Get the website url for visit
```shell
vela logs netlify-app -n default | grep "Website URL"
netlify-comp--1-b4fcg netlify-comp 2022-06-14T15:43:30.641036980Z Website URL: https://deploy-from-vela.netlify.app
```
- More info
- About the netlify-cli
- https://docs.netlify.com/
- About the SaaS Platform
- https://app.netlify.com/

View File

@ -5,7 +5,7 @@ title: VelaUX
## Install
```shell script
vela addon enable velaux --version=v1.4.6
vela addon enable velaux
```
expected output:
@ -89,14 +89,87 @@ If you enabled the traefik addon, you can set the `gatewayDriver` parameter to u
vela addon enable velaux domain=example.doamin.com gatewayDriver=traefik
```
If you want to enable VelaUX with SSL:
1. Create the certificate configuration:
```shell
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
annotations:
config.oam.dev/alias: "VelaUX SSL Certificate"
labels:
app.oam.dev/source-of-truth: from-inner-system
config.oam.dev/catalog: velacore-config
config.oam.dev/type: config-tls-certificate
name: velaux-cert
namespace: vela-system
spec:
components:
- name: velaux
properties:
cert: <CERT_BASE64>
key: <KEY_BASE64>
type: config-tls-certificate
```
Please make sure the certificate matches the domain.
2. Enable VelaUX with domain
```shell
vela addon enable velaux domain=example.doamin.com gatewayDriver=traefik secretName=velaux-cert
```
## Setup with MongoDB database
VelaUX supports the Kubernetes and MongoDB as the database. the default is Kubernetes. We strongly advise using the MongoDB database to power your production environment.
VelaUX supports Kubernetes and MongoDB as the database. the default is Kubernetes. We strongly advise using the MongoDB database to power your production environment.
```shell script
vela addon enable velaux dbType=mongodb dbURL=mongodb://<MONGODB_USER>:<MONGODB_PASSWORD>@<MONGODB_URL>
```
You can also deploy the MongoDB with this application configuration:
> Your cluster must have a default storage class.
```yaml
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: velaux-db
namespace: vela-system
spec:
components:
- name: velaux-db
properties:
chart: mongodb
repoType: helm
url: https://charts.bitnami.com/bitnami
values:
persistence:
size: 20Gi
version: 12.1.12
type: helm
policies:
- name: vela-system
properties:
clusters:
- local
namespace: vela-system
type: topology
workflow:
steps:
- name: vela-system
properties:
policies:
- vela-system
type: deploy
```
After deployed, let's get the root password from the secret `vela-system/velaux-db-mongodb`.
## Specify the addon image
By default the image repo is docker hub, you can specify the image repo by the `repo` parameter: