Add comments above handlers

Adding comments above handlers with slight
description on their purpouse to be displayed
in the godoc for the openfaas-cloud repository

Signed-off-by: Martin Dekov (VMware) <[email protected]>

github-status/handler.go

@@ -31,7 +31,9 @@ var (
 	token = ""
 )
 
-// Handle a serverless request
+// Handle reports the building process of the
+// function along with the function stack by sending
+// commit statuses to GitHub on pending, failure or success
 func Handle(req []byte) string {
 
 	if hmacEnabled() {

gitlab-event/handler.go

@@ -28,7 +28,9 @@ var (
 	supportedEvents = [...]string{PushEvent, ProjectUpdateEvent, ProjectDestroyEvent}
 )
 
-// Handle a serverless request
+// Handle is the function which accepts events from
+// GitLab and filters them also checks if the repository
+// is installed on the cloud
 func Handle(req []byte) string {
 	eventHeader := os.Getenv("Http_X_Gitlab_Event")
 	xGitlabToken := os.Getenv("Http_X_Gitlab_Token")

gitlab-push/handler.go

@@ -24,7 +24,9 @@ const (
 
 var audit sdk.Audit
 
-// Handle a serverless request
+// Handle accepts push event from gitlab-event
+// and transforms the payload into PushEvent struct
+// which is then sent to git-tar for a function to be built
 func Handle(req []byte) string {
 	validateErr := validateRequest(req)
 	if validateErr != nil {

gitlab-status/handler.go

@@ -11,7 +11,9 @@ import (
 	"github.com/openfaas/openfaas-cloud/sdk"
 )
 
-// Handle a serverless request
+// Handle reports the building process of the
+// function and the function stack to GitLab by
+// sending commit statuses on pending, success, failure
 func Handle(req []byte) string {
 	if validateError := validateRequest(req); validateError != nil {
 		log.Fatal(validateError)

import-secrets/handler.go

@@ -17,7 +17,9 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
-// Handle a serverless request
+// Handle uses SealedSecrets to bind the secrets
+// to the cluster so the buildshiprun can bind user
+// secrets to function
 func Handle(req []byte) string {
 	event := getEventFromHeader()
 

list-functions/handler.go

@@ -13,7 +13,10 @@ import (
 	"github.com/openfaas/openfaas-cloud/sdk"
 )
 
-// Handle a serverless request
+// Handle takes the functions which are built
+// by buildshiprun and exposes the function object
+// to be consumed by the dashboard so the function
+// can be displayed
 func Handle(req []byte) string {
 
 	user := string(req)

pipeline-log/handler.go

@@ -14,7 +14,8 @@ import (
 	"github.com/openfaas/openfaas-cloud/sdk"
 )
 
-// Handle a serverless request
+// Handle sends the function logs to the
+// pipeline to be exposed in the dashboard
 func Handle(req []byte) string {
 	method := os.Getenv("Http_Method")
 

system-metrics/handler.go

@@ -17,7 +17,7 @@ type Metrics struct {
 	Failure int `json:"failure"`
 }
 
-// Handle a serverless request
+// Handle exposes the OpenFaaS instance metrics
 func Handle(req []byte) string {
 	fnName, err := parseFunctionName()