add comments to public methods

equinor · Sep 16, 2024 · 01378fa · 01378fa
1 parent 97e16f4
commit 01378fa
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 46 deletions.
diff --git a/pipeline-runner/internal/jobs/build/acr.go b/pipeline-runner/internal/jobs/build/acr.go
@@ -27,6 +27,7 @@ const (
 	acrHomePath                  = "/home/radix-image-builder"
 )
 
+// NewBuildKit returns a JobBuilder implementation for building components and jobs using radix-image-builder (https://github.com/equinor/radix-image-builder)
 func NewACR() JobsBuilder {
 	return &acr{}
 }

diff --git a/pipeline-runner/internal/jobs/build/buildkit.go b/pipeline-runner/internal/jobs/build/buildkit.go
@@ -27,9 +27,10 @@ const (
 	buildKitHomePath                = "/home/build"
 	buildKitBuildSecretsPath        = "/build-secrets"
 	privateImageHubDockerAuthPath   = "/radix-private-image-hubs"
-	defaultExternalRegistruAuthPath = "/radix-default-external-registry-auth"
+	defaultExternalRegistryAuthPath = "/radix-default-external-registry-auth"
 )
 
+// NewBuildKit returns a JobBuilder implementation for building components and jobs using radix-buildkit-builder (https://github.com/equinor/radix-buildkit-builder)
 func NewBuildKit() JobsBuilder {
 	return &buildKit{}
 }
@@ -239,7 +240,7 @@ func (c *buildKitKubeJobProps) getPodContainerArgs() []string {
 	// When multiple files contains credentials for the same registry (e.g. docker.io), credentials from the last file is used
 	var authFiles []string
 	if len(c.pipelineArgs.ExternalContainerRegistryDefaultAuthSecret) > 0 {
-		authFiles = append(authFiles, path.Join(defaultExternalRegistruAuthPath, corev1.DockerConfigJsonKey))
+		authFiles = append(authFiles, path.Join(defaultExternalRegistryAuthPath, corev1.DockerConfigJsonKey))
 	}
 	authFiles = append(authFiles, path.Join(privateImageHubDockerAuthPath, corev1.DockerConfigJsonKey))
 	for _, authFile := range authFiles {
@@ -347,7 +348,7 @@ func (c *buildKitKubeJobProps) getPodContainerVolumeMounts() []corev1.VolumeMoun
 		volumeMounts = append(volumeMounts,
 			corev1.VolumeMount{
 				Name:      c.pipelineArgs.ExternalContainerRegistryDefaultAuthSecret,
-				MountPath: defaultExternalRegistruAuthPath,
+				MountPath: defaultExternalRegistryAuthPath,
 				ReadOnly:  true,
 			},
 		)

diff --git a/pipeline-runner/internal/jobs/build/interface.go b/pipeline-runner/internal/jobs/build/interface.go
@@ -6,6 +6,8 @@ import (
 	batchv1 "k8s.io/api/batch/v1"
 )
 
+// JobsBuilder defines interface for creating pipeline build jobs
 type JobsBuilder interface {
+	// BuildJobs returns a slice of Kubernetes jobs to be used for building container images for Radix components and jobs
 	BuildJobs(useBuildCache bool, pipelineArgs model.PipelineArguments, cloneURL, gitCommitHash, gitTags string, componentImages []pipeline.BuildComponentImage, buildSecrets []string) []batchv1.Job
 }
diff --git a/pipeline-runner/internal/jobs/build/internal/kubejob.go b/pipeline-runner/internal/jobs/build/internal/kubejob.go
@@ -7,6 +7,7 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
+// KubeJobProps defines properties to be used with the BuildKubeJob function.
 type KubeJobProps interface {
 	JobName() string
 	JobLabels() map[string]string
@@ -21,6 +22,7 @@ type KubeJobProps interface {
 	PodContainers() []corev1.Container
 }
 
+// BuildKubeJob builds a Kubernetes job with properties defined by source argument
 func BuildKubeJob(props KubeJobProps) batchv1.Job {
 	return batchv1.Job{
 		ObjectMeta: metav1.ObjectMeta{

diff --git a/pipeline-runner/internal/jobs/build/kubejob.go b/pipeline-runner/internal/jobs/build/kubejob.go