Cloud Posse installer and distribution of native apps, binaries and alpine packages
goruha Added prefix to all env vars (#106)
* Added prefix to all env vars
Latest commit 5c7e575 Dec 7, 2018

README.md

README Header

Cloud Posse

Packages TravisCI Build Status Codefresh Build Status Latest Release Slack Community

Cloud Posse distribution of awesome apps.


This project is part of our comprehensive "SweetOps" approach towards DevOps.

It's 100% Open Source and licensed under the APACHE2.

Introduction

Use this repo to easily install releases of popular Open Source apps. We provide a few ways to use it.

  1. Make Based Installer. This installer works regardless of your OS and distribution. It downloads packages directly from their GitHub source repos and installs them to your INSTALL_PATH.
  2. Alpine Linux Packages. Use our Alpine repository to install prebuilt packages that use the original source binary (where possible) from the maintainers' official GitHub repo releases.
  3. Docker Image. Use our docker image as a base-image or as part of a multi-stage docker build. The docker image always distributes the latest linux binaries for x86_64 architectures.

See examples below for usage.

Is one of our packages out of date?

Open up an issue or submit a PR (preferred). We'll review quickly!

Usage

Alpine Repository (recommended)

A public Alpine repository is provided by Cloud Posse. The repository is hosted on Amazon S3 and fronted by CloudFlare's CDN with end-to-end TLS. This ensures insane availability with DDoS mitigation and low-cost hosting. Using this alpine repository is ultimately more reliable than depending on GitHub for availability and provides an easier way to manage dependencies pinned at multiple versions.

The repository itself is managed using alpinist, which takes care of the heavy lifting of building repository indexes. You can self-host your own Alpine repository using this strategy.

Configure the alpine repository:

The Easy Way

We provide a bootstrap script to configure the alpine repository for your version of alpine.

curl -sSL https://apk.cloudposse.com/install.sh | sudo bash

NOTE: Requires bash and curl to run:

For Docker

Add the following to your Dockerfile near the top.

# 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

NOTE: we support alpine 3.7 and 3.8 packages at this time

Installing Alpine Packages

When adding packages, we recommend using apk add --update $package to update the repository index before installing packages.

Simply install any package as normal:

apk add gomplate

But we recommend that you use version pinning:

apk add gomplate==3.0.0-r0

And maybe even repository pinning, so you know that you get our versions:

apk add gomplate@cloudposse==3.0.0-r0

Makefile Interface

The Makefile interface works on OSX and Linux. It's a great way to distribute binaries in an OS-agnostic way which does not depend on a package manager (e.g. no brew or apt-get).

This method is ideal for local development environments (which is how we use it) where you need the dependencies installed natively for your OS/architecture, such as installing a package on OSX.

See all available packages:

make -C install help

Install everything...

make -C install all

Install specific packages:

make -C install aws-vault chamber

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

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.

Here's a stub you can include into a Makefile to make it easier to install binary dependencies.

export PACKAGES_VERSION ?= master
export PACKAGES_PATH ?= packages/
export INSTALL_PATH ?= $(PACKAGES_PATH)/vendor

## Install packages
packages/install:
        @if [ ! -d $(PACKAGES_PATH) ]; then \
          echo "Installing packages $(PACKAGES_VERSION)..."; \
          rm -rf $(PACKAGES_PATH); \
          git clone --depth=1 -b $(PACKAGES_VERSION) https://github.com/cloudposse/packages.git $(PACKAGES_PATH); \
          rm -rf $(PACKAGES_PATH)/.git; \
        fi

## Install package (e.g. helm, helmfile, kubectl)
packages/install/%: packages/install
        @make -C $(PACKAGES_PATH)/install $(subst packages/install/,,$@)

## Uninstall package (e.g. helm, helmfile, kubectl)
packages/uninstall/%:
        @make -C $(PACKAGES_PATH)/uninstall $(subst packages/uninstall/,,$@)

Makefile Targets

atlantis                  0.4.10     Terraform For Teams
awless                    0.1.11     A Mighty CLI for AWS
aws-iam-authenticator     0.3.0      A tool to use AWS IAM credentials to authenticate to a Kubernetes cluster
aws-vault                 4.4.1      A vault for securely storing and accessing AWS credentials in development environments
chamber                   2.2.0      CLI for managing secrets
cli53                     0.8.12     Command line tool for Amazon Route 53
cloudflared               2018.8.0   Argo Tunnel client
codefresh                 0.8.83     Codefresh CLI provides a full and flexible interface to interact with Codefresh.
ctop                      0.7.1      Top-like interface for container metrics
emailcli                  1.0.3      Command line email sending client written in Go.
fargate                   0.2.3      CLI for AWS Fargate
fetch                     0.3.1      fetch makes it easy to download files, folders, and release assets from a specific git commit, branch, or tag of public andssss
figurine                  0.2.2      Print your name in style
ghr                       0.12.0     Upload multiple artifacts to GitHub Release in parallel
github-commenter          0.1.2      Command line utility for creating GitHub comments on Commits, Pull Request Reviews or Issues
github-release            0.7.2      Commandline app to create and edit releases on Github (and upload artifacts)
gitleaks                  1.2.0      Audit git repos for secrets 🔑
gometalinter              2.0.11     Concurrently run Go lint tools and normalise their output
gomplate                  3.0.0      A flexible commandline tool for template rendering. Supports lots of local and remote datasources.
goofys                    0.19.0     a high-performance, POSIX-ish Amazon S3 file system written in Go
gosu                      1.10       Simple Go-based setuid+setgid+setgroups+exec
gotop                     1.5.0      A terminal based graphical activity monitor inspired by gtop and vtop
helm                      2.11.0     The Kubernetes Package Manager
helmfile                  0.40.1     Deploy Kubernetes Helm Charts
htmltest                  0.10.1     :white_check_mark: Test generated HTML for problems
hugo                      0.49.2     The world’s fastest framework for building websites.
json2hcl                  0.0.6      Convert JSON to HCL, and vice versa
k6                        0.22.1     A modern load testing tool, using Go and JavaScript - https://k6.io
kops                      1.10.0     Kubernetes Operations (kops) - Production Grade K8s Installation, Upgrades, and Management
kubectl                   1.12.1     Issue tracker and mirror of kubectl code
kubectx                   0.6.1      Fast way to switch between clusters and namespaces in kubectl – [✩Star] if you're using it!
kubens                    0.6.1      Fast way to switch between clusters and namespaces in kubectl – [✩Star] if you're using it!
lectl                     0.17       Script to check issued certificates by Let's Encrypt on CTL (Certificate Transparency Log) using https://crt.sh
misspell                  0.3.4      Correct commonly misspelled English words in source files
packer                    1.3.1      Packer is a tool for creating identical machine images for multiple platforms from a single source configuration.
shellcheck                0.5.0      ShellCheck, a static analysis tool for shell scripts
shfmt                     2.5.1      A shell parser, formatter and interpreter (POSIX/Bash/mksh)
slack-notifier            0.1.3      Command line utility to send messages with attachments to Slack channels via Incoming Webhooks
sops                      3.1.1      Secrets management stinks, use some sops!
stern                     1.8.0      ⎈ Multi pod and container log tailing for Kubernetes
teleport                  3.0.0      Privileged access management for elastic infrastructure.
terraform                 0.11.8     Terraform is a tool for building, changing, and combining infrastructure safely and efficiently.
terraform-docs            0.4.5      Generate docs from terraform modules
terragrunt                0.17.0     Terragrunt is a thin wrapper for Terraform that provides extra tools for working with multiple Terraform modules.
yq                        2.1.1      yq is a portable command-line YAML processor

Share the Love

Like this project? Please give it a ★ on our GitHub! (it helps us a lot)

Are you using this project or any of our other projects? Consider leaving a testimonial. =)

Related Projects

Check out these related projects.

  • build-harness - Collection of Makefiles to facilitate building Golang projects, Dockerfiles, Helm charts, and more
  • 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, send us an email or join our Slack Community.

README Commercial Support

Commercial 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 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

  • 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.

Slack Community

Join our Open Source Community 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 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

Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

Developing

If you are interested in being a contributor and want to get involved in developing this project or help out with our other projects, we would love to hear from you! Shoot us an email.

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

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

Copyright

Copyright © 2017-2018 Cloud Posse, LLC

License

License

See LICENSE for full details.

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you 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

  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
"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.

Trademarks

All other trademarks referenced herein are the property of their respective owners.

About

This project is maintained and funded by Cloud Posse, LLC. Like it? Please let us know by leaving a testimonial!

Cloud Posse

We're a DevOps Professional Services company based in Los Angeles, CA. We ❤️ Open Source Software.

We offer paid support on all of our projects.

Check out our other projects, follow us on twitter, apply for a job, or hire us to help with your cloud strategy and implementation.

Contributors

Erik Osterman
Erik Osterman
Igor Rodionov
Igor Rodionov
Andriy Knysh
Andriy Knysh

README Footer Beacon