fourierr / catalog

Catalog of community maintained components and traits.

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.

• 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.

How to use

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

Contribution

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

This doc will introduce how to make an KuebVela 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 which has been tested for enough can promote as a verified one.

• A verified Addon must have some basic important information.

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

  • A detail introduction for this addon in README.md for this addon as the documentation.

  • Better provide many useful examples in dir

Community

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