v1alpha1

package
v0.14.0 Latest Latest
Warning

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

Go to latest
Published: Apr 16, 2020 License: Apache-2.0 Imports: 8 Imported by: 47

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.

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

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 added in v0.11.0

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 added in v0.11.0

func (in *CustomCerts) DeepCopy() *CustomCerts

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

func (*CustomCerts) DeepCopyInto added in v0.11.0

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 added in v0.13.0

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 added in v0.13.0

func (in *HighAvailability) DeepCopy() *HighAvailability

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

func (*HighAvailability) DeepCopyInto added in v0.13.0

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

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 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 added in v0.10.0

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

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 added in v0.11.0

func (is *KnativeServingStatus) IsFullySupported() bool

func (*KnativeServingStatus) IsInstalled

func (is *KnativeServingStatus) IsInstalled() bool

func (*KnativeServingStatus) IsReady

func (is *KnativeServingStatus) IsReady() bool

func (*KnativeServingStatus) MarkDependenciesInstalled added in v0.11.0

func (is *KnativeServingStatus) MarkDependenciesInstalled()

func (*KnativeServingStatus) MarkDependencyInstalling added in v0.11.0

func (is *KnativeServingStatus) MarkDependencyInstalling(msg string)

func (*KnativeServingStatus) MarkDependencyMissing added in v0.11.0

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 added in v0.14.0

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 added in v0.14.0

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

func (*ResourceRequirementsOverride) DeepCopyInto added in v0.14.0

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL