Fix: fix the error of link path
Signed-off-by: barnettZQG <barnett.zqg@gmail.com>
|  | @ -45,7 +45,7 @@ For learning how to program KubeVela in detail, please check the `Administrator | |||
| - Platform builders for PaaS, Serverless, Application Management/Delivery systems | ||||
| 	- KubeVela works as an application delivery engine that you could build your advanced platform with. | ||||
| - ISV, SaaS owners, and Application Architects who need to distribute software to anywhere | ||||
| 	- KubeVela has full extension and integration capabilities to allow users to distribute applications with [customized addons](./platform-engineers/addon/intro) easily. Think about an App Store but on Kubernetes and clouds. | ||||
| 	- KubeVela has full extension and integration capabilities to allow users to distribute applications with [customized addons](../platform-engineers/addon/intro) easily. Think about an App Store but on Kubernetes and clouds. | ||||
| - Application Developers, Operators, DevOps Engineers | ||||
| 	- VelaUX is an addon of KubeVela, with this addon enabled, it provides an out-of-box modern application Continuous Delivery (CD) and Management platform with an easy-to-use UI console. | ||||
| 
 | ||||
|  |  | |||
|  | @ -1,6 +1,5 @@ | |||
| --- | ||||
| title: Addon management | ||||
| slug: cli/addon/addon | ||||
| --- | ||||
| 
 | ||||
| You can get more capabilities from KubeVela ecosystem by installing addons. | ||||
|  | @ -320,7 +320,7 @@ output: { | |||
| 
 | ||||
| It's common that a component definition is composed by multiple API resources, for example, a `webserver` component that is composed by a Deployment and a Service. CUE is a great solution to achieve this in simplified primitives. | ||||
| 
 | ||||
| > Another approach to do composition in KubeVela of course is [using Helm](../helm/component). | ||||
| > Another approach to do composition in KubeVela of course is [using Helm](../../tutorials/helm). | ||||
| 
 | ||||
| ## How-to | ||||
| 
 | ||||
|  |  | |||
|  | @ -4,14 +4,13 @@ title:  获取更多运维特征 | |||
| 
 | ||||
| KubeVela 中的模块完全都是可定制和可插拔的,所以除了内置的运维能力之外,你还可以通过如下的方式添加更多你自己的运维能力。 | ||||
| 
 | ||||
| * 查看 [所有运维特征参考列表](./references)。 | ||||
| 
 | ||||
| ## 1. 查看 [所有运维特征参考列表](./references)。 | ||||
| * 通过 [安装插件](../../how-to/cli/addon/addon) 获得更多运维特征。 | ||||
| 
 | ||||
| ## 2. 通过 [安装插件](../../how-to/cli/addon/addon) 获得更多运维特征。 | ||||
| * 自定义扩展 | ||||
| 
 | ||||
| ## 3. 自定义扩展 | ||||
| 
 | ||||
| * 阅读[如何通过已经存在的 Definition 修改从而自定义组件类型](../../platform-engineers/cue/definition-edit)。 | ||||
| * [构建自己的能力](../../platform-engineers/cue/advanced) | ||||
|   * 阅读[如何通过已经存在的 Definition 修改从而自定义组件类型](../../platform-engineers/cue/definition-edit)。 | ||||
|   * [构建自己的能力](../../platform-engineers/cue/advanced) | ||||
|   学习从零开始构建运维特征。 | ||||
| * [构建自己的插件](../../platform-engineers/addon/intro)。  | ||||
|   * [构建`自己的插件](../../platform-engineers/addon/intro)。 | ||||
|  |  | |||
|  | @ -45,7 +45,7 @@ KubeVela 本身是一个的应用交付与管理控制平面,它架在 Kuberne | |||
| - 云原生应用平台的构建者、PaaS、Serverless 平台工程师、基础设施平台管理员: | ||||
|   - KubeVela 是一个普适的、高可扩展的应用交付引擎与内核,它以极简的架构实现了原生 Kubernetes 多集群控制平面的能力,能够将 OAM 应用引擎直接植入企业已有的 PaaS 平台之中并不破坏已有的能力,从而实现标准化应用交付。 | ||||
| - 第三方软件供应商(ISV)、垂直领域软件开发者、架构师: | ||||
|   - KubeVela 提供的充分的可扩展和集成能力,可以允许你[自定义插件](./platform-engineers/addon/intro) 完成复杂应用的构建和分发,是一个 Kubernetes 和云平台之上的应用商店(App Store)。 | ||||
|   - KubeVela 提供的充分的可扩展和集成能力,可以允许你[自定义插件](../platform-engineers/addon/intro) 完成复杂应用的构建和分发,是一个 Kubernetes 和云平台之上的应用商店(App Store)。 | ||||
| - 云原生时代的应用研发、运维人员、DevOps 工程师: | ||||
|   - VelaUX 是一个基于 Vela Addon 机制构建的扩展能力集,安装这个插件后,你就拥有了一个开箱即用的现代化持续交付(CD)和应用管理平台。 | ||||
| 
 | ||||
