v1alpha1

Documentation

Overview

Package v1alpha1 is the v1alpha1 version of the API. +kubebuilder:object:generate=true +groupName=operator.h3poteto.dev

Index

• Variables
• func Resource(resource string) schema.GroupResource
• type FluentBitSpec
  • func (in *FluentBitSpec) DeepCopy() *FluentBitSpec
  • func (in *FluentBitSpec) DeepCopyInto(out *FluentBitSpec)
• type FluentDSpec
  • func (in *FluentDSpec) DeepCopy() *FluentDSpec
  • func (in *FluentDSpec) DeepCopyInto(out *FluentDSpec)
• type SidecarInjector
  • func (in *SidecarInjector) DeepCopy() *SidecarInjector
  • func (in *SidecarInjector) DeepCopyInto(out *SidecarInjector)
  • func (in *SidecarInjector) DeepCopyObject() runtime.Object
• type SidecarInjectorList
  • func (in *SidecarInjectorList) DeepCopy() *SidecarInjectorList
  • func (in *SidecarInjectorList) DeepCopyInto(out *SidecarInjectorList)
  • func (in *SidecarInjectorList) DeepCopyObject() runtime.Object
• type SidecarInjectorSpec
  • func (in *SidecarInjectorSpec) DeepCopy() *SidecarInjectorSpec
  • func (in *SidecarInjectorSpec) DeepCopyInto(out *SidecarInjectorSpec)
• type SidecarInjectorStatus
  • func (in *SidecarInjectorStatus) DeepCopy() *SidecarInjectorStatus
  • func (in *SidecarInjectorStatus) DeepCopyInto(out *SidecarInjectorStatus)

Variables

var (
	// TODO: move SchemeBuilder with zz_generated.deepcopy.go to k8s.io/api.
	// localSchemeBuilder and AddToScheme will stay in k8s.io/kubernetes.
	SchemeBuilder runtime.SchemeBuilder

	AddToScheme = localSchemeBuilder.AddToScheme
)

var SchemeGroupVersion = schema.GroupVersion{Group: "operator.h3poteto.dev", Version: "v1alpha1"}

Functions

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type FluentBitSpec

type FluentBitSpec struct {
	// +optional
	// Docker image name which you want to inject to your pods as sidecars. For example, ghcr.io/h3poteto/fluentbit-forward:latest
	DockerImage string `json:"dockerImage"`
	// +optional
	// A FluentD hostname as a aggregator. Injected fluent-bit pods will send logs to this endpoint.
	AggregatorHost string `json:"aggregatorHost"`
	// +optional
	// A FluentD port number as a aggregator.
	AggregatorPort int32 `json:"aggregatorPort"`
	// +optional
	// Lod directory path in your pods. SidecarInjector will mount a volume in this directory, and share it with injected fluent-bit pod. So fluent-bit pod can read application logs in this volume.
	ApplicationLogDir string `json:"applicationLogDir"`
	// +optional
	// This tag is prefix of received log's tag. Injected fluent-bit will add this prefix for all log's tag.
	TagPrefix string `json:"tagPrefix"`
	// +optional
	// Additional environment variables for SidecarInjector
	CustomEnv string `json:"customEnv"`
}

FluentBitSpec describe fluent-bit options for SidecarInjector.

func (*FluentBitSpec) DeepCopy

func (in *FluentBitSpec) DeepCopy() *FluentBitSpec

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

func (*FluentBitSpec) DeepCopyInto

func (in *FluentBitSpec) DeepCopyInto(out *FluentBitSpec)

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

type FluentDSpec

