v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the managed v1alpha1 API group +kubebuilder:object:generate=true +groupName=managed.openshift.io

Index

• Variables
• func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenAPIDefinition
• type CustomDomain
  • func (in *CustomDomain) DeepCopy() *CustomDomain
  • func (in *CustomDomain) DeepCopyInto(out *CustomDomain)
  • func (in *CustomDomain) DeepCopyObject() runtime.Object
• type CustomDomainCondition
  • func (in *CustomDomainCondition) DeepCopy() *CustomDomainCondition
  • func (in *CustomDomainCondition) DeepCopyInto(out *CustomDomainCondition)
• type CustomDomainConditionType
• type CustomDomainList
  • func (in *CustomDomainList) DeepCopy() *CustomDomainList
  • func (in *CustomDomainList) DeepCopyInto(out *CustomDomainList)
  • func (in *CustomDomainList) DeepCopyObject() runtime.Object
• type CustomDomainSpec
  • func (in *CustomDomainSpec) DeepCopy() *CustomDomainSpec
  • func (in *CustomDomainSpec) DeepCopyInto(out *CustomDomainSpec)
• type CustomDomainStateType
• type CustomDomainStatus
  • func (in *CustomDomainStatus) DeepCopy() *CustomDomainStatus
  • func (in *CustomDomainStatus) DeepCopyInto(out *CustomDomainStatus)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "managed.openshift.io", Version: "v1alpha1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Functions

func GetOpenAPIDefinitions

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

Types

type CustomDomain

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

	Spec   CustomDomainSpec   `json:"spec,omitempty"`
	Status CustomDomainStatus `json:"status,omitempty"`
}

CustomDomain is the Schema for the customdomains API +kubebuilder:subresource:status +kubebuilder:printcolumn:name="Endpoint",type=string,JSONPath=`.status.endpoint` +kubebuilder:printcolumn:name="Domain",type=string,JSONPath=`.spec.domain` +kubebuilder:printcolumn:name="Status",type=string,JSONPath=`.status.state` +kubebuilder:resource:path=customdomains,scope=Cluster

func (*CustomDomain) DeepCopy

func (in *CustomDomain) DeepCopy() *CustomDomain

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

func (*CustomDomain) DeepCopyInto

func (in *CustomDomain) DeepCopyInto(out *CustomDomain)

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

func (*CustomDomain) DeepCopyObject

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

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

type CustomDomainCondition

