refactor: Rename starboard.workload.* labels to starboard.resource.* (#…

…15)

Signed-off-by: Daniel Pacak <[email protected]>

README.md

@@ -130,13 +130,13 @@ After that you can pull the vulnerabilities reports using the `kubectl get` comm
 
 ```
 $ kubectl get vulnerabilities -n dev -o yaml \
-    -l starboard.workload.kind=Deployment \
-    -l starboard.workload.name=booking-svc
+    -l starboard.resource.kind=Deployment \
+    -l starboard.resource.name=booking-svc
 ```
 
 > **NOTE** The label selectors are used to find vulnerability reports for the specified Deployment.
 > For Deployments with *N* containers Starboard creates *N* instances of `vulnerabilities.aquasecurity.github.io`
-> resources. There's the `starboard.workload.container` label to associate the vulnerability report with a particular
+> resources. There's the `starboard.container.name` label to associate the vulnerability report with a particular
 > container image.
 
 Additionally, you could check for other risks with:
@@ -149,8 +149,8 @@ And get the corresponding report(s):
 
 ```
 $ kubectl get risks -n dev -o yaml \
-    -l starboard.workload.kind=Deployment \
-    -l starboard.workload.name=booking-svc
+    -l starboard.resource.kind=Deployment \
+    -l starboard.resource.name=booking-svc
 ```
 
 ## Contributing

pkg/find/vulnerabilities/crd/writer.go

@@ -37,8 +37,8 @@ func (s *writer) createVulnerability(workload kube.Workload, container string, r
 		ObjectMeta: meta.ObjectMeta{
 			Name: fmt.Sprintf(uuid.New().String()),
 			Labels: map[string]string{
-				kube.LabelWorkloadKind:  workload.Kind.String(),
-				kube.LabelWorkloadName:  workload.Name,
+				kube.LabelResourceKind:  workload.Kind.String(),
+				kube.LabelResourceName:  workload.Name,
 				kube.LabelContainerName: container,
 			},
 		},

pkg/find/vulnerabilities/trivy/scanner.go

@@ -174,8 +174,8 @@ func (s *scanner) prepareJob(workload kube.Workload, spec core.PodSpec) (*batch.
 			Name:      jobName,
 			Namespace: kube.NamespaceStarboard,
 			Labels: map[string]string{
-				kube.LabelWorkloadKind: workload.Kind.String(),
-				kube.LabelWorkloadName: workload.Name,
+				kube.LabelResourceKind: workload.Kind.String(),
+				kube.LabelResourceName: workload.Name,
 			},
 		},
 		Spec: batch.JobSpec{
@@ -185,8 +185,8 @@ func (s *scanner) prepareJob(workload kube.Workload, spec core.PodSpec) (*batch.
 			Template: core.PodTemplateSpec{
 				ObjectMeta: meta.ObjectMeta{
 					Labels: map[string]string{
-						kube.LabelWorkloadKind: workload.Kind.String(),
-						kube.LabelWorkloadName: workload.Name,
+						kube.LabelResourceKind: workload.Kind.String(),
+						kube.LabelResourceName: workload.Name,
 					},
 				},
 				Spec: core.PodSpec{

pkg/kube/workload.go

@@ -9,13 +9,9 @@ const (
 )
 
 const (
-	// Deprecated use LabelResourceKind instead, which is more generic
-	LabelWorkloadKind = "starboard.workload.kind"
-	// Deprecated use LabelResourceName instead, which is more generic
-	LabelWorkloadName  = "starboard.workload.name"
-	LabelContainerName = "starboard.container.name"
 	LabelResourceKind  = "starboard.resource.kind"
 	LabelResourceName  = "starboard.resource.name"
+	LabelContainerName = "starboard.container.name"
 
 	LabelScannerName   = "starboard.scanner.name"
 	LabelScannerVendor = "starboard.scanner.vendor"

pkg/polaris/crd/writer.go

@@ -42,8 +42,8 @@ func (w *writer) Write(report sec.ConfigAudit) (err error) {
 				ObjectMeta: meta.ObjectMeta{
 					Name: name,
 					Labels: map[string]string{
-						kube.LabelWorkloadKind: report.Resource.Kind,
-						kube.LabelWorkloadName: report.Resource.Name,
+						kube.LabelResourceKind: report.Resource.Kind,
+						kube.LabelResourceName: report.Resource.Name,
 					},
 				},
 				Report: report,