v1alpha2

Documentation

Overview

Package v1alpha2 contains API Schema definitions for the cache v1alpha2 API group +k8s:deepcopy-gen=package,register +groupName=osdk.openshift.io

Index

• Variables
• type ScorecardOutput
  • func NewScorecardOutput() *ScorecardOutput
  • func (in *ScorecardOutput) DeepCopy() *ScorecardOutput
  • func (in *ScorecardOutput) DeepCopyInto(out *ScorecardOutput)
  • func (in *ScorecardOutput) DeepCopyObject() runtime.Object
  • func (s ScorecardOutput) MarshalText() (string, error)
• type ScorecardTestResult
  • func (in *ScorecardTestResult) DeepCopy() *ScorecardTestResult
  • func (in *ScorecardTestResult) DeepCopyInto(out *ScorecardTestResult)
• type State

Variables

var (
	// SchemeGroupVersion is group version used to register these objects
	SchemeGroupVersion = schema.GroupVersion{Group: "osdk.openshift.io", Version: "v1alpha2"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion}
)

Types

type ScorecardOutput

type ScorecardOutput struct {
	metav1.TypeMeta `json:",inline"`
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`

	// Log contains the scorecard's log.
	Log string `json:"log"`
	// Results is an array of ScorecardTestResult for the current scorecard run.
	Results []ScorecardTestResult `json:"results"`
}

ScorecardOutput is the schema for the scorecard API

func NewScorecardOutput

func NewScorecardOutput() *ScorecardOutput

func (*ScorecardOutput) DeepCopy

func (in *ScorecardOutput) DeepCopy() *ScorecardOutput

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ScorecardOutput.

func (*ScorecardOutput) DeepCopyInto

func (in *ScorecardOutput) DeepCopyInto(out *ScorecardOutput)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ScorecardOutput) DeepCopyObject

func (in *ScorecardOutput) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (ScorecardOutput) MarshalText

func (s ScorecardOutput) MarshalText() (string, error)

type ScorecardTestResult

type ScorecardTestResult struct {
	// Name is the name of the test
	Name string `json:"name"`
	// Description describes what the test does
	Description string `json:"description"`
	// Labels that further describe the test and enable selection
	Labels map[string]string `json:"labels,omitempty"`
	// State is the final state of the test
	State State `json:"state,omitempty"`
	// Errors is a list of the errors that occurred during the test (this can include both fatal and non-fatal errors)
	Errors []string `json:"errors,omitempty"`
	// Suggestions is a list of suggestions for the user to improve their score (if applicable)
	Suggestions []string `json:"suggestions,omitempty"`
	// Log holds a log produced from the test (if applicable)
	Log string `json:"log,omitempty"`
	// CRName holds the CR name this test was run with (if applicable)
	CRName string `json:"crname,omitempty"`
}

ScorecardTestResult contains the results of an individual scorecard test.

func (*ScorecardTestResult) DeepCopy

func (in *ScorecardTestResult) DeepCopy() *ScorecardTestResult

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ScorecardTestResult.

func (*ScorecardTestResult) DeepCopyInto

func (in *ScorecardTestResult) DeepCopyInto(out *ScorecardTestResult)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type State

type State string

State is a type used to indicate the result state of a Test.

const (
	// NotRun occurs when a user specifies the --list flag
	NotRunState State = ""
	// PassState occurs when a Test's ExpectedPoints == MaximumPoints.
	PassState State = "pass"
	// FailState occurs when a Test's ExpectedPoints == 0.
	FailState State = "fail"
	// ErrorState occurs when a Test encounters a fatal error and the reported points should not be considered.
	ErrorState State = "error"
)