v1alpha1

package

v0.0.0-...-b88d067 Latest Latest Go to latest Published: Dec 19, 2024 License: Apache-2.0 Imports: 4 Imported by: 25

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/openshift/api

Documentation ¶

Overview ¶

Package v1alpha1 is an API version in the controlplane.operator.openshift.io group

Index ¶

Constants
Variables
func Resource(resource string) schema.GroupResource
type LogEntry
type OutageEntry
type PodNetworkConnectivityCheck
type PodNetworkConnectivityCheckCondition
type PodNetworkConnectivityCheckConditionType
type PodNetworkConnectivityCheckList
type PodNetworkConnectivityCheckSpec
type PodNetworkConnectivityCheckStatus

Constants ¶

View Source

const (
	LogEntryReasonDNSResolve      = "DNSResolve"
	LogEntryReasonDNSError        = "DNSError"
	LogEntryReasonTCPConnect      = "TCPConnect"
	LogEntryReasonTCPConnectError = "TCPConnectError"
)

Variables ¶

View Source

var (
	GroupName    = "controlplane.operator.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 ¶

func (*LogEntry) DeepCopy ¶

func (in *LogEntry) DeepCopy() *LogEntry

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

func (*LogEntry) DeepCopyInto ¶

func (in *LogEntry) DeepCopyInto(out *LogEntry)

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

func (LogEntry) SwaggerDoc ¶

func (LogEntry) SwaggerDoc() map[string]string

type OutageEntry ¶

type OutageEntry struct {

	// start of outage detected
	// +required
	// +nullable
	Start metav1.Time `json:"start"`

	// end of outage detected
	// +optional
	// +nullable
	End metav1.Time `json:"end,omitempty"`

	// startLogs contains log entries related to the start of this outage. Should contain
	// the original failure, any entries where the failure mode changed.
	// +optional
	StartLogs []LogEntry `json:"startLogs,omitempty"`

	// endLogs contains log entries related to the end of this outage. Should contain the success
	// entry that resolved the outage and possibly a few of the failure log entries that preceded it.
	// +optional
	EndLogs []LogEntry `json:"endLogs,omitempty"`

	// message summarizes outage details in a human readable format.
	// +optional
	Message string `json:"message,omitempty"`
}

OutageEntry records time period of an outage

func (*OutageEntry) DeepCopy ¶

func (in *OutageEntry) DeepCopy() *OutageEntry

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

func (*OutageEntry) DeepCopyInto ¶

func (in *OutageEntry) DeepCopyInto(out *OutageEntry)

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

func (OutageEntry) SwaggerDoc ¶

func (OutageEntry) SwaggerDoc() map[string]string

type PodNetworkConnectivityCheck ¶

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

	// spec defines the source and target of the connectivity check
	// +required
	Spec PodNetworkConnectivityCheckSpec `json:"spec"`

	// status contains the observed status of the connectivity check
	// +optional
	Status PodNetworkConnectivityCheckStatus `json:"status,omitempty"`
}

PodNetworkConnectivityCheck

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. +kubebuilder:object:root=true +kubebuilder:resource:path=podnetworkconnectivitychecks,scope=Namespaced +kubebuilder:subresource:status +openshift:api-approved.openshift.io=https://github.com/openshift/api/pull/639 +openshift:file-pattern=cvoRunLevel=0000_10,operatorName=network,operatorOrdering=01 +kubebuilder:metadata:annotations=include.release.openshift.io/self-managed-high-availability=true +openshift:compatibility-gen:level=4

func (*PodNetworkConnectivityCheck) DeepCopy ¶

func (in *PodNetworkConnectivityCheck) DeepCopy() *PodNetworkConnectivityCheck

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

func (*PodNetworkConnectivityCheck) DeepCopyInto ¶

func (in *PodNetworkConnectivityCheck) DeepCopyInto(out *PodNetworkConnectivityCheck)

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

func (*PodNetworkConnectivityCheck) DeepCopyObject ¶

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

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

