Update readme and add stern (#13)

* Update readme and add stern * Update README * Fix readme * Add YAML manifest * Add contributors * Add codefresh badge * Fix badge
cloudposse · Jun 20, 2018 · c11273f · c11273f
1 parent 34659f1
commit c11273f
Show file tree

Hide file tree

Showing 5 changed files with 298 additions and 48 deletions.
diff --git a/Makefile b/Makefile
@@ -4,6 +4,9 @@ export DOCKER_TAG ?= latest
 export DOCKER_IMAGE_NAME ?= $(DOCKER_IMAGE):$(DOCKER_TAG)
 export DOCKER_BUILD_FLAGS = 
 
+export DEFAULT_HELP_TARGET := help/install
+export README_DEPS ?= docs/targets.md
+
 -include $(shell curl -sSL -o .build-harness "https://git.io/build-harness"; echo .build-harness)
 
 all: init deps build install run
@@ -19,3 +22,6 @@ push:
 
 run:
 	docker run -it ${DOCKER_IMAGE_NAME} sh
+
+help/install:
+	@$(SELF) help/generate MAKEFILE_LIST=install/Makefile
diff --git a/README.md b/README.md
@@ -1,30 +1,24 @@
-# Packages [![Build Status](https://travis-ci.org/cloudposse/packages.svg?branch=master)](https://travis-ci.org/cloudposse/packages)
+<!-- This file was automatically generated by the `build-harness`. Make all changes to `README.yaml` and run `make readme` to rebuild this file. -->
+
+[![Cloud Posse](https://cloudposse.com/logo-300x69.png)](https://cloudposse.com)
+
+# Packages  [![TravisCI Build Status](https://travis-ci.org/cloudposse/packages.svg?branch=master)](https://travis-ci.org/cloudposse/packages) [![Codefresh Build Status](https://g.codefresh.io/api/badges/build?repoOwner=cloudposse&repoName=packages&branch=master&pipelineName=packages&accountName=cloudposse&type=cf-1)](https://g.codefresh.io/repositories/cloudposse/packages/builds?filter=trigger:build;branch:master;service:5b234974667ab79287990636~packages) [![Latest Release](https://img.shields.io/github/release/cloudposse/packages.svg)](https://github.com/cloudposse/packages/releases) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)
+
 
 Cloud Posse distribution of native apps.
 
 Use this repo to easily install binary releases of popular apps. This is useful for inclusion into a `Dockerfile` to install dependencies.
 
-## Manifest
 
-```
-Available targets:
+---
+
+This project is part of our comprehensive ["SweetOps"](https://docs.cloudposse.com) approach towards DevOps. 
+
+
+It's 100% Open Source and licensed under the [APACHE2](LICENSE).
+
+
 
-  aws-vault                           Install aws-vault to easily assume roles (not related to HashiCorp Vault)
-  chamber                             Install Chamber to manage secrets with SSM+KMS
-  fetch                               Install fetch to easily download files, folders, and release assets from a specific git commit, branch, or tag
-  github-commenter                    Install github-commenter
-  gomplate                            Install gomplate
-  goofys                              Install goofys
-  helm                                Install helm
-  helmfile                            Install helmfile
-  kops                                Install kops
-  kubectl                             Install kubectl
-  kubectx                             Install kubectx
-  kubens                              Install kubens
-  sops                                Install sops (required by `helm-secrets`)
-  terraform                           Install Terraform
-  yq                                  Install YQ to manipulte YAML
-```
 
 ## Usage
 
@@ -48,26 +42,35 @@ Install to a specific folder:
 make -C install aws-vault INSTALL_PATH=/usr/bin
 ```
 
+Uninstall a specific package
+```
+make -C uninstall yq
+```
+
+
+
+
+## Examples
+
+### Docker Multi-stage Build
+
 Add this to a `Dockerfile` to install packages using a multi-stage build process:
 ```
 FROM cloudposse/packages:latest AS packages
 
 COPY --from=packages /packages/bin/kubectl /usr/local/bin/
 ```
 
+### Docker with Git Clone
+
 Or... add this to a `Dockerfile` to easily install packages on-demand:
 ```
 RUN git clone --depth=1 -b master https://github.com/cloudposse/packages.git /packages && \
     rm -rf /packages/.git && \
     make -C /packages/install kubectl
 ```
 
-Uninstall a specific package
-```
-make -C uninstall yq
-```
-
-## Makefile Inclusion
+### Makefile Inclusion
 
 Sometimes it's necessary to install some binary dependencies when building projects. For example, we frequently 
 rely on `gomplate` or `helm` to build chart packages.
@@ -98,12 +101,71 @@ packages/uninstall/%:
 ```
 
 
+
+## Makefile Targets
+```
+Available targets:
+
+  aws-vault                           Install aws-vault to easily assume roles (not related to HashiCorp Vault)
+  chamber                             Install Chamber to manage secrets with SSM+KMS
+  fetch                               Install fetch to easily download files, folders, and release assets from a specific git commit, branch, or tag
+  github-commenter                    Install github-commenter
+  gomplate                            Install gomplate
+  goofys                              Install goofys
+  helm                                Install helm
+  helmfile                            Install helmfile to easily deploy collections of helm charts
+  htmltest                            Install htmltest
+  htmltest-darwin                     Install htmltest (darwin)
+  htmltest-linux                      Install htmltest (linux)
+  hugo                                Install hugo framework for building static websites.
+  hugo-darwin                         Install hugo framework for building static websites (darwin)
+  hugo-linux                          Install hugo framework for building static websites (linux)
+  kops                                Install kops
+  kubectl                             Install kubectl
+  kubectx                             Install kubectx
+  kubens                              Install kubens
+  sops                                Install sops (required by `helm-secrets`)
+  stern                               Install stern multi pod and container log tailing for Kubernetes
+  terraform                           Install Terraform
+  terraform-docs                      Install terraform-docs to generate docs from terraform modules
+  terragrunt                          Install terragrunt for tools that make it easier to work with multiple Terraform modules
+  yq                                  Install YQ to manipulte YAML
+
+```
+
+
+
+## Related Projects
+
+Check out these related projects.
+
+- [build-harness](https://github.com/cloudposse/build-harness) - Collection of Makefiles to facilitate building Golang projects, Dockerfiles, Helm charts, and more
+- [geodesic](https://github.com/cloudposse/geodesic) - Geodesic is the fastest way to get up and running with a rock solid, production grade cloud platform built on strictly Open Source tools.
+
+
 ## Help
 
 **Got a question?**
 
-File a GitHub [issue](https://github.com/cloudposse/packages/issues), send us an [email](mailto:[email protected]) or reach out to us on [Gitter](https://gitter.im/cloudposse/).
+File a GitHub [issue](https://github.com/cloudposse/packages/issues), send us an [email][email] or join our [Slack Community][slack].
+
+## Commerical Support
 
+Work directly with our team of DevOps experts via email, slack, and video conferencing. 
+
+We provide *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 fulltime engineer. 
+
+- **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.
+- **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.
 
 ## Contributing
 
@@ -113,22 +175,26 @@ Please use the [issue tracker](https://github.com/cloudposse/packages/issues) to
 
 ### Developing
 
-If you are interested in being a contributor and want to get involved in developing `packages`, we would love to hear from you! Shoot us an [email](mailto:[email protected]).
+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:[email protected]).
 
 In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
 
  1. **Fork** the repo on GitHub
  2. **Clone** the project to your own machine
  3. **Commit** changes to your own branch
  4. **Push** your work back up to your fork
- 5. Submit a **Pull request** so that we can review your changes
+ 5. Submit a **Pull Request** so that we can review your changes
+
+**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
 
-**NOTE:** Be sure to merge the latest from "upstream" before making a pull request!
+## Copyright
 
+Copyright © 2017-2018 [Cloud Posse, LLC](https://cloudposse.com)
 
-## License
 
-[APACHE 2.0](LICENSE) © 2018 [Cloud Posse, LLC](https://cloudposse.com)
+## License 
+
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) 
 
 See [LICENSE](LICENSE) for full details.
 
@@ -140,7 +206,7 @@ See [LICENSE](LICENSE) for full details.
     "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
+      https://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
@@ -150,31 +216,43 @@ See [LICENSE](LICENSE) for full details.
     under the License.
 
 
+## Trademarks
+
+All other trademarks referenced herein are the property of their respective owners.
+
 ## About
 
-`packages` is maintained and funded by [Cloud Posse, LLC][website].
+This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know at <[email protected]>
 
-![Cloud Posse](https://cloudposse.com/logo-300x69.png)
+[![Cloud Posse](https://cloudposse.com/logo-300x69.png)](https://cloudposse.com)
 
+We're a [DevOps Professional Services][hire] company based in Los Angeles, CA. We love [Open Source Software](https://github.com/cloudposse/)!
 
-Like it? Please let us know at <[email protected]>
+We offer paid support on all of our projects.  
 
-We love [Open Source Software](https://github.com/cloudposse/)!
+Check out [our other projects][github], [apply for a job][jobs], or [hire us][hire] to help with your cloud strategy and implementation.
 
-See [our other projects][community]
-or [hire us][hire] to help build your next cloud-platform.
+  [docs]: https://docs.cloudposse.com/
+  [website]: https://cloudposse.com/
+  [github]: https://github.com/cloudposse/
+  [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:[email protected]
 
-  [website]: http://cloudposse.com/
-  [community]: https://github.com/cloudposse/
-  [hire]: http://cloudposse.com/contact/
 
 ### Contributors
 
+|  [![Erik Osterman][osterman_avatar]](osterman_homepage)<br/>[Erik Osterman][osterman_homepage] | [![Igor Rodionov][goruha_avatar]](goruha_homepage)<br/>[Igor Rodionov][goruha_homepage] | [![Andriy Knysh][aknysh_avatar]](aknysh_homepage)<br/>[Andriy Knysh][aknysh_homepage] |
+|---|---|---|
+
+  [osterman_homepage]: https://github.com/osterman
+  [osterman_avatar]: http://s.gravatar.com/avatar/88c480d4f73b813904e00a5695a454cb?s=144
+  [goruha_homepage]: https://github.com/goruha/
+  [goruha_avatar]: http://s.gravatar.com/avatar/bc70834d32ed4517568a1feb0b9be7e2?s=144
+  [aknysh_homepage]: https://github.com/aknysh/
+  [aknysh_avatar]: https://avatars0.githubusercontent.com/u/7356997?v=4&u=ed9ce1c9151d552d985bdf5546772e14ef7ab617&s=144
 
-| [![Erik Osterman][erik_img]][erik_web]<br/>[Erik Osterman][erik_web] | [![Andriy Knysh][andriy_img]][andriy_web]<br/>[Andriy Knysh][andriy_web] |
-|-------------------------------------------------------|------------------------------------------------------------------|
 
-  [erik_img]: http://s.gravatar.com/avatar/88c480d4f73b813904e00a5695a454cb?s=144
-  [erik_web]: https://github.com/osterman/
-  [andriy_img]: https://avatars0.githubusercontent.com/u/7356997?v=4&u=ed9ce1c9151d552d985bdf5546772e14ef7ab617&s=144
-  [andriy_web]: https://github.com/aknysh/