v1

Documentation

Overview

Package v1 contains API Schema definitions for the status v1 API group +kubebuilder:object:generate=true +groupName=status.kcloutie.com

Index

• Variables
• type CommitStatusesStatus
• type PipelineRunStatus
  • func (in *PipelineRunStatus) DeepCopy() *PipelineRunStatus
  • func (in *PipelineRunStatus) DeepCopyInto(out *PipelineRunStatus)
  • func (in *PipelineRunStatus) DeepCopyObject() runtime.Object
• type PipelineRunStatusList
  • func (in *PipelineRunStatusList) DeepCopy() *PipelineRunStatusList
  • func (in *PipelineRunStatusList) DeepCopyInto(out *PipelineRunStatusList)
  • func (in *PipelineRunStatusList) DeepCopyObject() runtime.Object
• type PipelineRunStatusSpec
  • func (in *PipelineRunStatusSpec) DeepCopy() *PipelineRunStatusSpec
  • func (in *PipelineRunStatusSpec) DeepCopyInto(out *PipelineRunStatusSpec)
• type PipelineRunStatusStatus
  • func (in *PipelineRunStatusStatus) DeepCopy() *PipelineRunStatusStatus
  • func (in *PipelineRunStatusStatus) DeepCopyInto(out *PipelineRunStatusStatus)
• type PipelineRunVariableSpec
• type PipelineRunsStatus
• type SecretRef

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "status.kcloutie.com", Version: "v1"}

	// 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 CommitStatusesStatus

type CommitStatusesStatus struct {
	// The account owner of the repository
	Owner string `json:"owner,omitempty"`

	// The name of the repository
	Repo string `json:"repo,omitempty"`

	// The commit sha
	Sha string `json:"sha,omitempty"`

	// The state of the status
	State string `json:"state,omitempty"`

	// The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status
	TargetUrl string `json:"targetUrl,omitempty"`

	// A short description of the status
	Description string `json:"description,omitempty"`

	// A string label to differentiate this status from the status of other systems
	Context string `json:"context,omitempty"`
}

type PipelineRunStatus

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

	Spec   PipelineRunStatusSpec   `json:"spec,omitempty"`
	Status PipelineRunStatusStatus `json:"status,omitempty"`
}

PipelineRunStatus is the Schema for the pipelinerunstatuses API

func (*PipelineRunStatus) DeepCopy

func (in *PipelineRunStatus) DeepCopy() *PipelineRunStatus

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

func (*PipelineRunStatus) DeepCopyInto

func (in *PipelineRunStatus) DeepCopyInto(out *PipelineRunStatus)

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

func (*PipelineRunStatus) DeepCopyObject

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

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

type PipelineRunStatusList

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

PipelineRunStatusList contains a list of PipelineRunStatus

func (*PipelineRunStatusList) DeepCopy

func (in *PipelineRunStatusList) DeepCopy() *PipelineRunStatusList

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

func (*PipelineRunStatusList) DeepCopyInto

func (in *PipelineRunStatusList) DeepCopyInto(out *PipelineRunStatusList)

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

func (*PipelineRunStatusList) DeepCopyObject

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

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

type PipelineRunStatusSpec

type PipelineRunStatusSpec struct {
	// True or false whether the operator is disabled
	// +optional
	Disabled bool `json:"disabled,omitempty"`

	// A string label to differentiate this status from the status of other systems. This field is case-insensitive.
	// +optional
	Context string `json:"context,omitempty"`

	// The base target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status.
	// +optional
	TargetUrlBaseUri string `json:"targetUrlBaseUri,omitempty"`

	// Pipeline variables extracted from the pipelineRun param section used to determine the owner/org name, repo name and commit sha of the pipelineRun
	PipelineRunVariables PipelineRunVariableSpec `json:"pipelineRunVariables,omitempty"`

	// The secret that contains the github personal access token used to make api calls to github
	SecretRef *SecretRef `json:"secretRef,omitempty"`

	GithubEnterprise string `json:"githubEnterprise,omitempty"`
}

PipelineRunStatusSpec defines the desired state of PipelineRunStatus Link: https://docs.github.com/en/rest/commits/statuses?apiVersion=2022-11-28#create-a-commit-status

func (*PipelineRunStatusSpec) DeepCopy

func (in *PipelineRunStatusSpec) DeepCopy() *PipelineRunStatusSpec

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

func (*PipelineRunStatusSpec) DeepCopyInto

func (in *PipelineRunStatusSpec) DeepCopyInto(out *PipelineRunStatusSpec)

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

type PipelineRunStatusStatus

type PipelineRunStatusStatus struct {
	PipelineRuns map[string]PipelineRunsStatus `json:"pipelineRuns,omitempty"`
}

PipelineRunStatusStatus defines the observed state of PipelineRunStatus

func (*PipelineRunStatusStatus) DeepCopy

func (in *PipelineRunStatusStatus) DeepCopy() *PipelineRunStatusStatus

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

func (*PipelineRunStatusStatus) DeepCopyInto

func (in *PipelineRunStatusStatus) DeepCopyInto(out *PipelineRunStatusStatus)

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

type PipelineRunVariableSpec

type PipelineRunVariableSpec struct {

	// The name of the pipelineRun variable that contains the github organization/owner name
	OwnerVariable string `json:"ownerVariable,omitempty"`

	// The name of the pipelineRun variable that contains the github repository name
	RepoVariable string `json:"repoVariable,omitempty"`

	// The name of the pipelineRun variable that contains the commit sha
	ShaVariable string `json:"shaVariable,omitempty"`
}

type PipelineRunsStatus

type PipelineRunsStatus struct {
	// The name of the pipeline run
	PipelineRunName string `json:"pipelineRunName,omitempty"`

	// Wether an error occurred processing the PipelineRun
	HadError string `json:"hadError,omitempty"`

	// The result of processing the PipelineRun
	Result string `json:"result,omitempty"`

	// The last record status of the pipelineRun
	// +optional
	LastStatus CommitStatusesStatus `json:"lastStatus,omitempty"`
}

type SecretRef

type SecretRef struct {
	SecretKey  string `json:"secretKey,omitempty"`
	SecretName string `json:"secretName,omitempty"`
}

SecretRef contains the information required to reference a single secret string This is needed because the other secretRef types are not cross-namespace and do not actually contain the "SecretName" field, which allows us to access a single secret value.