internal

package
v1.33.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 29, 2024 License: Apache-2.0 Imports: 33 Imported by: 0

README

Internal package

This package can't be included by external repositories. We will maintain methods/functions here that should be shared between our different implementations (e.g. kubectl-fdb and the controller). We mark these methods internal to prevent external usage, since we don't give any guarantees for backwards compatibility.

Documentation

Index

Constants

View Source 
const (
	// MockUnreachableAnnotation defines if a Pod should be unreachable. This annotation
	// is currently only used for testing cases.
	MockUnreachableAnnotation = "foundationdb.org/mock-unreachable"

	// FDBImageTypeUnified indicates that a pod is using a unified image for the
	// main container and sidecar container.
	FDBImageTypeUnified FDBImageType = "unified"

	// FDBImageTypeSplit indicates that a pod is using a different image for the
	// main container and sidecar container.
	FDBImageTypeSplit FDBImageType = "split"

	// CurrentConfigurationAnnotation is the annotation we use to store the
	// latest configuration.
	CurrentConfigurationAnnotation = "foundationdb.org/launcher-current-configuration"

	// EnvironmentAnnotation is the annotation we use to store the environment
	// variables.
	EnvironmentAnnotation = "foundationdb.org/launcher-environment"
)
View Source 
const (
	// ClusterFileKey defines the key name in the ConfigMap
	ClusterFileKey = "cluster-file"
)

Variables

This section is empty.

Functions

func BuildOwnerReference added in v0.39.2 

func BuildOwnerReference(ownerType metav1.TypeMeta, ownerMetadata metav1.ObjectMeta) []metav1.OwnerReference

BuildOwnerReference returns an OwnerReference for the provided input

func ContainsPod added in v1.14.0 

func ContainsPod(cluster *fdbv1beta2.FoundationDBCluster, pod corev1.Pod) bool

ContainsPod checks if the given Pod is part of the cluster or not.

func CreateDefaultBackup added in v0.39.2 

func CreateDefaultBackup(cluster *fdbv1beta2.FoundationDBCluster) *fdbv1beta2.FoundationDBBackup

CreateDefaultBackup creates a defaultFoundationDBCluster for testing

func CreateDefaultCluster added in v0.39.2 

func CreateDefaultCluster() *fdbv1beta2.FoundationDBCluster

CreateDefaultCluster creates a default FoundationDBCluster for testing

func CreatePVCMap added in v0.45.0 

func CreatePVCMap(cluster *fdbv1beta2.FoundationDBCluster, pvcs *corev1.PersistentVolumeClaimList) map[fdbv1beta2.ProcessGroupID]corev1.PersistentVolumeClaim

CreatePVCMap creates a map with the process group ID as a key and the according PVC as a value

func GetBackupDeployment added in v0.39.2 

func GetBackupDeployment(backup *fdbv1beta2.FoundationDBBackup) (*appsv1.Deployment, error)

GetBackupDeployment builds a deployment for backup agents for a cluster.

func GetConfigMap added in v0.39.2 

func GetConfigMap(cluster *fdbv1beta2.FoundationDBCluster) (*corev1.ConfigMap, error)

GetConfigMap builds a config map for a cluster's dynamic config

func GetConfigMapMonitorConfEntry added in v0.39.2 

func GetConfigMapMonitorConfEntry(pClass fdbv1beta2.ProcessClass, imageType FDBImageType, serversPerPod int) string

GetConfigMapMonitorConfEntry returns the specific key for the monitor conf in the ConfigMap

func GetDynamicConfHash added in v0.39.2 

func GetDynamicConfHash(configMap *corev1.ConfigMap, pClass fdbv1beta2.ProcessClass, imageType FDBImageType, serversPerPod int) (string, error)

GetDynamicConfHash gets a hash of the data from the config map holding the cluster's dynamic conf.

This will omit keys that we do not expect the Pods to reference e.g. for storage Pods only include the storage config.

func GetEnvVars added in v0.39.2 

func GetEnvVars(container v1.Container) map[string]*v1.EnvVar

GetEnvVars returns a HashMap of EnvVars for the container

func GetHeadlessService added in v0.39.2 

func GetHeadlessService(cluster *fdbv1beta2.FoundationDBCluster) *corev1.Service

GetHeadlessService builds a headless service for a FoundationDB cluster.

func GetImage added in v0.39.2 

func GetImage(image string, configs []fdbv1beta2.ImageConfig, versionString string, allowTagOverride bool) (string, error)

GetImage returns the image for container

func GetJSONHash added in v0.39.2 

func GetJSONHash(object interface{}) (string, error)

GetJSONHash serializes an object to JSON and takes a hash of the resulting JSON.

func GetMonitorConf added in v0.39.2 

func GetMonitorConf(cluster *fdbv1beta2.FoundationDBCluster, processClass fdbv1beta2.ProcessClass, podClient podclient.FdbPodClient, serversPerPod int) (string, error)

GetMonitorConf builds the monitor conf template

func GetMonitorProcessConfiguration added in v0.49.0 

