Skip to content

Commit

Permalink
ADd note on production usage
Browse files Browse the repository at this point in the history
Signed-off-by: Alex Ellis (OpenFaaS Ltd) <[email protected]>
  • Loading branch information
alexellis committed Jun 25, 2020
1 parent 04dd690 commit 1cc1a16
Showing 1 changed file with 14 additions and 8 deletions.
22 changes: 14 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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:
Expand Down Expand Up @@ -215,6 +215,12 @@ Email [[email protected]](mailto:[email protected]) 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.
Expand Down

0 comments on commit 1cc1a16

Please sign in to comment.