v1alpha3

Documentation

Overview

Package v1alpha3 contains API Schema definitions for the core v1alpha3 API group +kubebuilder:object:generate=true +groupName=core.openfeature.dev

Index

• Variables
• type FlagSourceConfiguration
  • func (in *FlagSourceConfiguration) DeepCopy() *FlagSourceConfiguration
  • func (in *FlagSourceConfiguration) DeepCopyInto(out *FlagSourceConfiguration)
  • func (in *FlagSourceConfiguration) DeepCopyObject() runtime.Object
• type FlagSourceConfigurationList
  • func (in *FlagSourceConfigurationList) DeepCopy() *FlagSourceConfigurationList
  • func (in *FlagSourceConfigurationList) DeepCopyInto(out *FlagSourceConfigurationList)
  • func (in *FlagSourceConfigurationList) DeepCopyObject() runtime.Object
• type FlagSourceConfigurationSpec
  • func (in *FlagSourceConfigurationSpec) DeepCopy() *FlagSourceConfigurationSpec
  • func (in *FlagSourceConfigurationSpec) DeepCopyInto(out *FlagSourceConfigurationSpec)
• type FlagSourceConfigurationStatus
  • func (in *FlagSourceConfigurationStatus) DeepCopy() *FlagSourceConfigurationStatus
  • func (in *FlagSourceConfigurationStatus) DeepCopyInto(out *FlagSourceConfigurationStatus)
• type Source
  • func (in *Source) DeepCopy() *Source
  • func (in *Source) DeepCopyInto(out *Source)
• type SyncProviderType

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "core.openfeature.dev", Version: "v1alpha3"}

	// 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 FlagSourceConfiguration

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

	Spec   FlagSourceConfigurationSpec   `json:"spec,omitempty"`
	Status FlagSourceConfigurationStatus `json:"status,omitempty"`
}

FlagSourceConfiguration is the Schema for the FlagSourceConfigurations API

func (*FlagSourceConfiguration) DeepCopy

func (in *FlagSourceConfiguration) DeepCopy() *FlagSourceConfiguration

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

func (*FlagSourceConfiguration) DeepCopyInto

func (in *FlagSourceConfiguration) DeepCopyInto(out *FlagSourceConfiguration)

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

func (*FlagSourceConfiguration) DeepCopyObject

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

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

type FlagSourceConfigurationList

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

FlagSourceConfigurationList contains a list of FlagSourceConfiguration

func (*FlagSourceConfigurationList) DeepCopy

func (in *FlagSourceConfigurationList) DeepCopy() *FlagSourceConfigurationList

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

func (*FlagSourceConfigurationList) DeepCopyInto

func (in *FlagSourceConfigurationList) DeepCopyInto(out *FlagSourceConfigurationList)

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

func (*FlagSourceConfigurationList) DeepCopyObject

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

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

type FlagSourceConfigurationSpec

