Documentation ¶
Overview ¶
Package v1alpha1 is the v1alpha1 version of the API. +groupName=kudzu.sh +k8s:openapi-gen=true
Index ¶
- Constants
- Variables
- func RegisterDefaults(scheme *runtime.Scheme) error
- func Resource(resource string) schema.GroupResource
- func SetDefaults_ImageSpec(spec *ImageSpec)
- func SetObjectDefaults_API(in *API)
- func SetObjectDefaults_APIList(in *APIList)
- type API
- type APIList
- type APISpec
- type APIStatus
- func (s *APIStatus) ConditionManager() duck.ConditionManager
- func (in *APIStatus) DeepCopy() *APIStatus
- func (in *APIStatus) DeepCopyInto(out *APIStatus)
- func (s *APIStatus) GetCondition(t duck.ConditionType) *duck.Condition
- func (s *APIStatus) GetConditions() duck.Conditions
- func (s *APIStatus) InitializeConditions()
- func (s *APIStatus) IsReady() bool
- func (s *APIStatus) SetConditions(conditions duck.Conditions)
- type ImageSpec
- type ImageStatus
- type ResourceStatus
- type SourceSpec
- type SourceStatus
Constants ¶
const ( APIReady = duck.ConditionReady APIApplied duck.ConditionType = "Applied" APIUpdated duck.ConditionType = "Updated" )
const GroupName = "kudzu.sh"
GroupName specifies the group name used to register the objects.
Variables ¶
var ( // localSchemeBuilder and AddToScheme will stay in k8s.io/kubernetes. SchemeBuilder runtime.SchemeBuilder // Depreciated: use Install instead AddToScheme = localSchemeBuilder.AddToScheme Install = localSchemeBuilder.AddToScheme )
var GroupVersion = v1.GroupVersion{Group: GroupName, Version: "v1alpha1"}
GroupVersion specifies the group and the version used to register the objects.
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1alpha1"}
SchemeGroupVersion is group version used to register these objects Deprecated: use GroupVersion instead.
Functions ¶
func RegisterDefaults ¶
RegisterDefaults adds defaulters functions to the given scheme. Public to allow building arbitrary schemes. All generated defaulters are covering - they call all nested defaulters.
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns a Group qualified GroupResource
func SetDefaults_ImageSpec ¶
func SetDefaults_ImageSpec(spec *ImageSpec)
func SetObjectDefaults_API ¶
func SetObjectDefaults_API(in *API)
func SetObjectDefaults_APIList ¶
func SetObjectDefaults_APIList(in *APIList)
Types ¶
type API ¶
type API struct { meta.TypeMeta `json:",inline"` meta.ObjectMeta `json:"metadata,omitempty"` Spec APISpec `json:"spec"` Status APIStatus `json:"status"` }
API is a set of custom resource definitions from the same group and version.
func (*API) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new API.
func (*API) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*API) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*API) GetSourceSpec ¶
func (a *API) GetSourceSpec() *SourceSpec
GetSourceSpec satisfies the Kudzu delegate.Object interface, allowing delegate Pods to be created to reify an API.
func (*API) GetSourceStatus ¶
func (a *API) GetSourceStatus() *SourceStatus
GetSourceStatus satisfies the Kudzu delegate.Object interface, allowing delegate Pods to be created to reify an API.
func (*API) SetSourceStatus ¶
func (a *API) SetSourceStatus(status *SourceStatus)
SetSourceStatus satisfies the Kudzu delegate.Object interface, allowing identity of the image used to reify the API to be saved.
type APIList ¶
type APIList struct { meta.TypeMeta `json:",inline"` meta.ListMeta `json:"metadata"` // Items is the list of API items in this list. Items []API `json:"items"` }
APIList is a list of API resources.
func (*APIList) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIList.
func (*APIList) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*APIList) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type APISpec ¶
type APISpec struct {
Source SourceSpec `json:"source"`
}
func (*APISpec) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APISpec.
func (*APISpec) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type APIStatus ¶
type APIStatus struct { // +optional Source *SourceStatus `json:"source,omitempty"` // +optional Conditions duck.Conditions `json:"conditions,omitempty"` // +optional ResourceCount int32 `json:"resourceCount,omitempty"` // +optional Resources []ResourceStatus `json:"resources,omitempty"` }
func (*APIStatus) ConditionManager ¶
func (s *APIStatus) ConditionManager() duck.ConditionManager
func (*APIStatus) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIStatus.
func (*APIStatus) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*APIStatus) GetCondition ¶
func (s *APIStatus) GetCondition(t duck.ConditionType) *duck.Condition
func (*APIStatus) GetConditions ¶
func (s *APIStatus) GetConditions() duck.Conditions
func (*APIStatus) InitializeConditions ¶
func (s *APIStatus) InitializeConditions()
func (*APIStatus) SetConditions ¶
func (s *APIStatus) SetConditions(conditions duck.Conditions)
type ImageSpec ¶
type ImageSpec struct { Repository string `json:"repository"` // +optional Tag string `json:"tag,omitempty"` // +optional Hash string `json:"hash,omitempty"` // +optional PullPolicy core.PullPolicy `json:"pullPolicy,omitempty"` }
ImageSpec specifies a Docker image to install an API or Operator. +k8s:deepcopy-gen=true
func (*ImageSpec) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ImageSpec.
func (*ImageSpec) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ImageSpec) Matches ¶
func (i ImageSpec) Matches(status *ImageStatus) bool
Matches verifies that an image's status matches its spec.
type ImageStatus ¶
type ImageStatus struct { Repository string `json:"repository"` Tag string `json:"tag"` Hash string `json:"hash"` }
ImageStatus is the status of fetching a Docker image to install an API or Operator. +k8s:deepcopy-gen=true
func (*ImageStatus) DeepCopy ¶
func (in *ImageStatus) DeepCopy() *ImageStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ImageStatus.
func (*ImageStatus) DeepCopyInto ¶
func (in *ImageStatus) DeepCopyInto(out *ImageStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ResourceStatus ¶
type ResourceStatus struct { Name string `json:"name"` Group string `json:"group"` Version string `json:"version"` Kind string `json:"kind"` }
+k8s:deepcopy-gen=true
func (*ResourceStatus) DeepCopy ¶
func (in *ResourceStatus) DeepCopy() *ResourceStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceStatus.
func (*ResourceStatus) DeepCopyInto ¶
func (in *ResourceStatus) DeepCopyInto(out *ResourceStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SourceSpec ¶
type SourceSpec struct {
Image *ImageSpec `json:"image,omitempty"`
}
SourceSpec specifies the source for an API or Operator. +k8s:deepcopy-gen=true
func (*SourceSpec) DeepCopy ¶
func (in *SourceSpec) DeepCopy() *SourceSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SourceSpec.
func (*SourceSpec) DeepCopyInto ¶
func (in *SourceSpec) DeepCopyInto(out *SourceSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (SourceSpec) Matches ¶
func (s SourceSpec) Matches(status *SourceStatus) bool
Matches verifies that a source's status matches its spec.
type SourceStatus ¶
type SourceStatus struct {
Image *ImageStatus `json:"image,omitempty"`
}
SourceStatus is the status of fetching the source for an API or Operator. +k8s:deepcopy-gen=true
func (*SourceStatus) DeepCopy ¶
func (in *SourceStatus) DeepCopy() *SourceStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SourceStatus.
func (*SourceStatus) DeepCopyInto ¶
func (in *SourceStatus) DeepCopyInto(out *SourceStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.