Documentation
¶
Overview ¶
+groupName=network.openshift.io
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( GroupName = "network.openshift.io" GroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1alpha1"} // Install is a function which adds this version to a scheme Install = schemeBuilder.AddToScheme // SchemeGroupVersion generated code relies on this name // Deprecated SchemeGroupVersion = GroupVersion // AddToScheme exists solely to keep the old generators creating valid code // DEPRECATED AddToScheme = schemeBuilder.AddToScheme )
Functions ¶
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource generated code relies on this being here, but it logically belongs to the group DEPRECATED
Types ¶
type DNSName ¶
type DNSName string
DNSName is used for validation of a DNS name. +kubebuilder:validation:Pattern=`^(\*\.)?([a-z0-9]([-a-z0-9]{0,61}[a-z0-9])?\.){2,}$` +kubebuilder:validation:MaxLength=254
type DNSNameResolver ¶
type DNSNameResolver struct { metav1.TypeMeta `json:",inline"` // metadata is the standard object's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty"` // spec is the specification of the desired behavior of the DNSNameResolver. // +required Spec DNSNameResolverSpec `json:"spec"` // status is the most recently observed status of the DNSNameResolver. // +optional Status DNSNameResolverStatus `json:"status,omitempty"` }
DNSNameResolver stores the DNS name resolution information of a DNS name. It can be enabled by the TechPreviewNoUpgrade feature set. It can also be enabled by the feature gate DNSNameResolver when using CustomNoUpgrade feature set.
Compatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.
func (*DNSNameResolver) DeepCopy ¶
func (in *DNSNameResolver) DeepCopy() *DNSNameResolver
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DNSNameResolver.
func (*DNSNameResolver) DeepCopyInto ¶
func (in *DNSNameResolver) DeepCopyInto(out *DNSNameResolver)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*DNSNameResolver) DeepCopyObject ¶
func (in *DNSNameResolver) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (DNSNameResolver) SwaggerDoc ¶
func (DNSNameResolver) SwaggerDoc() map[string]string
type DNSNameResolverList ¶
type DNSNameResolverList struct { metav1.TypeMeta `json:",inline"` // metadata is the standard list's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ListMeta `json:"metadata,omitempty"` // items gives the list of DNSNameResolvers. Items []DNSNameResolver `json:"items"` }
DNSNameResolverList contains a list of DNSNameResolvers.
Compatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.
func (*DNSNameResolverList) DeepCopy ¶
func (in *DNSNameResolverList) DeepCopy() *DNSNameResolverList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DNSNameResolverList.
func (*DNSNameResolverList) DeepCopyInto ¶
func (in *DNSNameResolverList) DeepCopyInto(out *DNSNameResolverList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*DNSNameResolverList) DeepCopyObject ¶
func (in *DNSNameResolverList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (DNSNameResolverList) SwaggerDoc ¶
func (DNSNameResolverList) SwaggerDoc() map[string]string
type DNSNameResolverResolvedAddress ¶
type DNSNameResolverResolvedAddress struct { // ip is an IP address associated with the dnsName. The validity of the IP address expires after // lastLookupTime + ttlSeconds. To refresh the information, a DNS lookup will be performed upon // the expiration of the IP address's validity. If the information is not refreshed then it will // be removed with a grace period after the expiration of the IP address's validity. // +required IP string `json:"ip"` // ttlSeconds is the time-to-live value of the IP address. The validity of the IP address expires after // lastLookupTime + ttlSeconds. On a successful DNS lookup the value of this field will be updated with // the current time-to-live value. If the information is not refreshed then it will be removed with a // grace period after the expiration of the IP address's validity. // +required TTLSeconds int32 `json:"ttlSeconds"` // lastLookupTime is the timestamp when the last DNS lookup was completed successfully. The validity of // the IP address expires after lastLookupTime + ttlSeconds. The value of this field will be updated to // the current time on a successful DNS lookup. If the information is not refreshed then it will be // removed with a grace period after the expiration of the IP address's validity. // +required LastLookupTime *metav1.Time `json:"lastLookupTime"` }
DNSNameResolverResolvedAddress describes the details of an IP address for a resolved DNS name.
func (*DNSNameResolverResolvedAddress) DeepCopy ¶
func (in *DNSNameResolverResolvedAddress) DeepCopy() *DNSNameResolverResolvedAddress
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DNSNameResolverResolvedAddress.
func (*DNSNameResolverResolvedAddress) DeepCopyInto ¶
func (in *DNSNameResolverResolvedAddress) DeepCopyInto(out *DNSNameResolverResolvedAddress)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (DNSNameResolverResolvedAddress) SwaggerDoc ¶
func (DNSNameResolverResolvedAddress) SwaggerDoc() map[string]string
type DNSNameResolverResolvedName ¶
type DNSNameResolverResolvedName struct { // conditions provide information about the state of the DNS name. // Known .status.conditions.type is: "Degraded". // "Degraded" is true when the last resolution failed for the DNS name, // and false otherwise. // +optional // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:"conditions,omitempty"` // dnsName is the resolved DNS name matching the name field of DNSNameResolverSpec. This field can // store both regular and wildcard DNS names which match the spec.name field. When the spec.name // field contains a regular DNS name, this field will store the same regular DNS name after it is // successfully resolved. When the spec.name field contains a wildcard DNS name, each resolvedName.dnsName // will store the regular DNS names which match the wildcard DNS name and have been successfully resolved. // If the wildcard DNS name can also be successfully resolved, then this field will store the wildcard // DNS name as well. // +required DNSName DNSName `json:"dnsName"` // resolvedAddresses gives the list of associated IP addresses and their corresponding TTLs and last // lookup times for the dnsName. // +required // +listType=map // +listMapKey=ip ResolvedAddresses []DNSNameResolverResolvedAddress `json:"resolvedAddresses"` // resolutionFailures keeps the count of how many consecutive times the DNS resolution failed // for the dnsName. If the DNS resolution succeeds then the field will be set to zero. Upon // every failure, the value of the field will be incremented by one. The details about the DNS // name will be removed, if the value of resolutionFailures reaches 5 and the TTL of all the // associated IP addresses have expired. ResolutionFailures int32 `json:"resolutionFailures,omitempty"` }
DNSNameResolverResolvedName describes the details of a resolved DNS name.
func (*DNSNameResolverResolvedName) DeepCopy ¶
func (in *DNSNameResolverResolvedName) DeepCopy() *DNSNameResolverResolvedName
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DNSNameResolverResolvedName.
func (*DNSNameResolverResolvedName) DeepCopyInto ¶
func (in *DNSNameResolverResolvedName) DeepCopyInto(out *DNSNameResolverResolvedName)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (DNSNameResolverResolvedName) SwaggerDoc ¶
func (DNSNameResolverResolvedName) SwaggerDoc() map[string]string
type DNSNameResolverSpec ¶
type DNSNameResolverSpec struct { // name is the DNS name for which the DNS name resolution information will be stored. // For a regular DNS name, only the DNS name resolution information of the regular DNS // name will be stored. For a wildcard DNS name, the DNS name resolution information // of all the DNS names that match the wildcard DNS name will be stored. // For a wildcard DNS name, the '*' will match only one label. Additionally, only a single // '*' can be used at the beginning of the wildcard DNS name. For example, '*.example.com.' // will match 'sub1.example.com.' but won't match 'sub2.sub1.example.com.' // +required // +kubebuilder:validation:XValidation:rule="self == oldSelf",message="spec.name is immutable" Name DNSName `json:"name"` }
DNSNameResolverSpec is a desired state description of DNSNameResolver.
func (*DNSNameResolverSpec) DeepCopy ¶
func (in *DNSNameResolverSpec) DeepCopy() *DNSNameResolverSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DNSNameResolverSpec.
func (*DNSNameResolverSpec) DeepCopyInto ¶
func (in *DNSNameResolverSpec) DeepCopyInto(out *DNSNameResolverSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (DNSNameResolverSpec) SwaggerDoc ¶
func (DNSNameResolverSpec) SwaggerDoc() map[string]string
type DNSNameResolverStatus ¶
type DNSNameResolverStatus struct { // resolvedNames contains a list of matching DNS names and their corresponding IP addresses // along with their TTL and last DNS lookup times. // +listType=map // +listMapKey=dnsName // +patchMergeKey=dnsName // +patchStrategy=merge // +optional ResolvedNames []DNSNameResolverResolvedName `json:"resolvedNames,omitempty" patchStrategy:"merge" patchMergeKey:"dnsName"` }
DNSNameResolverStatus defines the observed status of DNSNameResolver.
func (*DNSNameResolverStatus) DeepCopy ¶
func (in *DNSNameResolverStatus) DeepCopy() *DNSNameResolverStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DNSNameResolverStatus.
func (*DNSNameResolverStatus) DeepCopyInto ¶
func (in *DNSNameResolverStatus) DeepCopyInto(out *DNSNameResolverStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (DNSNameResolverStatus) SwaggerDoc ¶
func (DNSNameResolverStatus) SwaggerDoc() map[string]string