type FlagSourceConfigurationSpec struct {
	// MetricsPort defines the port to serve metrics on, defaults to 8014
	// +optional
	MetricsPort int32 `json:"metricsPort"`

	// Port defines the port to listen on, defaults to 8013
	// +optional
	Port int32 `json:"port"`

	// SocketPath defines the unix socket path to listen on
	// +optional
	SocketPath string `json:"socketPath"`

	// Evaluator sets an evaluator, defaults to 'json'
	// +optional
	Evaluator string `json:"evaluator"`

	// Image allows for the sidecar image to be overridden, defaults to 'ghcr.io/open-feature/flagd'
	// +optional
	Image string `json:"image"`

	// Tag to be appended to the sidecar image, defaults to 'main'
	// +optional
	Tag string `json:"tag"`

	// SyncProviders define the syncProviders and associated configuration to be applied to the sidecar
	// +kubebuilder:validation:MinItems=1
	Sources []Source `json:"sources"`

	// EnvVars define the env vars to be applied to the sidecar, any env vars in FeatureFlagConfiguration CRs
	// are added at the lowest index, all values will have the EnvVarPrefix applied, default FLAGD
	// +optional
	EnvVars []corev1.EnvVar `json:"envVars"`

	// SyncProviderArgs are string arguments passed to all sync providers, defined as key values separated by =
	// +optional
	SyncProviderArgs []string `json:"syncProviderArgs"`

	// DefaultSyncProvider defines the default sync provider
	// +optional
	DefaultSyncProvider string `json:"defaultSyncProvider"`

	// LogFormat allows for the sidecar log format to be overridden, defaults to 'json'
	// +optional
	LogFormat string `json:"logFormat"`

	// EnvVarPrefix defines the prefix to be applied to all environment variables applied to the sidecar, default FLAGD
	// +optional
	EnvVarPrefix string `json:"envVarPrefix"`

	// RolloutOnChange dictates whether annotated deployments will be restarted when configuration changes are
	// detected in this CR, defaults to false
	// +optional
	RolloutOnChange *bool `json:"rolloutOnChange"`

	// ProbesEnabled defines whether to enable liveness and readiness probes of flagd sidecar. Default true (enabled).
	// +optional
	ProbesEnabled *bool `json:"probesEnabled"`

	// DebugLogging defines whether to enable --debug flag of flagd sidecar. Default false (disabled).
	// +optional
	DebugLogging *bool `json:"debugLogging"`

	// OtelCollectorUri defines whether to enable --otel-collector-uri flag of flagd sidecar. Default false (disabled).
	// +optional
	OtelCollectorUri string `json:"otelCollectorUri"`

	// Resources defines flagd sidecar resources. Default to operator sidecar-cpu-* and sidecar-ram-* flags.
	// +optional
	Resources corev1.ResourceRequirements `json:"resources"`
}

FlagSourceConfigurationSpec defines the desired state of FlagSourceConfiguration

func (*FlagSourceConfigurationSpec) DeepCopy

func (in *FlagSourceConfigurationSpec) DeepCopy() *FlagSourceConfigurationSpec

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

func (*FlagSourceConfigurationSpec) DeepCopyInto

func (in *FlagSourceConfigurationSpec) DeepCopyInto(out *FlagSourceConfigurationSpec)

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

type FlagSourceConfigurationStatus

type FlagSourceConfigurationStatus struct {
}

FlagSourceConfigurationStatus defines the observed state of FlagSourceConfiguration

func (*FlagSourceConfigurationStatus) DeepCopy

func (in *FlagSourceConfigurationStatus) DeepCopy() *FlagSourceConfigurationStatus

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

func (*FlagSourceConfigurationStatus) DeepCopyInto

func (in *FlagSourceConfigurationStatus) DeepCopyInto(out *FlagSourceConfigurationStatus)

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

type Source

type Source struct {
	// Source is a URI of the flag sources
	Source string `json:"source"`

	// Provider type - kubernetes, http(s), grpc(s) or filepath
	// +optional
	Provider SyncProviderType `json:"provider"`

	// HttpSyncBearerToken is a bearer token. Used by http(s) sync provider only
	// +optional
	HttpSyncBearerToken string `json:"httpSyncBearerToken"`

	// TLS - Enable/Disable secure TLS connectivity. Currently used only by GRPC sync
	// +optional
	TLS bool `json:"tls"`

	// CertPath is a path of a certificate to be used by grpc TLS connection
	// +optional
	CertPath string `json:"certPath"`

	// ProviderID is an identifier to be used in grpc provider
	// +optional
	ProviderID string `json:"providerID"`

	// Selector is a flag configuration selector used by grpc provider
	// +optional
	Selector string `json:"selector,omitempty"`
}

func (*Source) DeepCopy

func (in *Source) DeepCopy() *Source

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

func (*Source) DeepCopyInto

func (in *Source) DeepCopyInto(out *Source)

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

type SyncProviderType

type SyncProviderType string