pkg

Documentation

Overview

Package types Copyright 2022 VMware, Inc. SPDX-License-Identifier: Apache-2.0

Index

• type AssessmentError
• type AssessmentFailure
• type AssessmentReport
• type CISReport
• type NamespaceAssessment
• type NamespaceInfo
• type WorkloadAssessment
• type WorkloadInfo
• type WorkloadReport

Types

type AssessmentError

type AssessmentError struct {
	Code  uint32 `json:"code,omitempty"`
	Error string `json:"error"`
	Cause string `json:"cause,omitempty"`
}

AssessmentError defines the error of assessment.

type AssessmentFailure

type AssessmentFailure struct {
	// The failure is based on which baseline
	Baseline v1alpha1.ComplianceBaseline
	// For which container (image)?
	Container workload.Container `json:"container"`
	// What error occurred?
	AssessmentError AssessmentError `json:"assessmentError"`
}

AssessmentFailure defines failures of the assessment.

type AssessmentReport

type AssessmentReport struct {
	TimeStamp            string                 `json:"timeStamp"`
	DocID                string                 `json:"docID"`
	NamespaceAssessments []*NamespaceAssessment `json:"namespaceAssessments"`
}

AssessmentReport struct definition

type CISReport

type CISReport struct {
	check.Controls
	CreateTimestamp string `json:"createTime"`
	NodeName        string `json:"nodeName"`
	DocID           string `json:"docID"`
}

type NamespaceAssessment

type NamespaceAssessment struct {
	// Which namespace?
	Namespace v1.LocalObjectReference `json:"namespace"`
	// Assessments contains results of namespace assessments.
	WorkloadAssessments []*WorkloadAssessment `json:"workloadAssessments"`
}

NamespaceAssessment defines assessment results for each Namespace.

type NamespaceInfo

type NamespaceInfo struct {
	// Which namespace?
	Namespace v1.LocalObjectReference `json:"namespace"`
	// Assessments contains results of namespace assessments.
	WorkloadInfos []*WorkloadInfo `json:"workloadInfos"`
}

NamespaceInfo defines information for each Namespace.

type WorkloadAssessment

type WorkloadAssessment struct {
	// For which workload is assessing?
	Workload wl.Workload `json:"workload"`
	// Indicates if all the compliance checks are passed.
	Passed bool `json:"passed"`
	// Keep all the failures of the assessment when passed is false.
	Failures []*AssessmentFailure `json:"failures,omitempty"`
}

WorkloadAssessment defines assessment results for each Workload.

type WorkloadInfo

type WorkloadInfo struct {
	// For which workload is assessing?
	Workload workload.Workload `json:"workload"`
}

WorkloadInfo defines information for each Workload.

type WorkloadReport

type WorkloadReport struct {
	NamespaceInfos []*NamespaceInfo `json:"namespaceInfos"`
}

WorkloadReport struct definition