seacrew / helm-compose Goto Github PK

Helm Compose is a helm plugin for managing multiple releases of one or many charts within a single configuration file.

Home Page: https://seacrew.github.io/helm-compose/

License: Apache License 2.0

Makefile 2.66% Go 90.99% Shell 6.35%

helm plugin compose helm-plugin helm-plugins k8s kubernetes

helm-compose's Introduction

Helm Compose is a tool for managing multiple releases of one or many different Helm charts. It is heavily inspired by Docker Compose and is an extension of the package manager idea behind Helm itself. It allows for full configuration-as-code capabilities in an single yaml file.

Installation

It is requirement to use helm v3.10.0+.

Install a specific version of helm compose (recommended). Click here for the latest version.

helm plugin install https://github.com/seacrew/helm-compose --version 1.3.0

Install the latest version.

helm plugin install https://github.com/seacrew/helm-compose

Quick Start Guide

Helm Compose makes it easy to define a list of Releases and all necessary Repositories for the charts you use in a single compose file.

Install your releases:

$ helm compose up -f helm-compose.yaml

Uninstall your releases

$ helm compose down -f helm-compose.yaml

A Helm Compose file looks something like this:

apiVersion: 1.1

storage:
  name: mycompose
  type: local # default
  path: .hcstate # default

releases:
  wordpress:
    chart: bitnami/wordpress
    chartVersion: 14.3.2
  wordpress2:
    chart: bitnami/wordpress
    chartVersion: 15.2.22
    namespace: homepage
    createNamespace: true
  postgres:
    chart: bitnami/postgresql
    chartVersion: 12.1.9
    namespace: database
    createNamespace: true

repositories:
  bitnami: https://charts.bitnami.com/bitnami

Check out the examples directory.

Documentation

Checkout the complete documentation.

helm-compose's People

Contributors

Stargazers

Watchers

Forkers

dberuben

helm-compose's Issues

feat: Support helm template

Currently, helm compose doesn't work together with helm template.

Asset store

Workaround to store images without adding them to the actual git repository.

Logos SVG:

Banner SVG:
(Font: Ubuntu Mono)

Banner PNG:

No arm release?

feat: Revision Update

Hi,

The revision is updated even when there are no updates in the helm compose file.
It's possible to have revision updated only when there is some things new in the config?

(☸|lspay-trial-eu-west-1:default)➜  helm-compose helm compose up
helloworld5 |		Release "helloworld5" has been upgraded. Happy Helming!
helloworld5 |		NAME: helloworld5
helloworld5 |		LAST DEPLOYED: Thu Aug 31 15:51:04 2023
helloworld5 |		NAMESPACE: default
helloworld5 |		STATUS: deployed
helloworld5 |		REVISION: 7
helloworld5 |		TEST SUITE: None
helloworld4 |		Release "helloworld4" has been upgraded. Happy Helming!
helloworld4 |		NAME: helloworld4
helloworld4 |		LAST DEPLOYED: Thu Aug 31 15:51:04 2023
helloworld4 |		NAMESPACE: default
helloworld4 |		STATUS: deployed
helloworld4 |		REVISION: 7
helloworld4 |		TEST SUITE: None
helloworld7 |		Release "helloworld7" has been upgraded. Happy Helming!
helloworld7 |		NAME: helloworld7
helloworld7 |		LAST DEPLOYED: Thu Aug 31 15:51:04 2023
helloworld7 |		NAMESPACE: default
helloworld7 |		STATUS: deployed
helloworld7 |		REVISION: 7
helloworld7 |		TEST SUITE: None
helloworld6 |		Release "helloworld6" has been upgraded. Happy Helming!
helloworld6 |		NAME: helloworld6
helloworld6 |		LAST DEPLOYED: Thu Aug 31 15:51:04 2023
helloworld6 |		NAMESPACE: default
helloworld6 |		STATUS: deployed
helloworld6 |		REVISION: 7
helloworld6 |		TEST SUITE: None
helloworld3 |		Release "helloworld3" has been upgraded. Happy Helming!
helloworld3 |		NAME: helloworld3
helloworld3 |		LAST DEPLOYED: Thu Aug 31 15:51:04 2023
helloworld3 |		NAMESPACE: default
helloworld3 |		STATUS: deployed
helloworld3 |		REVISION: 7
helloworld3 |		TEST SUITE: None
helloworld1 |		Release "helloworld1" has been upgraded. Happy Helming!
helloworld1 |		NAME: helloworld1
helloworld1 |		LAST DEPLOYED: Thu Aug 31 15:51:04 2023
helloworld1 |		NAMESPACE: default
helloworld1 |		STATUS: deployed
helloworld1 |		REVISION: 7
helloworld1 |		TEST SUITE: None
helloworld2 |		Release "helloworld2" has been upgraded. Happy Helming!
helloworld2 |		NAME: helloworld2
helloworld2 |		LAST DEPLOYED: Thu Aug 31 15:51:04 2023
helloworld2 |		NAMESPACE: default
helloworld2 |		STATUS: deployed
helloworld2 |		REVISION: 7
helloworld2 |		TEST SUITE: None
(☸|lspay-trial-eu-west-1:default)➜  helm-compose helm ls
NAME       	NAMESPACE	REVISION	UPDATED                              	STATUS  	CHART            	APP VERSION
helloworld1	default  	7       	2023-08-31 15:51:04.050979 +0200 CEST	deployed	hello-world-0.6.0
helloworld2	default  	7       	2023-08-31 15:51:04.103239 +0200 CEST	deployed	hello-world-0.6.0
helloworld3	default  	7       	2023-08-31 15:51:04.141622 +0200 CEST	deployed	hello-world-0.6.0
helloworld4	default  	7       	2023-08-31 15:51:04.06492 +0200 CEST 	deployed	hello-world-0.6.0
helloworld5	default  	7       	2023-08-31 15:51:04.01752 +0200 CEST 	deployed	hello-world-0.6.0
helloworld6	default  	7       	2023-08-31 15:51:04.101631 +0200 CEST	deployed	hello-world-0.6.0
helloworld7	default  	7       	2023-08-31 15:51:04.143614 +0200 CEST	deployed	hello-world-0.6.0
(☸|lspay-trial-eu-west-1:default)➜  helm-compose helm compose list
| Date             | Revision |
| ---------------- | -------- |
| 2023-08-31 15:29 |        4 |
| 2023-08-31 15:30 |        5 |
| 2023-08-31 15:36 |        6 |
| 2023-08-31 15:45 |        7 |
| 2023-08-31 15:47 |        8 |
| 2023-08-31 15:48 |        9 |
| 2023-08-31 15:48 |       10 |
| 2023-08-31 15:49 |       11 |
| 2023-08-31 15:49 |       12 |
| 2023-08-31 15:51 |       13 |

