inspectionsmodels

package
v1.4.6 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 29, 2024 License: MPL-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type VmwareTanzuManageV1alpha1ClusterInspectionScan

type VmwareTanzuManageV1alpha1ClusterInspectionScan struct {

	// Full name for the inspection scan.
	FullName *VmwareTanzuManageV1alpha1ClusterInspectionScanFullName `json:"fullName,omitempty"`

	// Metadata for the inspection object.
	Meta *objectmetamodel.VmwareTanzuCoreV1alpha1ObjectMeta `json:"meta,omitempty"`

	// Inspection Scan spec.
	Spec *VmwareTanzuManageV1alpha1ClusterInspectionScanSpec `json:"spec,omitempty"`

	// Status of the Inspection Scan object.
	Status *VmwareTanzuManageV1alpha1ClusterInspectionScanStatus `json:"status,omitempty"`

	// Metadata describing the type of the resource.
	Type *objectmetamodel.VmwareTanzuCoreV1alpha1ObjectType `json:"type,omitempty"`
}

VmwareTanzuManageV1alpha1ClusterInspectionScan Run an on demand inspection scan on a cluster

Running an inspection scan verifies whether the cluster is certified conformant or security compliant. It is a diagnostic tool that helps you understand the state of a cluster by running a set of tests and provides clear informative reports about the cluster.

swagger:model vmware.tanzu.manage.v1alpha1.cluster.inspection.scan.Scan

func (*VmwareTanzuManageV1alpha1ClusterInspectionScan) MarshalBinary

MarshalBinary interface implementation.

func (*VmwareTanzuManageV1alpha1ClusterInspectionScan) UnmarshalBinary

UnmarshalBinary interface implementation.

type VmwareTanzuManageV1alpha1ClusterInspectionScanCISSpec

type VmwareTanzuManageV1alpha1ClusterInspectionScanCISSpec struct {

	// List of Targets that the CIS plugin will run against.
	CisTargets []*VmwareTanzuManageV1alpha1ClusterInspectionScanCISSpecTargets `json:"cisTargets"`
}

VmwareTanzuManageV1alpha1ClusterInspectionScanCISSpec CIS security inspection scan specification.

swagger:model vmware.tanzu.manage.v1alpha1.cluster.inspection.scan.CISSpec

func (*VmwareTanzuManageV1alpha1ClusterInspectionScanCISSpec) MarshalBinary

MarshalBinary interface implementation.

func (*VmwareTanzuManageV1alpha1ClusterInspectionScanCISSpec) UnmarshalBinary

UnmarshalBinary interface implementation.

type VmwareTanzuManageV1alpha1ClusterInspectionScanCISSpecTargets

type VmwareTanzuManageV1alpha1ClusterInspectionScanCISSpecTargets string

VmwareTanzuManageV1alpha1ClusterInspectionScanCISSpecTargets Targets is an enumeration of targets that CIS can run against.

  • TARGETS_UNSPECIFIED: Unspecified Target refers to an unspecified target.
  • LEADER_NODE: Target is the leader Node.
  • NODE: Target is all nodes apart from the control plane nodes.
  • ETCD: Target is the ETCD.
  • CONTROL_PLANE: Target is the control plane components.
  • POLICIES: Target is the policies on the cluster.

swagger:model vmware.tanzu.manage.v1alpha1.cluster.inspection.scan.CISSpec.Targets

