Safe Haskell	Safe-Infered

Ganeti.HTools.Node

Contents

Type declarations
Helper functions
Initialization functions
Diagnostic functions
Update functions
Stats functions
Node graph functions
Making of a Graph from a node/instance list
Display functions

Description

Module describing a node.

All updates are functional (copy-based) and return a new node with updated value.

Synopsis

Type declarations

type TagMap = Map String IntSource

data Node Source

The node type.

Constructors

Node

Fields

name :: String: The node name
alias :: String: The shortened name (for display purposes)
tMem :: Double: Total memory (MiB)
nMem :: Int: Node memory (MiB)
fMem :: Int: Free memory (MiB)
fMemForth :: Int: Free memory (MiB) including forthcoming instances
xMem :: Int: Unaccounted memory (MiB)
tDsk :: Double: Total disk space (MiB)
fDsk :: Int: Free disk space (MiB)
fDskForth :: Int: Free disk space (MiB) including forthcoming instances
tCpu :: Double: Total CPU count
tCpuSpeed :: Double: Relative CPU speed
nCpu :: Int: VCPUs used by the node OS
uCpu :: Int: Used VCPU count
uCpuForth :: Int: Used VCPU count including forthcoming instances
tSpindles :: Int: Node spindles (spindle_count node parameter, or actual spindles, see note below)
fSpindles :: Int: Free spindles (see note below)
fSpindlesForth :: Int: Free spindles (see note below) including forthcoming instances
pList :: [Idx]: List of primary instance indices
pListForth :: [Idx]: List of primary instance indices including forthcoming instances
sList :: [Idx]: List of secondary instance indices
sListForth :: [Idx]: List of secondary instance indices including forthcoming instances
idx :: Ndx: Internal index for book-keeping
peers :: PeerMap: Pnode to instance mapping
failN1 :: Bool: Whether the node has failed n1
failN1Forth :: Bool: Whether the node has failed n1, including forthcoming instances
rMem :: Int: Maximum memory needed for failover by primaries of this node
rMemForth :: Int: Maximum memory needed for failover by primaries of this node, including forthcoming instances
pMem :: Double: Percent of free memory
pMemForth :: Double: Percent of free memory including forthcoming instances
pDsk :: Double: Percent of free disk
pDskForth :: Double: Percent of free disk including forthcoming instances
pRem :: Double: Percent of reserved memory
pRemForth :: Double: Percent of reserved memory including forthcoming instances
pCpu :: Double: Ratio of virtual to physical CPUs
pCpuForth :: Double: Ratio of virtual to physical CPUs including forthcoming instances
mDsk :: Double: Minimum free disk ratio
loDsk :: Int: Autocomputed from mDsk low disk threshold
hiCpu :: Int: Autocomputed from mCpu high cpu threshold
hiSpindles :: Double: Limit auto-computed from policy spindle_ratio and the node spindle count (see note below)
instSpindles :: Double: Spindles used by instances (see note below)
instSpindlesForth :: Double: Spindles used by instances (see note below) including forthcoming instances
offline :: Bool: Whether the node should not be used for allocations and skipped from score computations
isMaster :: Bool: Whether the node is the master node
nTags :: [String]: The node tags for this node
utilPool :: DynUtil: Total utilisation capacity
utilLoad :: DynUtil: Sum of instance utilisation
utilLoadForth :: DynUtil: Sum of instance utilisation, including forthcoming instances
pTags :: TagMap: Primary instance exclusion tags and their count, including forthcoming instances
group :: Gdx: The node's group (index)
iPolicy :: IPolicy: The instance policy (of the node's group)
exclStorage :: Bool: Effective value of exclusive_storage
migTags :: Set String: migration-relevant tags
rmigTags :: Set String: migration tags able to receive
locationTags :: Set String: common-failure domains the node belongs to
locationScore :: Int

Instances

Eq Node
Show Node
Arbitrary Node
Element Node

pCpuEff :: Node -> DoubleSource

Derived parameter: ratio of virutal to physical CPUs, weighted by CPU speed.

pCpuEffForth :: Node -> DoubleSource

Derived parameter: ratio of virutal to physical CPUs, weighted by CPU speed and taking forthcoming instances into account.

type AssocList = [(Ndx, Node)]Source

A simple name for the int, node association list.

type List = Container Node Source

A simple name for a node map.

type GenericAllocElement a = (List, Instance, [Node], a)Source

A simple name for an allocation element (here just for logistic reasons), generic in the type of the metric.

type AllocElement = GenericAllocElement Score Source

A simple name for an allocation element (here just for logistic reasons).

noSecondary :: Ndx Source

Constant node index for a non-moveable instance.

Helper functions

addTag :: TagMap -> String -> TagMap Source

addTags :: TagMap -> [String] -> TagMap Source

Add multiple tags.

delTag :: TagMap -> String -> TagMap Source

delTags :: TagMap -> [String] -> TagMap Source

Remove multiple tags.

rejectAddTags :: TagMap -> [String] -> BoolSource

Check if we can add a list of tags to a tagmap.

conflictingPrimaries :: Node -> IntSource

Check how many primary instances have conflicting tags. The algorithm to compute this is to sum the count of all tags, then subtract the size of the tag map (since each tag has at least one, non-conflicting instance); this is equivalent to summing the values in the tag map minus one.

incIf :: Num a => Bool -> a -> a -> aSource

decIf :: Num a => Bool -> a -> a -> aSource

haveExclStorage :: List -> BoolSource

Is exclusive storage enabled on any node?

Initialization functions

create :: String -> Double -> Int -> Int -> Double -> Int -> Double -> Int -> Bool -> Int -> Int -> Gdx -> Bool -> Node Source

Create a new node.

The index and the peers maps are empty, and will be need to be update later via the setIdx and buildPeers functions.

mDskToloDsk :: Double -> Double -> IntSource

mCpuTohiCpu :: Double -> Double -> IntSource

computeHiSpindles :: Double -> Int -> DoubleSource

setIdx :: Node -> Ndx -> Node Source

Changes the index.

This is used only during the building of the data structures.

setAlias :: Node -> String -> Node Source

Changes the alias.

This is used only during the building of the data structures.

setOffline :: Node -> Bool -> Node Source

Sets the offline attribute.

setMaster :: Node -> Bool -> Node Source

Sets the master attribute

setNodeTags :: Node -> [String] -> Node Source

Sets the node tags attribute

setMigrationTags :: Node -> Set String -> Node Source

Set migration tags

setRecvMigrationTags :: Node -> Set String -> Node Source

Set the migration tags a node is able to receive

setLocationTags :: Node -> Set String -> Node Source

Set the location tags

setXmem :: Node -> Int -> Node Source

Sets the unnaccounted memory.

setMdsk :: Node -> Double -> Node Source

Sets the max disk usage ratio.

setMcpu :: Node -> Double -> Node Source

Sets the max cpu usage ratio. This will update the node's ipolicy, losing sharing (but it should be a seldomly done operation).

setPolicy :: IPolicy -> Node -> Node Source

Sets the policy.

computeMaxRes :: PeerMap -> Elem Source

buildPeers :: Node -> List -> Node Source

Builds the peer map for a given node.

calcSpindleUse :: Bool -> Node -> Instance -> DoubleSource

calcSpindleUseForth :: Bool -> Node -> Instance -> DoubleSource

calcNewFreeSpindles :: Bool -> Node -> Instance -> IntSource

calcNewFreeSpindlesForth :: Bool -> Node -> Instance -> IntSource

calcFmemOfflineOrForthcoming :: Node -> Container Instance -> IntSource

setPri :: Node -> Instance -> Node Source

Assigns an instance to a node as primary and update the used VCPU count, utilisation data and tags map.

setSec :: Node -> Instance -> Node Source

Assigns an instance to a node as secondary and updates disk utilisation.

computePDsk :: Int -> Double -> DoubleSource

computeNewPDsk :: Node -> Int -> Int -> DoubleSource

Diagnostic functions

getPolicyHealth :: Node -> OpResult ()Source

For a node diagnose whether it conforms with all policies. The type is chosen to represent that of a no-op node operation.

Update functions

setCpuSpeed :: Node -> Double -> Node Source

Set the CPU speed

removePri :: Node -> Instance -> Node Source

Removes a primary instance.

removeSec :: Node -> Instance -> Node Source

Removes a secondary instance.

addPri :: Node -> Instance -> OpResult Node Source

Adds a primary instance (basic version).

addPriEx Source

Arguments

:: Bool	Whether to override the N+1 and other soft checks, useful if we come from a worse status (e.g. offline). If this is True, forthcoming instances may exceed available Node resources.
-> Node	The target node
-> Instance	The instance to add
-> OpResult Node	The result of the operation, either the new version of the node or a failure mode

Adds a primary instance (extended version).

addSec :: Node -> Instance -> Ndx -> OpResult Node Source

Adds a secondary instance (basic version).

addSecEx :: Bool -> Node -> Instance -> Ndx -> OpResult Node Source

Adds a secondary instance (extended version).

addSecExEx :: Bool -> Bool -> Node -> Instance -> Ndx -> OpResult Node Source

Adds a secondary instance (doubly extended version). The first parameter tells addSecExEx to ignore disks completly. There is only one legitimate use case for this, and this is failing over a DRBD instance where the primary node is offline (and hence will become the secondary afterwards).

checkMigration :: Node -> Node -> OpResult ()Source

Predicate on whether migration is supported between two nodes.

Stats functions

availDisk :: Node -> IntSource

Computes the amount of available disk on a given node.

iDsk :: Node -> IntSource

Computes the amount of used disk on a given node.

availMem :: Node -> IntSource

Computes the amount of available memory on a given node.

availCpu :: Node -> IntSource

Computes the amount of available memory on a given node.

iMem :: Node -> IntSource

The memory used by instances on a given node.

Node graph functions

Making of a Graph from a node/instance list

instanceToEdges :: Instance -> [Edge]Source

instancesToEdges :: List -> [Edge]Source

nodesToBounds :: List -> Maybe BoundsSource

nodeToSharedSecondaryEdge :: List -> Node -> [Edge]Source

filterValid :: List -> [Edge] -> [Edge]Source

mkNodeGraph :: List -> List -> Maybe GraphSource

Transform a Node + Instance list into a NodeGraph type. Returns Nothing if the node list is empty.

mkRebootNodeGraph :: List -> List -> List -> Maybe GraphSource

Transform a Nodes + Instances into a NodeGraph with all reboot exclusions. This includes edges between nodes that are the primary nodes of instances that have the same secondary node. Nodes not in the node list will not be part of the graph, but they are still considered for the edges arising from two instances having the same secondary node. Return Nothing if the node list is empty.