|  |  | |||
|  | @ -1,6 +1,5 @@ | |||
| --- | ||||
| title: 插件管理 | ||||
| slug: cli/addon/addon | ||||
| --- | ||||
| 
 | ||||
| 你可以通过安装 KubeVela 的插件(Addon)获取更多的系统功能。 | ||||
|  | @ -75,7 +74,6 @@ vela addon enable fluxcd --version=1.0.0 | |||
| vela addon enable <addon-name> --clusters={cluster1,cluster2} | ||||
| ``` | ||||
| 
 | ||||
| 
 | ||||
| 安装完成后,插件中的功能会以组件,运维特征,工作流步骤等形式呈现,你可以通过 `vela component`,`vela trait` 等命令查看新增的能力,也可以在[插件的参考文档](../../../reference/addons/overview)中查看每个官方插件对应的能力. | ||||
| 
 | ||||
| ### 删除/卸载已安装的插件 | ||||
|  | @ -141,4 +139,4 @@ Addon: velaux enabled Successfully | |||
| 
 | ||||
| ## 编写自己的插件包 | ||||
| 
 | ||||
| 请参考[插件包制作文档](../../../platform-engineers/addon/intro)。 | ||||
| 请参考[插件包制作文档](../../../platform-engineers/addon/intro)。 | ||||
|  | @ -4,14 +4,13 @@ title:  获取更多运维特征 | |||
| 
 | ||||
| KubeVela 中的模块完全都是可定制和可插拔的,所以除了内置的运维能力之外,你还可以通过如下的方式添加更多你自己的运维能力。 | ||||
| 
 | ||||
| * 查看 [所有运维特征参考列表](./references)。 | ||||
| 
 | ||||
| ## 1. 查看 [所有运维特征参考列表](./references)。 | ||||
| * 通过 [安装插件](../../how-to/cli/addon/addon) 获得更多运维特征。 | ||||
| 
 | ||||
| ## 2. 通过 [安装插件](../../how-to/cli/addon/addon) 获得更多运维特征。 | ||||
| * 自定义扩展 | ||||
| 
 | ||||
| ## 3. 自定义扩展 | ||||
| 
 | ||||
| * 阅读[如何通过已经存在的 Definition 修改从而自定义组件类型](../../platform-engineers/cue/definition-edit)。 | ||||
| * [构建自己的能力](../../platform-engineers/cue/advanced) | ||||
|   * 阅读[如何通过已经存在的 Definition 修改从而自定义组件类型](../../platform-engineers/cue/definition-edit)。 | ||||
|   * [构建自己的能力](../../platform-engineers/cue/advanced) | ||||
|   学习从零开始构建运维特征。 | ||||
| * [构建自己的插件](../../platform-engineers/addon/intro)。  | ||||
|   * [构建`自己的插件](../../platform-engineers/addon/intro)。 | ||||
|  |  | |||
|  | @ -45,7 +45,7 @@ KubeVela 本身是一个的应用交付与管理控制平面,它架在 Kuberne | |||
| - 云原生应用平台的构建者、PaaS、Serverless 平台工程师、基础设施平台管理员: | ||||
|   - KubeVela 是一个普适的、高可扩展的应用交付引擎与内核,它以极简的架构实现了原生 Kubernetes 多集群控制平面的能力,能够将 OAM 应用引擎直接植入企业已有的 PaaS 平台之中并不破坏已有的能力,从而实现标准化应用交付。 | ||||
| - 第三方软件供应商(ISV)、垂直领域软件开发者、架构师: | ||||
|   - KubeVela 提供的充分的可扩展和集成能力,可以允许你[自定义插件](./platform-engineers/addon/intro) 完成复杂应用的构建和分发,是一个 Kubernetes 和云平台之上的应用商店(App Store)。 | ||||
|   - KubeVela 提供的充分的可扩展和集成能力,可以允许你[自定义插件](../platform-engineers/addon/intro) 完成复杂应用的构建和分发,是一个 Kubernetes 和云平台之上的应用商店(App Store)。 | ||||
| - 云原生时代的应用研发、运维人员、DevOps 工程师: | ||||
|   - VelaUX 是一个基于 Vela Addon 机制构建的扩展能力集,安装这个插件后,你就拥有了一个开箱即用的现代化持续交付(CD)和应用管理平台。 | ||||
| 
 | ||||