const (

	// VmwareTanzuManageV1alpha1ClusterInspectionScanCISSpecTargetsTARGETSUNSPECIFIED captures enum value "TARGETS_UNSPECIFIED".
	VmwareTanzuManageV1alpha1ClusterInspectionScanCISSpecTargetsTARGETSUNSPECIFIED VmwareTanzuManageV1alpha1ClusterInspectionScanCISSpecTargets = "TARGETS_UNSPECIFIED"

	// VmwareTanzuManageV1alpha1ClusterInspectionScanCISSpecTargetsLEADERNODE captures enum value "LEADER_NODE".
	VmwareTanzuManageV1alpha1ClusterInspectionScanCISSpecTargetsLEADERNODE VmwareTanzuManageV1alpha1ClusterInspectionScanCISSpecTargets = "LEADER_NODE"

	// VmwareTanzuManageV1alpha1ClusterInspectionScanCISSpecTargetsNODE captures enum value "NODE".
	VmwareTanzuManageV1alpha1ClusterInspectionScanCISSpecTargetsNODE VmwareTanzuManageV1alpha1ClusterInspectionScanCISSpecTargets = "NODE"

	// VmwareTanzuManageV1alpha1ClusterInspectionScanCISSpecTargetsETCD captures enum value "ETCD".
	VmwareTanzuManageV1alpha1ClusterInspectionScanCISSpecTargetsETCD VmwareTanzuManageV1alpha1ClusterInspectionScanCISSpecTargets = "ETCD"

	// VmwareTanzuManageV1alpha1ClusterInspectionScanCISSpecTargetsCONTROLPLANE captures enum value "CONTROL_PLANE".
	VmwareTanzuManageV1alpha1ClusterInspectionScanCISSpecTargetsCONTROLPLANE VmwareTanzuManageV1alpha1ClusterInspectionScanCISSpecTargets = "CONTROL_PLANE"

	// VmwareTanzuManageV1alpha1ClusterInspectionScanCISSpecTargetsPOLICIES captures enum value "POLICIES".
	VmwareTanzuManageV1alpha1ClusterInspectionScanCISSpecTargetsPOLICIES VmwareTanzuManageV1alpha1ClusterInspectionScanCISSpecTargets = "POLICIES"
)

func (VmwareTanzuManageV1alpha1ClusterInspectionScanCISSpecTargets) Pointer

Pointer returns a pointer to a freshly-allocated VmwareTanzuManageV1alpha1ClusterInspectionScanCISSpecTargets.

type VmwareTanzuManageV1alpha1ClusterInspectionScanConformanceSpec

type VmwareTanzuManageV1alpha1ClusterInspectionScanConformanceSpec interface{}

VmwareTanzuManageV1alpha1ClusterInspectionScanConformanceSpec Conformance inspection scan specification.

swagger:model vmware.tanzu.manage.v1alpha1.cluster.inspection.scan.ConformanceSpec

type VmwareTanzuManageV1alpha1ClusterInspectionScanData

type VmwareTanzuManageV1alpha1ClusterInspectionScanData struct {

	// Scan to create.
	Scan *VmwareTanzuManageV1alpha1ClusterInspectionScan `json:"scan,omitempty"`
}

VmwareTanzuManageV1alpha1ClusterInspectionScanData Request to create a Scan.

swagger:model vmware.tanzu.manage.v1alpha1.cluster.inspection.scan.CreateScanRequest

func (*VmwareTanzuManageV1alpha1ClusterInspectionScanData) MarshalBinary

MarshalBinary interface implementation.

func (*VmwareTanzuManageV1alpha1ClusterInspectionScanData) UnmarshalBinary

UnmarshalBinary interface implementation.

type VmwareTanzuManageV1alpha1ClusterInspectionScanE2ESpec

type VmwareTanzuManageV1alpha1ClusterInspectionScanE2ESpec interface{}

VmwareTanzuManageV1alpha1ClusterInspectionScanE2ESpec E2E inspection scan specification.

swagger:model vmware.tanzu.manage.v1alpha1.cluster.inspection.scan.E2ESpec

type VmwareTanzuManageV1alpha1ClusterInspectionScanFullName

type VmwareTanzuManageV1alpha1ClusterInspectionScanFullName struct {

	// Name of Cluster.
	ClusterName string `json:"clusterName,omitempty"`

	// Name of management cluster.
	ManagementClusterName string `json:"managementClusterName,omitempty"`

	// Name of the inspection scan.
	Name string `json:"name,omitempty"`

	// Org ID of the inspection scan.
	OrgID string `json:"orgId,omitempty"`

	// Name of Provisioner.
	ProvisionerName string `json:"provisionerName,omitempty"`
}

VmwareTanzuManageV1alpha1ClusterInspectionScanFullName FullName of the inspection scan.

