Documentation ¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the konfirm v1alpha1 API group +kubebuilder:object:generate=true +groupName=konfirm.goraft.tech
Index ¶
- Constants
- Variables
- type HelmPolicy
- type HelmPolicyList
- type HelmPolicySpec
- type RetainPolicy
- type Test
- type TestList
- type TestPhase
- type TestResult
- type TestRun
- type TestRunList
- type TestRunPhase
- type TestRunSpec
- type TestRunStatus
- type TestSpec
- type TestStatus
- type TestSuite
- type TestSuiteHelmSetUp
- type TestSuiteHelmTrigger
- type TestSuiteList
- type TestSuitePhase
- type TestSuiteSetUp
- type TestSuiteSpec
- type TestSuiteStatus
- type TestSuiteTrigger
- type TestSuiteTriggers
- type TestTemplate
Constants ¶
const GroupName = "konfirm.goraft.tech"
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1alpha1"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion} // AddToScheme adds the types in this group-version to the given scheme. AddToScheme = SchemeBuilder.AddToScheme )
Functions ¶
This section is empty.
Types ¶
type HelmPolicy ¶
type HelmPolicy struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec HelmPolicySpec `json:"spec,omitempty"` }
HelmPolicy is the Schema for the helmpolicies API
func (*HelmPolicy) DeepCopy ¶
func (in *HelmPolicy) DeepCopy() *HelmPolicy
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HelmPolicy.
func (*HelmPolicy) DeepCopyInto ¶
func (in *HelmPolicy) DeepCopyInto(out *HelmPolicy)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*HelmPolicy) DeepCopyObject ¶
func (in *HelmPolicy) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type HelmPolicyList ¶
type HelmPolicyList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []HelmPolicy `json:"items"` }
HelmPolicyList contains a list of HelmPolicy
func (*HelmPolicyList) DeepCopy ¶
func (in *HelmPolicyList) DeepCopy() *HelmPolicyList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HelmPolicyList.
func (*HelmPolicyList) DeepCopyInto ¶
func (in *HelmPolicyList) DeepCopyInto(out *HelmPolicyList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*HelmPolicyList) DeepCopyObject ¶
func (in *HelmPolicyList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type HelmPolicySpec ¶
type HelmPolicySpec struct { // ExportTo specifies namespaces permitted to observe a release ExportTo []string `json:"exportTo,omitempty"` }
HelmPolicySpec defines the desired state of HelmPolicy
func (*HelmPolicySpec) DeepCopy ¶
func (in *HelmPolicySpec) DeepCopy() *HelmPolicySpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HelmPolicySpec.
func (*HelmPolicySpec) DeepCopyInto ¶
func (in *HelmPolicySpec) DeepCopyInto(out *HelmPolicySpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RetainPolicy ¶
type RetainPolicy string
+kubebuilder:validation:Enum=Always;Never;OnFailure
const ( RetainAlways RetainPolicy = "Always" RetainNever RetainPolicy = "Never" RetainOnFailure RetainPolicy = "OnFailure" )
type Test ¶
type Test struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec TestSpec `json:"spec,omitempty"` Status TestStatus `json:"status,omitempty"` }
Test is the Schema for the tests API
func (*Test) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Test.
func (*Test) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Test) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type TestList ¶
type TestList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []Test `json:"items"` }
TestList contains a list of Test
func (*TestList) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TestList.
func (*TestList) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*TestList) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*TestList) GetObjects ¶
type TestPhase ¶
type TestPhase string
+kubebuilder:validation:Enum=Pending;Starting;Running;Passed;Failed;Unknown
func (*TestPhase) FromPodPhase ¶
type TestResult ¶
type TestResult struct { Description string `json:"description,omitempty"` Passed bool `json:"passed,omitempty"` Test string `json:"test,omitempty"` }
TestResult describes the outcome of a completed Test
func (*TestResult) DeepCopy ¶
func (in *TestResult) DeepCopy() *TestResult
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TestResult.
func (*TestResult) DeepCopyInto ¶
func (in *TestResult) DeepCopyInto(out *TestResult)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TestRun ¶
type TestRun struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec TestRunSpec `json:"spec,omitempty"` Status TestRunStatus `json:"status,omitempty"` }
TestRun is the Schema for the testruns API
func (*TestRun) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TestRun.
func (*TestRun) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*TestRun) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type TestRunList ¶
type TestRunList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []TestRun `json:"items"` }
TestRunList contains a list of TestRun
func (*TestRunList) DeepCopy ¶
func (in *TestRunList) DeepCopy() *TestRunList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TestRunList.
func (*TestRunList) DeepCopyInto ¶
func (in *TestRunList) DeepCopyInto(out *TestRunList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*TestRunList) DeepCopyObject ¶
func (in *TestRunList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*TestRunList) GetObjects ¶
func (l *TestRunList) GetObjects() []client.Object
type TestRunPhase ¶
type TestRunPhase string
TestRunPhase describes the phase a TestRun is currently in
const ( TestRunStarting TestRunPhase = "Starting" TestRunRunning TestRunPhase = "Running" TestRunPassed TestRunPhase = "Passed" TestRunFailed TestRunPhase = "Failed" )
func (TestRunPhase) IsFinal ¶
func (t TestRunPhase) IsFinal() bool
type TestRunSpec ¶
type TestRunSpec struct { // +kubebuilder:default=OnFailure RetentionPolicy RetainPolicy `json:"retentionPolicy,omitempty"` // +kubebuilder:validation:MinItems=1 Tests []TestTemplate `json:"tests"` }
TestRunSpec defines the desired state of TestRun
func (*TestRunSpec) DeepCopy ¶
func (in *TestRunSpec) DeepCopy() *TestRunSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TestRunSpec.
func (*TestRunSpec) DeepCopyInto ¶
func (in *TestRunSpec) DeepCopyInto(out *TestRunSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TestRunStatus ¶
type TestRunStatus struct { // Current Conditions Conditions []metav1.Condition `json:"conditions,omitempty"` // +kubebuilder:default=Pending // Phase (Pending, Starting, Passed, Failed) Phase TestRunPhase `json:"phase,omitempty"` // Message Message string `json:"message,omitempty"` // Results Results []TestResult `json:"results,omitempty"` }
TestRunStatus defines the observed state of TestRun
func (*TestRunStatus) DeepCopy ¶
func (in *TestRunStatus) DeepCopy() *TestRunStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TestRunStatus.
func (*TestRunStatus) DeepCopyInto ¶
func (in *TestRunStatus) DeepCopyInto(out *TestRunStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TestSpec ¶
type TestSpec struct { // +kubebuilder:default=OnFailure // RetentionPolicy specifies how generated resources should be handled after the Test finishes. RetentionPolicy RetainPolicy `json:"retentionPolicy,omitempty"` // Template is the PodSpecTemplate that will be used to run the test Template v1.PodTemplateSpec `json:"template"` }
TestSpec defines the desired state of Test
func (*TestSpec) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TestSpec.
func (*TestSpec) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TestStatus ¶
type TestStatus struct { // Current Conditions Conditions []metav1.Condition `json:"conditions,omitempty"` // Phase (Pending, Starting, Running, Succeeded, Failed, or Unknown) // +kubebuilder:default=Pending Phase TestPhase `json:"phase,omitempty"` // Messages Messages map[string]string `json:"messages,omitempty"` }
TestStatus defines the observed state of Test
func (*TestStatus) DeepCopy ¶
func (in *TestStatus) DeepCopy() *TestStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TestStatus.
func (*TestStatus) DeepCopyInto ¶
func (in *TestStatus) DeepCopyInto(out *TestStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TestSuite ¶
type TestSuite struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec TestSuiteSpec `json:"spec,omitempty"` Trigger TestSuiteTrigger `json:"trigger,omitempty"` Status TestSuiteStatus `json:"status,omitempty"` }
TestSuite is the Schema for the testsuites API +kubebuilder:object:root=true +kubebuilder:resource:shortName=ts +kubebuilder:subresource:trigger +kubebuilder:subresource:status
func (*TestSuite) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TestSuite.
func (*TestSuite) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*TestSuite) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type TestSuiteHelmSetUp ¶
type TestSuiteHelmSetUp struct { SecretName string `json:"secret,omitempty"` ChartKey string `json:"chartKey,omitempty"` ValuesKey string `json:"valuesKey,omitempty"` }
TestSuiteHelmSetUp describes a Secret-embedded
func (*TestSuiteHelmSetUp) DeepCopy ¶
func (in *TestSuiteHelmSetUp) DeepCopy() *TestSuiteHelmSetUp
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TestSuiteHelmSetUp.
func (*TestSuiteHelmSetUp) DeepCopyInto ¶
func (in *TestSuiteHelmSetUp) DeepCopyInto(out *TestSuiteHelmSetUp)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TestSuiteHelmTrigger ¶
type TestSuiteHelmTrigger struct {
Release string `json:"release,omitempty"`
}
TestSuiteHelmTrigger describes a Helm release that will trigger a TestSuite
func (*TestSuiteHelmTrigger) DeepCopy ¶
func (in *TestSuiteHelmTrigger) DeepCopy() *TestSuiteHelmTrigger
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TestSuiteHelmTrigger.
func (*TestSuiteHelmTrigger) DeepCopyInto ¶
func (in *TestSuiteHelmTrigger) DeepCopyInto(out *TestSuiteHelmTrigger)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TestSuiteList ¶
type TestSuiteList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []TestSuite `json:"items"` }
TestSuiteList contains a list of TestSuite +kubebuilder:object:root=true
func (*TestSuiteList) DeepCopy ¶
func (in *TestSuiteList) DeepCopy() *TestSuiteList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TestSuiteList.
func (*TestSuiteList) DeepCopyInto ¶
func (in *TestSuiteList) DeepCopyInto(out *TestSuiteList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*TestSuiteList) DeepCopyObject ¶
func (in *TestSuiteList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*TestSuiteList) GetObjects ¶
func (l *TestSuiteList) GetObjects() []client.Object
type TestSuitePhase ¶
type TestSuitePhase string
TestSuitePhase describes the phase a TestSuite is currently in
const ( TestSuitePending TestSuitePhase = "Pending" TestSuiteReady TestSuitePhase = "Ready" TestSuiteRunning TestSuitePhase = "Running" TestSuiteError TestSuitePhase = "Error" )
func (TestSuitePhase) IsError ¶
func (p TestSuitePhase) IsError() bool
IsError returns true if TestSuitePhase is "Error"
func (TestSuitePhase) IsPending ¶
func (p TestSuitePhase) IsPending() bool
IsPending returns true if TestSuitePhase is "Pending"
func (TestSuitePhase) IsReady ¶
func (p TestSuitePhase) IsReady() bool
IsReady returns true if TestSuitePhase is "Ready"
func (TestSuitePhase) IsRunning ¶
func (p TestSuitePhase) IsRunning() bool
IsRunning returns true if TestSuitePhase is "Running"
type TestSuiteSetUp ¶
type TestSuiteSetUp struct {
Helm TestSuiteHelmSetUp `json:"helm,omitempty"`
}
TestSuiteSetUp describes any setup that should occur before the Tests are run
func (*TestSuiteSetUp) DeepCopy ¶
func (in *TestSuiteSetUp) DeepCopy() *TestSuiteSetUp
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TestSuiteSetUp.
func (*TestSuiteSetUp) DeepCopyInto ¶
func (in *TestSuiteSetUp) DeepCopyInto(out *TestSuiteSetUp)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TestSuiteSpec ¶
type TestSuiteSpec struct { // +kubebuilder:default=3 // +kubebuilder:validation:Maximum=255 // +kubebuilder:validation:Minimum=0 HistoryLimit uint8 `json:"historyLimit,omitempty"` SetUp TestSuiteSetUp `json:"setUp,omitempty"` // +kubebuilder:validation:Required Template TestRunSpec `json:"template"` When TestSuiteTriggers `json:"when,omitempty"` }
TestSuiteSpec defines the desired state of TestSuite
func (*TestSuiteSpec) DeepCopy ¶
func (in *TestSuiteSpec) DeepCopy() *TestSuiteSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TestSuiteSpec.
func (*TestSuiteSpec) DeepCopyInto ¶
func (in *TestSuiteSpec) DeepCopyInto(out *TestSuiteSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TestSuiteStatus ¶
type TestSuiteStatus struct { // Current Conditions Conditions []metav1.Condition `json:"conditions,omitempty"` // +kubebuilder:default=Pending // Phase (Pending, Ready, Running, Error) Phase TestSuitePhase `json:"phase,omitempty"` CurrentTestRun string `json:"currentTestRun,omitempty"` NextRun *metav1.Time `json:"nextRun,omitempty"` }
TestSuiteStatus describes the observed state of TestSuite
func (*TestSuiteStatus) DeepCopy ¶
func (in *TestSuiteStatus) DeepCopy() *TestSuiteStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TestSuiteStatus.
func (*TestSuiteStatus) DeepCopyInto ¶
func (in *TestSuiteStatus) DeepCopyInto(out *TestSuiteStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TestSuiteTrigger ¶
type TestSuiteTrigger struct { // +kubebuilder:default:false // NeedsRun is true if the TestSuite should be triggered NeedsRun bool `json:"needsRun"` }
TestSuiteTrigger describes the trigger state of TestSuite
func (*TestSuiteTrigger) DeepCopy ¶
func (in *TestSuiteTrigger) DeepCopy() *TestSuiteTrigger
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TestSuiteTrigger.
func (*TestSuiteTrigger) DeepCopyInto ¶
func (in *TestSuiteTrigger) DeepCopyInto(out *TestSuiteTrigger)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TestSuiteTriggers ¶
type TestSuiteTriggers struct { // Schedule in Cron format, see https://en.wikipedia.org/wiki/Cron. Schedule string `json:"cron,omitempty"` // HelmRelease to watch for upgrades/install HelmRelease string `json:"helmRelease,omitempty"` }
TestSuiteTriggers describes when a TestSuite should run
func (*TestSuiteTriggers) DeepCopy ¶
func (in *TestSuiteTriggers) DeepCopy() *TestSuiteTriggers
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TestSuiteTriggers.
func (*TestSuiteTriggers) DeepCopyInto ¶
func (in *TestSuiteTriggers) DeepCopyInto(out *TestSuiteTriggers)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TestTemplate ¶
type TestTemplate struct { // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:Required Description string `json:"description"` RetentionPolicy RetainPolicy `json:"retentionPolicy,omitempty"` // +kubebuilder:validation:Required Template v1.PodTemplateSpec `json:"template"` }
TestTemplate describes a templated Test
func (*TestTemplate) DeepCopy ¶
func (in *TestTemplate) DeepCopy() *TestTemplate
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TestTemplate.
func (*TestTemplate) DeepCopyInto ¶
func (in *TestTemplate) DeepCopyInto(out *TestTemplate)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.