Skip to content
Kubernetes apps, the easy way 😎
Go Shell Makefile
Branch: master
Clone or download

Latest commit

alexellis Add sponsored app offer via OpenFaaS Ltd
Signed-off-by: Alex Ellis (OpenFaaS Ltd) <alexellis2@gmail.com>
Latest commit 719f80c May 23, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Added arm check message to PR template Mar 29, 2020
ci Rename for English speakers Feb 26, 2020
cmd Add note for running Nginx on K8s 1.18 May 12, 2020
docs Add images Feb 27, 2020
hack Rename to bazaar Feb 26, 2020
pkg Fix download of Helm on Git Bash Apr 13, 2020
.DEREK.yml Add .DEREK.yml Feb 26, 2020
.gitignore Add images Feb 27, 2020
.travis.yml Inline travis build environment Apr 13, 2020
LICENSE Rename to bazaar Feb 26, 2020
Makefile Update fmt target Feb 26, 2020
README.md Add sponsored app offer via OpenFaaS Ltd May 23, 2020
get.sh support downloading into a folder with a space Apr 7, 2020
go.mod Tidy go-mod Feb 26, 2020
go.sum Tidy go-mod Feb 26, 2020
main.go Add license headers Mar 9, 2020

README.md

arkade - get Kubernetes apps, the easy way

arkade provides a simple Golang CLI with strongly-typed flags to install charts and apps to your cluster in one command.

arkade logo

Build Status GoDoc License: MIT Go Report Card GitHub All Releases

Gone are the days of contending with dozens of README files just to get the right version of helm and to install a chart with sane defaults.

Get arkade

# Note: you can also run without `sudo` and move the binary yourself
curl -sLS https://dl.get-arkade.dev | sudo sh

arkade --help
ark --help  # a handy alias

# Windows users with Git Bash
curl -sLS https://dl.get-arkade.dev | sh

Windows users: arkade requires bash to be available, therefore Windows users can install Git Bash.

An alias of ark is created at installation time, so you can also run ark install APP

You can buy an arkade t-shirt in the OpenFaaS Ltd store

Usage

Here's a few examples of apps you can install, for a complete list run: arkade install --help.

  • arkade install - install an app
  • arkade update - update arkade
  • arkade info - the post-install screen for an app

Install an app

No need to worry about whether you're installing to Intel or ARM architecture, the correct values will be set for you automatically.

arkade install openfaas --gateways 2 --load-balancer false

Reduce the repetition

Normally up to a dozen commands (including finding and downloading helm), now just one. No searching for the correct CRD to apply, no trying to install helm, no trying to find the correct helm repo to add:

arkade install cert-manager

Other common tools:

arkade install ingress-nginx

arkade install metrics-server

Bye-bye values.yaml, hello flags

We use strongly typed Go CLI flags, so that you can run --help instead of trawling through countless Helm chart README files to find the correct --set combination for what you want.

arkade install ingress-nginx --help

Install ingress-nginx. This app can be installed with Host networking for
cases where an external LB is not available. please see the --host-mode
flag and the ingress-nginx docs for more info

Usage:
  arkade install ingress-nginx [flags]

Aliases:
  ingress-nginx, nginx-ingress

Examples:
  arkade install ingress-nginx --namespace default

Flags:
      --helm3              Use helm3, if set to false uses helm2 (default true)
  -h, --help               help for ingress-nginx
      --host-mode          If we should install ingress-nginx in host mode.
  -n, --namespace string   The namespace used for installation (default "default")
      --update-repo        Update the helm repo (default true)

Override with --set

You can also set helm overrides, for apps which use helm via --set

ark install openfaas --set=faasIdler.dryRun=false

After installation, an info message will be printed with help for usage, you can get back to this at any time via:

arkade info <NAME>

Get a self-hosted TLS registry with authentication

Here's how you can get a self-hosted Docker registry with TLS and authentication in just 5 commands on an empty cluster:

arkade install ingress-nginx
arkade install cert-manager
arkade install docker-registry
arkade install docker-registry-ingress \
  --email web@example.com \
  --domain reg.example.com

Get OpenFaaS with TLS

The same for OpenFaaS would look like this:

arkade install ingress-nginx
arkade install cert-manager
arkade install openfaas
arkade install openfaas-ingress \
  --email web@example.com \
  --domain reg.example.com

Get a public IP for a private cluster and your IngressController

And if you're running on a private cloud, on-premises or on your laptop, you can simply add the inlets-operator using inlets-pro to get a secure TCP tunnel and a public IP address.

arkade install inlets-operator \
  --access-token $HOME/digitalocean-token \
  --region lon1 \
  --license $(cat $HOME/license.txt)

Tutorials & community blog posts

Explore the apps

arkade install --help
ark --help

cert-manager            Install cert-manager
chart                   Install the specified helm chart
cron-connector          Install cron-connector for OpenFaaS
crossplane              Install Crossplane
docker-registry         Install a Docker registry
docker-registry-ingress Install registry ingress with TLS
info                    Find info about a Kubernetes app
inlets-operator         Install inlets-operator
istio                   Install istio
kafka-connector         Install kafka-connector for OpenFaaS
kubernetes-dashboard    Install kubernetes-dashboard
linkerd                 Install linkerd
metrics-server          Install metrics-server
minio                   Install minio
mongodb                 Install mongodb
ingress-nginx           Install ingress-nginx
openfaas                Install openfaas
openfaas-ingress        Install openfaas ingress with TLS
postgresql              Install postgresql

Community & contributing

Sponsored apps

As of May 2020, you can propose your project or product as a Sponsored App. Sponsored Apps work just like any other app that we've curated, however they will have a note next to them in the app description (sponsored) and a kink to your chosen site upon installation. An app sponsorship can be purchased for a minimum of 12 months and includes free development and support of the app for arkade. When your sponsorship expires your app can be renewed at that time, or it will disappear automatically based upon the end-date.

Email sales@openfaas.com to find out more.

What about helm and k3sup?

In the same way that brew uses git and Makefiles to compile applications for your Mac, arkade uses upstream helm charts and kubectl to install applications to your Kubernetes cluster.

On k3sup vs. arkade: The codebase in this project is derived from k3sup. k3sup (ketchup) was developed to automate building of k3s clusters over SSH, then gained the powerful feature to install apps in a single command. The presence of the word "k3s" in the name of the application confused many people, this is why arkade has come to exist.

And yes, of course it works with k3s and where possible, apps are available for ARM.

Tools and cached versions of helm

When required, tools, CLIs, and the helm binaries are downloaded and extracted to $HOME/.arkade.

If installing a tool which uses helm3, arkade will check for a cached version and use that, otherwise it will download it on demand.

Suggesting a new app

To suggest a new app, please check past issues and raise an issue for it.

Improving the code or fixing an issue

Before contributing code, please see the CONTRIBUTING guide. Note that arkade uses the same guide as inlets.dev.

Both Issues and PRs have their own templates. Please fill out the whole template.

All commits must be signed-off as part of the Developer Certificate of Origin (DCO)

Join us on Slack

Join #arkade on slack.openfaas.io

License

MIT

You can’t perform that action at this time.