Documentation
¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the mpas v1alpha1 API group +kubebuilder:object:generate=true +groupName=mpas.ocm.software
Index ¶
- Constants
- Variables
- type CommitTemplate
- type Credentials
- type ExistingRepositoryPolicy
- type Repository
- func (in *Repository) DeepCopy() *Repository
- func (in *Repository) DeepCopyInto(out *Repository)
- func (in *Repository) DeepCopyObject() runtime.Object
- func (in *Repository) GetConditions() []metav1.Condition
- func (in Repository) GetRepositoryURL() string
- func (in Repository) GetRequeueAfter() time.Duration
- func (in *Repository) SetConditions(conditions []metav1.Condition)
- type RepositoryList
- type RepositorySpec
- type RepositoryStatus
Constants ¶
const ( // RepositoryCreateFailedReason is used when we fail to create a Repository. RepositoryCreateFailedReason = "RepositoryCreateFailed" // UpdatingBranchProtectionFailedReason is used when we fail to update a branch protection rules. UpdatingBranchProtectionFailedReason = "UpdatingBranchProtectionFailed" )
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: "mpas.ocm.software", 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 CommitTemplate ¶
type CommitTemplate struct {
Email string `json:"email"`
Message string `json:"message"`
Name string `json:"name"`
}
CommitTemplate defines the commit template to use when automated commits are made.
func (*CommitTemplate) DeepCopy ¶
func (in *CommitTemplate) DeepCopy() *CommitTemplate
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CommitTemplate.
func (*CommitTemplate) DeepCopyInto ¶
func (in *CommitTemplate) DeepCopyInto(out *CommitTemplate)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Credentials ¶
type Credentials struct {
SecretRef v1.LocalObjectReference `json:"secretRef"`
}
Credentials contains ways of authenticating the creation of a repository.
func (*Credentials) DeepCopy ¶
func (in *Credentials) DeepCopy() *Credentials
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Credentials.
func (*Credentials) DeepCopyInto ¶
func (in *Credentials) DeepCopyInto(out *Credentials)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ExistingRepositoryPolicy ¶
type ExistingRepositoryPolicy string
ExistingRepositoryPolicy defines what to do in case a requested repository already exists.
var ( // ExistingRepositoryPolicyAdopt will use the repository if it exists. ExistingRepositoryPolicyAdopt ExistingRepositoryPolicy = "adopt" // ExistingRepositoryPolicyFail will fail if the requested repository already exists. ExistingRepositoryPolicyFail ExistingRepositoryPolicy = "fail" )
type Repository ¶
type Repository struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec RepositorySpec `json:"spec,omitempty"`
Status RepositoryStatus `json:"status,omitempty"`
}
Repository is the Schema for the repositories API
func (*Repository) DeepCopy ¶
func (in *Repository) DeepCopy() *Repository
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Repository.
func (*Repository) DeepCopyInto ¶
func (in *Repository) DeepCopyInto(out *Repository)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Repository) DeepCopyObject ¶
func (in *Repository) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Repository) GetConditions ¶
func (in *Repository) GetConditions() []metav1.Condition
GetConditions returns the conditions of the ComponentVersion.
func (Repository) GetRepositoryURL ¶
func (in Repository) GetRepositoryURL() string
GetRepositoryURL construct a repository URL based on either domain or the provider data.
func (Repository) GetRequeueAfter ¶
func (in Repository) GetRequeueAfter() time.Duration
GetRequeueAfter returns the duration after which the ComponentVersion must be reconciled again.
func (*Repository) SetConditions ¶
func (in *Repository) SetConditions(conditions []metav1.Condition)
SetConditions sets the conditions of the ComponentVersion.
type RepositoryList ¶
type RepositoryList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []Repository `json:"items"`
}
RepositoryList contains a list of Repository
func (*RepositoryList) DeepCopy ¶
func (in *RepositoryList) DeepCopy() *RepositoryList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RepositoryList.
func (*RepositoryList) DeepCopyInto ¶
func (in *RepositoryList) DeepCopyInto(out *RepositoryList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*RepositoryList) DeepCopyObject ¶
func (in *RepositoryList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type RepositorySpec ¶
type RepositorySpec struct {
//+required
Provider string `json:"provider"`
//+required
Owner string `json:"owner"`
//+required
Credentials Credentials `json:"credentials"`
//+optional
//+kubebuilder:default:=main
DefaultBranch string `json:"defaultBranch,omitempty"`
//+optional
Interval metav1.Duration `json:"interval,omitempty"`
//+optional
//+kubebuilder:validation:Enum=public;private;internal
//+kubebuilder:default:=private
Visibility string `json:"visibility,omitempty"`
//+kubebuilder:default:=true
IsOrganization bool `json:"isOrganization"`
//+optional
Domain string `json:"domain,omitempty"`
//+optional
Maintainers []string `json:"maintainers,omitempty"`
//+optional
//+kubebuilder:default:=adopt
//+kubebuilder:validation:Enum=adopt;fail
ExistingRepositoryPolicy ExistingRepositoryPolicy `json:"existingRepositoryPolicy,omitempty"`
//+optional
CommitTemplate *CommitTemplate `json:"commitTemplate,omitempty"`
}
RepositorySpec defines the desired state of Repository
func (*RepositorySpec) DeepCopy ¶
func (in *RepositorySpec) DeepCopy() *RepositorySpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RepositorySpec.
func (*RepositorySpec) DeepCopyInto ¶
func (in *RepositorySpec) DeepCopyInto(out *RepositorySpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RepositoryStatus ¶
type RepositoryStatus struct {
// ObservedGeneration is the last reconciled generation.
// +optional
ObservedGeneration int64 `json:"observedGeneration,omitempty"`
// +optional
// +kubebuilder:printcolumn:name="Ready",type="string",JSONPath=".status.conditions[?(@.type==\"Ready\")].status",description=""
// +kubebuilder:printcolumn:name="Status",type="string",JSONPath=".status.conditions[?(@.type==\"Ready\")].message",description=""
Conditions []metav1.Condition `json:"conditions,omitempty"`
}
RepositoryStatus defines the observed state of Repository
func (*RepositoryStatus) DeepCopy ¶
func (in *RepositoryStatus) DeepCopy() *RepositoryStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RepositoryStatus.
func (*RepositoryStatus) DeepCopyInto ¶
func (in *RepositoryStatus) DeepCopyInto(out *RepositoryStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.