Getting Started

In order to get started using Helm with Release you will need to add a few files to your repository. You will need to create the following files:
1
.release.yaml
2
.release/application-template.yaml
3
.release/environment-variables.yaml
Copied!
The .release.yaml is loaded during application creation. It defines where Release will look for the default application template and environment variables that will be used during application creation.
1
application_template: .release/application-template.yaml
2
environment_variables: .release/environment-variables.yaml
Copied!
This is an example .release.yaml file that will load .release/application-template.yaml and .release/environment-variables.yaml
The application-template.yaml is the default application template during application creation and is also used for deployment in gitops enabled applications.
1
---
2
app: elasticsearch-helm
3
auto_deploy: true
4
context: release-handsup-us-east-1
5
domain: elasticsearch-helm.rls.sh
6
mode: development
7
repo_name: awesome-release/elasticsearch-helm
8
environment_templates:
9
- name: ephemeral
10
- name: permanent
11
resources:
12
  cpu:
13
    limits: 1000m
14
    requests: 100m
15
  memory:
16
    limits: 1Gi
17
    requests: 100Mi
18
  replicas: 1
19
charts:
20
- name: elasticsearch
21
  add: elastic
22
  repo_url: https://helm.elastic.co
23
  directory: elasticsearch
24
  values: values.yaml
25
workflows:
26
- name: setup
27
  parallelize:
28
  - step: elasticsearch
29
    tasks:
30
    - charts.elasticsearch
31
- name: patch
32
  parallelize:
33
  - step: elasticsearch
34
    tasks:
35
    - charts.elasticsearch
Copied!
This is an application template that will deploy elasticsearch via Helm.
The environment-variables.yaml defines default environment variables that can be used by your application. This environment variables will be passed to your Helm charts and are used to populate your Helm values.yaml file.
1
---
2
defaults:
3
- key: ELASTICSEARCH_USERNAME
4
  value: elastic
5
  secret: false
6
- key: ELASTICSEARCH_PASSWORD
7
  value: supersecret
8
  secret: true
9
services: {}
Copied!
Here is an example environment-variables.yaml with a username and password that can be consumed by your Helm values.yaml
Once you have created and checked in the necessary files into your source control repository you are ready to create an application in Release. See Create Your Application to learn more about how to make an application in Release.

Reference documentation - Previous

Helm

Version Controlled Helm Charts

Last modified 3mo ago

Copy link