Add the comment and change the restful handler to private

src/kubernetes/kubectl.go

@@ -4,11 +4,20 @@ import (
 	"k8s.io/client-go/kubernetes"
 )
 
+/*
+	KubeCtl object is used to interact with the kubernetes cluster.
+	Use the export function New to Get a KubeCtl object.
+*/
 type KubeCtl struct {
 	Clientset kubernetes.Interface
 	Namespace string
 }
 
+/*
+	The API to New a kubectl object and you need to pass two parameters
+	1. The kubernetes clientset object from the client-go library. You can also use the fake-client for testing
+	2. The namespace of the kubernetes you want to manipulate
+*/
 func New(clientset kubernetes.Interface, namespace string) *KubeCtl {
 	return &KubeCtl{
 		Clientset: clientset,

src/kubernetes/nodes.go

@@ -5,10 +5,12 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
+//Get the Node object by the node name
 func (kc *KubeCtl) GetNode(name string) (*corev1.Node, error) {
 	return kc.Clientset.CoreV1().Nodes().Get(name, metav1.GetOptions{})
 }
 
+//Get all nodes from the k8s cluster
 func (kc *KubeCtl) GetNodes() ([]*corev1.Node, error) {
 	nodes := []*corev1.Node{}
 	nodesList, err := kc.Clientset.CoreV1().Nodes().List(metav1.ListOptions{})
@@ -21,6 +23,7 @@ func (kc *KubeCtl) GetNodes() ([]*corev1.Node, error) {
 	return nodes, nil
 }
 
+//Get the external IP address of node
 func (kc *KubeCtl) GetNodeExternalIP(name string) (string, error) {
 	node, err := kc.GetNode(name)
 	if err != nil {

src/server/handler_version.go

@@ -5,7 +5,7 @@ import (
 	"github.com/linkernetworks/vortex/src/serviceprovider"
 )
 
-func VersionHandler(sp *serviceprovider.Container) restful.RouteFunction {
+func versionHandler(sp *serviceprovider.Container) restful.RouteFunction {
 	return func(req *restful.Request, resp *restful.Response) {
 	}
 }

src/server/route.go

@@ -25,7 +25,7 @@ func (a *App) AppRoute() *mux.Router {
 func newVersionService(sp *serviceprovider.Container) *restful.WebService {
 	webService := new(restful.WebService)
 	webService.Path("/v1/versions").Consumes(restful.MIME_JSON, restful.MIME_JSON).Produces(restful.MIME_JSON, restful.MIME_JSON)
-	webService.Route(webService.GET("/").To(VersionHandler(sp)))
+	webService.Route(webService.GET("/").To(versionHandler(sp)))
 	return webService
 }