func (PodNetworkConnectivityCheck) SwaggerDoc ¶

func (PodNetworkConnectivityCheck) SwaggerDoc() map[string]string

type PodNetworkConnectivityCheckCondition ¶

type PodNetworkConnectivityCheckCondition struct {

	// type of the condition
	// +required
	Type PodNetworkConnectivityCheckConditionType `json:"type"`

	// status of the condition
	// +required
	Status metav1.ConditionStatus `json:"status"`

	// reason for the condition's last status transition in a machine readable format.
	// +optional
	Reason string `json:"reason,omitempty"`

	// message indicating details about last transition in a human readable format.
	// +optional
	Message string `json:"message,omitempty"`

	// Last time the condition transitioned from one status to another.
	// +required
	// +nullable
	LastTransitionTime metav1.Time `json:"lastTransitionTime"`
}

PodNetworkConnectivityCheckCondition represents the overall status of the pod network connectivity. +k8s:deepcopy-gen=true

func (*PodNetworkConnectivityCheckCondition) DeepCopy ¶

func (in *PodNetworkConnectivityCheckCondition) DeepCopy() *PodNetworkConnectivityCheckCondition

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

func (*PodNetworkConnectivityCheckCondition) DeepCopyInto ¶

func (in *PodNetworkConnectivityCheckCondition) DeepCopyInto(out *PodNetworkConnectivityCheckCondition)

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

func (PodNetworkConnectivityCheckCondition) SwaggerDoc ¶

func (PodNetworkConnectivityCheckCondition) SwaggerDoc() map[string]string

type PodNetworkConnectivityCheckConditionType ¶

type PodNetworkConnectivityCheckConditionType string

const (
	// Reachable indicates that the endpoint was reachable from the pod.
	Reachable PodNetworkConnectivityCheckConditionType = "Reachable"
)

type PodNetworkConnectivityCheckList ¶

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

	// items contains the items
	Items []PodNetworkConnectivityCheck `json:"items"`
}

PodNetworkConnectivityCheckList is a collection of PodNetworkConnectivityCheck

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. +openshift:compatibility-gen:level=4

func (*PodNetworkConnectivityCheckList) DeepCopy ¶

func (in *PodNetworkConnectivityCheckList) DeepCopy() *PodNetworkConnectivityCheckList

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

func (*PodNetworkConnectivityCheckList) DeepCopyInto ¶

func (in *PodNetworkConnectivityCheckList) DeepCopyInto(out *PodNetworkConnectivityCheckList)

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

func (*PodNetworkConnectivityCheckList) DeepCopyObject ¶

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

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

func (PodNetworkConnectivityCheckList) SwaggerDoc ¶

func (PodNetworkConnectivityCheckList) SwaggerDoc() map[string]string

type PodNetworkConnectivityCheckSpec ¶

type PodNetworkConnectivityCheckSpec struct {
	// sourcePod names the pod from which the condition will be checked
	// +kubebuilder:validation:Pattern=`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`
	// +required
	SourcePod string `json:"sourcePod"`

	// EndpointAddress to check. A TCP address of the form host:port. Note that
	// if host is a DNS name, then the check would fail if the DNS name cannot
	// be resolved. Specify an IP address for host to bypass DNS name lookup.
	// +kubebuilder:validation:Pattern=`^\S+:\d*$`
	// +required
	TargetEndpoint string `json:"targetEndpoint"`

	// TLSClientCert, if specified, references a kubernetes.io/tls type secret with 'tls.crt' and
	// 'tls.key' entries containing an optional TLS client certificate and key to be used when
	// checking endpoints that require a client certificate in order to gracefully preform the
	// scan without causing excessive logging in the endpoint process. The secret must exist in
	// the same namespace as this resource.
	// +optional
	TLSClientCert v1.SecretNameReference `json:"tlsClientCert,omitempty"`
}

func (*PodNetworkConnectivityCheckSpec) DeepCopy ¶