type CustomDomainCondition struct {
	// Type is the type of the condition.
	Type CustomDomainConditionType `json:"type,omitempty"`
	// Status is the status of the condition
	Status corev1.ConditionStatus `json:"status,omitempty"`
	// LastProbeTime is the last time we probed the condition.
	// +optional
	LastProbeTime metav1.Time `json:"lastProbeTime,omitempty"`
	// LastTransitionTime is the laste time the condition transitioned from one status to another.
	// +optional
	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`
	// Reason is a unique, one-word, CamelCase reason for the condition's last transition.
	// +optional
	Reason string `json:"reason,omitempty"`
	// Message is a human-readable message indicating details about last transition.
	// +optional
	Message string `json:"message,omitempty"`
}

CustomDomainCondition contains details for the current condition of a custom domain

func (*CustomDomainCondition) DeepCopy

func (in *CustomDomainCondition) DeepCopy() *CustomDomainCondition

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

func (*CustomDomainCondition) DeepCopyInto

func (in *CustomDomainCondition) DeepCopyInto(out *CustomDomainCondition)

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

type CustomDomainConditionType

type CustomDomainConditionType string

CustomDomainConditionType is a valid value for CustomDomainCondition.Type

const (
	// CustomDomainConditionCreating is set when a CustomDomain is being created
	CustomDomainConditionCreating CustomDomainConditionType = "Creating"

	// CustomDomainConditionDeprecated is set when a CustomDomain has returned to native ingress controller
	CustomDomainConditionDeprecated CustomDomainConditionType = "Deprecated"

	// CustomDomainConditionSecretNotFound is set when the TLS secret has not been found yet
	CustomDomainConditionSecretNotFound CustomDomainConditionType = "SecretNotFound"

	// CustomDomainConditionInvalidName is set when the CR name is invalid (eg. "default", "apps2")
	CustomDomainConditionInvalidName CustomDomainConditionType = "InvalidName"

	// CustomDomainConditionInvalidScope is set when the loadbalancer scope is modified
	CustomDomainConditionInvalidScope CustomDomainConditionType = "InvalidScope"

	// CustomDomainConditionFailed is set when custom domain creation has failed
	CustomDomainConditionFailed CustomDomainConditionType = "Failed"

	// CustomDomainConditionReady is set when a CustomDomain creation is ready
	CustomDomainConditionReady CustomDomainConditionType = "Ready"
)

type CustomDomainList

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

CustomDomainList contains a list of CustomDomain

func (*CustomDomainList) DeepCopy

func (in *CustomDomainList) DeepCopy() *CustomDomainList

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

func (*CustomDomainList) DeepCopyInto

func (in *CustomDomainList) DeepCopyInto(out *CustomDomainList)

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

func (*CustomDomainList) DeepCopyObject

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

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

type CustomDomainSpec

type CustomDomainSpec struct {

	// This field can be used to define the custom domain
	Domain string `json:"domain"`

	// Certificate points to the custom TLS secret
	Certificate corev1.SecretReference `json:"certificate"`

	// This field determines whether the CustomDomain ingress is internal or external. Defaults to External if empty.
	//
	// +kubebuilder:validation:Enum=External;Internal
	// +kubebuilder:default:="External"
	// +optional
	Scope string `json:"scope,omitempty"`

	// This field is used to filter the set of namespaces serviced by the
	// CustomDomain ingress. This is useful for implementing shards.
	//
	// If unset, the default is no filtering.
	//
	// +optional
	NamespaceSelector *metav1.LabelSelector `json:"namespaceSelector,omitempty"`

	// This field is used to filter the set of Routes serviced by the ingress
	// controller. This is useful for implementing shards.
	//
	// If unset, the default is no filtering.
	//
	// +optional
	RouteSelector *metav1.LabelSelector `json:"routeSelector,omitempty"`

	// This field is used to specify the type of AWS load balancer.
	//
	// Valid values are:
	//
	// * "Classic": A Classic Load Balancer that makes routing decisions at either the transport layer (TCP/SSL) or the application layer (HTTP/HTTPS). See the following for additional details: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/load-balancer-types.html#clb
	//
	// * "NLB": A Network Load Balancer that makes routing decisions at the transport layer (TCP/SSL). See the following for additional details: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/load-balancer-types.html#nlb
	//
	// +kubebuilder:validation:Enum=Classic;NLB
	// +kubebuilder:default:="Classic"
	// +optional
	LoadBalancerType operatorv1.AWSLoadBalancerType `json:"loadBalancerType,omitempty"`
}

CustomDomainSpec defines the desired state of CustomDomain

func (*CustomDomainSpec) DeepCopy

func (in *CustomDomainSpec) DeepCopy() *CustomDomainSpec

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

func (*CustomDomainSpec) DeepCopyInto

func (in *CustomDomainSpec) DeepCopyInto(out *CustomDomainSpec)

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

type CustomDomainStateType

type CustomDomainStateType string

CustomDomainStateType is a valid value for CustomDomainStatus.State

const (
	// CustomDomainStateNotReady is set when custom domain is not ready
	CustomDomainStateNotReady CustomDomainStateType = "NotReady"

	// CustomDomainStateReady is set when a custom domain is ready
	CustomDomainStateReady CustomDomainStateType = "Ready"
)

type CustomDomainStatus

type CustomDomainStatus struct {

	// The various conditions for the custom domain
	Conditions []CustomDomainCondition `json:"conditions"`

	// The overall state of the custom domain
	State CustomDomainStateType `json:"state,omitempty"`

	// The DNS record added for the ingress controller
	DNSRecord string `json:"dnsRecord"`

	// The endpoint is a resolvable DNS address for external DNS to point to
	Endpoint string `json:"endpoint"`

	// The scope dictates whether the ingress controller is internal or external
	// +optional
	Scope string `json:"scope"`
}

CustomDomainStatus defines the observed state of CustomDomain

func (*CustomDomainStatus) DeepCopy

func (in *CustomDomainStatus) DeepCopy() *CustomDomainStatus

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

func (*CustomDomainStatus) DeepCopyInto

func (in *CustomDomainStatus) DeepCopyInto(out *CustomDomainStatus)

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