apiVersion: 1.0

storage:
  name: mycompose
  type: local # default
  path: .hcstate # default

releases:
  helloworld1:
    chart: sikalabs/hello-world 
    values:
      replicas: 2
  helloworld2:
    chart: sikalabs/hello-world 
    values:
      replicas: 2
  helloworld3:
    chart: sikalabs/hello-world 
    values:
      TEXT:
        COUCOUL3: DANIELTEST
      replicas: 1
  helloworld4:
    chart: sikalabs/hello-world 
    values:
      replicas: 2
  helloworld5:
    chart: sikalabs/hello-world 
    values:
      TEXT:
        COUCOUL5: DANIELTEST
      replicas: 2
  helloworld6:
    chart: sikalabs/hello-world 
    values:
      replicas: 2
  helloworld7:
    chart: sikalabs/hello-world 
    values:
      replicas: 2
repositories:
  sikalabs: https://helm.sikalabs.io

apiVersion: 1.0

storage:
  name: mycompose
  type: local # default
  path: .hcstate # default

releases:
  wordpress:
    chart: bitnami/wordpress
    chartVersion: 14.3.2
    values:
      resources:
        limits:
          memory: 1G
          cpu: 1G
        requests:
          memory: 512Mi
          cpu: 300m
      replicaCount: 2
  wordpress2:
    chart: bitnami/wordpress
    chartVersion: 15.2.22
    namespace: default
    values:
      replicaCount: 3
  postgres:
    chart: bitnami/postgresql
    chartVersion: 12.1.9
    namespace: default

repositories:
  bitnami: https://charts.bitnami.com/bitnami

the output is

(☸|lspay-trial-eu-west-1:default)➜  helm-compose helm compose up
wordpress |		unknown flag: --set-json
wordpress2 |		unknown flag: --set-json
postgres |		Release "postgres" has been upgraded. Happy Helming!
postgres |		NAME: postgres
postgres |		LAST DEPLOYED: Thu Aug 31 10:53:05 2023
postgres |		NAMESPACE: default
postgres |		STATUS: deployed
postgres |		REVISION: 5
postgres |		TEST SUITE: None
postgres |		NOTES:
postgres |		CHART NAME: postgresql
postgres |		CHART VERSION: 12.1.9
postgres |		APP VERSION: 15.1.0
...

feat: new storage provider gcs - google bucket support

feat: only upgrade helm on change

Did I miss something?

(☸|lspay-trial-eu-west-1:default)➜  helm-compose-test helm ls
NAME       	NAMESPACE	REVISION	UPDATED                              	STATUS  	CHART            	APP VERSION
helloworld1	default  	4       	2023-09-01 15:56:18.159761 +0200 CEST	deployed	hello-world-0.6.0
helloworld2	default  	4       	2023-09-01 15:56:18.115698 +0200 CEST	deployed	hello-world-0.6.0
(☸|lspay-trial-eu-west-1:default)➜  helm-compose-test helm plugin list
NAME   	VERSION	DESCRIPTION
compose	1.2.0

apiVersion: 1.1

storage:
  name: mycompose
  type: local # default
  path: .hcstate # default

releases:
  helloworld1:
    chart: sikalabs/hello-world 
    values:
      replicas: 2
  helloworld2:
    chart: sikalabs/hello-world 
    values:
      replicas: 2
repositories:
  sikalabs: https://helm.sikalabs.io