v1alpha1

package
v0.14.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 8, 2020 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

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.

Package v1alpha1 contains API Schema definitions for the serving v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=operator.knative.dev

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.

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.

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.

Package v1alpha1 contains API Schema definitions for the serving v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=serving.knative.dev

Index

Constants

View Source 
const (
	DependenciesInstalled apis.ConditionType = "DependenciesInstalled"
	InstallSucceeded      apis.ConditionType = "InstallSucceeded"
	DeploymentsAvailable  apis.ConditionType = "DeploymentsAvailable"
)
View Source 
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"

	// The Kind of the custom resource. This is used for CRDs.
	Kind = "KnativeServing"
)
View Source 
const (
	// EventingConditionReady is set when the KnativeEventing Operator is installed, configured and ready.
	EventingConditionReady = apis.ConditionReady
)

Variables

View Source 
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 GetOpenAPIDefinitions 

func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenAPIDefinition

func RegisterDefaults 

func RegisterDefaults(scheme *runtime.Scheme) error

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

Types

type CustomCerts 

type CustomCerts struct {
	// One of ConfigMap or Secret
	Type string `json:"type"`

	// The name of the ConfigMap or Secret
	Name string `json:"name"`
}

CustomCerts refers to either a ConfigMap or Secret containing valid CA certificates

func (*CustomCerts) DeepCopy 

func (in *CustomCerts) DeepCopy() *CustomCerts

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

func (*CustomCerts) DeepCopyInto 

func (in *CustomCerts) DeepCopyInto(out *CustomCerts)

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

type HighAvailability 

type HighAvailability struct {
	// Replicas is the number of replicas that HA parts of the control plane
	// will be scaled to.
	Replicas int32 `json:"replicas"`
}

HighAvailability specifies options for deploying Knative Serving control plane in a highly available manner. Note that HighAvailability is still in progress and does not currently provide a completely HA control plane.

func (*HighAvailability) DeepCopy 

func (in *HighAvailability) DeepCopy() *HighAvailability

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

func (*HighAvailability) DeepCopyInto 

func (in *HighAvailability) DeepCopyInto(out *HighAvailability)

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

type IstioGatewayOverride 

type IstioGatewayOverride struct {
	// A map of values to replace the "selector" values in the knative-ingress-gateway and cluster-local-gateway
	Selector map[string]string `json:"selector,omitempty"`
}

IstioGatewayOverride override the knative-ingress-gateway and cluster-local-gateway

func (*IstioGatewayOverride) DeepCopy 

func (in *IstioGatewayOverride) DeepCopy() *IstioGatewayOverride

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

func (*IstioGatewayOverride) DeepCopyInto 

func (in *IstioGatewayOverride) DeepCopyInto(out *IstioGatewayOverride)

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

type KnativeEventing 

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 

func (in *KnativeEventing) DeepCopy() *KnativeEventing

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

func (*KnativeEventing) DeepCopyInto 

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 

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

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

func (*KnativeEventing) GroupVersionKind 

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

GroupVersionKind returns SchemeGroupVersion of an KnativeEventing

type KnativeEventingList 

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 

func (in *KnativeEventingList) DeepCopy() *KnativeEventingList

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

func (*KnativeEventingList) DeepCopyInto 

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 

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

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

type KnativeEventingSpec 

type KnativeEventingSpec struct {
	// A means to override the corresponding entries in the upstream configmaps
	// +optional
	Config map[string]map[string]string `json:"config,omitempty"`

	// A means to override the corresponding deployment images in the upstream.
	// If no registry is provided, the knative release images will be used.
	// +optional
	Registry Registry `json:"registry,omitempty"`

	// The default broker type to use for the brokers Knative creates.
	// If no value is provided, ChannelBasedBroker will be used.
	// +optional
	DefaultBrokerClass string `json:"defaultBrokerClass,omitempty"`
}

KnativeEventingSpec defines the desired state of KnativeEventing +k8s:openapi-gen=true

