v1alpha1

Documentation

Overview

package v1alpha1 custom resorces for the cluster logging operator.

NOTE: This API is under construction and subject to change.

NOTE: Doc comments are written using JSON names (lowerCase) rather than Go UpperCase style.

IMPORTANT: Run "make generate" to regenerate code after modifying any files in this package. Add custom validation using kubebuilder tags: https://book.kubebuilder.io/beyond_basics/generating_crd.html

+groupName=logging.openshift.io +k8s:deepcopy-gen=package,register +k8s:openapi-gen=true +kubebuilder:object:generate=true

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

Index

• Constants
• Variables
• type LogFileMetricExporter
  • func (in *LogFileMetricExporter) DeepCopy() *LogFileMetricExporter
  • func (in *LogFileMetricExporter) DeepCopyInto(out *LogFileMetricExporter)
  • func (in *LogFileMetricExporter) DeepCopyObject() runtime.Object
• type LogFileMetricExporterList
  • func (in *LogFileMetricExporterList) DeepCopy() *LogFileMetricExporterList
  • func (in *LogFileMetricExporterList) DeepCopyInto(out *LogFileMetricExporterList)
  • func (in *LogFileMetricExporterList) DeepCopyObject() runtime.Object
• type LogFileMetricExporterSpec
  • func (in *LogFileMetricExporterSpec) DeepCopy() *LogFileMetricExporterSpec
  • func (in *LogFileMetricExporterSpec) DeepCopyInto(out *LogFileMetricExporterSpec)
• type LogFileMetricExporterStatus
  • func (in *LogFileMetricExporterStatus) DeepCopy() *LogFileMetricExporterStatus
  • func (in *LogFileMetricExporterStatus) DeepCopyInto(out *LogFileMetricExporterStatus)

Constants

const (
	// ReasonValid is used as a reason for the condition indicating that the LogFileMetricExporter is deployed.
	ReasonValid string = "Valid"
	// ReasonInvalid is used as a reason for the condition indicating that there was an issue with the LogFileMetricExporter instance.
	ReasonInvalid string = "Invalid"
)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "logging.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
)

Types

type LogFileMetricExporter

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

	Spec   LogFileMetricExporterSpec   `json:"spec,omitempty"`
	Status LogFileMetricExporterStatus `json:"status,omitempty"`
}

+k8s:openapi-gen=true +kubebuilder:subresource:status +kubebuilder:resource:categories=logging,shortName=lfme +kubebuilder:object:root=true A Log File Metric Exporter instance. LogFileMetricExporter is the Schema for the logFileMetricExporters API +operator-sdk:csv:customresourcedefinitions:displayName="Log File Metric Exporter",resources={{Pod,v1}, {Service,v1}, {ServiceMonitor,v1}, {DaemonSet, v1}}

func (*LogFileMetricExporter) DeepCopy

func (in *LogFileMetricExporter) DeepCopy() *LogFileMetricExporter

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

func (*LogFileMetricExporter) DeepCopyInto

func (in *LogFileMetricExporter) DeepCopyInto(out *LogFileMetricExporter)

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

func (*LogFileMetricExporter) DeepCopyObject

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

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

type LogFileMetricExporterList

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

+kubebuilder:object:root=true LogFileMetricExporterList contains a list of LogFileMetricExporter

func (*LogFileMetricExporterList) DeepCopy

func (in *LogFileMetricExporterList) DeepCopy() *LogFileMetricExporterList

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

func (*LogFileMetricExporterList) DeepCopyInto

func (in *LogFileMetricExporterList) DeepCopyInto(out *LogFileMetricExporterList)

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

func (*LogFileMetricExporterList) DeepCopyObject

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

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

type LogFileMetricExporterSpec

type LogFileMetricExporterSpec struct {
	// The resource requirements for the LogFileMetricExporter
	// +nullable
	// +optional
	//+operator-sdk:csv:customresourcedefinitions:type=spec,displayName="LogFileMetricExporter Resource Requirements",xDescriptors={"urn:alm:descriptor:com.tectonic.ui:resourceRequirements"}
	Resources *corev1.ResourceRequirements `json:"resources,omitempty"`

	// Define which Nodes the Pods are scheduled on.
	// +nullable
	// +optional
	//+operator-sdk:csv:customresourcedefinitions:type=spec,displayName="LogFileMetricExporter Node Selector",xDescriptors={"urn:alm:descriptor:com.tectonic.ui:selector:core:v1:ConfigMap"}
	NodeSelector map[string]string `json:"nodeSelector,omitempty"`

	// Define the tolerations the Pods will accept
	// +nullable
	// +optional
	//+operator-sdk:csv:customresourcedefinitions:type=spec,displayName="LogFileMetricExporter Pod Tolerations",xDescriptors={"urn:alm:descriptor:com.tectonic.ui:selector:core:v1:Toleration"}
	Tolerations []corev1.Toleration `json:"tolerations,omitempty"`
}

LogFileMetricExporterSpec defines the desired state of LogFileMetricExporter

func (*LogFileMetricExporterSpec) DeepCopy

func (in *LogFileMetricExporterSpec) DeepCopy() *LogFileMetricExporterSpec

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

func (*LogFileMetricExporterSpec) DeepCopyInto

func (in *LogFileMetricExporterSpec) DeepCopyInto(out *LogFileMetricExporterSpec)

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

type LogFileMetricExporterStatus

type LogFileMetricExporterStatus struct {
	// Conditions of the Log File Metrics Exporter.
	//+operator-sdk:csv:customresourcedefinitions:type=status,displayName="Log File Metrics Exporter Conditions",xDescriptors={"urn:alm:descriptor:com.tectonic.ui:logFileMetricsExporterConditions"}
	Conditions []metav1.Condition `json:"conditions,omitempty"`
}

LogFileMetricExporterStatus defines the observed state of LogFileMetricExporter

func (*LogFileMetricExporterStatus) DeepCopy

func (in *LogFileMetricExporterStatus) DeepCopy() *LogFileMetricExporterStatus

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

func (*LogFileMetricExporterStatus) DeepCopyInto

func (in *LogFileMetricExporterStatus) DeepCopyInto(out *LogFileMetricExporterStatus)

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