v1alpha1

Documentation

Overview

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. package v1alpha1

Package v1alpha1 contains API Schema definitions for the core v1alpha1 API group +kubebuilder:object:generate=true +groupName=combo.io

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. package v1alpha1

Index

• Constants
• Variables
• type Argument
  • func (in *Argument) DeepCopy() *Argument
  • func (in *Argument) DeepCopyInto(out *Argument)
• type Combination
  • func (in *Combination) DeepCopy() *Combination
  • func (in *Combination) DeepCopyInto(out *Combination)
  • func (in *Combination) DeepCopyObject() runtime.Object
  • func (c *Combination) SetStatusCondition(condition metav1.Condition)
• type CombinationList
  • func (in *CombinationList) DeepCopy() *CombinationList
  • func (in *CombinationList) DeepCopyInto(out *CombinationList)
  • func (in *CombinationList) DeepCopyObject() runtime.Object
• type CombinationSpec
  • func (in *CombinationSpec) DeepCopy() *CombinationSpec
  • func (in *CombinationSpec) DeepCopyInto(out *CombinationSpec)
• type CombinationStatus
  • func (in *CombinationStatus) DeepCopy() *CombinationStatus
  • func (in *CombinationStatus) DeepCopyInto(out *CombinationStatus)
• type Template
  • func (in *Template) DeepCopy() *Template
  • func (in *Template) DeepCopyInto(out *Template)
  • func (in *Template) DeepCopyObject() runtime.Object
• type TemplateList
  • func (in *TemplateList) DeepCopy() *TemplateList
  • func (in *TemplateList) DeepCopyInto(out *TemplateList)
  • func (in *TemplateList) DeepCopyObject() runtime.Object
• type TemplateSpec
  • func (in *TemplateSpec) DeepCopy() *TemplateSpec
  • func (in *TemplateSpec) DeepCopyInto(out *TemplateSpec)

Constants

const (
	TypeInvalid    = "Invalid"
	TypeFinished   = "Finished"
	TypeInProgress = "InProgress"

	ReasonProcessing          = "Processing"
	ReasonTemplateNotFound    = "TemplateNotFound"
	ReasonTemplateBodyInvalid = "TemplateBodyInvalid"
	ReasonEvaluationsInvalid  = "EvaluationsInvalid"
	ReasonProcessed           = "Processed"
)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "combo.io", 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
)

Types

type Argument

type Argument struct {
	// Key defines what is going to be replaced in the template
	Key string `json:"key"`

	// Values defines the options to replace the defined key
	// +kubebuilder:validation:MinItems:=1
	Values []string `json:"values"`
}

Argument defines a key and values for it that will be replaced in a template

func (*Argument) DeepCopy

func (in *Argument) DeepCopy() *Argument

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

func (*Argument) DeepCopyInto

func (in *Argument) DeepCopyInto(out *Argument)

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

type Combination

type Combination struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   CombinationSpec   `json:"spec"`
	Status CombinationStatus `json:"status,omitempty"`
}

Combination is the Schema for a combination

func (*Combination) DeepCopy

func (in *Combination) DeepCopy() *Combination

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

func (*Combination) DeepCopyInto

func (in *Combination) DeepCopyInto(out *Combination)

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

func (*Combination) DeepCopyObject

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

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

func (*Combination) SetStatusCondition

func (c *Combination) SetStatusCondition(condition metav1.Condition)

SetCondition sets the condition if it has not already been set

type CombinationList

type CombinationList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Combination `json:"items"`
}

CombinationList contains a list of Combination

func (*CombinationList) DeepCopy

func (in *CombinationList) DeepCopy() *CombinationList

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

func (*CombinationList) DeepCopyInto

func (in *CombinationList) DeepCopyInto(out *CombinationList)

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

func (*CombinationList) DeepCopyObject

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

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

type CombinationSpec

type CombinationSpec struct {
	// Template is the name of the template to evaluate.
	// +kubebuilder:validation:Pattern=[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*
	Template string `json:"template"`

	// Arguments contains the list of values to use for each parameter in the combination.
	// +kubebuilder:validation:MinItems:=1
	Arguments []Argument `json:"arguments,omitempty"`
}

CombinationSpec defines arguments that replace parameters within the given template

func (*CombinationSpec) DeepCopy

func (in *CombinationSpec) DeepCopy() *CombinationSpec

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

func (*CombinationSpec) DeepCopyInto

func (in *CombinationSpec) DeepCopyInto(out *CombinationSpec)

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

type CombinationStatus

type CombinationStatus struct {
	// Conditions represents the current condition of the Combination.
	Conditions []metav1.Condition `json:"conditions,omitempty"`
	// Represents the evaluation to this combination once processed
	Evaluations []string `json:"evaluations,omitempty"`
}

CombinationStatus defines the observed state of Combination

func (*CombinationStatus) DeepCopy

func (in *CombinationStatus) DeepCopy() *CombinationStatus

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

func (*CombinationStatus) DeepCopyInto

func (in *CombinationStatus) DeepCopyInto(out *CombinationStatus)

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

type Template

type Template struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec TemplateSpec `json:"spec"`
}

Template is a custom resource that represents a parameterized set of Kubernetes manifests.

func (*Template) DeepCopy

func (in *Template) DeepCopy() *Template

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

func (*Template) DeepCopyInto

func (in *Template) DeepCopyInto(out *Template)

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

func (*Template) DeepCopyObject

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

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

type TemplateList

type TemplateList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Template `json:"items"`
}

TemplateList contains a list of Template

func (*TemplateList) DeepCopy

func (in *TemplateList) DeepCopy() *TemplateList

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

func (*TemplateList) DeepCopyInto

func (in *TemplateList) DeepCopyInto(out *TemplateList)

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

func (*TemplateList) DeepCopyObject

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

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

type TemplateSpec

type TemplateSpec struct {
	// Body is the parameterized template string.
	Body string `json:"body"`

	// Parameters is the set of strings within Body to treat as parameters.
	// +kubebuilder:validation:MinItems:=1
	Parameters []string `json:"parameters,omitempty"`
}

TemplateSpec defines the desired state of a Template

func (*TemplateSpec) DeepCopy

func (in *TemplateSpec) DeepCopy() *TemplateSpec

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

func (*TemplateSpec) DeepCopyInto

func (in *TemplateSpec) DeepCopyInto(out *TemplateSpec)

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