func (*KnativeEventingSpec) DeepCopy 

func (in *KnativeEventingSpec) DeepCopy() *KnativeEventingSpec

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

func (*KnativeEventingSpec) DeepCopyInto 

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 

type KnativeEventingStatus struct {
	duckv1.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 

func (in *KnativeEventingStatus) DeepCopy() *KnativeEventingStatus

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

func (*KnativeEventingStatus) DeepCopyInto 

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 

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

GetCondition returns the current condition of a given condition type

func (*KnativeEventingStatus) InitializeConditions 

func (es *KnativeEventingStatus) InitializeConditions()

InitializeConditions initializes conditions of an KnativeEventingStatus

func (*KnativeEventingStatus) IsReady 

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 

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

MarkEventingFailed marks the KnativeEventing status as failed

func (*KnativeEventingStatus) MarkEventingNotReady 

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

MarkEventingNotReady marks the KnativeEventing status as ready == Unknown

func (*KnativeEventingStatus) MarkEventingReady 

func (es *KnativeEventingStatus) MarkEventingReady()

MarkEventingReady marks the KnativeEventing status as ready

func (*KnativeEventingStatus) MarkInstallationFailed 

func (es *KnativeEventingStatus) MarkInstallationFailed(reason, message string)

MarkInstallationFailed marks the InstallationSucceeded status as failed

func (*KnativeEventingStatus) MarkInstallationNotReady 

func (es *KnativeEventingStatus) MarkInstallationNotReady(reason, message string)

MarkInstallationNotReady marks the InstallationSucceeded status as ready == Unknown

func (*KnativeEventingStatus) MarkInstallationReady 

func (es *KnativeEventingStatus) MarkInstallationReady()

MarkInstallationReady marks the InstallationSucceeded status as ready

type KnativeServing 

type KnativeServing struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   KnativeServingSpec   `json:"spec,omitempty"`
	Status KnativeServingStatus `json:"status,omitempty"`
}

KnativeServing is the Schema for the knativeservings API +k8s:openapi-gen=true

func (*KnativeServing) DeepCopy 

func (in *KnativeServing) DeepCopy() *KnativeServing

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

func (*KnativeServing) DeepCopyInto 

func (in *KnativeServing) DeepCopyInto(out *KnativeServing)

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

func (*KnativeServing) DeepCopyObject 

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

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

func (*KnativeServing) GroupVersionKind 

func (ks *KnativeServing) GroupVersionKind() schema.GroupVersionKind

GroupVersionKind returns SchemeGroupVersion of a KnativeServing

type KnativeServingList 

type KnativeServingList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []KnativeServing `json:"items"`
}

KnativeServingList contains a list of KnativeServing

func (*KnativeServingList) DeepCopy 

func (in *KnativeServingList) DeepCopy() *KnativeServingList

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

func (*KnativeServingList) DeepCopyInto 

func (in *KnativeServingList) DeepCopyInto(out *KnativeServingList)

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

func (*KnativeServingList) DeepCopyObject 

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

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

type KnativeServingSpec 

type KnativeServingSpec struct {

	// A means to override the corresponding entries in the upstream configmaps
	// +optional
	Config map[string]map[string]string `json:"config,omitempty"`

	// A means to override the corresponding deployment images in the upstream.
	// If no registry is provided, the knative release images will be used.
	// +optional
	Registry Registry `json:"registry,omitempty"`

	// A means to override the knative-ingress-gateway
	KnativeIngressGateway IstioGatewayOverride `json:"knative-ingress-gateway,omitempty"`

	// A means to override the cluster-local-gateway
	ClusterLocalGateway IstioGatewayOverride `json:"cluster-local-gateway,omitempty"`

	// Enables controller to trust registries with self-signed certificates
	ControllerCustomCerts CustomCerts `json:"controller-custom-certs,omitempty"`

	// Allows specification of HA control plane
	// +optional
	HighAvailability *HighAvailability `json:"high-availability,omitempty"`

	// Override containers' resource requirements
	// +optional
	Resources []ResourceRequirementsOverride `json:"resources,omitempty"`
}

