Skip to content

Latest commit

 

History

History
55 lines (29 loc) · 3.23 KB

README.md

File metadata and controls

55 lines (29 loc) · 3.23 KB
Raw

KubeVela Catalog

Introduction

This is repo of source files of community KubeVela addons which extend the capability of platform. An addoon can be a kubernetes operator and its X-definition such as Fluxcd or other useful components for KubeVela such as VelaUX.

Addons here contain verified addons which have been tested for a long time can be used in product environment and experimental addons which isn't general available yet.

  • Verified Addons: when a pull Request of addons were merged to this directory, the addon will automatically synced to the OSS bucket( https://addons.kubevela.net ). This will be displayed in vela CLI by vela addon list or VelaUX by default.

image

  • Experimental Addons: some addons which were not well verified will be merged into the experimental addons directory, the addon will also be synced to the OSS bucket( https://addons.kubevela.net in path experimental) automatically. 
    vela addon registry add experimental --type=helm --endpoint=https://addons.kubevela.net/experimental/

image

How to use

You can enable these addons by Vela cli or VelaUX. Please refer to doc for more infos.

History addon versions

Since any changes about one addon will upgrade the version, this repo's source files always are the latest version of addons, but you can find all other history versions' download url of an addon in https://addons.kubevela.net/index.yaml. Then you can download and enable them if you want.

Contribution

Community members are welcome to contribute this repo by putting their customize vela addons here.

This doc will introduce how to make an KubeVela addon and the mechanism behind it.

Please be aware of this contribution rules when contribute addons.

  • A new addon added in this repo should be put in as an experimental one unless you have test for a long time in your product environment and be approved by most maintainers.

  • An experimental addon must meet these conditions to be promoted as a verified one.

    • This addon must be tested by addon's e2e-test to guarantee this addon can be enabled successfully.

    • This addon must have some basic but necessary information.

      • An accessible icon url and source url defined in addon's metadata.yaml.

      • A detail introduction include a basic example about how to use and what's the benefit of this addon in README.md.

      • Also provide an introduction in KubeVela documentation.

      • It's more likely to be accepted if useful examples are provided in example dir.

Community

Welcome to KubeVela community. Refer to here for more info.