Documentation
¶
Overview ¶
Package v1alpha1 contains the core resources of the GitHub provider. +kubebuilder:object:generate=true +groupName=github.crossplane.io +versionName=v1alpha1
Index ¶
- Constants
- Variables
- type ProviderConfig
- func (in *ProviderConfig) DeepCopy() *ProviderConfig
- func (in *ProviderConfig) DeepCopyInto(out *ProviderConfig)
- func (in *ProviderConfig) DeepCopyObject() runtime.Object
- func (p *ProviderConfig) GetCondition(ct xpv2.ConditionType) xpv2.Condition
- func (p *ProviderConfig) GetUsers() int64
- func (p *ProviderConfig) SetConditions(c ...xpv2.Condition)
- func (p *ProviderConfig) SetUsers(i int64)
- type ProviderConfigList
- type ProviderConfigSpec
- type ProviderConfigStatus
- type ProviderConfigUsage
- func (in *ProviderConfigUsage) DeepCopy() *ProviderConfigUsage
- func (in *ProviderConfigUsage) DeepCopyInto(out *ProviderConfigUsage)
- func (in *ProviderConfigUsage) DeepCopyObject() runtime.Object
- func (p *ProviderConfigUsage) GetProviderConfigReference() xpv2.Reference
- func (p *ProviderConfigUsage) GetResourceReference() xpv2.TypedReference
- func (p *ProviderConfigUsage) SetProviderConfigReference(r xpv2.Reference)
- func (p *ProviderConfigUsage) SetResourceReference(r xpv2.TypedReference)
- type ProviderConfigUsageList
- type ProviderCredentials
Constants ¶
const ( Group = "github.crossplane.io" Version = "v1alpha1" )
Package type metadata.
Variables ¶
var ( // SchemeGroupVersion is group version used to register these objects SchemeGroupVersion = schema.GroupVersion{Group: Group, Version: Version} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion} )
var ( ProviderConfigKind = reflect.TypeOf(ProviderConfig{}).Name() ProviderConfigGroupKind = schema.GroupKind{Group: Group, Kind: ProviderConfigKind}.String() ProviderConfigKindAPIVersion = ProviderConfigKind + "." + SchemeGroupVersion.String() ProviderConfigGroupVersionKind = SchemeGroupVersion.WithKind(ProviderConfigKind) )
ProviderConfig type metadata.
var ( ProviderConfigUsageKind = reflect.TypeOf(ProviderConfigUsage{}).Name() ProviderConfigUsageGroupKind = schema.GroupKind{Group: Group, Kind: ProviderConfigUsageKind}.String() ProviderConfigUsageKindAPIVersion = ProviderConfigUsageKind + "." + SchemeGroupVersion.String() ProviderConfigUsageGroupVersionKind = SchemeGroupVersion.WithKind(ProviderConfigUsageKind) ProviderConfigUsageListKind = reflect.TypeOf(ProviderConfigUsageList{}).Name() ProviderConfigUsageListGroupKind = schema.GroupKind{Group: Group, Kind: ProviderConfigUsageListKind}.String() ProviderConfigUsageListKindAPIVersion = ProviderConfigUsageListKind + "." + SchemeGroupVersion.String() ProviderConfigUsageListGroupVersionKind = SchemeGroupVersion.WithKind(ProviderConfigUsageListKind) )
ProviderConfigUsage type metadata.
Functions ¶
This section is empty.
Types ¶
type ProviderConfig ¶
type ProviderConfig struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec ProviderConfigSpec `json:"spec"`
Status ProviderConfigStatus `json:"status,omitempty"`
}
A ProviderConfig configures a GitHub provider. +kubebuilder:subresource:status +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:printcolumn:name="SECRET-NAME",type="string",JSONPath=".spec.credentials.secretRef.name",priority=1 +kubebuilder:resource:scope=Cluster,categories={crossplane,provider,github}
func (*ProviderConfig) DeepCopy ¶
func (in *ProviderConfig) DeepCopy() *ProviderConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProviderConfig.
func (*ProviderConfig) DeepCopyInto ¶
func (in *ProviderConfig) DeepCopyInto(out *ProviderConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ProviderConfig) DeepCopyObject ¶
func (in *ProviderConfig) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*ProviderConfig) GetCondition ¶
func (p *ProviderConfig) GetCondition(ct xpv2.ConditionType) xpv2.Condition
GetCondition of this ProviderConfig.
func (*ProviderConfig) GetUsers ¶
func (p *ProviderConfig) GetUsers() int64
GetUsers of this ProviderConfig.
func (*ProviderConfig) SetConditions ¶
func (p *ProviderConfig) SetConditions(c ...xpv2.Condition)
SetConditions of this ProviderConfig.
func (*ProviderConfig) SetUsers ¶
func (p *ProviderConfig) SetUsers(i int64)
SetUsers of this ProviderConfig.
type ProviderConfigList ¶
type ProviderConfigList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []ProviderConfig `json:"items"`
}
ProviderConfigList contains a list of ProviderConfig.
func (*ProviderConfigList) DeepCopy ¶
func (in *ProviderConfigList) DeepCopy() *ProviderConfigList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProviderConfigList.
func (*ProviderConfigList) DeepCopyInto ¶
func (in *ProviderConfigList) DeepCopyInto(out *ProviderConfigList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ProviderConfigList) DeepCopyObject ¶
func (in *ProviderConfigList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ProviderConfigSpec ¶
type ProviderConfigSpec struct {
// Credentials required to authenticate to this provider.
Credentials ProviderCredentials `json:"credentials"`
// AdditionalCredentials is an optional list of extra GitHub App
// credentials. When set, the provider treats Credentials together with
// these as a pool: on every reconcile it picks the credential with the
// most available rate-limit quota and skips any whose quota was
// recently exhausted (HTTP 429), giving the GitHub apps time to
// reset before being tried again.
// +optional
AdditionalCredentials []ProviderCredentials `json:"additionalCredentials"`
}
A ProviderConfigSpec defines the desired state of a ProviderConfig.
func (*ProviderConfigSpec) DeepCopy ¶
func (in *ProviderConfigSpec) DeepCopy() *ProviderConfigSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProviderConfigSpec.
func (*ProviderConfigSpec) DeepCopyInto ¶
func (in *ProviderConfigSpec) DeepCopyInto(out *ProviderConfigSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ProviderConfigStatus ¶
type ProviderConfigStatus struct {
xpv2.ProviderConfigStatus `json:",inline"`
}
A ProviderConfigStatus reflects the observed state of a ProviderConfig.
func (*ProviderConfigStatus) DeepCopy ¶
func (in *ProviderConfigStatus) DeepCopy() *ProviderConfigStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProviderConfigStatus.
func (*ProviderConfigStatus) DeepCopyInto ¶
func (in *ProviderConfigStatus) DeepCopyInto(out *ProviderConfigStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ProviderConfigUsage ¶
type ProviderConfigUsage struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
xpv2.ProviderConfigUsage `json:",inline"`
}
A ProviderConfigUsage indicates that a resource is using a ProviderConfig. +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:printcolumn:name="CONFIG-NAME",type="string",JSONPath=".providerConfigRef.name" +kubebuilder:printcolumn:name="RESOURCE-KIND",type="string",JSONPath=".resourceRef.kind" +kubebuilder:printcolumn:name="RESOURCE-NAME",type="string",JSONPath=".resourceRef.name" +kubebuilder:resource:scope=Cluster,categories={crossplane,provider,github}
func (*ProviderConfigUsage) DeepCopy ¶
func (in *ProviderConfigUsage) DeepCopy() *ProviderConfigUsage
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProviderConfigUsage.
func (*ProviderConfigUsage) DeepCopyInto ¶
func (in *ProviderConfigUsage) DeepCopyInto(out *ProviderConfigUsage)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ProviderConfigUsage) DeepCopyObject ¶
func (in *ProviderConfigUsage) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*ProviderConfigUsage) GetProviderConfigReference ¶
func (p *ProviderConfigUsage) GetProviderConfigReference() xpv2.Reference
GetProviderConfigReference of this ProviderConfigUsage.
func (*ProviderConfigUsage) GetResourceReference ¶
func (p *ProviderConfigUsage) GetResourceReference() xpv2.TypedReference
GetResourceReference of this ProviderConfigUsage.
func (*ProviderConfigUsage) SetProviderConfigReference ¶
func (p *ProviderConfigUsage) SetProviderConfigReference(r xpv2.Reference)
SetProviderConfigReference of this ProviderConfigUsage.
func (*ProviderConfigUsage) SetResourceReference ¶
func (p *ProviderConfigUsage) SetResourceReference(r xpv2.TypedReference)
SetResourceReference of this ProviderConfigUsage.
type ProviderConfigUsageList ¶
type ProviderConfigUsageList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []ProviderConfigUsage `json:"items"`
}
ProviderConfigUsageList contains a list of ProviderConfigUsage
func (*ProviderConfigUsageList) DeepCopy ¶
func (in *ProviderConfigUsageList) DeepCopy() *ProviderConfigUsageList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProviderConfigUsageList.
func (*ProviderConfigUsageList) DeepCopyInto ¶
func (in *ProviderConfigUsageList) DeepCopyInto(out *ProviderConfigUsageList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ProviderConfigUsageList) DeepCopyObject ¶
func (in *ProviderConfigUsageList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*ProviderConfigUsageList) GetItems ¶
func (p *ProviderConfigUsageList) GetItems() []resource.ProviderConfigUsage
GetItems of this ProviderConfigUsageList.
type ProviderCredentials ¶
type ProviderCredentials struct {
// Source of the provider credentials.
// +kubebuilder:validation:Enum=None;Secret;InjectedIdentity;Environment;Filesystem
Source xpv2.CredentialsSource `json:"source"`
xpv2.CommonCredentialSelectors `json:",inline"`
}
ProviderCredentials required to authenticate.
func (*ProviderCredentials) DeepCopy ¶
func (in *ProviderCredentials) DeepCopy() *ProviderCredentials
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProviderCredentials.
func (*ProviderCredentials) DeepCopyInto ¶
func (in *ProviderCredentials) DeepCopyInto(out *ProviderCredentials)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
Source Files