Skip to content

Commit 3650bb9

Browse files
committed
Add note on production usage
Signed-off-by: Alex Ellis (OpenFaaS Ltd) <alexellis2@gmail.com>
1 parent 61abb22 commit 3650bb9

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

_posts/2020-08-28-openfaas-arkade.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,15 +30,19 @@ arkade has evolved since it was first created to install OpenFaaS, to now instal
3030

3131
It then gained the ability to install CLIs such as `faas-cli` and `kubectl` which are relatively easy to find, but when you need 3-5 of these over the course of a short tutorial, break the flow.
3232

33+
During development, Kubernetes clusters can be treated as ephemeral and tools like Kind and k3d make it easy to use them that way. Now if you're anything like us, then you may be re-creating a cluster several times per day to test a PR or change to your project. arkade is built for developers to rapidly get a working system with whatever they need. You can use it in production, or in a pipeline, but you may find that a GitOps style more suitable using a tool like [ArgoCD](https://argoproj.github.io/argo-cd/) or [Flux](https://fluxcd.io).
34+
3335
### Helm 2 - insecure by default
3436

3537
Since around 2017, OpenFaaS was packaged with a [helm](https://helm.sh) chart, and back in those days, you used to have to install a very insecure component to your cluster ([Tiller](https://v2.helm.sh/docs/install/)), which ran in a kind of "God mode." If someone accessed Tiller, and it was very easy to do so, then it would be game over. This wasn't just a problem for OpenFaaS, but for any other helm chart you wanted to install.
3638

3739
Fortunately DevOps professionals had identified a series of 3-5 additional steps that meant you could avoid using Tiller. This involved: fetching a compressed archive and then running a "template" command, which generated plain YAML files, which could be applied using `kubectl`. In addition to these commands, one had to add the specific helm chart repository, synchronise it and do a few other tasks like creating namespaces.
3840

39-
I wrote some code to automate all of this and packaged in a tool called `k3sup` as `k3sup app install openfaas`. The short story is that many users were confused about the `k3sup` and its link to `k3s` naming and so this code was spun out into a new project called `arkade`. This is the same reason that `arkade` is not hosted in the openfaas organisation. Many users adopting Kubernetes could benefit from a platform like OpenFaaS that makes it very simple to get an endpoint up and running without worrying about boiler-plate code, however my fear is that if arkade lived in the openfaas organisation on GitHub, folks would dismiss it as being exclusively for or part of OpenFaaS, which it is not.
41+
I wrote some code to automate all of this and packaged in a tool called `k3sup` as `k3sup app install openfaas`. The short story is that many users were confused about the `k3sup` and its link to `k3s` naming and so this code was spun out into a new project called `arkade`.
42+
43+
> This is the same reason that `arkade` is not hosted in the openfaas organisation. Many users adopting Kubernetes could benefit from a platform like OpenFaaS that makes it very simple to get an endpoint up and running without worrying about boiler-plate code, however my fear is that if arkade lived in the openfaas organisation on GitHub, folks would dismiss it as being exclusively for or part of OpenFaaS, which it is not.
4044
41-
> Note: we recently removed the code to support Helm2 and YAML templating, because Helm 3 arrived and made installation more secure, and easier to use. The Helm 3 binary can still template YAML, but we have not seen much demand for it.
45+
We recently removed the code to support Helm2 and YAML templating, because Helm 3 arrived and made installation more secure, and easier to use. The Helm 3 binary can still template YAML, but we have not seen much demand for it.
4246

4347
### Who's building arkade?
4448

0 commit comments

Comments
 (0)