Documentation ¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the eventing v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=operator.knative.dev
Copyright 2019 The Knative Authors ¶
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Copyright 2020 The Knative Authors ¶
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Index ¶
- Constants
- Variables
- func Resource(resource string) schema.GroupResource
- type Eventing
- type EventingList
- type EventingSpec
- type EventingStatus
- type KnativeEventing
- type KnativeEventingList
- type KnativeEventingSpec
- type KnativeEventingStatus
- func (in *KnativeEventingStatus) DeepCopy() *KnativeEventingStatus
- func (in *KnativeEventingStatus) DeepCopyInto(out *KnativeEventingStatus)
- func (es *KnativeEventingStatus) GetCondition(t apis.ConditionType) *apis.Condition
- func (es *KnativeEventingStatus) InitializeConditions()
- func (es *KnativeEventingStatus) IsReady() bool
- func (es *KnativeEventingStatus) MarkEventingFailed(reason, message string)
- func (es *KnativeEventingStatus) MarkEventingInstalled()
- func (es *KnativeEventingStatus) MarkEventingNotReady(reason, message string)
- func (es *KnativeEventingStatus) MarkEventingReady()
- type Registry
Constants ¶
const ( // EventingConditionReady is set when the KnativeEventing Operator is installed, configured and ready. EventingConditionReady = apis.ConditionReady // InstallSucceeded is set when the Knative KnativeEventing is installed. InstallSucceeded apis.ConditionType = "InstallSucceeded" )
const ( // The group name. This is used for CRDs. GroupName = "operator.knative.dev" // The Version of the schema. This is used for CRDs. SchemaVersion = "v1alpha1" // Kind of a CRD. Kind = "KnativeEventing" // ResourceName is name of CRD that is used in CLI. ResourceName = "knativeeventing" // PluralResourceName is plural version of name of CRD used in CLI. PluralResourceName = "knativeeventings" )
Variables ¶
var ( // SchemeGroupVersion is group version used to register these objects SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: SchemaVersion} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) AddToScheme = SchemeBuilder.AddToScheme )
Functions ¶
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns a Group qualified GroupResource
Types ¶
type Eventing ¶
type Eventing struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec EventingSpec `json:"spec,omitempty"` Status EventingStatus `json:"status,omitempty"` }
Eventing is the Schema for the eventings API +k8s:openapi-gen=true
func (*Eventing) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Eventing.
func (*Eventing) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Eventing) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type EventingList ¶
type EventingList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []Eventing `json:"items"` }
EventingList contains a list of Eventing
func (*EventingList) DeepCopy ¶
func (in *EventingList) DeepCopy() *EventingList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EventingList.
func (*EventingList) DeepCopyInto ¶
func (in *EventingList) DeepCopyInto(out *EventingList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*EventingList) DeepCopyObject ¶
func (in *EventingList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type EventingSpec ¶
type EventingSpec struct { }
EventingSpec defines the desired state of Eventing +k8s:openapi-gen=true
func (*EventingSpec) DeepCopy ¶
func (in *EventingSpec) DeepCopy() *EventingSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EventingSpec.
func (*EventingSpec) DeepCopyInto ¶
func (in *EventingSpec) DeepCopyInto(out *EventingSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type EventingStatus ¶
type EventingStatus struct { duckv1beta1.Status `json:",inline"` // The version of the installed release // +optional Version string `json:"version,omitempty"` }
EventingStatus defines the observed state of Eventing +k8s:openapi-gen=true
func (*EventingStatus) DeepCopy ¶
func (in *EventingStatus) DeepCopy() *EventingStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EventingStatus.
func (*EventingStatus) DeepCopyInto ¶
func (in *EventingStatus) DeepCopyInto(out *EventingStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KnativeEventing ¶ added in v0.12.0
type KnativeEventing struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec KnativeEventingSpec `json:"spec,omitempty"` Status KnativeEventingStatus `json:"status,omitempty"` }
KnativeEventing is the Schema for the eventings API +k8s:openapi-gen=true
func (*KnativeEventing) DeepCopy ¶ added in v0.12.0
func (in *KnativeEventing) DeepCopy() *KnativeEventing
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KnativeEventing.
func (*KnativeEventing) DeepCopyInto ¶ added in v0.12.0
func (in *KnativeEventing) DeepCopyInto(out *KnativeEventing)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KnativeEventing) DeepCopyObject ¶ added in v0.12.0
func (in *KnativeEventing) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*KnativeEventing) GroupVersionKind ¶ added in v0.12.0
func (e *KnativeEventing) GroupVersionKind() schema.GroupVersionKind
GroupVersionKind returns SchemeGroupVersion of an KnativeEventing
type KnativeEventingList ¶ added in v0.12.0
type KnativeEventingList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []KnativeEventing `json:"items"` }
KnativeEventingList contains a list of KnativeEventing
func (*KnativeEventingList) DeepCopy ¶ added in v0.12.0
func (in *KnativeEventingList) DeepCopy() *KnativeEventingList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KnativeEventingList.
func (*KnativeEventingList) DeepCopyInto ¶ added in v0.12.0
func (in *KnativeEventingList) DeepCopyInto(out *KnativeEventingList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KnativeEventingList) DeepCopyObject ¶ added in v0.12.0
func (in *KnativeEventingList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type KnativeEventingSpec ¶ added in v0.12.0
type KnativeEventingSpec struct { }
KnativeEventingSpec defines the desired state of KnativeEventing +k8s:openapi-gen=true
func (*KnativeEventingSpec) DeepCopy ¶ added in v0.12.0
func (in *KnativeEventingSpec) DeepCopy() *KnativeEventingSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KnativeEventingSpec.
func (*KnativeEventingSpec) DeepCopyInto ¶ added in v0.12.0
func (in *KnativeEventingSpec) DeepCopyInto(out *KnativeEventingSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KnativeEventingStatus ¶ added in v0.12.0
type KnativeEventingStatus struct { duckv1beta1.Status `json:",inline"` // The version of the installed release // +optional Version string `json:"version,omitempty"` }
KnativeEventingStatus defines the observed state of KnativeEventing +k8s:openapi-gen=true
func (*KnativeEventingStatus) DeepCopy ¶ added in v0.12.0
func (in *KnativeEventingStatus) DeepCopy() *KnativeEventingStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KnativeEventingStatus.
func (*KnativeEventingStatus) DeepCopyInto ¶ added in v0.12.0
func (in *KnativeEventingStatus) DeepCopyInto(out *KnativeEventingStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KnativeEventingStatus) GetCondition ¶ added in v0.12.0
func (es *KnativeEventingStatus) GetCondition(t apis.ConditionType) *apis.Condition
GetCondition returns the current condition of a given condition type
func (*KnativeEventingStatus) InitializeConditions ¶ added in v0.12.0
func (es *KnativeEventingStatus) InitializeConditions()
InitializeConditions initializes conditions of an KnativeEventingStatus
func (*KnativeEventingStatus) IsReady ¶ added in v0.12.0
func (es *KnativeEventingStatus) IsReady() bool
IsReady looks at the conditions and if the Status has a condition EventingConditionReady returns true if ConditionStatus is True
func (*KnativeEventingStatus) MarkEventingFailed ¶ added in v0.12.0
func (es *KnativeEventingStatus) MarkEventingFailed(reason, message string)
MarkEventingFailed marks the KnativeEventing status as failed
func (*KnativeEventingStatus) MarkEventingInstalled ¶ added in v0.12.0
func (es *KnativeEventingStatus) MarkEventingInstalled()
MarkEventingInstalled set InstallSucceeded in KnativeEventingStatus as true
func (*KnativeEventingStatus) MarkEventingNotReady ¶ added in v0.12.0
func (es *KnativeEventingStatus) MarkEventingNotReady(reason, message string)
MarkEventingNotReady marks the KnativeEventing status as ready == Unknown
func (*KnativeEventingStatus) MarkEventingReady ¶ added in v0.12.0
func (es *KnativeEventingStatus) MarkEventingReady()
MarkEventingReady marks the KnativeEventing status as ready
type Registry ¶
type Registry struct { // The default image reference template to use for all knative images. // It takes the form of example-registry.io/custom/path/${NAME}:custom-tag // ${NAME} will be replaced by the deployment container name, or caching.internal.knative.dev/v1alpha1/Image name. // +optional Default string `json:"default,omitempty"` // A map of a container name or image name to the full image location of the individual knative image. // +optional Override map[string]string `json:"override,omitempty"` }
Registry defines image overrides of knative images. This affects both apps/v1.Deployment and caching.internal.knative.dev/v1alpha1.Image. The default value is used as a default format to override for all knative deployments. The override values are specific to each knative deployment. +k8s:openapi-gen=true
func (*Registry) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Registry.
func (*Registry) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.