Statistics
| Branch: | Tag: | Revision:

root / src / Ganeti / HTools / Group.hs @ 6d3d13ab

History | View | Annotate | Download (2.6 kB)

1
{-| Module describing a node group.
2

    
3
-}
4

    
5
{-
6

    
7
Copyright (C) 2010, 2011, 2012 Google Inc.
8

    
9
This program is free software; you can redistribute it and/or modify
10
it under the terms of the GNU General Public License as published by
11
the Free Software Foundation; either version 2 of the License, or
12
(at your option) any later version.
13

    
14
This program is distributed in the hope that it will be useful, but
15
WITHOUT ANY WARRANTY; without even the implied warranty of
16
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17
General Public License for more details.
18

    
19
You should have received a copy of the GNU General Public License
20
along with this program; if not, write to the Free Software
21
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
22
02110-1301, USA.
23

    
24
-}
25

    
26
module Ganeti.HTools.Group
27
  ( Group(..)
28
  , List
29
  , AssocList
30
  -- * Constructor
31
  , create
32
  , setIdx
33
  , isAllocable
34
  ) where
35

    
36
import qualified Ganeti.HTools.Container as Container
37

    
38
import qualified Ganeti.HTools.Types as T
39

    
40
-- * Type declarations
41

    
42
-- | The node group type.
43
data Group = Group
44
  { name        :: String        -- ^ The node name
45
  , uuid        :: T.GroupID     -- ^ The UUID of the group
46
  , idx         :: T.Gdx         -- ^ Internal index for book-keeping
47
  , allocPolicy :: T.AllocPolicy -- ^ The allocation policy for this group
48
  , iPolicy     :: T.IPolicy     -- ^ The instance policy for this group
49
  , allTags     :: [String]      -- ^ The tags for this group
50
  } deriving (Show, Eq)
51

    
52
-- Note: we use the name as the alias, and the UUID as the official
53
-- name
54
instance T.Element Group where
55
  nameOf     = uuid
56
  idxOf      = idx
57
  setAlias   = setName
58
  setIdx     = setIdx
59
  allNames n = [name n, uuid n]
60

    
61
-- | A simple name for the int, node association list.
62
type AssocList = [(T.Gdx, Group)]
63

    
64
-- | A simple name for a node map.
65
type List = Container.Container Group
66

    
67
-- * Initialization functions
68

    
69
-- | Create a new group.
70
create :: String -> T.GroupID -> T.AllocPolicy -> T.IPolicy -> [String] -> Group
71
create name_init id_init apol_init ipol_init tags_init =
72
  Group { name        = name_init
73
        , uuid        = id_init
74
        , allocPolicy = apol_init
75
        , iPolicy     = ipol_init
76
        , allTags     = tags_init
77
        , idx         = -1
78
        }
79

    
80
-- | Sets the group index.
81
--
82
-- This is used only during the building of the data structures.
83
setIdx :: Group -> T.Gdx -> Group
84
setIdx t i = t {idx = i}
85

    
86
-- | Changes the alias.
87
--
88
-- This is used only during the building of the data structures.
89
setName :: Group -> String -> Group
90
setName t s = t { name = s }
91

    
92
-- | Checks if a group is allocable.
93
isAllocable :: Group -> Bool
94
isAllocable = (/= T.AllocUnallocable) . allocPolicy