operator

README

FederatorAI Operator

FederatorAI Operator is an Operator that manages FederatorAI components for an OpenShift cluster. Once installed, the FederatoAI Operator provides the following features:

• Create/Clean up: Launch FederatorAI components using the Operator.
• Easy Configuration: Easily configure data source of Prometheus and enable/disable add-on components, such as GUI, and predictive autoscaling.
• Pod Scaling Recommendation/Autoscaling: Use provided CRD to setup target pods and desired policies for scaling recommendation and autoscaling.

Note: FederatorAI requires a Prometheus datasource to get historical metrics of pods and nodes. When launching FederatorAI components, Prometheus connection settings need to be provided.

FederatorAI

FederatorAI is the brain of resource orchestration for kubernetes. We use machine learning technology to provide intelligence that foresees future resource usage of your Kubernetes cluster across multiple layers. FederatorAI recommends the right sizes of containers and the right number of replications. It also elastically manages pod scaling and scheduling of your containerized applications. The overall benefit is cost reduction up to 50% and higher service quality, such as fewer OOM issues. For more information, visit github.com/containers-ai/alameda

Documentations

Please visit docs

Resources

• How to Write Go Code
• Effective Go
• Go Code Review Comments
• GitHub Flow
• Go modules
• Standard Go Project Layout
• CRI tools

Documentation

Index

• type Config
  • func NewDefaultConfig() Config
• type MetricsConfig
  • func NewDefaultMetricsConfig() MetricsConfig

Types

type Config

type Config struct {
	WatchNamespace string        `mapstructure:"watch-namespace"`
	Metrics        MetricsConfig `mapstructure:"metrics"`
	Log            log.Config    `mapstructure:"log"`
}

Config encapsultes configuration of federatorai operator

func NewDefaultConfig

func NewDefaultConfig() Config

NewDefaultConfig creates operator default configuration

type MetricsConfig

type MetricsConfig struct {
	Host string `mapstructure:"host"`
	Port int    `mapstructure:"port"`
}

MetricsConfig encapsultes configuration of federatorai operator metrics server

func NewDefaultMetricsConfig

func NewDefaultMetricsConfig() MetricsConfig

NewDefaultMetricsConfig creates operator's metrics server default configuration