Working with Helm charts
Overview
For details on Helm charts, refer to the official Helm documentation.
This page is mean to give some assistance working with Axual Helm charts.
Browse the Axual Helm charts
Refresh
After gaining access, new versions of the Axual Helm charts can be updated using the command helm repo update that will update all repositories.
Browse versions
When updated, browsing the Helm charts can be done through helm repo search axual-helm-stable. This returns an overview of all Helm charts within axual-helm-stable, for example:
NAME CHART VERSION APP VERSION DESCRIPTION axual-helm-stable/api-gateway 0.4.3 0.4.3 Helm Charts that deploy API Gateway axual-helm-stable/apicurio-registry 2.3.3 2.3.3 Helm Charts to deploy Apicurio Registry axual-helm-stable/axual-connect 0.2.0 0.2.0 A Helm chart for Axual Kafka Connect on Kubernetes axual-helm-stable/axual-governance 0.4.1 0.4.1 Axual Governance charts which install all Axual... axual-helm-stable/axual-governance-core 0.4.1 0.4.1 Axual Governance core which installs core Axual... axual-helm-stable/axual-operator 0.10.0 strimzi-0.34.0 Strimzi: Apache Kafka running on Kubernetes ...
Browse a single Chart
For this example we dive into the API Gateway component.
| The Helm README and values.yaml are synced into the component documentation, for example Api Gateway Helm Readme |
To get all different Helm chart versions for this component, run helm search repo axual-helm-stable/api-gateway -l, where the -l shows all versions.
NAME CHART VERSION APP VERSION DESCRIPTION axual-helm-stable/api-gateway 0.4.3 0.4.3 Helm Charts that deploy API Gateway axual-helm-stable/api-gateway 0.4.2 0.4.2 Helm Charts that deploy API Gateway axual-helm-stable/api-gateway 0.4.1 0.4.1 Helm Charts that deploy API Gateway axual-helm-stable/api-gateway 0.3.2 0.3.2 Helm Charts that deploy API Gateway axual-helm-stable/api-gateway 0.3.1 0.3.1 Helm Charts that deploy API Gateway axual-helm-stable/api-gateway 0.3.0 0.3.0 Helm Charts that deploy API Gateway axual-helm-stable/api-gateway 0.2.1 0.2.1 Helm Charts that deploy API Gateway axual-helm-stable/api-gateway 0.2.0 0.2.0 Helm Charts that deploy API Gateway axual-helm-stable/api-gateway 0.1.1 0.1.1 Helm Charts that deploy API Gateway axual-helm-stable/api-gateway 0.1.0 0.1.0 Helm Charts that deploy API Gateway
Now to get the full details, it is possible to download a particular version of the Chart archive for inspection of the values.yaml, values.schema.json or the templated Kubernetes resources by running helm pull axual-helm-stable/api-gateway --version 0.4.2
After a tar -xvf api-gateway-0.4.2.tgz you can get every detail of the Chart inside directory api-gateway:
ls -l api-gateway/* -rw-r--r--@ 1 user staff 198 27 Jun 10:11 api-gateway/Chart.yaml -rw-r--r--@ 1 user staff 11199 27 Jun 10:11 api-gateway/README.md -rw-r--r--@ 1 user staff 3114 27 Jun 10:11 api-gateway/values.local.yaml -rw-r--r--@ 1 user staff 19631 27 Jun 10:11 api-gateway/values.schema.json -rw-r--r--@ 1 user staff 10310 27 Jun 10:11 api-gateway/values.yaml api-gateway/templates: total 104 -rw-r--r--@ 1 user staff 1822 27 Jun 10:11 _helpers.tpl -rw-r--r--@ 1 user staff 254 27 Jun 10:11 configmap.yaml -rw-r--r--@ 1 user staff 4779 27 Jun 10:11 deployment.yaml -rw-r--r--@ 1 user staff 1000 27 Jun 10:11 hpa.yaml -rw-r--r--@ 1 user staff 1164 27 Jun 10:11 ingress.yaml -rw-r--r--@ 1 user staff 553 27 Jun 10:11 pdb.yaml -rw-r--r--@ 1 user staff 1454 27 Jun 10:11 prometheusrule.yaml -rw-r--r--@ 1 user staff 1289 27 Jun 10:11 route.yaml -rw-r--r--@ 1 user staff 290 27 Jun 10:11 secrets.yaml -rw-r--r--@ 1 user staff 460 27 Jun 10:11 service.yaml -rw-r--r--@ 1 user staff 499 27 Jun 10:11 serviceaccount.yaml -rw-r--r--@ 1 user staff 709 27 Jun 10:11 servicemonitor.yaml
From here you can access the README, Chart.yaml and values.yaml but also the templates used to construct Kubernetes resources, like the templates/deployment.yaml.
| If you notice any bugs, inconsistencies or missing features inside the Axual Helm charts, please notify us via Support. Thanks you in advance! |