Skip to content
Permalink
master
Switch branches/tags
Go to file
 
 
Cannot retrieve contributors at this time
239 lines (179 sloc) 8.92 KB

Thanks for helping make Fission better😍!

There are many areas we can use contributions - ranging from code, documentation, feature proposals, issue triage, samples, and content creation.

First, please read the code of conduct. By participating, you're expected to uphold this code.

Table of Contents

Choose something to work on

  • The easiest way to start is to look at existing issues and see if there's something there that you'd like to work on. You can filter issues with label "Good first issue" which are relatively self sufficient issues and great for first time contributors.

    • If you are going to pick up an issue, it would be good to add a comment stating the intention.
    • If the contribution is a big change/new feature, please raise an issue and discuss the needs, design in the issue in detail.
  • For contributing a new Fission environment, please check the environments repo

  • For contributing a new Keda Connector, please check the Keda Connectors repo

Get Help.

Do reach out on Slack or Twitter and we are happy to help.

Contributing - building & deploying

Prerequisite

  • You'll need the go compiler and tools installed. Currently version 1.12.x of Go is needed.

  • You'll also need docker for building images locally.

  • You will need a Kubernetes cluster and you can use one of options from below.

    • Minikube
    • Kind
    • Cluster in cloud such as GKE (Google Kubernetes Engine cluster)/ EKS (Elastic Kubernetes Service)/ AKS (Azure Kubernetes Service)
  • Kubectl and Helm installed.

  • Skaffold for local development workflow to make it easier to build and deploy Fission.

  • And of course some basic concepts of Fission such as environment, function are good to be aware of!

Getting Started

Get the code locally and after you have made changes - you can verify formatting and other basic checks.

# Clone the repo
$ git clone https://github.com/fission/fission.git $GOPATH/src/github.com/fission/fission
$ cd $GOPATH/src/github.com/fission/fission

$ go mod vendor

# Run checks on your changes
$ ./hack/verify-gofmt.sh
$ ./hack/verify-govet.sh

Use Skaffold with Kind/K8S Cluster to build and deploy

You should bring up Kind/Minikube cluster or if using a cloud provider cluster then Kubecontext should be pointing to appropriate cluster.

  • For building & deploying to Cloud Provider K8S cluster such as GKE/EKS/AKS:
$ skaffold config set default-repo vishalbiyani  // (vishalbiyani - should be your registry/Docker Hub handle)
$ skaffold run
  • For building & deploying to Kind cluster use Kind profile
$ kind create cluster
$ kubectl create ns fission
$ skaffold run -p kind

Validating Installation

If you are using Helm, you should see release installed:

helm list
NAME   	NAMESPACE	REVISION	UPDATED                             	STATUS	CHART            	APP VERSION
fission	fission  	1       	2020-05-19 16:31:46.947562 +0530 IST	success	fission-all-1.11.0	1.11.0

Also you should see the Fission services deployed and running:

$ kubectl get pods -n fission
NAME                                                    READY   STATUS             RESTARTS   AGE
buildermgr-6f778d4ff9-dqnq5                             1/1     Running            0          6h9m
controller-d44bd4f4d-5q4z5                              1/1     Running            0          6h9m
executor-557c68c6fd-dg8ld                               1/1     Running            0          6h9m
influxdb-845548c959-2954p                               1/1     Running            0          6h9m
kubewatcher-5784c454b8-5mqsk                            1/1     Running            0          6h9m
logger-bncqn                                            2/2     Running            0          6h9m
mqtrigger-kafka-765b674ff-jk5x9                         1/1     Running            0          6h9m
mqtrigger-nats-streaming-797498966c-xgxmk               1/1     Running            3          6h9m
nats-streaming-6bf48bccb6-fmmr9                         1/1     Running            0          6h9m
router-db76576bd-xxh7r                                  1/1     Running            0          6h9m
storagesvc-799dcb5bdf-f69k9                             1/1     Running            0          6h9m
timer-7d85d9c9fb-knctw                                  1/1     Running            0          6h9m

Understanding code structure

cmd

cmd package is entry point for all runtime components and also has Dockerfile for each component. The actual logic here will be pretty light and most of logic of each component is in pkg (Discussed later)

Component Runtime Component Used in
fetcher Docker Image Environments
fission-bundle Docker Image Binary for all components
fission-cli CLI Binary CLI by user
preupgradechecks Docker Image Pre-install upgrade
.
cmd
├── fetcher
│   ├── Dockerfile.fission-fetcher
│   ├── app
│   └── main.go
├── fission-bundle
│   ├── Dockerfile.fission-bundle
│   ├── main.go
│   └── mqtrigger
├── fission-cli
│   ├── app
│   ├── fission-cli
│   └── main.go
└── preupgradechecks
    ├── Dockerfile.fission-preupgradechecks
    ├── main.go
    └── preupgradechecks.go

fetcher : is a very lightweight component and all of related logic is in fetcher package itself. Fetcher helps in fetching and uploading code and in specializing environments.

fission-bundle : is a component which is a single binary for all components. Based on arguments you pass to fission-bundle - it becomes that component. For ex.

/fission-bundle --controllerPort "8888"							             # Runs Controller

/fission-bundle --kubewatcher --routerUrl http://router.fission  # Runs Kubewatcher

So most server side components running on server side are fission-bundle binary wrapped in container and used with different arguments. Various arguments and environment variables are passed from manifests/helm chart

fission-cli : is the cli used by end user to interact Fission

preupgradechecks : is again a small independent component to do pre-install upgrade tasks.

pkg

Pkg is where most of core components and logic reside. The structure is fairly self-explanatory for example all of executor related functionality will be in executor package and so on.

.
├── pkg
│   ├── apis
│   ├── builder
│   ├── buildermgr
│   ├── cache
│   ├── canaryconfigmgr
│   ├── controller
│   ├── crd
│   ├── error
│   ├── executor
│   ├── fetcher
│   ├── fission-cli
│   ├── generator
│   ├── info
│   ├── kubewatcher
│   ├── logger
│   ├── mqtrigger
│   ├── plugin
│   ├── publisher
│   ├── router
│   ├── storagesvc
│   ├── throttler
│   ├── timer
│   └── utils

Charts

Fission currently has two charts - and we recommend using fission-all for development.

.
├── charts
│   ├── README.md
│   ├── fission-all
│   └── fission-core

Environments

Each of runtime environments is in fission/environments repo and fairly independent. If you are enhancing or creating a new environment - most likely you will end up making changes in that repo.

.
├── environments
│   ├── binary
│   ├── dotnet
│   ├── dotnet20
│   ├── go
│   ├── jvm
│   ├── nodejs
│   ├── perl
│   ├── php7
│   ├── python
│   ├── ruby
│   └── tensorflow-serving