extend target info (#289)

## Description Extend target info with the following properties: Tags Image instance type (micro, large, etc.) Platform (linux distro) add ../vpc/security-group to the location which is only the region currently Launch time ## Type of Change [* ] New Feature
openclarity · May 2, 2023 · d2c799f · d2c799f
1 parent 3739716
commit d2c799f
Show file tree

Hide file tree

Showing 13 changed files with 514 additions and 97 deletions.
diff --git a/api/models/models.gen.go b/api/models/models.gen.go
diff --git a/api/openapi.yaml b/api/openapi.yaml
@@ -1308,6 +1308,18 @@ components:
         - id
       additionalProperties: false
 
+
+    SecurityGroup:
+      type: object
+      description: general cloud security group
+      properties:
+        id:
+          type: string
+          minLength: 1
+      required:
+        - id
+      additionalProperties: false
+
     AwsSecurityGroup:
       type: object
       description: AWS security group
@@ -1448,10 +1460,33 @@ components:
           $ref: '#/components/schemas/CloudProvider'
         location:
           type: string
+        tags:
+          type: array
+          items:
+            $ref: '#/components/schemas/Tag'
+          nullable: true
+        securityGroups:
+          type: array
+          items:
+            $ref: '#/components/schemas/SecurityGroup'
+          nullable: true
+        image:
+          type: string
+        instanceType:
+          type: string
+        platform:
+          type: string
+        launchTime:
+          type: string
+          format: date-time
       required:
         - objectType
         - instanceID
         - location
+        - instanceType
+        - image
+        - platform
+        - launchTime
 
     PodInfo:
       type: object

diff --git a/api/server/server.gen.go b/api/server/server.gen.go
diff --git a/backend/pkg/database/demo.go b/backend/pkg/database/demo.go
@@ -405,12 +405,19 @@ func createVulnerabilityFindings(base models.Finding, vulnerabilities []models.V
 	return ret
 }
 
-func createVMInfo(instanceID, location string, instanceProvider models.CloudProvider) *models.TargetType {
+func createVMInfo(instanceID, location, image, instanceType, platform string,
+	tags []models.Tag, launchTime time.Time, instanceProvider models.CloudProvider,
+) *models.TargetType {
 	info := models.TargetType{}
 	err := info.FromVMInfo(models.VMInfo{
+		Image:            image,
 		InstanceID:       instanceID,
 		InstanceProvider: &instanceProvider,
+		InstanceType:     instanceType,
+		LaunchTime:       launchTime,
 		Location:         location,
+		Platform:         platform,
+		Tags:             &tags,
 	})
 	if err != nil {
 		panic(err)
@@ -448,7 +455,8 @@ func createTargets() []models.Target {
 					TotalNegligibleVulnerabilities: utils.PointerTo(0),
 				},
 			},
-			TargetInfo: createVMInfo(awsInstanceEUCentral11, awsRegionEUCentral1, models.AWS),
+			TargetInfo: createVMInfo(awsInstanceEUCentral11, awsRegionEUCentral1+"/"+awsVPCEUCentral11+"/"+awsSGEUCentral111,
+				"ami-111", "t2.large", "Linux", []models.Tag{{Key: "Name", Value: "target1"}}, time.Now(), models.AWS),
 		},
 		{
 			ScansCount: utils.PointerTo(1),
@@ -467,7 +475,8 @@ func createTargets() []models.Target {
 					TotalNegligibleVulnerabilities: utils.PointerTo(0),
 				},
 			},
-			TargetInfo: createVMInfo(awsInstanceEUCentral12, awsRegionEUCentral1, models.AWS),
+			TargetInfo: createVMInfo(awsInstanceEUCentral12, awsRegionEUCentral1+"/"+awsVPCEUCentral11+"/"+awsSGEUCentral111,
+				"ami-111", "t2.large", "Linux", []models.Tag{{Key: "Name", Value: "target2"}}, time.Now(), models.AWS),
 		},
 		{
 			ScansCount: utils.PointerTo(1),
@@ -486,7 +495,8 @@ func createTargets() []models.Target {
 					TotalNegligibleVulnerabilities: utils.PointerTo(0),
 				},
 			},
-			TargetInfo: createVMInfo(awsInstanceUSEast11, awsRegionUSEast1, models.AWS),
+			TargetInfo: createVMInfo(awsInstanceUSEast11, awsRegionUSEast1+"/"+awsVPCUSEast11+"/"+awsSGUSEast111,
+				"ami-112", "t2.micro", "Linux", []models.Tag{{Key: "Name", Value: "target3"}}, time.Now(), models.AWS),
 		},
 	}
 }

