godoc

Author: arttor

README.md

@@ -4,6 +4,9 @@
 ![GitHub](https://img.shields.io/github/license/arttor/helmify)
 ![GitHub release (latest by date)](https://img.shields.io/github/v/release/arttor/helmify)
 [![Go Report Card](https://goreportcard.com/badge/github.com/arttor/helmify)](https://goreportcard.com/report/github.com/arttor/helmify)
+[![GoDoc](https://godoc.org/github.com/arttor/helmify?status.svg)](https://pkg.go.dev/github.com/arttor/helmify?tab=doc)
+[![Maintainability](https://api.codeclimate.com/v1/badges/2ee755bb948d363207bb/maintainability)](https://codeclimate.com/github/arttor/helmify/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/2ee755bb948d363207bb/test_coverage)](https://codeclimate.com/github/arttor/helmify/test_coverage)
 ![Works](https://img.shields.io/badge/works-on--my--machine-blueviolet)
 
 Helmify reads kubernetes resources from std.in and produces a [Helm](https://github.com/helm/helm) chart.
@@ -29,7 +32,7 @@ Tested with operator-sdk version: "v1.8.0".
 ```makefile
 HELMIFY = $(shell pwd)/bin/helmify
 helmify:
-	$(call go-get-tool,$(HELMIFY),github.com/arttor/helmify/cmd/[email protected].0)
+	$(call go-get-tool,$(HELMIFY),github.com/arttor/helmify/cmd/[email protected].2)
 
 helm: manifests kustomize helmify
 	$(KUSTOMIZE) build config/default | $(HELMIFY)

internal/test_utils.go

@@ -17,6 +17,7 @@ metadata:
 
 var TestNs = GenerateObj(nsYaml)
 
+// GenerateObj generates unstructured form yaml string.
 func GenerateObj(objYaml string) *unstructured.Unstructured {
 	obj := unstructured.Unstructured{}
 	dec := yaml.NewDecodingSerializer(unstructured.UnstructuredJSONScheme)

pkg/app/app.go

@@ -20,7 +20,7 @@ import (
 	"syscall"
 )
 
-// Start point for application to process input to a Helm chart.
+// Start - application entrypoint for processing input to a Helm chart.
 func Start(input io.Reader, config config.Config) error {
 	setLogLevel(config)
 	ctx, cancelFunc := context.WithCancel(context.Background())

pkg/flags/flags.go

@@ -19,6 +19,7 @@ Usage:
 Flags:
 `
 
+// Read command-line flags into app config.
 func Read() config.Config {
 	result := config.Config{}
 	var h, help bool

pkg/helm/doc.go

@@ -0,0 +1,2 @@
+// Package helm contains code for writing templates to a filesystem as Helm chart.
+package helm

pkg/helmify/context.go

@@ -17,17 +17,20 @@ type Context struct {
 	objects    []*unstructured.Unstructured
 }
 
+// WithOutput returns context with output set.
 func (c *Context) WithOutput(output Output) *Context {
 	c.output = output
 	return c
 }
 
+// WithConfig returns context with config set.
 func (c *Context) WithConfig(config config.Config) *Context {
 	c.config = config
 	c.info.ChartName = config.ChartName
 	return c
 }
 
+// WithProcessors  add processors to the context and returns it.
 func (c *Context) WithProcessors(processors ...Processor) *Context {
 	c.processors = append(c.processors, processors...)
 	return c

pkg/processor/configmap/configmap.go

@@ -37,13 +37,15 @@ var (
 	}
 )
 
+// New creates processor for k8s ConfigMap resource.
 func New() helmify.Processor {
 	return &configMap{}
 }
 
 type configMap struct {
 }
 
+// Process k8s ConfigMap object into template. Returns false if not capable of processing given resource type.
 func (d configMap) Process(info helmify.ChartInfo, obj *unstructured.Unstructured) (bool, helmify.Template, error) {
 	if obj.GroupVersionKind() != configMapGVC {
 		return false, nil, nil

pkg/processor/crd/crd.go

@@ -35,13 +35,15 @@ var crdGVC = schema.GroupVersionKind{
 	Kind:    "CustomResourceDefinition",
 }
 
+// New creates processor for k8s CustomResourceDefinition resource.
 func New() helmify.Processor {
 	return &crd{}
 }
 
 type crd struct {
 }
 
+// Process k8s CustomResourceDefinition object into template. Returns false if not capable of processing given resource type.
 func (c crd) Process(info helmify.ChartInfo, obj *unstructured.Unstructured) (bool, helmify.Template, error) {
 	if obj.GroupVersionKind() != crdGVC {
 		return false, nil, nil

pkg/processor/deployment/deployment.go

@@ -49,13 +49,15 @@ spec:
     spec:
 %[2]s`
 
+// New creates processor for k8s Deployment resource.
 func New() helmify.Processor {
 	return &deployment{}
 }
 
 type deployment struct {
 }
 
+// Process k8s Deployment object into template. Returns false if not capable of processing given resource type.
 func (d deployment) Process(info helmify.ChartInfo, obj *unstructured.Unstructured) (bool, helmify.Template, error) {
 	if obj.GroupVersionKind() != deploymentGVC {
 		return false, nil, nil

pkg/processor/deployment/deployment_test.go

@@ -26,8 +26,21 @@ spec:
         control-plane: controller-manager
     spec:
       containers:
+      - args:
+        - --secure-listen-address=0.0.0.0:8443
+        - --upstream=http://127.0.0.1:8080/
+        - --logtostderr=true
+        - --v=10
+        image: gcr.io/kubebuilder/kube-rbac-proxy:v0.8.0
+        name: kube-rbac-proxy
+        ports:
+        - containerPort: 8443
+          name: https
       - args:
         - --health-probe-bind-address=:8081
+        - --metrics-bind-address=127.0.0.1:8080
+        - --leader-elect
+        command:
         - /manager
         volumeMounts:
         - mountPath: /controller_manager_config.yaml
@@ -42,6 +55,19 @@ spec:
               name: my-operator-secret-vars
               key: VAR1
         image: controller:latest
+        livenessProbe:
+          httpGet:
+            path: /healthz
+            port: 8081
+          initialDelaySeconds: 15
+          periodSeconds: 20
+        name: manager
+        readinessProbe:
+          httpGet:
+            path: /readyz
+            port: 8081
+          initialDelaySeconds: 5
+          periodSeconds: 10
         resources:
           limits:
             cpu: 100m