func (in *PodNetworkConnectivityCheckSpec) DeepCopy() *PodNetworkConnectivityCheckSpec

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

func (*PodNetworkConnectivityCheckSpec) DeepCopyInto ¶

func (in *PodNetworkConnectivityCheckSpec) DeepCopyInto(out *PodNetworkConnectivityCheckSpec)

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

func (PodNetworkConnectivityCheckSpec) SwaggerDoc ¶

func (PodNetworkConnectivityCheckSpec) SwaggerDoc() map[string]string

type PodNetworkConnectivityCheckStatus ¶

type PodNetworkConnectivityCheckStatus struct {
	// successes contains logs successful check actions
	// +optional
	Successes []LogEntry `json:"successes,omitempty"`

	// failures contains logs of unsuccessful check actions
	// +optional
	Failures []LogEntry `json:"failures,omitempty"`

	// outages contains logs of time periods of outages
	// +optional
	Outages []OutageEntry `json:"outages,omitempty"`

	// conditions summarize the status of the check
	// +patchMergeKey=type
	// +patchStrategy=merge
	// +optional
	Conditions []PodNetworkConnectivityCheckCondition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"`
}

+k8s:deepcopy-gen=true

func (*PodNetworkConnectivityCheckStatus) DeepCopy ¶

func (in *PodNetworkConnectivityCheckStatus) DeepCopy() *PodNetworkConnectivityCheckStatus

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

func (*PodNetworkConnectivityCheckStatus) DeepCopyInto ¶

func (in *PodNetworkConnectivityCheckStatus) DeepCopyInto(out *PodNetworkConnectivityCheckStatus)

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

func (PodNetworkConnectivityCheckStatus) SwaggerDoc ¶

func (PodNetworkConnectivityCheckStatus) SwaggerDoc() map[string]string

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
zz_generated.crd-manifests

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

Documentation ¶

Overview ¶

Index ¶

Constants ¶

Variables ¶

Functions ¶

func Resource ¶

Types ¶

type LogEntry ¶

func (*LogEntry) DeepCopy ¶

func (*LogEntry) DeepCopyInto ¶

func (LogEntry) SwaggerDoc ¶

type OutageEntry ¶

func (*OutageEntry) DeepCopy ¶

func (*OutageEntry) DeepCopyInto ¶

func (OutageEntry) SwaggerDoc ¶

type PodNetworkConnectivityCheck ¶

func (*PodNetworkConnectivityCheck) DeepCopy ¶

func (*PodNetworkConnectivityCheck) DeepCopyInto ¶

func (*PodNetworkConnectivityCheck) DeepCopyObject ¶

func (PodNetworkConnectivityCheck) SwaggerDoc ¶

type PodNetworkConnectivityCheckCondition ¶

func (*PodNetworkConnectivityCheckCondition) DeepCopy ¶

func (*PodNetworkConnectivityCheckCondition) DeepCopyInto ¶

func (PodNetworkConnectivityCheckCondition) SwaggerDoc ¶

type PodNetworkConnectivityCheckConditionType ¶

type PodNetworkConnectivityCheckList ¶

func (*PodNetworkConnectivityCheckList) DeepCopy ¶

func (*PodNetworkConnectivityCheckList) DeepCopyInto ¶

func (*PodNetworkConnectivityCheckList) DeepCopyObject ¶

func (PodNetworkConnectivityCheckList) SwaggerDoc ¶

type PodNetworkConnectivityCheckSpec ¶

func (*PodNetworkConnectivityCheckSpec) DeepCopy ¶

func (*PodNetworkConnectivityCheckSpec) DeepCopyInto ¶

func (PodNetworkConnectivityCheckSpec) SwaggerDoc ¶

type PodNetworkConnectivityCheckStatus ¶

func (*PodNetworkConnectivityCheckStatus) DeepCopy ¶

func (*PodNetworkConnectivityCheckStatus) DeepCopyInto ¶

func (PodNetworkConnectivityCheckStatus) SwaggerDoc ¶

Source Files ¶

Directories ¶