func GetMonitorProcessConfiguration(cluster *fdbv1beta2.FoundationDBCluster, processClass fdbv1beta2.ProcessClass, processCount int, imageType FDBImageType, customParameterSubstitutions map[string]string) (monitorapi.ProcessConfiguration, error)

GetMonitorProcessConfiguration builds the monitor conf template for the unified image.

func GetObjectMetadata added in v0.39.2 

func GetObjectMetadata(cluster *fdbv1beta2.FoundationDBCluster, base *metav1.ObjectMeta, processClass fdbv1beta2.ProcessClass, id fdbv1beta2.ProcessGroupID) metav1.ObjectMeta

GetObjectMetadata returns the ObjectMetadata for a process

func GetPod added in v0.39.2 

func GetPod(cluster *fdbv1beta2.FoundationDBCluster, processGroup *fdbv1beta2.ProcessGroupStatus) (*corev1.Pod, error)

GetPod builds a pod for a new process group

func GetPodDNSName added in v0.51.0 

func GetPodDNSName(cluster *fdbv1beta2.FoundationDBCluster, podName string) string

GetPodDNSName determines the fully qualified DNS name for a pod.

func GetPodLabels added in v0.44.0 

func GetPodLabels(cluster *fdbv1beta2.FoundationDBCluster, processClass fdbv1beta2.ProcessClass, id string) map[string]string

GetPodLabels creates the labels that we will apply to a Pod

func GetPodListOptions added in v0.39.2 

func GetPodListOptions(cluster *fdbv1beta2.FoundationDBCluster, processClass fdbv1beta2.ProcessClass, id string) []client.ListOption

GetPodListOptions returns the listOptions to list Pods

func GetPodMatchLabels added in v0.44.0 

func GetPodMatchLabels(cluster *fdbv1beta2.FoundationDBCluster, processClass fdbv1beta2.ProcessClass, id string) map[string]string

GetPodMatchLabels creates the labels that we will use when filtering for a pod.

func GetPodMetadata added in v0.39.2 

func GetPodMetadata(cluster *fdbv1beta2.FoundationDBCluster, processClass fdbv1beta2.ProcessClass, id fdbv1beta2.ProcessGroupID, specHash string) metav1.ObjectMeta

GetPodMetadata returns the metadata for a specific Pod

func GetPodSpec added in v0.39.2 

func GetPodSpec(cluster *fdbv1beta2.FoundationDBCluster, processGroup *fdbv1beta2.ProcessGroupStatus) (*corev1.PodSpec, error)

GetPodSpec builds a pod spec for a FoundationDB pod

func GetPodSpecHash added in v0.39.2 

func GetPodSpecHash(cluster *fdbv1beta2.FoundationDBCluster, processGroup *fdbv1beta2.ProcessGroupStatus, spec *corev1.PodSpec) (string, error)

GetPodSpecHash builds the hash of the expected spec for a pod.

func GetProcessClassFromMeta 

func GetProcessClassFromMeta(cluster *fdbv1beta2.FoundationDBCluster, metadata v1.ObjectMeta) fdbv1beta2.ProcessClass

GetProcessClassFromMeta fetches the process class from an object's metadata.

func GetProcessGroup added in v1.26.0 

func GetProcessGroup(cluster *fdbv1beta2.FoundationDBCluster, processClass fdbv1beta2.ProcessClass, idNum int) *fdbv1beta2.ProcessGroupStatus

GetProcessGroup is a helper method that creates a ProcessGroup based on the provided process class and id number.

func GetProcessGroupIDFromMeta added in v0.44.0 

func GetProcessGroupIDFromMeta(cluster *fdbv1beta2.FoundationDBCluster, metadata metav1.ObjectMeta) fdbv1beta2.ProcessGroupID

GetProcessGroupIDFromMeta fetches the process group ID from an object's metadata.

func GetProcessGroupIDFromPodName added in v1.8.1 

func GetProcessGroupIDFromPodName(cluster *fdbv1beta2.FoundationDBCluster, podName string) fdbv1beta2.ProcessGroupID

GetProcessGroupIDFromPodName returns the process group ID for a given Pod name.

func GetPublicIPSource added in v0.46.0 

func GetPublicIPSource(pod *corev1.Pod) (fdbv1beta2.PublicIPSource, error)

GetPublicIPSource determines how a Pod has gotten its public IP.

func GetPublicIPsForPod added in v0.39.2 

func GetPublicIPsForPod(pod *corev1.Pod, log logr.Logger) []string

GetPublicIPsForPod returns the public IPs for a Pod

func GetPvc added in v0.39.2 

func GetPvc(cluster *fdbv1beta2.FoundationDBCluster, processGroup *fdbv1beta2.ProcessGroupStatus) (*corev1.PersistentVolumeClaim, error)

GetPvc builds a persistent volume claim for a FoundationDB process group.

func GetPvcMetadata added in v0.39.2 

func GetPvcMetadata(cluster *fdbv1beta2.FoundationDBCluster, processClass fdbv1beta2.ProcessClass, id fdbv1beta2.ProcessGroupID) metav1.ObjectMeta

GetPvcMetadata returns the metadata for a PVC

