Documentation ¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the simple-cicd v1alpha1 API group +kubebuilder:object:generate=true +groupName=simple-cicd.jlsalvador.online
Index ¶
- Variables
- type ConditionType
- type NamespacedName
- type NextWorkflow
- type When
- type Workflow
- type WorkflowList
- type WorkflowSpec
- type WorkflowStatus
- type WorkflowWebhook
- type WorkflowWebhookList
- type WorkflowWebhookRequest
- type WorkflowWebhookRequestList
- type WorkflowWebhookRequestSpec
- type WorkflowWebhookRequestStatus
- type WorkflowWebhookSpec
- type WorkflowWebhookStatus
Constants ¶
This section is empty.
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: "simple-cicd.jlsalvador.online", 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 ConditionType ¶
type ConditionType string
const ( WorkflowWebhookRequestProgressing ConditionType = "Progressing" WorkflowWebhookRequestWaiting ConditionType = "Waiting" WorkflowWebhookRequestDone ConditionType = "Done" )
type NamespacedName ¶
type NamespacedName struct { // +required Namespace string `json:"namespace"` // +required Name string `json:"name"` }
func (NamespacedName) AsType ¶
func (nn NamespacedName) AsType() types.NamespacedName
func (*NamespacedName) DeepCopy ¶
func (in *NamespacedName) DeepCopy() *NamespacedName
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NamespacedName.
func (*NamespacedName) DeepCopyInto ¶
func (in *NamespacedName) DeepCopyInto(out *NamespacedName)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (NamespacedName) String ¶
func (nn NamespacedName) String() string
type NextWorkflow ¶
type NextWorkflow struct { // Workflow namespace // +required Namespace string `json:"namespace"` // Workflow name // +required Name string `json:"name"` // Describes the conditions for when a Job will be handled. // If not specified, the default behavior is "Always". // // Possible statuses: // - OnSuccess: The Job will be handled when all previous Jobs were successful. // - OnAnySuccess: The Job will be handled when any previous Job was successful. // - OnFailure: The Job will be handled when all previous Jobs were not successful. // - OnAnyFailure: The Job will be handled when any previous Job was not successful. // - Always: The Job will always be handled. // // +optional When *When `json:"when,omitempty"` }
func (NextWorkflow) AsNamespacedName ¶
func (nw NextWorkflow) AsNamespacedName() NamespacedName
func (*NextWorkflow) DeepCopy ¶
func (in *NextWorkflow) DeepCopy() *NextWorkflow
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NextWorkflow.
func (*NextWorkflow) DeepCopyInto ¶
func (in *NextWorkflow) DeepCopyInto(out *NextWorkflow)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (NextWorkflow) String ¶
func (nw NextWorkflow) String() string
type When ¶
type When string
Describes the conditions for when a Job will be handled. If not specified, the default behavior is "Always".
Possible statuses:
- OnSuccess: The Job will be handled when all previous Jobs were successful.
- OnAnySuccess: The Job will be handled when any previous Job was successful.
- OnFailure: The Job will be handled when all previous Jobs were not successful.
- OnAnyFailure: The Job will be handled when any previous Job was not successful.
- Always: The Job will always be handled.
+kubebuilder:validation:Enum=OnSuccess;OnAnySuccess;OnFailure;OnAnyFailure;Always
const ( // Forbids a Job to be executed when any previous Job was not successful. OnSuccess When = "OnSuccess" // Allows a Job to be executed when any previous Job was successful. OnAnySuccess When = "OnAnySuccess" // Forbids a Job to be executed when any previous Job was successful. OnFailure When = "OnFailure" // Allows a Job to be executed when any previous Job was not successful. OnAnyFailure When = "OnAnyFailure" // Always allows a Job to be executed. Always When = "Always" )
type Workflow ¶
type Workflow struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec WorkflowSpec `json:"spec,omitempty"` Status WorkflowStatus `json:"status,omitempty"` }
Workflow is the Schema for the workflows API
func (*Workflow) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Workflow.
func (*Workflow) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Workflow) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type WorkflowList ¶
type WorkflowList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []Workflow `json:"items"` }
WorkflowList contains a list of Workflow
func (*WorkflowList) DeepCopy ¶
func (in *WorkflowList) DeepCopy() *WorkflowList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WorkflowList.
func (*WorkflowList) DeepCopyInto ¶
func (in *WorkflowList) DeepCopyInto(out *WorkflowList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*WorkflowList) DeepCopyObject ¶
func (in *WorkflowList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type WorkflowSpec ¶
type WorkflowSpec struct { // Jobs to be cloned // +required JobsToBeCloned []NamespacedName `json:"jobsToBeCloned"` // Optional list of Workflow to execute next // +optional Next []NextWorkflow `json:"next,omitempty"` // Defaults to false // +optional Suspend *bool `json:"suspend,omitempty" protobuf:"varint,10,opt,name=suspend"` }
WorkflowSpec defines the desired state of Workflow
func (*WorkflowSpec) DeepCopy ¶
func (in *WorkflowSpec) DeepCopy() *WorkflowSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WorkflowSpec.
func (*WorkflowSpec) DeepCopyInto ¶
func (in *WorkflowSpec) DeepCopyInto(out *WorkflowSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type WorkflowStatus ¶
type WorkflowStatus struct { }
WorkflowStatus defines the observed state of Workflow
func (*WorkflowStatus) DeepCopy ¶
func (in *WorkflowStatus) DeepCopy() *WorkflowStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WorkflowStatus.
func (*WorkflowStatus) DeepCopyInto ¶
func (in *WorkflowStatus) DeepCopyInto(out *WorkflowStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type WorkflowWebhook ¶
type WorkflowWebhook struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec WorkflowWebhookSpec `json:"spec,omitempty"` Status WorkflowWebhookStatus `json:"status,omitempty"` }
WorkflowWebhook is the Schema for the workflowwebhooks API
func (*WorkflowWebhook) DeepCopy ¶
func (in *WorkflowWebhook) DeepCopy() *WorkflowWebhook
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WorkflowWebhook.
func (*WorkflowWebhook) DeepCopyInto ¶
func (in *WorkflowWebhook) DeepCopyInto(out *WorkflowWebhook)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*WorkflowWebhook) DeepCopyObject ¶
func (in *WorkflowWebhook) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type WorkflowWebhookList ¶
type WorkflowWebhookList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []WorkflowWebhook `json:"items"` }
WorkflowWebhookList contains a list of WorkflowWebhook
func (*WorkflowWebhookList) DeepCopy ¶
func (in *WorkflowWebhookList) DeepCopy() *WorkflowWebhookList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WorkflowWebhookList.
func (*WorkflowWebhookList) DeepCopyInto ¶
func (in *WorkflowWebhookList) DeepCopyInto(out *WorkflowWebhookList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*WorkflowWebhookList) DeepCopyObject ¶
func (in *WorkflowWebhookList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type WorkflowWebhookRequest ¶
type WorkflowWebhookRequest struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec WorkflowWebhookRequestSpec `json:"spec,omitempty"` Status WorkflowWebhookRequestStatus `json:"status,omitempty"` }
WorkflowWebhookRequest is the Schema for the workflowwebhookrequests API
func (*WorkflowWebhookRequest) DeepCopy ¶
func (in *WorkflowWebhookRequest) DeepCopy() *WorkflowWebhookRequest
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WorkflowWebhookRequest.
func (*WorkflowWebhookRequest) DeepCopyInto ¶
func (in *WorkflowWebhookRequest) DeepCopyInto(out *WorkflowWebhookRequest)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*WorkflowWebhookRequest) DeepCopyObject ¶
func (in *WorkflowWebhookRequest) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type WorkflowWebhookRequestList ¶
type WorkflowWebhookRequestList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []WorkflowWebhookRequest `json:"items"` }
WorkflowWebhookRequestList contains a list of WorkflowWebhookRequest
func (*WorkflowWebhookRequestList) DeepCopy ¶
func (in *WorkflowWebhookRequestList) DeepCopy() *WorkflowWebhookRequestList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WorkflowWebhookRequestList.
func (*WorkflowWebhookRequestList) DeepCopyInto ¶
func (in *WorkflowWebhookRequestList) DeepCopyInto(out *WorkflowWebhookRequestList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*WorkflowWebhookRequestList) DeepCopyObject ¶
func (in *WorkflowWebhookRequestList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type WorkflowWebhookRequestSpec ¶
type WorkflowWebhookRequestSpec struct { // Reference to the WorkflowWebhook. // +required WorkflowWebhook NamespacedName `json:"workflowWebhook"` // Specifies the host on which the URL is sought. // +optional Host string `json:"host,omitempty"` // Specifies the HTTP method (GET, POST, PUT, etc.). // +optional Method string `json:"method,omitempty"` // Specifies the URI being requested. // +optional Url string `json:"url,omitempty"` // Contains headers for the HTTP request. // +optional Headers map[string][]string `json:"headers,omitempty"` // Body of the HTTP request as Base64 encoded data. // The serialized form of the Body is a base64 encoded string, // representing the arbitrary (possibly non-string) data value. // Described in https://tools.ietf.org/html/rfc4648#section-4 // +optional Body []byte `json:"body,omitempty" protobuf:"bytes,2,rep,name=body"` // List of Jobs running associated with current Workflows triggered. // +optional CurrentJobs []NamespacedName `json:"currentJobs,omitempty"` // List of Workflows currently triggered. // +optional CurrentWorkflows []NamespacedName `json:"currentWorkflows,omitempty"` // List of the next Workflows to be triggered. // +optional NextWorkflows []NextWorkflow `json:"nextWorkflows,omitempty"` // When set to true, instructs the operator to skip // this WorkflowWebhookRequest during future reconciliations. // +optional Done bool `json:"done,omitempty"` }
WorkflowWebhookRequestSpec defines the desired state of WorkflowWebhookRequest
func (*WorkflowWebhookRequestSpec) DeepCopy ¶
func (in *WorkflowWebhookRequestSpec) DeepCopy() *WorkflowWebhookRequestSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WorkflowWebhookRequestSpec.
func (*WorkflowWebhookRequestSpec) DeepCopyInto ¶
func (in *WorkflowWebhookRequestSpec) DeepCopyInto(out *WorkflowWebhookRequestSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type WorkflowWebhookRequestStatus ¶
type WorkflowWebhookRequestStatus struct { // Represents the observations of a WorkflowWebhookRequestStatus's current state. // WorkflowWebhookRequestStatus.Status.Conditions.Type are: "Progressing", "Waiting", "Done" // WorkflowWebhookRequestStatus.Status.Conditions.Status are one of True, False, Unknown. // WorkflowWebhookRequestStatus.Status.Conditions.Reason the value should be a CamelCase string and producers of specific // condition types may define expected values and meanings for this field, and whether the values // are considered a guaranteed API. // WorkflowWebhookRequestStatus.Status.Conditions.Message is a human readable message indicating details about the transition. // For further information see: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#typical-status-properties // // Conditions store the status conditions of the WorkflowWebhookRequestStatus instances // +operator-sdk:csv:customresourcedefinitions:type=status Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` }
WorkflowWebhookRequestStatus defines the observed state of WorkflowWebhookRequest
func (*WorkflowWebhookRequestStatus) DeepCopy ¶
func (in *WorkflowWebhookRequestStatus) DeepCopy() *WorkflowWebhookRequestStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WorkflowWebhookRequestStatus.
func (*WorkflowWebhookRequestStatus) DeepCopyInto ¶
func (in *WorkflowWebhookRequestStatus) DeepCopyInto(out *WorkflowWebhookRequestStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type WorkflowWebhookSpec ¶
type WorkflowWebhookSpec struct { // +required Workflows []NamespacedName `json:"workflows"` }
WorkflowWebhookSpec defines the desired state of WorkflowWebhook
func (*WorkflowWebhookSpec) DeepCopy ¶
func (in *WorkflowWebhookSpec) DeepCopy() *WorkflowWebhookSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WorkflowWebhookSpec.
func (*WorkflowWebhookSpec) DeepCopyInto ¶
func (in *WorkflowWebhookSpec) DeepCopyInto(out *WorkflowWebhookSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type WorkflowWebhookStatus ¶
type WorkflowWebhookStatus struct { }
WorkflowWebhookStatus defines the observed state of WorkflowWebhook
func (*WorkflowWebhookStatus) DeepCopy ¶
func (in *WorkflowWebhookStatus) DeepCopy() *WorkflowWebhookStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WorkflowWebhookStatus.
func (*WorkflowWebhookStatus) DeepCopyInto ¶
func (in *WorkflowWebhookStatus) DeepCopyInto(out *WorkflowWebhookStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.