From 1cc1a16e1e978b33ebcda25f3a1dbc88f84985f8 Mon Sep 17 00:00:00 2001 From: "Alex Ellis (OpenFaaS Ltd)" Date: Thu, 25 Jun 2020 22:10:07 +0100 Subject: [PATCH] ADd note on production usage Signed-off-by: Alex Ellis (OpenFaaS Ltd) --- README.md | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 0990a7904..16c829d50 100644 --- a/README.md +++ b/README.md @@ -43,14 +43,6 @@ Here's a few examples of apps you can install, for a complete list run: `arkade * `arkade get` - install a CLI tool such as `kubectl` or `faas-cli` * `arkade update` - print instructions to update arkade itself -### 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. - -```bash -arkade install openfaas --gateways 2 --load-balancer false -``` - ### Install a CLI tool arkade will determine the correct URL to download a CLI tool of your choice taking into account for your Operating System and CPU architecture - whether Intel or ARM. @@ -66,6 +58,14 @@ arkade get helm Think of `arkade get TOOL` as a doing for CLIs, what `arkade install` does for helm. +### 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. + +```bash +arkade install openfaas --gateways 2 --load-balancer false +``` + #### Reduce the repetition [Normally up to a dozen commands](https://cert-manager.io/docs/installation/kubernetes/) (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: @@ -215,6 +215,12 @@ Email [sales@openfaas.com](mailto:sales@openfaas.com) to find out more. In the same way that [brew](https://brew.sh) uses git and Makefiles to compile applications for your Mac, `arkade` uses upstream [helm](https://helm.sh) charts and `kubectl` to install applications to your Kubernetes cluster. arkade exposes strongly-typed flags for the various popular options for helm charts, and enables easier discovery through `arkade install --help` and `arkade install APP --help`. +### Is arkade suitable for production use? + +If you consider helm suitable, and `kubectl` then yes, arkade by definition uses those tools and the upstream artifacts of OSS projects. + +Do you want to run arkade in a CI or CD pipeline? Go ahead. + ### What is in scope for `arkade get`? Generally speaking, tools that are used with the various arkade apps or with Kubernetes are in scope. If you want to propose a tool, raise a GitHub issue.