KnativeServingSpec defines the desired state of KnativeServing +k8s:openapi-gen=true

func (*KnativeServingSpec) DeepCopy 

func (in *KnativeServingSpec) DeepCopy() *KnativeServingSpec

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

func (*KnativeServingSpec) DeepCopyInto 

func (in *KnativeServingSpec) DeepCopyInto(out *KnativeServingSpec)

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

type KnativeServingStatus 

type KnativeServingStatus struct {
	duckv1.Status `json:",inline"`

	// The version of the installed release
	// +optional
	Version string `json:"version,omitempty"`
}

KnativeServingStatus defines the observed state of KnativeServing +k8s:openapi-gen=true

func (*KnativeServingStatus) DeepCopy 

func (in *KnativeServingStatus) DeepCopy() *KnativeServingStatus

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

func (*KnativeServingStatus) DeepCopyInto 

func (in *KnativeServingStatus) DeepCopyInto(out *KnativeServingStatus)

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

func (*KnativeServingStatus) GetCondition 

func (is *KnativeServingStatus) GetCondition(t apis.ConditionType) *apis.Condition

func (*KnativeServingStatus) InitializeConditions 

func (is *KnativeServingStatus) InitializeConditions()

func (*KnativeServingStatus) IsAvailable 

func (is *KnativeServingStatus) IsAvailable() bool

func (*KnativeServingStatus) IsDeploying 

func (is *KnativeServingStatus) IsDeploying() bool

func (*KnativeServingStatus) IsFullySupported 

func (is *KnativeServingStatus) IsFullySupported() bool

func (*KnativeServingStatus) IsInstalled 

func (is *KnativeServingStatus) IsInstalled() bool

func (*KnativeServingStatus) IsReady 

func (is *KnativeServingStatus) IsReady() bool

func (*KnativeServingStatus) MarkDependenciesInstalled 

func (is *KnativeServingStatus) MarkDependenciesInstalled()

func (*KnativeServingStatus) MarkDependencyInstalling 

func (is *KnativeServingStatus) MarkDependencyInstalling(msg string)

func (*KnativeServingStatus) MarkDependencyMissing 

func (is *KnativeServingStatus) MarkDependencyMissing(msg string)

func (*KnativeServingStatus) MarkDeploymentsAvailable 

func (is *KnativeServingStatus) MarkDeploymentsAvailable()

func (*KnativeServingStatus) MarkDeploymentsNotReady 

func (is *KnativeServingStatus) MarkDeploymentsNotReady()

func (*KnativeServingStatus) MarkInstallFailed 

func (is *KnativeServingStatus) MarkInstallFailed(msg string)

func (*KnativeServingStatus) MarkInstallSucceeded 

func (is *KnativeServingStatus) MarkInstallSucceeded()

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"`

	// A list of secrets to be used when pulling the knative images. The secret must be created in the
	// same namespace as the knative-serving deployments, and not the namespace of this resource.
	// +optional
	ImagePullSecrets []corev1.LocalObjectReference `json:"imagePullSecrets,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.

type ResourceRequirementsOverride 

type ResourceRequirementsOverride struct {
	// The container name
	Container string `json:"container"`
	// The desired ResourceRequirements
	corev1.ResourceRequirements
}

ResourceRequirementsOverride enables the user to override any container's resource requests/limits specified in the embedded manifest

func (*ResourceRequirementsOverride) DeepCopy 

func (in *ResourceRequirementsOverride) DeepCopy() *ResourceRequirementsOverride

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

func (*ResourceRequirementsOverride) DeepCopyInto 

func (in *ResourceRequirementsOverride) DeepCopyInto(out *ResourceRequirementsOverride)

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.