mgr

Documentation

Overview

Package mgr for the Ceph manager.

Package mgr for the Ceph manager.

Package mgr for the Ceph manager.

Index

• Constants
• Variables
• func CreateExternalMetricsEndpoints(namespace string, externalMgrEndpoints []v1.EndpointAddress, ...) *v1.Endpoints
• func GeneratePassword(length int) (string, error)
• func GenerateRandomBytes(length int) ([]byte, error)
• func IsModuleInSpec(modules []cephv1.Module, moduleName string) bool
• type Cluster
  • func New(context *clusterd.Context, clusterInfo *cephclient.ClusterInfo, ...) *Cluster
  • func (c *Cluster) DeployPrometheusRule(name, namespace string) error
  • func (c *Cluster) EnableServiceMonitor(service *v1.Service) error
  • func (c *Cluster) MakeMetricsService(name, servicePortMetricName string) *v1.Service
  • func (c *Cluster) Start() error

Constants

const (
	// AppName is the ceph mgr application name
	AppName = "rook-ceph-mgr"

	PgautoscalerModuleName = "pg_autoscaler"
)

const (
	ExternalMgrAppName        = "rook-ceph-mgr-external"
	ServiceExternalMetricName = "http-external-metrics"
)

Variables

var PrometheusExternalRuleName = "prometheus-ceph-vVERSION-rules-external"

PrometheusExternalRuleName is the name of the prometheus external rule

Functions

func CreateExternalMetricsEndpoints

func CreateExternalMetricsEndpoints(namespace string, externalMgrEndpoints []v1.EndpointAddress, ownerRef metav1.OwnerReference) *v1.Endpoints

CreateExternalMetricsEndpoints creates external metric endpoint

func GeneratePassword

func GeneratePassword(length int) (string, error)

func GenerateRandomBytes

func GenerateRandomBytes(length int) ([]byte, error)

GenerateRandomBytes returns securely generated random bytes.

func IsModuleInSpec

func IsModuleInSpec(modules []cephv1.Module, moduleName string) bool

IsModuleInSpec returns whether a module is present in the CephCluster manager spec

Types

type Cluster

type Cluster struct {
	Replicas int
	// contains filtered or unexported fields
}

Cluster represents the Rook and environment configuration settings needed to set up Ceph mgrs.

func New

func New(context *clusterd.Context, clusterInfo *cephclient.ClusterInfo, spec cephv1.ClusterSpec, rookVersion string) *Cluster

New creates an instance of the mgr

func (*Cluster) DeployPrometheusRule

func (c *Cluster) DeployPrometheusRule(name, namespace string) error

DeployPrometheusRule deploy prometheusRule that adds alerting and/or recording rules to the cluster

func (*Cluster) EnableServiceMonitor

func (c *Cluster) EnableServiceMonitor(service *v1.Service) error

EnableServiceMonitor add a servicemonitor that allows prometheus to scrape from the monitoring endpoint of the cluster

func (*Cluster) MakeMetricsService

func (c *Cluster) MakeMetricsService(name, servicePortMetricName string) *v1.Service

MakeMetricsService generates the Kubernetes service object for the monitoring service

func (*Cluster) Start

func (c *Cluster) Start() error

Start begins the process of running a cluster of Ceph mgrs.