README
¶
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.
Documentation
¶
Overview ¶
Copyright © 2023 The Helm Compose Authors
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Source Files
Directories