swagger:model vmware.tanzu.manage.v1alpha1.cluster.inspection.scan.FullName

func (*VmwareTanzuManageV1alpha1ClusterInspectionScanFullName) MarshalBinary

MarshalBinary interface implementation.

func (*VmwareTanzuManageV1alpha1ClusterInspectionScanFullName) UnmarshalBinary

UnmarshalBinary interface implementation.

type VmwareTanzuManageV1alpha1ClusterInspectionScanListData

type VmwareTanzuManageV1alpha1ClusterInspectionScanListData struct {

	// List of scans.
	Scans []*VmwareTanzuManageV1alpha1ClusterInspectionScan `json:"scans"`

	// Total count.
	TotalCount string `json:"totalCount,omitempty"`
}

VmwareTanzuManageV1alpha1ClusterInspectionScanListData Response from listing Scans.

swagger:model vmware.tanzu.manage.v1alpha1.cluster.inspection.scan.ListScansResponse

func (*VmwareTanzuManageV1alpha1ClusterInspectionScanListData) MarshalBinary

MarshalBinary interface implementation.

func (*VmwareTanzuManageV1alpha1ClusterInspectionScanListData) UnmarshalBinary

UnmarshalBinary interface implementation.

type VmwareTanzuManageV1alpha1ClusterInspectionScanLiteSpec

type VmwareTanzuManageV1alpha1ClusterInspectionScanLiteSpec interface{}

VmwareTanzuManageV1alpha1ClusterInspectionScanLiteSpec Lite inspection scan specification.

swagger:model vmware.tanzu.manage.v1alpha1.cluster.inspection.scan.LiteSpec

type VmwareTanzuManageV1alpha1ClusterInspectionScanProgressInfo

type VmwareTanzuManageV1alpha1ClusterInspectionScanProgressInfo struct {

	// Number of tests completed.
	NumTestsCompleted string `json:"numTestsCompleted,omitempty"`

	// Number of tests run as part of the inspection scan.
	TotalNumTests string `json:"totalNumTests,omitempty"`
}

VmwareTanzuManageV1alpha1ClusterInspectionScanProgressInfo Progress information about the inspection scan.

swagger:model vmware.tanzu.manage.v1alpha1.cluster.inspection.scan.ProgressInfo

func (*VmwareTanzuManageV1alpha1ClusterInspectionScanProgressInfo) MarshalBinary

MarshalBinary interface implementation.

func (*VmwareTanzuManageV1alpha1ClusterInspectionScanProgressInfo) UnmarshalBinary

UnmarshalBinary interface implementation.

type VmwareTanzuManageV1alpha1ClusterInspectionScanReport

type VmwareTanzuManageV1alpha1ClusterInspectionScanReport struct {

	// Map of all the diagnostic files in the report tarball.
	Diagnostic map[string]string `json:"diagnostic,omitempty"`

	// Map of files containing host information (config, healthz).
	Hosts map[string]string `json:"hosts,omitempty"`

	// Meta-info of this report.
	Info *VmwareTanzuManageV1alpha1ClusterInspectionScanReportInfo `json:"info,omitempty"`

	// Map of files with metadata information about the scan (Config, query time, run).
	Meta map[string]string `json:"meta,omitempty"`

	// Map of all the files ending in .xml.
	Results map[string]string `json:"results,omitempty"`

	// Download URL for the .tar.gz file with this full report.
	TarballDownloadURL string `json:"tarballDownloadUrl,omitempty"`
}

VmwareTanzuManageV1alpha1ClusterInspectionScanReport Encapsulates the data for a Inspection scan run.

swagger:model vmware.tanzu.manage.v1alpha1.cluster.inspection.scan.Report

func (*VmwareTanzuManageV1alpha1ClusterInspectionScanReport) MarshalBinary

MarshalBinary interface implementation.

func (*VmwareTanzuManageV1alpha1ClusterInspectionScanReport) UnmarshalBinary

UnmarshalBinary interface implementation.

type VmwareTanzuManageV1alpha1ClusterInspectionScanReportInfo

