...

Package v1alpha1

import "github.com/openshift/api/operatorcontrolplane/v1alpha1"
Overview
Index

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
    func (in *LogEntry) DeepCopy() *LogEntry
    func (in *LogEntry) DeepCopyInto(out *LogEntry)
    func (LogEntry) SwaggerDoc() map[string]string
type OutageEntry
    func (in *OutageEntry) DeepCopy() *OutageEntry
    func (in *OutageEntry) DeepCopyInto(out *OutageEntry)
    func (OutageEntry) SwaggerDoc() map[string]string
type PodNetworkConnectivityCheck
    func (in *PodNetworkConnectivityCheck) DeepCopy() *PodNetworkConnectivityCheck
    func (in *PodNetworkConnectivityCheck) DeepCopyInto(out *PodNetworkConnectivityCheck)
    func (in *PodNetworkConnectivityCheck) DeepCopyObject() runtime.Object
    func (PodNetworkConnectivityCheck) SwaggerDoc() map[string]string
type PodNetworkConnectivityCheckCondition
    func (in *PodNetworkConnectivityCheckCondition) DeepCopy() *PodNetworkConnectivityCheckCondition
    func (in *PodNetworkConnectivityCheckCondition) DeepCopyInto(out *PodNetworkConnectivityCheckCondition)
    func (PodNetworkConnectivityCheckCondition) SwaggerDoc() map[string]string
type PodNetworkConnectivityCheckConditionType
type PodNetworkConnectivityCheckList
    func (in *PodNetworkConnectivityCheckList) DeepCopy() *PodNetworkConnectivityCheckList
    func (in *PodNetworkConnectivityCheckList) DeepCopyInto(out *PodNetworkConnectivityCheckList)
    func (in *PodNetworkConnectivityCheckList) DeepCopyObject() runtime.Object
    func (PodNetworkConnectivityCheckList) SwaggerDoc() map[string]string
type PodNetworkConnectivityCheckSpec
    func (in *PodNetworkConnectivityCheckSpec) DeepCopy() *PodNetworkConnectivityCheckSpec
    func (in *PodNetworkConnectivityCheckSpec) DeepCopyInto(out *PodNetworkConnectivityCheckSpec)
    func (PodNetworkConnectivityCheckSpec) SwaggerDoc() map[string]string
type PodNetworkConnectivityCheckStatus
    func (in *PodNetworkConnectivityCheckStatus) DeepCopy() *PodNetworkConnectivityCheckStatus
    func (in *PodNetworkConnectivityCheckStatus) DeepCopyInto(out *PodNetworkConnectivityCheckStatus)
    func (PodNetworkConnectivityCheckStatus) SwaggerDoc() map[string]string

Package files

doc.go register.go types_conditioncheck.go zz_generated.deepcopy.go zz_generated.swagger_doc_generated.go

Constants

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

Variables

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
)

func Resource

func Resource(resource string) schema.GroupResource

Resource generated code relies on this being here, but it logically belongs to the group DEPRECATED

type LogEntry

LogEntry records events

type LogEntry struct {
    // Start time of check action.
    // +kubebuilder:validation:Required
    // +required
    // +nullable
    Start metav1.Time `json:"time"`

    // Success indicates if the log entry indicates a success or failure.
    // +kubebuilder:validation:Required
    // +required
    Success bool `json:"success"`

    // Reason for status in a machine readable format.
    // +optional
    Reason string `json:"reason,omitempty"`

    // Message explaining status in a human readable format.
    // +optional
    Message string `json:"message,omitempty"`

    // Latency records how long the action mentioned in the entry took.
    // +optional
    // +nullable
    Latency metav1.Duration `json:"latency,omitempty"`
}

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

OutageEntry records time period of an outage

type OutageEntry struct {

    // Start of outage detected
    // +kubebuilder:validation:Required
    // +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"`
}

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

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

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
    // +kubebuilder:validation:Required
    // +required
    Spec PodNetworkConnectivityCheckSpec `json:"spec"`

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

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

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

type PodNetworkConnectivityCheckCondition struct {

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

    // Status of the condition
    // +kubebuilder:validation:Required
    // +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.
    // +kubebuilder:validation:Required
    // +required
    // +nullable
    LastTransitionTime metav1.Time `json:"lastTransitionTime"`
}

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

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

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

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:Required
    // +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:Required
    // +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

+k8s:deepcopy-gen=true

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

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