diff --git a/backend/pkg/database/gorm/odata.go b/backend/pkg/database/gorm/odata.go
@@ -331,12 +331,35 @@ var schemaMetas = map[string]odatasql.SchemaMeta{
 	},
 	"VMInfo": {
 		Fields: odatasql.Schema{
-			"objectType":       odatasql.FieldMeta{FieldType: odatasql.PrimitiveFieldType},
-			"instanceID":       odatasql.FieldMeta{FieldType: odatasql.PrimitiveFieldType},
-			"location":         odatasql.FieldMeta{FieldType: odatasql.PrimitiveFieldType},
+			"objectType":   odatasql.FieldMeta{FieldType: odatasql.PrimitiveFieldType},
+			"instanceID":   odatasql.FieldMeta{FieldType: odatasql.PrimitiveFieldType},
+			"location":     odatasql.FieldMeta{FieldType: odatasql.PrimitiveFieldType},
+			"launchTime":   odatasql.FieldMeta{FieldType: odatasql.PrimitiveFieldType},
+			"platform":     odatasql.FieldMeta{FieldType: odatasql.PrimitiveFieldType},
+			"instanceType": odatasql.FieldMeta{FieldType: odatasql.PrimitiveFieldType},
+			"image":        odatasql.FieldMeta{FieldType: odatasql.PrimitiveFieldType},
+			"tags": odatasql.FieldMeta{
+				FieldType: odatasql.CollectionFieldType,
+				CollectionItemMeta: &odatasql.FieldMeta{
+					FieldType:           odatasql.ComplexFieldType,
+					ComplexFieldSchemas: []string{"Tag"},
+				},
+			},
+			"securityGroups": odatasql.FieldMeta{
+				FieldType: odatasql.CollectionFieldType,
+				CollectionItemMeta: &odatasql.FieldMeta{
+					FieldType:           odatasql.ComplexFieldType,
+					ComplexFieldSchemas: []string{"SecurityGroup"},
+				},
+			},
 			"instanceProvider": odatasql.FieldMeta{FieldType: odatasql.PrimitiveFieldType},
 		},
 	},
+	"SecurityGroup": {
+		Fields: odatasql.Schema{
+			"id": odatasql.FieldMeta{FieldType: odatasql.PrimitiveFieldType},
+		},
+	},
 	"ScanFindingsSummary": {
 		Fields: odatasql.Schema{
 			"totalPackages":          odatasql.FieldMeta{FieldType: odatasql.PrimitiveFieldType},

diff --git a/runtime_scan/pkg/orchestrator/configwatcher/scan_runner.go b/runtime_scan/pkg/orchestrator/configwatcher/scan_runner.go
@@ -150,9 +150,15 @@ func (scw *ScanConfigWatcher) createTarget(ctx context.Context, instance types.I
 	info := models.TargetType{}
 	instanceProvider := models.AWS
 	err := info.FromVMInfo(models.VMInfo{
+		Image:            instance.GetImage(),
 		InstanceID:       instance.GetID(),
 		InstanceProvider: &instanceProvider,
+		InstanceType:     instance.GetType(),
+		LaunchTime:       instance.GetLaunchTime(),
 		Location:         instance.GetLocation(),
+		Platform:         instance.GetPlatform(),
+		Tags:             convertTags(instance.GetTags()),
+		SecurityGroups:   createSecurityGroups(instance.GetSecurityGroups()),
 	})
 	if err != nil {
 		return "", fmt.Errorf("failed to create VMInfo: %v", err)
@@ -170,3 +176,24 @@ func (scw *ScanConfigWatcher) createTarget(ctx context.Context, instance types.I
 	}
 	return *createdTarget.Id, nil
 }
+
+func createSecurityGroups(sgs []string) *[]models.SecurityGroup {
+	ret := make([]models.SecurityGroup, len(sgs))
+	for i, sg := range sgs {
+		ret[i] = models.SecurityGroup{
+			Id: sg,
+		}
+	}
+	return &ret
+}
+
+func convertTags(tags []types.Tag) *[]models.Tag {
+	ret := make([]models.Tag, len(tags))
+	for i, tag := range tags {
+		ret[i] = models.Tag{
+			Key:   tag.Key,
+			Value: tag.Val,
+		}
+	}
+	return &ret
+}