type VmwareTanzuManageV1alpha1ClusterInspectionScanReportInfo struct {

	// Kubernetes Server Version.
	KubeServerVersion string `json:"kubeServerVersion,omitempty"`

	// Number of inspections failed.
	NumFailed string `json:"numFailed,omitempty"`

	// Total number of inspections as part of the scan.
	NumInspections string `json:"numInspections,omitempty"`

	// Number of inspection tests in warning state.
	NumWarning string `json:"numWarning,omitempty"`

	// Progress information about the inspection scan.
	ProgressInfo *VmwareTanzuManageV1alpha1ClusterInspectionScanProgressInfo `json:"progressInfo,omitempty"`

	// Internal ID of the run.
	ReportID string `json:"reportId,omitempty"`

	// Result is a success / failure condition based on the result of the scan.
	Result *VmwareTanzuManageV1alpha1ClusterInspectionScanReportInfoResult `json:"result,omitempty"`

	// Date and time of the run.
	// Format: date-time
	RunDatetime strfmt.DateTime `json:"runDatetime,omitempty"`

	// The scan type.
	ScanType string `json:"scanType,omitempty"`
}

VmwareTanzuManageV1alpha1ClusterInspectionScanReportInfo Contains the metadata for a single report (e.g. report id, etc).

swagger:model vmware.tanzu.manage.v1alpha1.cluster.inspection.scan.ReportInfo

func (*VmwareTanzuManageV1alpha1ClusterInspectionScanReportInfo) MarshalBinary

MarshalBinary interface implementation.

func (*VmwareTanzuManageV1alpha1ClusterInspectionScanReportInfo) UnmarshalBinary

UnmarshalBinary interface implementation.

type VmwareTanzuManageV1alpha1ClusterInspectionScanReportInfoResult

type VmwareTanzuManageV1alpha1ClusterInspectionScanReportInfoResult string

VmwareTanzuManageV1alpha1ClusterInspectionScanReportInfoResult Result describes the status of the inspection.

  • RESULT_UNSPECIFIED: Unspecified result indicates the scan result is unknown.
  • SUCCESS: Success - to be used if all the tests are part of the scan are successful.
  • FAILURE: Failure - to indicate that one or more test as part of the scan failed.
  • WARNING: Warning - to indicate that one or more test as part of the scan has a warning error.

swagger:model vmware.tanzu.manage.v1alpha1.cluster.inspection.scan.ReportInfo.Result

const (

	// VmwareTanzuManageV1alpha1ClusterInspectionScanReportInfoResultRESULTUNSPECIFIED captures enum value "RESULT_UNSPECIFIED".
	VmwareTanzuManageV1alpha1ClusterInspectionScanReportInfoResultRESULTUNSPECIFIED VmwareTanzuManageV1alpha1ClusterInspectionScanReportInfoResult = "RESULT_UNSPECIFIED"

	// VmwareTanzuManageV1alpha1ClusterInspectionScanReportInfoResultSUCCESS captures enum value "SUCCESS".
	VmwareTanzuManageV1alpha1ClusterInspectionScanReportInfoResultSUCCESS VmwareTanzuManageV1alpha1ClusterInspectionScanReportInfoResult = "SUCCESS"

	// VmwareTanzuManageV1alpha1ClusterInspectionScanReportInfoResultFAILURE captures enum value "FAILURE".
	VmwareTanzuManageV1alpha1ClusterInspectionScanReportInfoResultFAILURE VmwareTanzuManageV1alpha1ClusterInspectionScanReportInfoResult = "FAILURE"

	// VmwareTanzuManageV1alpha1ClusterInspectionScanReportInfoResultWARNING captures enum value "WARNING".
	VmwareTanzuManageV1alpha1ClusterInspectionScanReportInfoResultWARNING VmwareTanzuManageV1alpha1ClusterInspectionScanReportInfoResult = "WARNING"
)

func (VmwareTanzuManageV1alpha1ClusterInspectionScanReportInfoResult) Pointer

Pointer returns a pointer to a freshly-allocated VmwareTanzuManageV1alpha1ClusterInspectionScanReportInfoResult.

