README.md

Cloud Posse distribution of awesome apps.

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!

Sponsorship

Package repository hosting is graciously provided by cloudsmith. Cloudsmith is the only fully hosted, cloud-native, universal package management solution, that enables your organization to create, store and share packages in any format, to any place, with total confidence. We believe there’s a better way to manage software assets and packages, and they’re making it happen!

Usage

Debian Repository (recommended)

A public Debian repository is provided by Cloud Posse. The repository is hosted by Cloudsmith Using this Debian repository is ultimately more reliable than depending on GitHub for availability and provides an easier way to manage dependencies pinned at multiple versions.

Configure the Debian repository:

The Easy Way

Cloudsmith provides an installation script to configure the Debian repository for your version of Debian.

curl -1sLf 'https://dl.cloudsmith.io/public/cloudposse/packages/cfg/setup/bash.deb.sh' | bash

NOTE: Requires bash and curl to run:

For Docker

Add the following to your Dockerfile near the top.

# Install the cloudposse Debian repository
RUN apt-get update && apt-get install -y apt-utils curl
RUN curl -1sLf 'https://dl.cloudsmith.io/public/cloudposse/packages/cfg/setup/bash.deb.sh' | bash

Installing Debian Packages

When adding packages, we recommend using apt-get update && apt-get install -yq $package to update the repository index before installing packages.

Simply install any package as normal:

apk-get install -y terraform

But we recommend that you use version pinning (the -\* is important, as it gets you the latest version of the package):

apt-get install gomplate=3.0.0-\*

RPM Repository

We publish RPM packages corresponding to all the Debian packages we publish. Installing the repository is almost the same as above.

curl -1sLf 'https://dl.cloudsmith.io/public/cloudposse/packages/cfg/setup/bash.rpm.sh' | bash

Install packages as normal. yum automatically updates the repository index before installing packages.

yum install -y terraform

Note that unlike other package systems, yum automatically updates the repository index before installing packages.

We still recommend version pinning, but yum makes it hard. You can use this command to list all the available versions of a package:

yum --showduplicate list $package

Then you can install the package with a version pinning:

VERSION=1.3.0
RELEASE=1
yum install -y $package-$VERSION-$RELEASE.$(uname -m)

Alpine Repository

A public Alpine repository is provided by Cloud Posse. The repository is hosted by Cloudsmith 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.

Configure the Alpine repository:

The Easy Way

Cloudsmith provides an installation script to configure the Alpine repository for your version of Alpine.

apk add --no-cache bash curl
curl -1sLf \
'https://dl.cloudsmith.io/public/cloudposse/packages/setup.alpine.sh' \
| bash  

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 --update terraform

But we recommend that you use version pinning:

apk add --update terraform==1.0.0-r0

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

apk add --update terraform@cloudposse==1.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

Rebuilding GitHub Action Workflows

The GitHub Action workflows are compiled from the .github/package-template.yml file by running make -C .github workflows. It's also run automatically when rebuilding the README.md with make readme.

Run this make target anytime the package-template.yml changes or any new packages are added to the vendor/ folder.

IMPORTANT: The package-template.yml supports a single macro for interpolation %PACKAGE_NAME% which is replaced using a sed expression. Since the workflow uses a combation of gotemplate-like interpolations as well as inlines shell scripts, we used the %VAR% form of interpolation to avoid the need for endless escaping of interpolation specifiers.

Testing Locally

Alpine

$ make docker/build/apk/shell
$ make -C vendor/<package> apk

Debian

$ make docker/build/deb/shell
$ make -C vendor/<package> deb

RPM

$ make docker/build/rpm/shell
$ make -C vendor/<package> rpm

Mac

$ make -C vendor/<package> install

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 main 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 ?= main
export PACKAGES_PATH ?= packages/
export INSTALL_PATH ?= $(PACKAGES_PATH)/bin

## 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/,,$@)

Contributing Additional Packages

In addition to following the Contributing section, the following steps can be used to add new packages for review (via a PR). If possible (and it usually is), you want to find an existing package with similarly packaged release (.tar, .gz, uncompressed binary, etc.), and copy and edit its Makefile.

1. Copy the Makefile from an existing, similar, package within the vendors directory. Name the new folder with the same name as the binary package being installed.
2. Edit the Makefile, ensuring the DOWNLOAD_URL is properly formatted
3. Run make init from within the directory to create the DESCRIPTION, LICENSE, RELEASE, and VERSION files.
4. Ensure that a test task exists in the package Makefile. It should check the version number of the installed binary if possible.
5. Test the install and ensure that it downloads and runs as expected (make -C install <your_package> INSTALL_PATH=/tmp)
6. Test the apk build (see below)
7. Update the README.md (make init readme/deps readme)

