Documentation
¶
Overview ¶
This package contains the CRD code, describing how the operator API will work in Kubernetes. When the contents of this package are modified, you must run `make` command to make sure files with `zz_generated.` prefix are updated, the additional code is generated as expected.
Package v1alpha1 contains API Schema definitions for the operator v1alpha1 API group +kubebuilder:object:generate=true +groupName=operator.shipwright.io
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: "operator.shipwright.io", Version: "v1alpha1"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) // AddToScheme adds the types in this group-version to the given scheme. AddToScheme = SchemeBuilder.AddToScheme )
Functions ¶
This section is empty.
Types ¶
type ShipwrightBuild ¶
type ShipwrightBuild struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec ShipwrightBuildSpec `json:"spec,omitempty"`
Status ShipwrightBuildStatus `json:"status,omitempty"`
}
ShipwrightBuild represents the deployment of Shipwright's build controller on a Kubernetes cluster.
func (*ShipwrightBuild) DeepCopy ¶
func (in *ShipwrightBuild) DeepCopy() *ShipwrightBuild
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ShipwrightBuild.
func (*ShipwrightBuild) DeepCopyInto ¶
func (in *ShipwrightBuild) DeepCopyInto(out *ShipwrightBuild)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ShipwrightBuild) DeepCopyObject ¶
func (in *ShipwrightBuild) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ShipwrightBuildList ¶
type ShipwrightBuildList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []ShipwrightBuild `json:"items"`
}
ShipwrightBuildList contains a list of ShipwrightBuild
func (*ShipwrightBuildList) DeepCopy ¶
func (in *ShipwrightBuildList) DeepCopy() *ShipwrightBuildList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ShipwrightBuildList.
func (*ShipwrightBuildList) DeepCopyInto ¶
func (in *ShipwrightBuildList) DeepCopyInto(out *ShipwrightBuildList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ShipwrightBuildList) DeepCopyObject ¶
func (in *ShipwrightBuildList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ShipwrightBuildSpec ¶
type ShipwrightBuildSpec struct {
// TargetNamespace is the target namespace where Shipwright's build controller will be deployed.
TargetNamespace string `json:"targetNamespace,omitempty"`
// Triggers configures the deployment of the Shipwright Triggers component.
// When omitted, triggers are not deployed.
// +optional
Triggers *TriggersSpec `json:"triggers,omitempty"`
}
ShipwrightBuildSpec defines the configuration of a Shipwright Build deployment.
func (*ShipwrightBuildSpec) DeepCopy ¶
func (in *ShipwrightBuildSpec) DeepCopy() *ShipwrightBuildSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ShipwrightBuildSpec.
func (*ShipwrightBuildSpec) DeepCopyInto ¶
func (in *ShipwrightBuildSpec) DeepCopyInto(out *ShipwrightBuildSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ShipwrightBuildSpec) TriggersEnabled ¶ added in v0.20.0
func (s *ShipwrightBuildSpec) TriggersEnabled() bool
TriggersEnabled returns true if the Triggers component should be deployed. Triggers are only deployed when spec.triggers.deployment is set to "Enabled".
type ShipwrightBuildStatus ¶
type ShipwrightBuildStatus struct {
// Conditions holds the latest available observations of a resource's current state.
Conditions []metav1.Condition `json:"conditions,omitempty"`
}
ShipwrightBuildStatus defines the observed state of ShipwrightBuild
func (*ShipwrightBuildStatus) DeepCopy ¶
func (in *ShipwrightBuildStatus) DeepCopy() *ShipwrightBuildStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ShipwrightBuildStatus.
func (*ShipwrightBuildStatus) DeepCopyInto ¶
func (in *ShipwrightBuildStatus) DeepCopyInto(out *ShipwrightBuildStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ShipwrightBuildStatus) IsReady ¶
func (status ShipwrightBuildStatus) IsReady() bool
IsReady returns true the Ready condition status is True
type TriggersDeployment ¶ added in v0.20.0
type TriggersDeployment string
TriggersDeployment indicates whether the Shipwright Triggers component should be deployed. +kubebuilder:validation:Enum=Enabled;Disabled
const ( // TriggersDeploymentEnabled indicates that the Shipwright Triggers // component should be deployed. TriggersDeploymentEnabled TriggersDeployment = "Enabled" // TriggersDeploymentDisabled indicates that the Shipwright Triggers // component should not be deployed. TriggersDeploymentDisabled TriggersDeployment = "Disabled" )
type TriggersSpec ¶ added in v0.20.0
type TriggersSpec struct {
// Deployment controls whether the triggers component is deployed.
// Defaults to "Disabled".
// +kubebuilder:default=Disabled
// +optional
Deployment TriggersDeployment `json:"deployment,omitempty"`
}
TriggersSpec defines the desired state of the Triggers component.
func (*TriggersSpec) DeepCopy ¶ added in v0.20.0
func (in *TriggersSpec) DeepCopy() *TriggersSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TriggersSpec.
func (*TriggersSpec) DeepCopyInto ¶ added in v0.20.0
func (in *TriggersSpec) DeepCopyInto(out *TriggersSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
Source Files