type VmwareTanzuManageV1alpha1ClusterInspectionScanSpec

type VmwareTanzuManageV1alpha1ClusterInspectionScanSpec struct {

	// CIS security inspection scan specification.
	CisSpec *VmwareTanzuManageV1alpha1ClusterInspectionScanCISSpec `json:"cisSpec,omitempty"`

	// Conformance inspection scan specification.
	ConformanceSpec VmwareTanzuManageV1alpha1ClusterInspectionScanConformanceSpec `json:"conformanceSpec,omitempty"`

	// E2E inspection scan specification.
	E2eSpec VmwareTanzuManageV1alpha1ClusterInspectionScanE2ESpec `json:"e2eSpec,omitempty"`

	// Lite inspection scan specification.
	LiteSpec VmwareTanzuManageV1alpha1ClusterInspectionScanLiteSpec `json:"liteSpec,omitempty"`
}

VmwareTanzuManageV1alpha1ClusterInspectionScanSpec Spec of the inspection scan.

swagger:model vmware.tanzu.manage.v1alpha1.cluster.inspection.scan.Spec

func (*VmwareTanzuManageV1alpha1ClusterInspectionScanSpec) MarshalBinary

MarshalBinary interface implementation.

func (*VmwareTanzuManageV1alpha1ClusterInspectionScanSpec) UnmarshalBinary

UnmarshalBinary interface implementation.

type VmwareTanzuManageV1alpha1ClusterInspectionScanStatus

type VmwareTanzuManageV1alpha1ClusterInspectionScanStatus struct {

	// Available phases of the inspection scan resource.
	AvailablePhases []*VmwareTanzuManageV1alpha1ClusterInspectionScanStatusPhase `json:"availablePhases"`

	// Condition 'Scheduled' with Status 'Unknown' indicates that the inspection is pending
	// Condition 'Scheduled' with 'True' and Condition 'Ready' with 'Unknown' indicates that the inspection is running
	// Condition 'Ready' with 'True' indicates that the inspection is complete
	// Condition 'Ready' with 'False' indicates that the inspection is in error state.
	Conditions map[string]statusmodel.VmwareTanzuCoreV1alpha1StatusCondition `json:"conditions,omitempty"`

	// Phase of the inspection scan based on conditions. If state is 'PHASE_UNSPECIFIED', use conditions to
	// interpret the state of the inspection.
	Phase *VmwareTanzuManageV1alpha1ClusterInspectionScanStatusPhase `json:"phase,omitempty"`

	// Additional information e.g., reason for ERROR state.
	PhaseInfo string `json:"phaseInfo,omitempty"`

	// Report details.
	Report *VmwareTanzuManageV1alpha1ClusterInspectionScanReport `json:"report,omitempty"`
}

VmwareTanzuManageV1alpha1ClusterInspectionScanStatus Status of the scan inspection.

swagger:model vmware.tanzu.manage.v1alpha1.cluster.inspection.scan.Status

func (*VmwareTanzuManageV1alpha1ClusterInspectionScanStatus) MarshalBinary

MarshalBinary interface implementation.

func (*VmwareTanzuManageV1alpha1ClusterInspectionScanStatus) UnmarshalBinary

UnmarshalBinary interface implementation.

type VmwareTanzuManageV1alpha1ClusterInspectionScanStatusPhase

type VmwareTanzuManageV1alpha1ClusterInspectionScanStatusPhase string

VmwareTanzuManageV1alpha1ClusterInspectionScanStatusPhase Phase describes the phase] of the inspection scan.

  • PHASE_UNSPECIFIED: Unknown - to be used if status of the current inspection scan is unknown.
  • RUNNING: Running - to indicate the inspection scan is currently running.
  • PENDING: Pending - to indicate that the inspectionscan is waiting to be started.
  • COMPLETE: Complete - to indicate that the sonobuoy open source has completed the inspection scan.
  • UPLOAD: Upload - to indicate that the inspection scan results are being uploaded to S3.
  • FINISH: Finish - to indicate that the inspection has completed inspection + uploaded results to S3 successfully.
  • STOP: Stop - to stop the sonobuoy inspection.
  • ERROR: Error - to indicate that an error had occurred during the inspection.
  • QUEUED: Queued - to indicate that the inspection is queued and waiting to be applied.
  • CANCEL: CANCEL - to indicate that the inspection is canceled.

