Merge branch 'master' into feature/teleport

cloudposse · Feb 11, 2019 · 508308b · 508308b
2 parents cdaa2f4 + 30176a0
commit 508308b
Show file tree

Hide file tree

Showing 40 changed files with 1,050 additions and 125 deletions.
diff --git a/Dockerfile b/Dockerfile
@@ -1,4 +1,5 @@
 FROM scratch
-COPY helmfile.d/ /helmfile.d/
-COPY scripts/ /scripts/
+COPY /releases /helmfiles/releases
+COPY /scripts /helmfiles/scripts
+COPY /helmfile.yaml /helmfiles/
 WORKDIR /
diff --git a/README.md b/README.md
@@ -1,18 +1,27 @@
 <!-- This file was automatically generated by the `build-harness`. Make all changes to `README.yaml` and run `make readme` to rebuild this file. -->
+[![README Header][readme_header_img]][readme_header_link]
 
-[![Cloud Posse](https://cloudposse.com/logo-300x69.svg)](https://cloudposse.com)
+[![Cloud Posse][logo]](https://cpco.io/homepage)
 
 # Helmfiles [![Codefresh Build Status](https://g.codefresh.io/api/badges/build?repoOwner=cloudposse&repoName=helmfiles&branch=master&pipelineName=helmfiles&accountName=cloudposse&type=cf-1)](https://g.codefresh.io/pipelines/helmfiles/builds) [![Latest Release](https://img.shields.io/github/release/cloudposse/helmfiles.svg)](https://github.com/cloudposse/helmfiles/releases/latest) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)
 
 
-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). It's also compatible with `helmfile.d`. 
+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!
 
 
 ---
 
-This project is part of our comprehensive ["SweetOps"](https://docs.cloudposse.com) approach towards DevOps. 
+This project is part of our comprehensive ["SweetOps"](https://cpco.io/sweetops) approach towards DevOps. 
+[<img align="right" title="Share via Email" src="https://docs.cloudposse.com/images/ionicons/ios-email-outline-2.0.1-16x16-999999.svg"/>][share_email]
+[<img align="right" title="Share on Google+" src="https://docs.cloudposse.com/images/ionicons/social-googleplus-outline-2.0.1-16x16-999999.svg" />][share_googleplus]
+[<img align="right" title="Share on Facebook" src="https://docs.cloudposse.com/images/ionicons/social-facebook-outline-2.0.1-16x16-999999.svg" />][share_facebook]
+[<img align="right" title="Share on Reddit" src="https://docs.cloudposse.com/images/ionicons/social-reddit-outline-2.0.1-16x16-999999.svg" />][share_reddit]
+[<img align="right" title="Share on LinkedIn" src="https://docs.cloudposse.com/images/ionicons/social-linkedin-outline-2.0.1-16x16-999999.svg" />][share_linkedin]
+[<img align="right" title="Share on Twitter" src="https://docs.cloudposse.com/images/ionicons/social-twitter-outline-2.0.1-16x16-999999.svg" />][share_twitter]
+
+
 
 
 It's 100% Open Source and licensed under the [APACHE2](LICENSE).
@@ -29,9 +38,80 @@ It's 100% Open Source and licensed under the [APACHE2](LICENSE).
 
 
 
+## 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"
+```
+
+
+
+
+
+
+
+
+## Share the Love 
+
+Like this project? Please give it a ★ on [our GitHub](https://github.com/cloudposse/helmfiles)! (it helps us **a lot**) 
+
+Are you using this project or any of our other projects? Consider [leaving a testimonial][testimonial]. =)
 
 
 ## Related Projects
@@ -42,6 +122,7 @@ Check out these related projects.
 - [Packages](https://github.com/cloudposse/packages) - Cloud Posse installer and distribution of native apps
 - [Terraform Root Modules](https://github.com/cloudposse/terraform-root-modules) - Collection of Terraform root module invocations for provisioning reference architectures
 - [Build Harness](https://github.com/cloudposse/build-harness) - Collection of Makefiles to facilitate building Golang projects, Dockerfiles, Helm charts, and more
+- [Chamber](https://docs.cloudposse.com/tools/chamber/) - a CRUD tool for managing secrets stored in AWS Systems Manager Parameter Store and exposing those secrets as Environment Variables to processes.
 
 
 
@@ -61,26 +142,34 @@ For additional context, refer to some of these links.
 
 File a GitHub [issue](https://github.com/cloudposse/helmfiles/issues), send us an [email][email] or join our [Slack Community][slack].
 
+[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
+
 ## Commercial Support
 
 Work directly with our team of DevOps experts via email, slack, and video conferencing. 
 
 We provide [*commercial support*][commercial_support] for all of our [Open Source][github] projects. As a *Dedicated Support* customer, you have access to our team of subject matter experts at a fraction of the cost of a full-time engineer. 
 
-[![E-Mail](https://img.shields.io/badge/email-hello@cloudposse.com-blue.svg)](mailto:hello@cloudposse.com)
+[![E-Mail](https://img.shields.io/badge/email-hello@cloudposse.com-blue.svg)][email]
 
 - **Questions.** We'll use a Shared Slack channel between your team and ours.
 - **Troubleshooting.** We'll help you triage why things aren't working.
 - **Code Reviews.** We'll review your Pull Requests and provide constructive feedback.
 - **Bug Fixes.** We'll rapidly work to fix any bugs in our projects.
-- **Build New Terraform Modules.** We'll develop original modules to provision infrastructure.
+- **Build New Terraform Modules.** We'll [develop original modules][module_development] to provision infrastructure.
 - **Cloud Architecture.** We'll assist with your cloud strategy and design.
 - **Implementation.** We'll provide hands-on support to implement our reference architectures. 
 
 
-## Community Forum
 
-Get access to our [Open Source Community Forum][slack] on Slack. It's **FREE** to join for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build *sweet* infrastructure.
+
+## Slack Community
+
+Join our [Open Source Community][slack] on Slack. It's **FREE** for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally *sweet* infrastructure.
+
+## Newsletter
+
+Signup for [our newsletter][newsletter] that covers everything on our technology radar.  Receive updates on what we're up to on GitHub as well as awesome new projects we discover. 
 
 ## Contributing
 
@@ -90,7 +179,7 @@ Please use the [issue tracker](https://github.com/cloudposse/helmfiles/issues) t
 
 ### Developing
 
-If you are interested in being a contributor and want to get involved in developing this project or [help out](https://github.com/orgs/cloudposse/projects/3) with our other projects, we would love to hear from you! Shoot us an [email](mailto:hello@cloudposse.com).
+If you are interested in being a contributor and want to get involved in developing this project or [help out](https://cpco.io/help-out) with our other projects, we would love to hear from you! Shoot us an [email][email].
 
 In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
 
@@ -105,7 +194,7 @@ In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
 
 ## Copyright
 
-Copyright © 2017-2018 [Cloud Posse, LLC](https://cloudposse.com)
+Copyright © 2017-2019 [Cloud Posse, LLC](https://cpco.io/copyright)
 
 
 
@@ -146,26 +235,16 @@ All other trademarks referenced herein are the property of their respective owne
 
 ## About
 
-This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know at <hello@cloudposse.com>
+This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know by [leaving a testimonial][testimonial]!
 
-[![Cloud Posse](https://cloudposse.com/logo-300x69.svg)](https://cloudposse.com)
+[![Cloud Posse][logo]][website]
 
-We're a [DevOps Professional Services][hire] company based in Los Angeles, CA. We love [Open Source Software](https://github.com/cloudposse/)!
+We're a [DevOps Professional Services][hire] company based in Los Angeles, CA. We ❤️  [Open Source Software][we_love_open_source].
 
-We offer paid support on all of our projects.  
+We offer [paid support][commercial_support] on all of our projects.  
 
-Check out [our other projects][github], [apply for a job][jobs], or [hire us][hire] to help with your cloud strategy and implementation.
+Check out [our other projects][github], [follow us on twitter][twitter], [apply for a job][jobs], or [hire us][hire] to help with your cloud strategy and implementation.
 
-  [docs]: https://docs.cloudposse.com/
-  [website]: https://cloudposse.com/
-  [github]: https://github.com/cloudposse/
-  [commercial_support]: https://github.com/orgs/cloudposse/projects
-  [jobs]: https://cloudposse.com/jobs/
-  [hire]: https://cloudposse.com/contact/
-  [slack]: https://slack.cloudposse.com/
-  [linkedin]: https://www.linkedin.com/company/cloudposse
-  [twitter]: https://twitter.com/cloudposse/
-  [email]: mailto:hello@cloudposse.com
 
 
 ### Contributors
@@ -187,3 +266,36 @@ Check out [our other projects][github], [apply for a job][jobs], or [hire us][hi
 
 
 
+
+[![README Footer][readme_footer_img]][readme_footer_link]
+[![Beacon][beacon]][website]
+
+  [logo]: https://cloudposse.com/logo-300x69.svg
+  [docs]: https://cpco.io/docs
+  [website]: https://cpco.io/homepage
+  [github]: https://cpco.io/github
+  [jobs]: https://cpco.io/jobs
+  [hire]: https://cpco.io/hire
+  [slack]: https://cpco.io/slack
+  [linkedin]: https://cpco.io/linkedin
+  [twitter]: https://cpco.io/twitter
+  [testimonial]: https://cpco.io/leave-testimonial
+  [newsletter]: https://cpco.io/newsletter
+  [email]: https://cpco.io/email
+  [commercial_support]: https://cpco.io/commercial-support
+  [we_love_open_source]: https://cpco.io/we-love-open-source
+  [module_development]: https://cpco.io/module-development
+  [terraform_modules]: https://cpco.io/terraform-modules
+  [readme_header_img]: https://cloudposse.com/readme/header/img?repo=cloudposse/helmfiles
+  [readme_header_link]: https://cloudposse.com/readme/header/link?repo=cloudposse/helmfiles
+  [readme_footer_img]: https://cloudposse.com/readme/footer/img?repo=cloudposse/helmfiles
+  [readme_footer_link]: https://cloudposse.com/readme/footer/link?repo=cloudposse/helmfiles
+  [readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img?repo=cloudposse/helmfiles
+  [readme_commercial_support_link]: https://cloudposse.com/readme/commercial-support/link?repo=cloudposse/helmfiles
+  [share_twitter]: https://twitter.com/intent/tweet/?text=Helmfiles&url=https://github.com/cloudposse/helmfiles
+  [share_linkedin]: https://www.linkedin.com/shareArticle?mini=true&title=Helmfiles&url=https://github.com/cloudposse/helmfiles
+  [share_reddit]: https://reddit.com/submit/?url=https://github.com/cloudposse/helmfiles
+  [share_facebook]: https://facebook.com/sharer/sharer.php?u=https://github.com/cloudposse/helmfiles
+  [share_googleplus]: https://plus.google.com/share?url=https://github.com/cloudposse/helmfiles
+  [share_email]: mailto:?subject=Helmfiles&body=https://github.com/cloudposse/helmfiles
+  [beacon]: https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/helmfiles?pixel&cs=github&cm=readme&an=helmfiles
diff --git a/README.yaml b/README.yaml
@@ -13,6 +13,72 @@ badges:
   - 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"
@@ -31,21 +97,23 @@ related:
     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/"
-
-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). It's also compatible with `helmfile.d`. 
-  
-  Pull Requests are welcome!
 
 # Contributors to this project
 contributors:

diff --git a/docs/targets.md b/docs/targets.md
@@ -2,7 +2,8 @@
 ```
 Available targets:
 
-  help                                This help screen
+  help                                Help screen
   help/all                            Display help for all targets
+  help/short                          This help short screen
 
 ```