Testing apk builds

To validate that a new package will build into an apk you can use the following steps;

make docker/build/apk/shell
make -C vendor/<appname> apk
# Some temp build files in the volume mount set user/group to nobody/nobody for apk building.
# It is easier to remove them while within the docker container.
rm -rf ./tmp/build.*
exit

Troubleshooting Package Addition

Here are some solutions to several common problems that may occur when adding a new package:

1. When adding a new app, the `make -C vendor/ apk` command fails, claiming it can't find the app's binary file, even though it is in the expected place.

   Part of the make -C vendor/<app> apk command is building a package for the binary file inside an Alpine Linux container. Since Alpine Linux uses musl as its C library, this often leads to situations where binaries built against libc might not function on Alpine. What's more, binaries from projects written in Go will not be found by the Alpine package builder at all if they are missing any necessary libraries, like libc. The solution to this problem is to add an export APKBUILD_DEPENDS += libc6-compat line to the top of your new package's associated Makefile.

2. When adding a new binary, the `make builder TARGETS=readme` command fails with `Unable to find image 'cloudposse/build-harness:sha-[some_SHA_stub]' locally`.

   This can occur when you have the cloudposse/build-harness repository checked out somewhere on your machine. make builder TARGETS=readme will end up looking for a docker image tagged with the SHA that the HEAD ref of your buld-harness points to. To correct this behavior, just run make init in the cloudposse/packages directory prior to running make builder TARGETS=readme.

Package Build Status

Build Status (* means amd64 only)	Version	Description
	0.9.0	Automatically gets credentials for Amazon ECR on docker push/docker pull
	0.27.0	Tool for interacting with the Alertmanager API
	2.13.0	Declarative GitOpts for Kubernetes
*	0.3.2	Easily assume AWS roles in your terminal.
	0.30.0	Terraform For Teams
	1.107.0	Universal Tool for DevOps and Cloud Automation
*	0.1.11	A Mighty CLI for AWS
	1.34.0	Tool for developers to build, release and operate containerized applications on AWS App Runner or Amazon ECS on AWS Fargate.
	0.6.27	A tool to use AWS IAM credentials to authenticate to a Kubernetes cluster
	2.25.0	A highly configurable way to wipe non-prod aws accounts. WARNING do not use in prod
	7.2.0	A vault for securely storing and accessing AWS credentials in development environments
*	1.6.5	Cloudflare's PKI and TLS toolkit
*	1.6.5	Cloudflare's PKI and TLS toolkit json parser
	3.1.0	CLI for managing secrets
	0.16.20	CLI to install, manage & troubleshoot Kubernetes clusters running Cilium
	0.8.22	Command line tool for Amazon Route 53
	0.37.2	Tool for wiping an aws account DANGER absolutely do not use in production
	2024.11.0	Argo Tunnel client
*	0.87.6	Codefresh CLI
	0.56.0	Test your configuration files using Open Policy Agent
consul [frozen]	1.16.4	Hashicorp consul
	0.7.7	Top-like interface for container metrics
	2.35.0	Unclutter your .profile
	1.117.0	A command line tool for DigitalOcean services
	3.0.0	A CLI tool and go library which recommends instance types based on resource criteria like vcpus and memory
	2.4.3	Ecspresso is a deployment tool for Amazon ECS
	1.1.0	Command line email sending client written in Go.
*	0.7.1	A simple wrapper that allows you to run commands within ethereal docker containers
	0.4.6	fetch makes it easy to download files, folders, and release assets from a specific public git commit, branch, or tag
	1.3.0	Print your name in style
	0.23.1	A command-line fuzzy finder
	2.62.0	The GitHub CLI
	0.17.0	Upload multiple artifacts to GitHub Releases in parallel
	0.28.0	Command line utility for creating GitHub comments on Commits, Pull Request Reviews or Issues
*	0.10.0	Commandline app to create and edit releases on Github (and upload artifacts)
	0.11.0	Command line utility for updating GitHub commit statuses and enabling required status checks for pull requests
	8.21.2	Audit git repos for secrets 🔑
	0.20.0	This an implementation of Jsonnet in pure Go.
	4.2.0	A flexible commandline tool for template rendering. Supports lots of local and remote datasources.
*	1.0.2	A stand-alone alternative to git2consul
*	0.24.0	a high-performance, POSIX-ish Amazon S3 file system written in Go
	1.17.0	Simple Go-based setuid+setgid+setgroups+exec
gotop [frozen]	3.0.0	A terminal based graphical activity monitor inspired by gtop and vtop
	1.9.1	Like cURL, but for gRPC: Command-line tool for interacting with gRPC servers
	0.2.15	A command line editor for HCL
	3.16.3	The Kubernetes Package Manager
	2.17.0	The Kubernetes Package Manager
	3.16.3	The Kubernetes Package Manager
	0.144.0	Deploy Kubernetes Helm Charts
	0.17.0	✅ Test generated HTML for problems
	0.138.0	The world’s fastest framework for building websites.
	0.10.39	Cloud cost estimates for Terraform
	0.2.1	Command line interface to JMESPath
	0.2.0	Convert JSON to HCL, and vice versa
	3.11.1	Jenkins-X
	5.7.4	Little helper to run Rancher Lab's k3s in Docker
	0.55.0	A modern load testing tool, using Go and JavaScript - https://k6.io
	0.32.7	Kubernetes CLI To Manage Your Clusters In Style
	0.8.3	K8s continuous backup to git
*	1.2.0	Machine Learning Toolkit for Kubernetes
	0.25.0	A tool for running local Kubernetes clusters using Docker
	1.30.1	Kubernetes Operations (kops) - Production Grade K8s Installation, Upgrades, and Management
krew [frozen]	0.4.1	Kubectl plugin manager
*	2.0.0	Utilities to manage kubernetes cronjobs. Run a CronJob manually for test purposes. Suspend/unsuspend a CronJob
	1.31.2	Production-Grade Container Scheduling and Management
kubectl-1.13 [frozen]	1.13.12	Production-Grade Container Scheduling and Management (v1.13)
kubectl-1.14 [frozen]	1.14.10	Production-Grade Container Scheduling and Management (v1.14)
kubectl-1.15 [frozen]	1.15.12	Production-Grade Container Scheduling and Management (v1.15)
kubectl-1.16 [frozen]	1.16.15	Production-Grade Container Scheduling and Management (v1.16)
kubectl-1.17 [frozen]	1.17.17	Production-Grade Container Scheduling and Management (v1.17)
kubectl-1.18 [frozen]	1.18.20	Production-Grade Container Scheduling and Management (v1.18)
kubectl-1.19 [frozen]	1.19.16	Production-Grade Container Scheduling and Management (v1.19)
	1.20.15	Production-Grade Container Scheduling and Management (v1.20)
	1.21.14	Production-Grade Container Scheduling and Management (v1.21)
	1.22.17	Production-Grade Container Scheduling and Management (v1.22)
	1.23.17	Production-Grade Container Scheduling and Management (v1.23)
	1.24.17	Production-Grade Container Scheduling and Management (v1.24)
	1.25.16	Production-Grade Container Scheduling and Management (v1.25)
	1.26.15	Production-Grade Container Scheduling and Management (v1.26)
	1.27.16	Production-Grade Container Scheduling and Management (v1.27)
	1.28.15	Production-Grade Container Scheduling and Management (v1.28)
	1.29.10	Production-Grade Container Scheduling and Management (v1.29)
	1.30.6	Production-Grade Container Scheduling and Management (v1.30)
	1.31.2	Production-Grade Container Scheduling and Management (v1.31)
	0.9.5	Switch faster between clusters and namespaces in kubectl
	0.9.5	Switch faster between clusters and namespaces in kubectl
*	0.16.1	Validate your Kubernetes configuration files, supports multiple Kubernetes versions
	0.23.3	The lazier way to manage everything docker
*	0.22.1	Script to check issued certificates by Let's Encrypt on CTL (Certificate Transparency Log) using https://crt.sh
	1.34.0	Run Kubernetes locally
*	0.3.4	Correct commonly misspelled English words in source files
	0.70.0	An open source project to policy-enable your service.
	0.35.1	Create cloud native Buildpacks
packer [frozen]	1.9.5	Packer is a tool for creating identical machine images for multiple platforms from a single source configuration.
	3.5	Universal markup converter
	1.17.0	Postgres metrics
	5.20.3	A cli tool to help discover deprecated apiVersions in Kubernetes
	0.21.5	A Kubernetes cluster resource sanitizer
	3.0.0	Prometheus CLI tool
	1.2.1	Tasty rainbows for your terminal! (lolcat clone)