swagger:model vmware.tanzu.manage.v1alpha1.cluster.inspection.scan.Status.Phase

const (

	// VmwareTanzuManageV1alpha1ClusterInspectionScanStatusPhasePHASEUNSPECIFIED captures enum value "PHASE_UNSPECIFIED".
	VmwareTanzuManageV1alpha1ClusterInspectionScanStatusPhasePHASEUNSPECIFIED VmwareTanzuManageV1alpha1ClusterInspectionScanStatusPhase = "PHASE_UNSPECIFIED"

	// VmwareTanzuManageV1alpha1ClusterInspectionScanStatusPhaseRUNNING captures enum value "RUNNING".
	VmwareTanzuManageV1alpha1ClusterInspectionScanStatusPhaseRUNNING VmwareTanzuManageV1alpha1ClusterInspectionScanStatusPhase = "RUNNING"

	// VmwareTanzuManageV1alpha1ClusterInspectionScanStatusPhasePENDING captures enum value "PENDING".
	VmwareTanzuManageV1alpha1ClusterInspectionScanStatusPhasePENDING VmwareTanzuManageV1alpha1ClusterInspectionScanStatusPhase = "PENDING"

	// VmwareTanzuManageV1alpha1ClusterInspectionScanStatusPhaseCOMPLETE captures enum value "COMPLETE".
	VmwareTanzuManageV1alpha1ClusterInspectionScanStatusPhaseCOMPLETE VmwareTanzuManageV1alpha1ClusterInspectionScanStatusPhase = "COMPLETE"

	// VmwareTanzuManageV1alpha1ClusterInspectionScanStatusPhaseUPLOAD captures enum value "UPLOAD".
	VmwareTanzuManageV1alpha1ClusterInspectionScanStatusPhaseUPLOAD VmwareTanzuManageV1alpha1ClusterInspectionScanStatusPhase = "UPLOAD"

	// VmwareTanzuManageV1alpha1ClusterInspectionScanStatusPhaseFINISH captures enum value "FINISH".
	VmwareTanzuManageV1alpha1ClusterInspectionScanStatusPhaseFINISH VmwareTanzuManageV1alpha1ClusterInspectionScanStatusPhase = "FINISH"

	// VmwareTanzuManageV1alpha1ClusterInspectionScanStatusPhaseSTOP captures enum value "STOP".
	VmwareTanzuManageV1alpha1ClusterInspectionScanStatusPhaseSTOP VmwareTanzuManageV1alpha1ClusterInspectionScanStatusPhase = "STOP"

	// VmwareTanzuManageV1alpha1ClusterInspectionScanStatusPhaseERROR captures enum value "ERROR".
	VmwareTanzuManageV1alpha1ClusterInspectionScanStatusPhaseERROR VmwareTanzuManageV1alpha1ClusterInspectionScanStatusPhase = "ERROR"

	// VmwareTanzuManageV1alpha1ClusterInspectionScanStatusPhaseQUEUED captures enum value "QUEUED".
	VmwareTanzuManageV1alpha1ClusterInspectionScanStatusPhaseQUEUED VmwareTanzuManageV1alpha1ClusterInspectionScanStatusPhase = "QUEUED"

	// VmwareTanzuManageV1alpha1ClusterInspectionScanStatusPhaseCANCEL captures enum value "CANCEL".
	VmwareTanzuManageV1alpha1ClusterInspectionScanStatusPhaseCANCEL VmwareTanzuManageV1alpha1ClusterInspectionScanStatusPhase = "CANCEL"
)

func (VmwareTanzuManageV1alpha1ClusterInspectionScanStatusPhase) Pointer

Pointer returns a pointer to a freshly-allocated VmwareTanzuManageV1alpha1ClusterInspectionScanStatusPhase.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL