Add comments to packages

pkg/cmd/argtoenv.go

@@ -1,3 +1,4 @@
+// Package cmd provides viper/cobra for shared command line flags
 package cmd
 
 import (

pkg/config/config.go

@@ -1,3 +1,4 @@
+// Package config provides the common configuration of the Quarks operators
 package config
 
 import (

pkg/crd/crd.go

@@ -1,3 +1,4 @@
+// Package crd handles the creation and updating of our CRDs in the cluster
 package crd
 
 import (

pkg/credsgen/generator.go

@@ -1,3 +1,4 @@
+// Package credsgen is an interface for generating different kinds of credentials
 package credsgen
 
 const (

pkg/kubeconfig/getter.go

@@ -1,3 +1,4 @@
+// Package kubeconfig  gets a valid kube config
 package kubeconfig
 
 import (

pkg/logger/logger.go

@@ -1,3 +1,4 @@
+// Package logger creates a logger for operators
 package logger
 
 import (

pkg/meltdown/meltdown.go

@@ -1,3 +1,4 @@
+// Package meltdown is used by reconcilers to delay reconciling if too many updates happen to a resource
 package meltdown
 
 import (

pkg/monitorednamespace/predicate.go

@@ -1,3 +1,4 @@
+// Package monitorednamespace returns a predicate to filter for resources with the right monitored label, it enables one operator to act on multiple, labeled namespace
 package monitorednamespace
 
 import (

pkg/names/names.go

@@ -1,3 +1,4 @@
+// Package names has helpers for naming resources and generating strings
 package names
 
 import (

pkg/pod/util.go

@@ -1,3 +1,4 @@
+// Package pod has helpers to deal with the Pod struct
 package pod
 
 import (

pkg/pointers/pointers.go

@@ -1,3 +1,4 @@
+// Package pointers has helpers to return pointers for basic types
 package pointers
 
 // Int returns a pointer to the int value provided

pkg/ratelimiter/slow.go

@@ -1,3 +1,4 @@
+// Package ratelimiter provides custom controller-runtime ratelimiters
 package ratelimiter
 
 import (

pkg/skip/skip.go

@@ -1,3 +1,4 @@
+// Package skip helps with skiping reconciles for stale resources
 package skip
 
 import (

pkg/util/util.go

@@ -1,3 +1,4 @@
+// Package util has helpers for dealing with maps and integers
 package util
 
 // UnionMaps creates a new map with all values contained in the maps passed to this function

pkg/versionedsecretstore/versioned_secret.go

@@ -1,3 +1,4 @@
+// Package versionedsecretstore impements versioned secrets, by appending a version suffix to their name
 package versionedsecretstore
 
 import (

pkg/webhook/webhook.go

@@ -1,3 +1,4 @@
+// Package webhook contains shared infrastructure for setting up webhook configs and certificates
 package webhook
 
 import (

testing/command_helper.go

@@ -1,3 +1,4 @@
+// Package testing provides helpers for tests, like wrappers for kubectl and helm
 package testing
 
 import (

testing/e2ehelper/e2e_helper.go

@@ -1,3 +1,4 @@
+// Package e2ehelper has common functionality for the end-to-end test suites
 package e2ehelper
 
 import (

testing/integration/environment.go

@@ -1,3 +1,4 @@
+// Package environment adds everything around mgr.Start() to run a local operator for the integration test suites
 package environment
 
 import (

testing/machine/machine.go

@@ -1,3 +1,4 @@
+// Package machine builds k8s resources for use in integration tests
 package machine
 
 import (

testing/testhelper/config.go

@@ -1,3 +1,4 @@
+// Package testhelper has common helpers for tests
 package testhelper
 
 import (