type FluentDSpec struct {
	// +optional
	// Docker image name which you want to inject to your pods as sidecars. For example, ghcr.io/h3poteto/fluentd-forward:latest
	DockerImage string `json:"dockerImage"`
	// +optional
	// A FluentD hostname as a aggregator. Injected fluentd pods will send logs to this endpoint.
	AggregatorHost string `json:"aggregatorHost"`
	// +optional
	// A FluentD port number as a aggregator.
	AggregatorPort int32 `json:"aggregatorPort"`
	// +optional
	// Lod directory path in your pods. SidecarInjector will mount a volume in this directory, and share it with injected fluentd pod. So fluentd pod can read application logs in this volume.
	ApplicationLogDir string `json:"applicationLogDir"`
	// +optional
	// This tag is prefix of received log's tag. Injected fluentd will add this prefix for all log's tag.
	TagPrefix string `json:"tagPrefix"`
	// +optional
	// A option for fluentd configuration, time_key.
	TimeKey string `json:"timeKey"`
	// +optional
	// A option for fluentd configuration, time_format.
	TimeFormat string `json:"timeFormat"`
	// +optional
	// Additional environment variables for SidecarInjector
	CustomEnv string `json:"customEnv"`
}

FluentDSpec describe fluentd options for SidcarInjector.

func (*FluentDSpec) DeepCopy

func (in *FluentDSpec) DeepCopy() *FluentDSpec

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

func (*FluentDSpec) DeepCopyInto

func (in *FluentDSpec) DeepCopyInto(out *FluentDSpec)

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

type SidecarInjector

type SidecarInjector struct {
	metav1.TypeMeta `json:",inline"`
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              SidecarInjectorSpec   `json:"spec"`
	Status            SidecarInjectorStatus `json:"status,omitempty"`
}

SidecarInjector is a top-level type. A client is created for it.

func (*SidecarInjector) DeepCopy

func (in *SidecarInjector) DeepCopy() *SidecarInjector

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

func (*SidecarInjector) DeepCopyInto

func (in *SidecarInjector) DeepCopyInto(out *SidecarInjector)

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

func (*SidecarInjector) DeepCopyObject

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

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

type SidecarInjectorList

type SidecarInjectorList struct {
	metav1.TypeMeta `json:",inline"`
	// +optional
	metav1.ListMeta `json:"metadata,omitempty"`

	Items []SidecarInjector `json:"items"`
}

SidecarInjectorList

func (*SidecarInjectorList) DeepCopy

func (in *SidecarInjectorList) DeepCopy() *SidecarInjectorList

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

func (*SidecarInjectorList) DeepCopyInto

func (in *SidecarInjectorList) DeepCopyInto(out *SidecarInjectorList)

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

func (*SidecarInjectorList) DeepCopyObject

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

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

type SidecarInjectorSpec

type SidecarInjectorSpec struct {
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:Type:=string
	// +kubebuilder:default=fluentd
	// +kubebuilder:validation:Enum=fluentd;fluent-bit
	// Default collector name which you want to inject. The name must be fluentd or fluent-bit. Default is fluentd.
	Collector string `json:"collector"`
	// +optional
	// +nullable
	// Please specify this argument when you specify fluentd as collector.
	FluentD *FluentDSpec `json:"fluentd"`
	// +optional
	// +nullable
	// Please specify this argument when you specify fluent-bit as collector
	FluentBit *FluentBitSpec `json:"fluentbit"`
}

SidecarInjectorSpec defines the desired state of SidecarInjector

func (*SidecarInjectorSpec) DeepCopy

func (in *SidecarInjectorSpec) DeepCopy() *SidecarInjectorSpec

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

func (*SidecarInjectorSpec) DeepCopyInto

func (in *SidecarInjectorSpec) DeepCopyInto(out *SidecarInjectorSpec)

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

type SidecarInjectorStatus

type SidecarInjectorStatus struct {
	InjectorDeploymentName string `json:"injectorDeploymentName"`
	// Available pods count under the deployment of SidecarInjector.
	InjectorPodCount int32 `json:"injectorPodCount"`
	// Whether the webhook service is available.
	InjectorServiceReady bool `json:"injectorServiceReady"`
}

SdecarInjectorStatus defines the observed state of SidecarInjector

func (*SidecarInjectorStatus) DeepCopy

func (in *SidecarInjectorStatus) DeepCopy() *SidecarInjectorStatus

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

func (*SidecarInjectorStatus) DeepCopyInto

func (in *SidecarInjectorStatus) DeepCopyInto(out *SidecarInjectorStatus)

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