openfaas / openfaas/faas-cli

Proposal: Install command

Open
#612 14 comments 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area/ux enhancement skill/intermediate
Dominant language
Go
Stars
816
Forks
230
Avg merge
6h 4m
Merged PRs (30d)
1

Description

Goal:

Create a command that installs OpenFaaS in a default configuration suitable for development, proofs of concepts and demonstrations.

The command should support:

  • Docker swarm
  • Kubernetes

Possible goal:

Design solution that is extensible / pluggable for other provider maintainers. Maybe use something like https://github.com/hashicorp/go-plugin and have the installer for each provider in a separate process, or the faas cli just calls the provider installer:

  • install command is invoked
  • plugin is downloaded
  • plugin invoked either through go-plugin or os/exec

Non-goal:

Implement installation for other providers:

  • fargate
  • nomad
  • etc....

Expected Behaviour

Default

faas-cli install

Installs OpenFaaS on Docker Swarm

Platform argument

faas-cli install -p k8s

or

faas-cli install -p swarm

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the faas-cli command structure and the proposed faas-cli install behavior. Compare the Docker Swarm default with the -p k8s platform option, then evaluate the mentioned go-plugin and os/exec approaches for provider installers. Done means a defined, extensible install design supporting Swarm and Kubernetes.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, go, kubernetes
Domain
cli, infrastructure
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.