Version: v1.0
How-to
In this section, it will introduce how to declare Helm charts as components via ComponentDefinition
.
Before reading this part, please make sure you've learned the definition and template concepts.
#
Prerequisite- Make sure you have enabled Helm support in the installation guide.
ComponentDefinition
#
Declare Here is an example ComponentDefinition
about how to use Helm as schematic module.
In detail:
.spec.workload
is required to indicate the workload type of this Helm based component. Please also check for known limitations if you have multiple workloads packaged in one chart..spec.schematic.helm
contains information of Helmrelease
andrepository
which leveragesfluxcd/flux2
.- i.e. the spec of
release
aligns withHelmReleaseSpec
and spec ofrepository
aligns withHelmRepositorySpec
.
- i.e. the spec of
Application
#
Declare an Here is an example Application
.
The component properties
is exactly the overlay values of the Helm chart.
Deploy the application and after several minutes (it may take time to fetch Helm chart), you can check the Helm release is installed.
Check the workload defined in the chart has been created successfully.
Check the values (image.tag = 5.1.2
) from application's properties
are assigned to the chart.