README.yaml

name: Helmfiles
license: APACHE2
github_repo: cloudposse/helmfiles

# Badges to display
badges:
  - name: "Codefresh Build Status"
    image: "https://g.codefresh.io/api/badges/build?repoOwner=cloudposse&repoName=helmfiles&branch=master&pipelineName=helmfiles&accountName=cloudposse&type=cf-1"
    url: "https://g.codefresh.io/pipelines/helmfiles/builds"
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/cloudposse/helmfiles.svg"
    url: "https://github.com/cloudposse/helmfiles/releases/latest"
  - name: "Slack Community"
    image: "https://slack.cloudposse.com/badge.svg"
    url: "https://slack.cloudposse.com"
    
description: |-
  Helmfiles is a comprehensive distribution of declarative [`helm`](https://helm.sh/) chart invocations. It makes it really easy to get up and running with a full stack of fully integrated apps for Kubernetes using [`helmfile`](https://github.com/roboll/helmfile).
  
  Pull Requests are welcome!

usage: |-

  Install the latest release of `helmfile` from the [helmfile releases](https://github.com/roboll/helmfile/releases) page.

  Alternatively, we also distribute `helmfile` as an [alpine package](https://github.com/cloudposse/packages).

  Add the cloudposse alpine repository.

  ```
  # Install the cloudposse alpine repository
  ADD https://apk.cloudposse.com/ops@cloudposse.com.rsa.pub /etc/apk/keys/
  RUN echo "@cloudposse https://apk.cloudposse.com/3.8/vendor" >> /etc/apk/repositories
  ```

  Install `helmfile` from the repository.

  ```
  RUN apk add helmfile
  ```


  ### Docker

  We distribute a docker image with all helmfiles. Use a multi-stage build to include them.

  ```
  FROM cloudposse/helmfiles:latest as helmfiles

  COPY --from=helmfiles /helmfiles /conf/helmfiles/
  ```

  **IMPORTANT:** we recommend pinning `cloudposse/helmfiles` to a specific release rather than using `latest`

  ### Git
  
  ```
  git clone git@github.com:cloudposse/helmfiles.git
  ```

  ### Configuration

  Define a `helmfile.yaml` which includes the releases you wish to support. Specify all releases in the order in which they should get installed.

  Here's an example of a [`helmfile.yaml`](helmfile.yaml):

  ```
  # Ordered list of releases. 
  helmfiles:
    - "releases/prometheus-operator.yaml"
    - "releases/cluster-autoscaler.yaml"
    - "releases/kiam.yaml"
    - "releases/external-dns.yaml"
    - "releases/kube-lego.yaml"
    - "releases/nginx-ingress.yaml"
    - "releases/kube-prometheus.yaml"
    - "releases/grafana.yaml"
    - "releases/heapster.yaml"
    - "releases/dashboard.yaml"
    - "releases/portal.yaml"
  ```

related:
  - name: "Geodesic"
    description: "Geodesic is the fastest way to get up and running with a rock solid, production grade cloud platform built on strictly Open Source tools."
    url: "https://github.com/cloudposse/geodesic"

  - name: "Packages"
    description: "Cloud Posse installer and distribution of native apps"
    url: "https://github.com/cloudposse/packages"

  - name: "Terraform Root Modules"
    description: "Collection of Terraform root module invocations for provisioning reference architectures"
    url: "https://github.com/cloudposse/terraform-root-modules"

  - name: "Build Harness"
    description: "Collection of Makefiles to facilitate building Golang projects, Dockerfiles, Helm charts, and more"
    url: "https://github.com/cloudposse/build-harness"

  - name: "Chamber"
    description: "a CRUD tool for managing secrets stored in AWS Systems Manager Parameter Store and exposing those secrets as Environment Variables to processes."
    url: "https://docs.cloudposse.com/tools/chamber/"


references:
  - name: "helmfile"
    description: "Helmfile is a declarative configuration for deploying distributions of helm charts"
    url: "https://github.com/roboll/helmfile"

  - name: "helm"
    description: "The package manager for Kubernetes"
    url: "https://helm.sh/"

  - name: "docs"
    description: "Documentation for how we use helmfile"
    url: "https://docs.cloudposse.com/tools/helmfile/"

# Contributors to this project
contributors:
  - name: "Erik Osterman"
    homepage: "https://github.com/osterman"
    avatar: "http://s.gravatar.com/avatar/88c480d4f73b813904e00a5695a454cb?s=144"
    github: "osterman"
  - name: "Igor Rodionov"
    homepage: "https://github.com/goruha/"
    avatar: "http://s.gravatar.com/avatar/bc70834d32ed4517568a1feb0b9be7e2?s=144"
    github: "goruha"
  - name: "Andriy Knysh"
    homepage: "https://github.com/aknysh/"
    avatar: "https://avatars0.githubusercontent.com/u/7356997?v=4&u=ed9ce1c9151d552d985bdf5546772e14ef7ab617&s=144"
    github: "aknysh"