v1alpha1

Documentation

Overview

Package v1alpha1 stores definitions and methods to handle application definitions and methods +kubebuilder:object:generate=true +k8s:deepcopy-gen=package +groupName=applications.pkg.katanomi.dev

Index

• Variables
• type DeployApplicationResults
  • func (in *DeployApplicationResults) DeepCopy() *DeployApplicationResults
  • func (in *DeployApplicationResults) DeepCopyInto(out *DeployApplicationResults)
  • func (app *DeployApplicationResults) IsEmpty() bool
• type DeployApplicationStatus
  • func (in *DeployApplicationStatus) DeepCopy() *DeployApplicationStatus
  • func (in *DeployApplicationStatus) DeepCopyInto(out *DeployApplicationStatus)
• type NamedDeployApplicationResult
  • func (in *NamedDeployApplicationResult) DeepCopy() *NamedDeployApplicationResult
  • func (in *NamedDeployApplicationResult) DeepCopyInto(out *NamedDeployApplicationResult)
  • func (n NamedDeployApplicationResult) IsSameResult(y NamedDeployApplicationResult) bool
• type NamedDeployApplicationResults
  • func (in NamedDeployApplicationResults) DeepCopy() NamedDeployApplicationResults
  • func (in NamedDeployApplicationResults) DeepCopyInto(out *NamedDeployApplicationResults)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "applications.pkg.katanomi.dev", 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 DeployApplicationResults

type DeployApplicationResults struct {
	// ApplicationRef stores the reference of the deployed application
	// as a kubernetes resource
	ApplicationRef *corev1.ObjectReference `json:"applicationRef"`

	// Before store status for the application or its components before the
	// deployment and may store previous versions and status
	Before []DeployApplicationStatus `json:"before,omitempty"`

	// After store status for the application or its components after the
	// deployment and may store the update versions and status
	After []DeployApplicationStatus `json:"after,omitempty"`
}

DeployApplicationResults describes a result of an application deployment stating the specific modified object and the modified components and versions

func (*DeployApplicationResults) DeepCopy

func (in *DeployApplicationResults) DeepCopy() *DeployApplicationResults

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

func (*DeployApplicationResults) DeepCopyInto

func (in *DeployApplicationResults) DeepCopyInto(out *DeployApplicationResults)

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

func (*DeployApplicationResults) IsEmpty

func (app *DeployApplicationResults) IsEmpty() bool

IsEmpty returns true if there is not enought information regarding the application deployment

type DeployApplicationStatus

type DeployApplicationStatus struct {
	// Name of the application or application subcomponent
	// if empty simbolizes the entire application update status
	Name string `json:"name"`
	// Status of the component/application. The contents are strictly tied
	// to the application/component type
	Status string `json:"status,omitempty"`
	// Version of the deployed application/component as a unique identifier
	// i.e container image url, artifact url, etc.
	Version string `json:"version,omitempty"`
}

DeployApplicationStatus represents the status of an Application or component deployed. Can be used to store status before update or after the update

func (*DeployApplicationStatus) DeepCopy

func (in *DeployApplicationStatus) DeepCopy() *DeployApplicationStatus

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

func (*DeployApplicationStatus) DeepCopyInto

func (in *DeployApplicationStatus) DeepCopyInto(out *DeployApplicationStatus)

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

type NamedDeployApplicationResult

type NamedDeployApplicationResult struct {
	// Name for the specific deployment application result
	Name string `json:"name,omitempty"`

	// DeployApplicationResults result of the deployment
	DeployApplicationResults `json:",inline"`
}

NamedDeployApplicationResult adds a name for DeployApplicationResults useful for store deployment data in a list

func (*NamedDeployApplicationResult) DeepCopy

func (in *NamedDeployApplicationResult) DeepCopy() *NamedDeployApplicationResult

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

func (*NamedDeployApplicationResult) DeepCopyInto

func (in *NamedDeployApplicationResult) DeepCopyInto(out *NamedDeployApplicationResult)

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

func (NamedDeployApplicationResult) IsSameResult

func (n NamedDeployApplicationResult) IsSameResult(y NamedDeployApplicationResult) bool

IsSameResult implements equal method for generic comparable usage

type NamedDeployApplicationResults

type NamedDeployApplicationResults []NamedDeployApplicationResult

NamedDeployApplicationResults list of NamedDeployApplicationResult with helpful methods to manage data

func (NamedDeployApplicationResults) DeepCopy

func (in NamedDeployApplicationResults) DeepCopy() NamedDeployApplicationResults

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

func (NamedDeployApplicationResults) DeepCopyInto

func (in NamedDeployApplicationResults) DeepCopyInto(out *NamedDeployApplicationResults)

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