support ephemeral containers (#106)

Signed-off-by: Amir Malka <[email protected]>

pkg/apis/softwarecomposition/types.go

@@ -268,8 +268,9 @@ type ApplicationProfile struct {
 }
 
 type ApplicationProfileSpec struct {
-	Containers     []ApplicationProfileContainer
-	InitContainers []ApplicationProfileContainer
+	Containers          []ApplicationProfileContainer
+	InitContainers      []ApplicationProfileContainer
+	EphemeralContainers []ApplicationProfileContainer
 }
 
 type ApplicationProfileContainer struct {

pkg/apis/softwarecomposition/v1beta1/types.go

@@ -248,6 +248,9 @@ type ApplicationProfileSpec struct {
 	// +patchMergeKey=name
 	// +patchStrategy=merge
 	InitContainers []ApplicationProfileContainer `json:"initContainers,omitempty" patchStrategy:"merge" patchMergeKey:"name"`
+	// +patchMergeKey=name
+	// +patchStrategy=merge
+	EphemeralContainers []ApplicationProfileContainer `json:"ephemeralContainers,omitempty" patchStrategy:"merge" patchMergeKey:"name"`
 }
 
 type ApplicationProfileContainer struct {

pkg/cleanup/discovery.go

@@ -139,6 +139,21 @@ func (h *KubernetesAPI) fetchWlidsFromRunningWorkloads(resourceMaps *ResourceMap
 				resourceMaps.RunningWlidsToContainerNames.Get(wlid).Add(nameStr)
 			}
 
+			ephemeralC, ok := workloadinterface.InspectMap(workload.Object, append(workloadinterface.PodSpec(workload.GetKind()), "ephemeralContainers")...)
+			if !ok {
+				continue
+			}
+			ephemralContainers := ephemeralC.([]interface{})
+			for _, container := range ephemralContainers {
+				name, ok := workloadinterface.InspectMap(container, "name")
+				if !ok {
+					logger.L().Debug("container has no name", helpers.String("resource", resource))
+					continue
+				}
+				nameStr := name.(string)
+				resourceMaps.RunningWlidsToContainerNames.Get(wlid).Add(nameStr)
+			}
+
 		}
 	}
 	return nil
@@ -192,6 +207,20 @@ func (h *KubernetesAPI) fetchInstanceIdsAndImageIdsAndReplicasFromRunningPods(re
 			imageIdStr := containerImageId.(string)
 			resourceMaps.RunningContainerImageIds.Add(imageIdStr)
 		}
+
+		ephemeralC, ok := workloadinterface.InspectMap(p.Object, "status", "ephemeralContainerStatuses")
+		if !ok {
+			continue
+		}
+		ephemeralContainers := ephemeralC.([]interface{})
+		for _, cs := range ephemeralContainers {
+			containerImageId, ok := workloadinterface.InspectMap(cs, "imageID")
+			if !ok {
+				continue
+			}
+			imageIdStr := containerImageId.(string)
+			resourceMaps.RunningContainerImageIds.Add(imageIdStr)
+		}
 	}
 	return nil
 }

pkg/registry/file/processor.go

@@ -2,11 +2,12 @@ package file
 
 import (
 	"fmt"
+	"strconv"
+
 	sets "github.com/deckarep/golang-set/v2"
 	"github.com/kubescape/k8s-interface/instanceidhandler/v1/helpers"
 	"github.com/kubescape/storage/pkg/apis/softwarecomposition"
 	"k8s.io/apimachinery/pkg/runtime"
-	"strconv"
 )
 
 type Processor interface {
@@ -46,7 +47,8 @@ func (a ApplicationProfileProcessor) PreSave(object runtime.Object) error {
 		return containers
 	}
 
-	// Use the function for both InitContainers and Containers
+	// Use the function for InitContainers, EphemeralContainers and Containers
+	profile.Spec.EphemeralContainers = processContainers(profile.Spec.EphemeralContainers)
 	profile.Spec.InitContainers = processContainers(profile.Spec.InitContainers)
 	profile.Spec.Containers = processContainers(profile.Spec.Containers)
 

pkg/registry/file/processor_test.go

@@ -2,12 +2,13 @@ package file
 
 import (
 	"fmt"
+	"testing"
+
 	"github.com/kubescape/k8s-interface/instanceidhandler/v1/helpers"
 	"github.com/kubescape/storage/pkg/apis/softwarecomposition"
 	"github.com/stretchr/testify/assert"
 	v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
-	"testing"
 )
 
 func TestApplicationProfileProcessor_PreSave(t *testing.T) {
@@ -18,12 +19,20 @@ func TestApplicationProfileProcessor_PreSave(t *testing.T) {
 		wantErr assert.ErrorAssertionFunc
 	}{
 		{
-			name: "ApplicationProfile with initContainers",
+			name: "ApplicationProfile with initContainers and ephemeralContainers",
 			object: &softwarecomposition.ApplicationProfile{
 				ObjectMeta: v1.ObjectMeta{
 					Annotations: map[string]string{},
 				},
 				Spec: softwarecomposition.ApplicationProfileSpec{
+					EphemeralContainers: []softwarecomposition.ApplicationProfileContainer{
+						{
+							Name: "ephemeralContainer",
+							Execs: []softwarecomposition.ExecCalls{
+								{Path: "/bin/bash", Args: []string{"-c", "echo abc"}},
+							},
+						},
+					},
 					InitContainers: []softwarecomposition.ApplicationProfileContainer{
 						{
 							Name: "initContainer",
@@ -56,10 +65,20 @@ func TestApplicationProfileProcessor_PreSave(t *testing.T) {
 			want: &softwarecomposition.ApplicationProfile{
 				ObjectMeta: v1.ObjectMeta{
 					Annotations: map[string]string{
-						helpers.ResourceSizeMetadataKey: "5",
+						helpers.ResourceSizeMetadataKey: "6",
 					},
 				},
 				Spec: softwarecomposition.ApplicationProfileSpec{
+					EphemeralContainers: []softwarecomposition.ApplicationProfileContainer{
+						{
+							Name:         "ephemeralContainer",
+							Capabilities: []string{},
+							Execs: []softwarecomposition.ExecCalls{
+								{Path: "/bin/bash", Args: []string{"-c", "echo abc"}},
+							},
+							Syscalls: []string{},
+						},
+					},
 					InitContainers: []softwarecomposition.ApplicationProfileContainer{
 						{
 							Name:         "initContainer",