|  |  | |||
|  | @ -1,6 +1,5 @@ | |||
| --- | ||||
| title: 插件管理 | ||||
| slug: cli/addon/addon | ||||
| --- | ||||
| 
 | ||||
| 你可以通过安装 KubeVela 的插件(Addon)获取更多的系统功能。 | ||||
|  | @ -75,7 +74,6 @@ vela addon enable fluxcd --version=1.0.0 | |||
| vela addon enable <addon-name> --clusters={cluster1,cluster2} | ||||
| ``` | ||||
| 
 | ||||
| 
 | ||||
| 安装完成后,插件中的功能会以组件,运维特征,工作流步骤等形式呈现,你可以通过 `vela component`,`vela trait` 等命令查看新增的能力,也可以在[插件的参考文档](../../../reference/addons/overview)中查看每个官方插件对应的能力. | ||||
| 
 | ||||
| ### 删除/卸载已安装的插件 | ||||
|  | @ -141,4 +139,4 @@ Addon: velaux enabled Successfully | |||
| 
 | ||||
| ## 编写自己的插件包 | ||||
| 
 | ||||
| 请参考[插件包制作文档](../../../platform-engineers/addon/intro)。 | ||||
| 请参考[插件包制作文档](../../../platform-engineers/addon/intro)。 | ||||
| Before Width: | Height: | Size: 340 KiB | 
| Before Width: | Height: | Size: 112 KiB | 
| Before Width: | Height: | Size: 97 KiB | 
| Before Width: | Height: | Size: 382 KiB | 
| Before Width: | Height: | Size: 140 KiB | 
| Before Width: | Height: | Size: 48 KiB | 
| Before Width: | Height: | Size: 274 KiB | 
| Before Width: | Height: | Size: 146 KiB | 
|  | @ -14,11 +14,11 @@ title: 单点登录 | |||
| 
 | ||||
| 要想使用 Dex,首先需要在插件页面中开启 Dex 插件: | ||||
| 
 | ||||
|  | ||||
|  | ||||
| 
 | ||||
| 开启完毕后,我们还需要更新一下 VelaUX 插件,打开其 Dex 选项。同样,我们在插件列表中找到 VelaUX,进行更新: | ||||
| 
 | ||||
|  | ||||
|  | ||||
| 
 | ||||
| ## 配置 Dex Connectors | ||||
| 
 | ||||
|  | @ -32,7 +32,7 @@ title: 单点登录 | |||
| 
 | ||||
| 完成 Oauth App 的创建后,在 Vela UX 的集成配置页面中,进行 Dex Connector 的配置。我们选择类型为 `GitHub`,并且设置对应 Oauth App 的 Client ID 以及 Client Secret,注意,此处的 Redirect URI 必须与之前在创建 Oauth App 时配置的 `[Vela UX 地址]/dex/callback` 保持一致。 | ||||
| 
 | ||||
|  | ||||
|  | ||||
| 
 | ||||
| ### 配置 LDAP Connector | ||||
| 
 | ||||
|  | @ -42,11 +42,11 @@ title: 单点登录 | |||
| 
 | ||||
| 选择 Connector 类型为 LDAP 后,在 Host 处填写 LDAP 服务器的地址,并且指定 BaseDN。 | ||||
| 
 | ||||
|  | ||||
|  | ||||
| 
 | ||||
| 如果你的 LDAP 没有提供匿名身份验证访问,那么你还需要打开高阶参数,填写 BindDN 和 BindPW,Connector 将使用这些信息进行用户的搜索。 | ||||
| 
 | ||||
|  | ||||
|  | ||||
| 
 | ||||
| > 关于更多类型的 Dex Connectors 配置,请查阅 [Dex Connectors 配置](../how-to/dashboard/config/dex-connectors) | ||||
| 
 | ||||
|  | @ -58,16 +58,16 @@ title: 单点登录 | |||
| 
 | ||||
| 配置完用户邮箱后,我们可以在平台配置页面中,将登录方式修改为 SSO 登录。 | ||||
| 
 | ||||
|  | ||||
|  | ||||
| 
 | ||||
| ### 使用单点登录 | ||||
| 
 | ||||
| 退出当前用户的登录,重新刷新页面,可以看到,我们已经进入了 Dex 的登录页面。 | ||||
| 
 | ||||
|  | ||||
|  | ||||
| 
 | ||||
| 你可以选择使用 GitHub 或者 LDAP 进行登录。进行选择后,授权此次登录: | ||||
| 
 | ||||
|  | ||||
|  | ||||
| 
 | ||||
| 至此,我们已经成功完成了使用 GitHub/LDAP 的单点登录。此时,如果登录的用户邮箱与之前本地登录的用户邮箱能够相互关联,新登入的用户将继承之前用户的权限。 | ||||
|  |  | |||
							
								
								
									
										13
									
								
								sidebars.js
								
								
								
								
							
							
						
						|  | @ -6,20 +6,13 @@ module.exports = { | |||
|       type: 'category', | ||||
|       label: 'Getting Started', | ||||
|       collapsed: false, | ||||
|       items: [ | ||||
|         'getting-started/introduction', | ||||
|         'install', | ||||
|         'quick-start', | ||||
|       ], | ||||
|       items: ['getting-started/introduction', 'install', 'quick-start'], | ||||
|     }, | ||||
|     { | ||||
|       type: 'category', | ||||
|       label: 'Basics', | ||||
|       collapsed: true, | ||||
|       items: [ | ||||
|         'getting-started/core-concept', | ||||
|         'getting-started/architecture', | ||||
|       ], | ||||
|       items: ['getting-started/core-concept', 'getting-started/architecture'], | ||||
|     }, | ||||
|     { | ||||
|       type: 'category', | ||||
|  | @ -112,7 +105,7 @@ module.exports = { | |||
|             'how-to/dashboard/target/overview', | ||||
|           ], | ||||
|         }, | ||||
|         'how-to/addon', | ||||
|         'how-to/cli/addon/addon', | ||||
|         { | ||||
|           'Install or upgrade': [ | ||||
|             'platform-engineers/system-operation/bootstrap-parameters', | ||||
|  |  | |||
|  | @ -45,7 +45,7 @@ For learning how to program KubeVela in detail, please check the `Administrator | |||
| - Platform builders for PaaS, Serverless, Application Management/Delivery systems | ||||
| 	- KubeVela works as an application delivery engine that you could build your advanced platform with. | ||||
| - ISV, SaaS owners, and Application Architects who need to distribute software to anywhere | ||||
| 	- KubeVela has full extension and integration capabilities to allow users to distribute applications with [customized addons](./platform-engineers/addon/intro) easily. Think about an App Store but on Kubernetes and clouds. | ||||
| 	- KubeVela has full extension and integration capabilities to allow users to distribute applications with [customized addons](../platform-engineers/addon/intro) easily. Think about an App Store but on Kubernetes and clouds. | ||||
| - Application Developers, Operators, DevOps Engineers | ||||
| 	- VelaUX is an addon of KubeVela, with this addon enabled, it provides an out-of-box modern application Continuous Delivery (CD) and Management platform with an easy-to-use UI console. | ||||
| 
 | ||||