func GetServersPerPodForPod added in v1.21.0 

func GetServersPerPodForPod(pod *corev1.Pod, pClass fdbv1beta2.ProcessClass) (int, error)

GetServersPerPodForPod returns the count of servers per Pod based on the processClass from the sidecar or 1

func GetService added in v0.39.2 

func GetService(cluster *fdbv1beta2.FoundationDBCluster, processGroup *fdbv1beta2.ProcessGroupStatus) (*corev1.Service, error)

GetService builds a service for a new process group

func GetSidecarImage added in v0.44.0 

func GetSidecarImage(cluster *fdbv1beta2.FoundationDBCluster, pClass fdbv1beta2.ProcessClass) (string, error)

GetSidecarImage returns the expected sidecar image for a specific process class

func GetSinglePodListOptions added in v0.39.2 

func GetSinglePodListOptions(cluster *fdbv1beta2.FoundationDBCluster, processGroupID fdbv1beta2.ProcessGroupID) []client.ListOption

GetSinglePodListOptions returns the listOptions to list a single Pod

func GetStartCommand added in v0.39.2 

func GetStartCommand(cluster *fdbv1beta2.FoundationDBCluster, processClass fdbv1beta2.ProcessClass, podClient podclient.FdbPodClient, processNumber int, processCount int) (string, error)

GetStartCommand builds the expected start command for a process group.

func GetStartCommandWithSubstitutions added in v1.29.0 

func GetStartCommandWithSubstitutions(cluster *fdbv1beta2.FoundationDBCluster, processClass fdbv1beta2.ProcessClass, substitutions map[string]string, processNumber int, processCount int) (string, error)

GetStartCommandWithSubstitutions will be used by GetStartCommand and for internal testing.

func GetSubstitutionsFromClusterAndPod added in v1.11.0 

func GetSubstitutionsFromClusterAndPod(logger logr.Logger, cluster *fdbv1beta2.FoundationDBCluster, pod *corev1.Pod) (map[string]string, error)

GetSubstitutionsFromClusterAndPod returns a map that contains the substitutions based on the provided cluster and Pod. This method is used for testing and in the MockFdbPodClient.

func IsNetworkError added in v0.39.1 

func IsNetworkError(err error) bool

IsNetworkError returns true if the network is a network error net.Error

func IsQuotaExceeded added in v1.0.0 

func IsQuotaExceeded(err error) bool

IsQuotaExceeded returns true if the error returned by the Kubernetes API is a forbidden error with the error message that the quota was exceeded

func IsTimeoutError added in v0.48.0 

func IsTimeoutError(err error) bool

IsTimeoutError returns true if the observed error was a timeout error

func NewFdbPodClient added in v0.39.2 

func NewFdbPodClient(cluster *fdbv1beta2.FoundationDBCluster, pod *corev1.Pod, log logr.Logger, getTimeout time.Duration, postTimeout time.Duration) (podclient.FdbPodClient, error)

NewFdbPodClient builds a client for working with an FDB Pod

func NormalizeClusterSpec 

func NormalizeClusterSpec(cluster *fdbv1beta2.FoundationDBCluster, options DeprecationOptions) error

NormalizeClusterSpec converts a cluster spec into an unambiguous, future-proof form, by applying any implicit defaults and moving configuration from deprecated fields into fully-supported fields.

func ProcessClassFromLabels 

func ProcessClassFromLabels(cluster *fdbv1beta2.FoundationDBCluster, labels map[string]string) fdbv1beta2.ProcessClass

ProcessClassFromLabels extracts the ProcessClass label from the metav1.ObjectMeta.Labels map

Types

type CliLogFileCleaner added in v1.1.1 

type CliLogFileCleaner struct {
	// contains filtered or unexported fields
}

CliLogFileCleaner contains the logger and the minFileAge

func NewCliLogFileCleaner added in v1.1.1 

func NewCliLogFileCleaner(log logr.Logger, minFileAge time.Duration) *CliLogFileCleaner

NewCliLogFileCleaner returns a new CliLogFileCleaner

func (CliLogFileCleaner) CleanupOldCliLogs added in v1.1.1 

func (c CliLogFileCleaner) CleanupOldCliLogs()

CleanupOldCliLogs removes old fdbcli log files.

type DeprecationOptions 

type DeprecationOptions struct {
	// Whether we should apply the latest defaults rather than the defaults that
	// were initially established for this major version.
	UseFutureDefaults bool

	// Whether we should only fill in defaults that have changes between major
	// versions of the operator.
	OnlyShowChanges bool
}

DeprecationOptions controls how deprecations and changes to defaults get applied to our specs.

type FDBImageType added in v0.49.0 

type FDBImageType string

FDBImageType describes a type of image a pod or cluster is using.

func GetDesiredImageType added in v0.49.0 

func GetDesiredImageType(cluster *fdbv1beta2.FoundationDBCluster) FDBImageType

GetDesiredImageType determines whether a cluster is configured to use the unified or the split image.

func GetImageType added in v0.49.0 

func GetImageType(pod *corev1.Pod) FDBImageType

GetImageType determines whether a pod is using the unified or the split image.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.