v1alpha1

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.

Index

• Constants
• Variables
• func Resource(resource string) schema.GroupResource
• type Eventing
  • func (in *Eventing) DeepCopy() *Eventing
  • func (in *Eventing) DeepCopyInto(out *Eventing)
  • func (in *Eventing) DeepCopyObject() runtime.Object
  • func (e *Eventing) GroupVersionKind() schema.GroupVersionKind
• type EventingList
  • func (in *EventingList) DeepCopy() *EventingList
  • func (in *EventingList) DeepCopyInto(out *EventingList)
  • func (in *EventingList) DeepCopyObject() runtime.Object
• type EventingSpec
  • func (in *EventingSpec) DeepCopy() *EventingSpec
  • func (in *EventingSpec) DeepCopyInto(out *EventingSpec)
• type EventingStatus
  • func (in *EventingStatus) DeepCopy() *EventingStatus
  • func (in *EventingStatus) DeepCopyInto(out *EventingStatus)
  • func (es *EventingStatus) GetCondition(t apis.ConditionType) *apis.Condition
  • func (es *EventingStatus) InitializeConditions()
  • func (es *EventingStatus) IsReady() bool
  • func (es *EventingStatus) MarkEventingFailed(reason, message string)
  • func (es *EventingStatus) MarkEventingInstalled()
  • func (es *EventingStatus) MarkEventingNotReady(reason, message string)
  • func (es *EventingStatus) MarkEventingReady()
• type Registry
  • func (in *Registry) DeepCopy() *Registry
  • func (in *Registry) DeepCopyInto(out *Registry)

Constants

const (
	// EventingConditionReady is set when the Eventing Operator is installed, configured and ready.
	EventingConditionReady = apis.ConditionReady

	// InstallSucceeded is set when the Knative Eventing is installed.
	InstallSucceeded apis.ConditionType = "InstallSucceeded"
)

Variables

var (
	// SchemeGroupVersion is group version used to register these objects
	SchemeGroupVersion = schema.GroupVersion{Group: "operator.knative.dev", Version: "v1alpha1"}

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

func (in *Eventing) DeepCopy() *Eventing

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

func (*Eventing) DeepCopyInto

func (in *Eventing) DeepCopyInto(out *Eventing)

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

func (*Eventing) DeepCopyObject

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

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

func (*Eventing) GroupVersionKind

func (e *Eventing) GroupVersionKind() schema.GroupVersionKind

GroupVersionKind returns SchemeGroupVersion of an Eventing

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.

func (*EventingStatus) GetCondition

func (es *EventingStatus) GetCondition(t apis.ConditionType) *apis.Condition

GetCondition returns the current condition of a given condition type

func (*EventingStatus) InitializeConditions

func (es *EventingStatus) InitializeConditions()

InitializeConditions initializes conditions of an EventingStatus

func (*EventingStatus) IsReady

func (es *EventingStatus) IsReady() bool

IsReady looks at the conditions and if the Status has a condition EventingConditionReady returns true if ConditionStatus is True

func (*EventingStatus) MarkEventingFailed

func (es *EventingStatus) MarkEventingFailed(reason, message string)

MarkEventingFailed marks the Eventing status as failed

func (*EventingStatus) MarkEventingInstalled

func (es *EventingStatus) MarkEventingInstalled()

MarkEventingInstalled set InstallSucceeded in EventingStatus as true

func (*EventingStatus) MarkEventingNotReady

func (es *EventingStatus) MarkEventingNotReady(reason, message string)

MarkEventingNotReady marks the Eventing status as ready == Unknown

func (*EventingStatus) MarkEventingReady

func (es *EventingStatus) MarkEventingReady()

MarkEventingReady marks the Eventing 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

func (in *Registry) DeepCopy() *Registry

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

func (*Registry) DeepCopyInto

func (in *Registry) DeepCopyInto(out *Registry)

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