|  |  | |||
|  | @ -1,6 +1,5 @@ | |||
| --- | ||||
| title: Addon management | ||||
| slug: cli/addon/addon | ||||
| --- | ||||
| 
 | ||||
| You can get more capabilities from KubeVela ecosystem by installing addons. | ||||
|  | @ -320,7 +320,7 @@ output: { | |||
| 
 | ||||
| It's common that a component definition is composed by multiple API resources, for example, a `webserver` component that is composed by a Deployment and a Service. CUE is a great solution to achieve this in simplified primitives. | ||||
| 
 | ||||
| > Another approach to do composition in KubeVela of course is [using Helm](../helm/component). | ||||
| > Another approach to do composition in KubeVela of course is [using Helm](../../tutorials/helm). | ||||
| 
 | ||||
| ## How-to | ||||
| 
 | ||||
|  |  | |||
| Before Width: | Height: | Size: 340 KiB | 
| Before Width: | Height: | Size: 112 KiB | 
| Before Width: | Height: | Size: 97 KiB | 
| Before Width: | Height: | Size: 382 KiB | 
| Before Width: | Height: | Size: 140 KiB | 
| Before Width: | Height: | Size: 48 KiB | 
| Before Width: | Height: | Size: 274 KiB | 
| Before Width: | Height: | Size: 146 KiB | 
|  | @ -14,11 +14,11 @@ After the platform is initialized, local login is used by default. Platform admi | |||
| 
 | ||||
| You need to enable the Dex Addon in the Addon list first to use SSO: | ||||
| 
 | ||||
|  | ||||
|  | ||||
| 
 | ||||
| After enabling the Dex Addon, we also need to upgrade the VelaUX addon and open its Dex option: | ||||
| 
 | ||||
|  | ||||
|  | ||||
| 
 | ||||
| ## Configure Dex Connectors | ||||
| 
 | ||||
|  | @ -31,7 +31,7 @@ Take GitHub Connector as an example, if you don't have a GitHub Oauth App, you n | |||
| 
 | ||||
| After creating the Oauth App, configure the Dex Connector in the integration configuration page. We choose the type `GitHub`, and set the Client ID and Client Secret corresponding to the Oauth App. Note that the Redirect URI here must be the same as the `[Vela UX address]/dex/callback` previously configured when the Oauth App was created. | ||||
| 
 | ||||
|  | ||||
|  | ||||
| 
 | ||||
| ### Configure LDAP Connector | ||||
| 
 | ||||
|  | @ -41,11 +41,11 @@ If you want to use LDAP for SSO, you need to set up the LDAP Connector first. | |||
| 
 | ||||
| After selecting the Connector type as LDAP, fill in the address of the LDAP server in `Host`, and specify `BaseDN`. | ||||
| 
 | ||||
|  | ||||
|  | ||||
| 
 | ||||
| If your LDAP does not provide anonymous authentication access, then you need to open the `Advanced Parameters`, fill in `BindDN` and `BindPW`, Connector will use these credentials for user search. | ||||
| 
 | ||||
|  | ||||
|  | ||||
| 
 | ||||
| > For more types of Dex Connectors, please refer to [Dex Connectors Configuration](../how-to/dashboard/config/dex-connectors). | ||||
| 
 | ||||
|  | @ -57,16 +57,16 @@ Since the newly logged in user does not have any permissions, we need to set an | |||
| 
 | ||||
| After configuring the user email, we can change the login method to SSO login in the platform configuration page. | ||||
| 
 | ||||
|  | ||||
|  | ||||
| 
 | ||||
| ## Use SSO Login | ||||
| 
 | ||||
| Log out and refresh the page again, you can see that we have entered the Dex login page. | ||||
| 
 | ||||
|  | ||||
|  | ||||
| 
 | ||||
| Then, you select GitHub or LDAP to login. | ||||
| 
 | ||||
|  | ||||
|  | ||||
| 
 | ||||
| So far, we have successfully completed SSO login with GitHub. At this point, if the email of the logged in user can be associated with the email of the previously logged in user, the newly logged in user will inherit the permissions of the previous user. | ||||
|  | @ -293,7 +293,7 @@ | |||
|         }, | ||||
|         { | ||||
|           "type": "doc", | ||||
|           "id": "version-v1.3/how-to/addon" | ||||
|           "id": "version-v1.3/how-to/cli/addon/addon" | ||||
|         }, | ||||
|         { | ||||
|           "collapsed": true, | ||||
|  | @ -536,4 +536,4 @@ | |||
|       "id": "version-v1.3/developers/references/devex/faq" | ||||
|     } | ||||
|   ] | ||||
| } | ||||
| } | ||||