*	0.5.0	Review Access - kubectl plugin to show an access matrix for all available resources
	2.9.2	Rancher CLI
	0.10.2	Find Kubernetes roles and cluster roles bound to any user, service account, or group name.
	2.36.18	CLI tool which enables you to login and retrieve AWS temporary credentials using a SAML IDP
	2.38.2	A command line utility to work with Sentry.
	0.10.0	ShellCheck, a static analysis tool for shell scripts
	3.10.0	A shell parser, formatter and interpreter (POSIX/Bash/mksh)
	0.10.0	Command line utility to send messages with attachments to Slack channels via Incoming Webhooks
	3.9.1	Secrets management stinks, use some sops!
	1.7.0	Spacelift.io client and CLI
	0.35.0	A unified CLI to manage your Spot resources.
*	1.2.2	Easy connect on EC2 instances thanks to AWS System Manager Agent
	1.31.0	⎈ Multi pod and container log tailing for Kubernetes
	0.3.0	Shell wrapper to run a login shell with sudo as the current user for the purpose of audit logging
	17.0.1	Secure Access for Developers that doesn't get in the way.
teleport-4.3* [frozen]	4.3.10	Privileged access management for elastic infrastructure.
teleport-4.4* [frozen]	4.4.12	Privileged access management for elastic infrastructure.
teleport-5.0* [frozen]	5.0.2	Secure Access for Developers that doesn't get in the way.
terraform [frozen]	1.5.7	Terraform is a tool for building, changing, and combining infrastructure safely and efficiently.
terraform-0.11 [frozen]	0.11.15	Terraform is a tool for building, changing, and combining infrastructure safely and efficiently.
terraform-0.12 [frozen]	0.12.31	Terraform is a tool for building, changing, and combining infrastructure safely and efficiently.
terraform-0.13 [frozen]	0.13.7	Terraform is a tool for building, changing, and combining infrastructure safely and efficiently.
	0.14.11	Terraform is a tool for building, changing, and combining infrastructure safely and efficiently.
	0.15.5	Terraform is a tool for building, changing, and combining infrastructure safely and efficiently.
terraform-1 [frozen]	1.5.7	Terraform enables you to safely and predictably create, change, and improve infrastructure.
	show 0.0.20240801114854+git6714b46f5fe4	A helper library for shallow inspection of Terraform configurations
	0.19.0	Generate docs from terraform modules
	3.1.13	CLI tool that checks Terraform code for module updates. Single binary, no dependencies. linux, osx, windows.
terraform_0.11 [frozen]	0.11.15	Terraform (Deprecated package. Use terraform-0.11 instead)
terraform_0.12 [frozen]	0.12.31	Terraform (Deprecated package. Use terraform-0.12 instead)
terraform_0.13 [frozen]	0.13.7	Terraform (Deprecated package. Use terraform-0.13 instead)
	0.68.14	Terragrunt is a thin wrapper for Terraform that provides extra tools for working with multiple Terraform modules.
	0.7.5	Terrahelp is as a command line utility that provides useful tricks like masking of terraform output.
	0.54.0	A Pluggable Terraform Linter
	0.7.9	A schema inspector for Terraform providers
	1.28.11	(DEPRECATED: use Trivy instead) Security scanner for your Terraform code
	0.36.1	Highly available Prometheus setup with long term storage capabilities. CNCF Sandbox project.
	0.57.0	A Simple and Comprehensive Vulnerability Scanner for Containers, Suitable for CI
	0.38.0	Variant is a Universal CLI tool that works like a task runner
	0.38.0	Second major version of Variant, a Universal CLI tool that works like a task runner
vault [frozen]	1.14.8	Hashicorp vault
	1.15.0	Backup and migrate Kubernetes applications and their persistent volumes
	0.42.0	Easy way to vendor portions of git repos, github releases, helm charts, docker image contents, etc. declaratively.
*	1.10.5	Codefresh runtime-environment agent
	0.1.0	Simple CLI for comparing two or more versions
*	1.4.1	Yet Another JSON Schema Validator [CLI]
	4.44.5	yq is a portable command-line YAML processor

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.

✨ Contributing

This project is under active development, and we encourage contributions from our community.

Many thanks to our outstanding contributors:

For 🐛 bug reports & feature requests, please use the issue tracker.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

1. Review our Code of Conduct and Contributor Guidelines.
2. Fork the repo on GitHub
3. Clone the project to your own machine
4. Commit changes to your own branch
5. Push your work back up to your fork
6. 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!

🌎 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

Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week — and usually a 5-minute read.

📆 Office Hours

Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you can’t find anywhere else. It's FREE for everyone!

License

Preamble to the Apache License, Version 2.0

Complete license is available in the LICENSE file.

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.

---

Copyright © 2017-2024 Cloud Posse, LLC