Synnefo » snf-ganeti

{-# LANGUAGE TemplateHaskell #-}

{-| Implementation of the Ganeti config objects.

Some object fields are not implemented yet, and as such they are

commented out below.

-}

{-

Copyright (C) 2011, 2012 Google Inc.

This program is free software; you can redistribute it and/or modify

it under the terms of the GNU General Public License as published by

the Free Software Foundation; either version 2 of the License, or

(at your option) any later version.

This program is distributed in the hope that it will be useful, but

WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

General Public License for more details.

You should have received a copy of the GNU General Public License

along with this program; if not, write to the Free Software

Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA

02110-1301, USA.

-}

module Ganeti.Objects

  ( VType(..)

  , vTypeFromRaw

  , HvParams

  , OsParams

  , PartialNicParams(..)

  , FilledNicParams(..)

  , fillNicParams

  , allNicParamFields

  , PartialNic(..)

  , FileDriver(..)

  , BlockDriver(..)

  , DiskMode(..)

  , DiskType(..)

  , DiskLogicalId(..)

  , Disk(..)

  , DiskTemplate(..)

  , PartialBeParams(..)

  , FilledBeParams(..)

  , fillBeParams

  , allBeParamFields

  , AdminState(..)

  , adminStateFromRaw

  , Instance(..)

  , toDictInstance

  , PartialNDParams(..)

  , FilledNDParams(..)

  , fillNDParams

  , allNDParamFields

  , Node(..)

  , NodeRole(..)

  , nodeRoleToRaw

  , roleDescription

  , AllocPolicy(..)

  , FilledISpecParams(..)

  , PartialISpecParams(..)

  , fillISpecParams

  , allISpecParamFields

  , FilledIPolicy(..)

  , PartialIPolicy(..)

  , fillIPolicy

  , DiskParams

  , NodeGroup(..)

  , IpFamily(..)

  , ipFamilyToVersion

  , fillDict

  , ClusterHvParams

  , OsHvParams

  , ClusterBeParams

  , ClusterOsParams

  , ClusterNicParams

  , Cluster(..)

  , ConfigData(..)

  , TimeStampObject(..)

  , UuidObject(..)

  , SerialNoObject(..)

  , TagsObject(..)

  , DictObject(..) -- re-exported from THH

  , TagSet -- re-exported from THH

  , Network(..)

  ) where

import Data.List (foldl')

import Data.Maybe

import qualified Data.Map as Map

import qualified Data.Set as Set

import Text.JSON (showJSON, readJSON, JSON, JSValue(..))

import qualified Text.JSON as J

import qualified Ganeti.Constants as C

import Ganeti.JSON

import Ganeti.Types

import Ganeti.THH

-- * Generic definitions

-- | Fills one map with keys from the other map, if not already

-- existing. Mirrors objects.py:FillDict.

fillDict :: (Ord k) => Map.Map k v -> Map.Map k v -> [k] -> Map.Map k v

fillDict defaults custom skip_keys =

  let updated = Map.union custom defaults

  in foldl' (flip Map.delete) updated skip_keys

-- | The VTYPES, a mini-type system in Python.

$(declareSADT "VType"

  [ ("VTypeString",      'C.vtypeString)

  , ("VTypeMaybeString", 'C.vtypeMaybeString)

  , ("VTypeBool",        'C.vtypeBool)

  , ("VTypeSize",        'C.vtypeSize)

  , ("VTypeInt",         'C.vtypeInt)

  ])

$(makeJSONInstance ''VType)

-- | The hypervisor parameter type. This is currently a simple map,

-- without type checking on key/value pairs.

type HvParams = Container JSValue

-- | The OS parameters type. This is, and will remain, a string

-- container, since the keys are dynamically declared by the OSes, and

-- the values are always strings.

type OsParams = Container String

-- | Class of objects that have timestamps.

class TimeStampObject a where

  cTimeOf :: a -> Double

  mTimeOf :: a -> Double

-- | Class of objects that have an UUID.

class UuidObject a where

  uuidOf :: a -> String

-- | Class of object that have a serial number.

class SerialNoObject a where

  serialOf :: a -> Int

-- | Class of objects that have tags.

class TagsObject a where

  tagsOf :: a -> Set.Set String

-- * Node role object

$(declareSADT "NodeRole"

  [ ("NROffline",   'C.nrOffline)

  , ("NRDrained",   'C.nrDrained)

  , ("NRRegular",   'C.nrRegular)

  , ("NRCandidate", 'C.nrMcandidate)

  , ("NRMaster",    'C.nrMaster)

  ])

$(makeJSONInstance ''NodeRole)

-- | The description of the node role.

roleDescription :: NodeRole -> String

roleDescription NROffline   = "offline"

roleDescription NRDrained   = "drained"

roleDescription NRRegular   = "regular"

roleDescription NRCandidate = "master candidate"

roleDescription NRMaster    = "master"

-- * Network definitions

-- FIXME: Not all types might be correct here, since they

-- haven't been exhaustively deduced from the python code yet.

$(buildObject "Network" "network" $

  [ simpleField "name"             [t| NonEmptyString |]

  , optionalField $

    simpleField "network_type"     [t| NetworkType |]

  , optionalField $

    simpleField "mac_prefix"       [t| String |]

  , optionalField $

    simpleField "family"           [t| Int |]

  , simpleField "network"          [t| NonEmptyString |]

  , optionalField $

    simpleField "network6"         [t| String |]

  , optionalField $

    simpleField "gateway"          [t| String |]

  , optionalField $

    simpleField "gateway6"         [t| String |]

  , optionalField $

    simpleField "size"             [t| J.JSValue |]

  , optionalField $

    simpleField "reservations"     [t| String |]

  , optionalField $

    simpleField "ext_reservations" [t| String |]

  ]

  ++ serialFields

  ++ tagsFields)

instance SerialNoObject Network where

  serialOf = networkSerial

instance TagsObject Network where

  tagsOf = networkTags

-- * NIC definitions

$(buildParam "Nic" "nicp"

  [ simpleField "mode" [t| NICMode |]

  , simpleField "link" [t| String  |]

  ])

$(buildObject "PartialNic" "nic"

  [ simpleField "mac" [t| String |]

  , optionalField $ simpleField "ip" [t| String |]

  , simpleField "nicparams" [t| PartialNicParams |]

  , optionalField $ simpleField "network" [t| Network |]

  ])

-- * Disk definitions

$(declareSADT "DiskMode"

  [ ("DiskRdOnly", 'C.diskRdonly)

  , ("DiskRdWr",   'C.diskRdwr)

  ])

$(makeJSONInstance ''DiskMode)

$(declareSADT "DiskType"

  [ ("LD_LV",       'C.ldLv)

  , ("LD_DRBD8",    'C.ldDrbd8)

  , ("LD_FILE",     'C.ldFile)

  , ("LD_BLOCKDEV", 'C.ldBlockdev)

  , ("LD_RADOS",    'C.ldRbd)

  , ("LD_EXT",      'C.ldExt)

  ])

$(makeJSONInstance ''DiskType)

-- | The persistent block driver type. Currently only one type is allowed.

$(declareSADT "BlockDriver"

  [ ("BlockDrvManual", 'C.blockdevDriverManual)

  ])

$(makeJSONInstance ''BlockDriver)

-- | Constant for the dev_type key entry in the disk config.

devType :: String

devType = "dev_type"

-- | The disk configuration type. This includes the disk type itself,

-- for a more complete consistency. Note that since in the Python

-- code-base there's no authoritative place where we document the

-- logical id, this is probably a good reference point.

data DiskLogicalId

  = LIDPlain String String  -- ^ Volume group, logical volume

  | LIDDrbd8 String String Int Int Int String

  -- ^ NodeA, NodeB, Port, MinorA, MinorB, Secret

  | LIDFile FileDriver String -- ^ Driver, path

  | LIDBlockDev BlockDriver String -- ^ Driver, path (must be under /dev)

  | LIDRados String String -- ^ Unused, path

  | LIDExt String String -- ^ ExtProvider, unique name

    deriving (Show, Eq)

-- | Mapping from a logical id to a disk type.

lidDiskType :: DiskLogicalId -> DiskType

lidDiskType (LIDPlain {}) = LD_LV

lidDiskType (LIDDrbd8 {}) = LD_DRBD8

lidDiskType (LIDFile  {}) = LD_FILE

lidDiskType (LIDBlockDev {}) = LD_BLOCKDEV

lidDiskType (LIDRados {}) = LD_RADOS

lidDiskType (LIDExt {}) = LD_EXT

-- | Builds the extra disk_type field for a given logical id.

lidEncodeType :: DiskLogicalId -> [(String, JSValue)]

lidEncodeType v = [(devType, showJSON . lidDiskType $ v)]

-- | Custom encoder for DiskLogicalId (logical id only).

encodeDLId :: DiskLogicalId -> JSValue

encodeDLId (LIDPlain vg lv) = JSArray [showJSON vg, showJSON lv]

encodeDLId (LIDDrbd8 nodeA nodeB port minorA minorB key) =

  JSArray [ showJSON nodeA, showJSON nodeB, showJSON port

          , showJSON minorA, showJSON minorB, showJSON key ]

encodeDLId (LIDRados pool name) = JSArray [showJSON pool, showJSON name]

encodeDLId (LIDFile driver name) = JSArray [showJSON driver, showJSON name]

encodeDLId (LIDBlockDev driver name) = JSArray [showJSON driver, showJSON name]

encodeDLId (LIDExt extprovider name) =

  JSArray [showJSON extprovider, showJSON name]

-- | Custom encoder for DiskLogicalId, composing both the logical id

-- and the extra disk_type field.

encodeFullDLId :: DiskLogicalId -> (JSValue, [(String, JSValue)])

encodeFullDLId v = (encodeDLId v, lidEncodeType v)

-- | Custom decoder for DiskLogicalId. This is manual for now, since

-- we don't have yet automation for separate-key style fields.

decodeDLId :: [(String, JSValue)] -> JSValue -> J.Result DiskLogicalId

decodeDLId obj lid = do

  dtype <- fromObj obj devType

  case dtype of

    LD_DRBD8 ->

      case lid of

        JSArray [nA, nB, p, mA, mB, k] -> do

          nA' <- readJSON nA

          nB' <- readJSON nB

          p'  <- readJSON p

          mA' <- readJSON mA

          mB' <- readJSON mB

          k'  <- readJSON k

          return $ LIDDrbd8 nA' nB' p' mA' mB' k'

        _ -> fail "Can't read logical_id for DRBD8 type"

    LD_LV ->

      case lid of

        JSArray [vg, lv] -> do

          vg' <- readJSON vg

          lv' <- readJSON lv

          return $ LIDPlain vg' lv'

        _ -> fail "Can't read logical_id for plain type"

    LD_FILE ->

      case lid of

        JSArray [driver, path] -> do

          driver' <- readJSON driver

          path'   <- readJSON path

          return $ LIDFile driver' path'

        _ -> fail "Can't read logical_id for file type"

    LD_BLOCKDEV ->

      case lid of

        JSArray [driver, path] -> do

          driver' <- readJSON driver

          path'   <- readJSON path

          return $ LIDBlockDev driver' path'

        _ -> fail "Can't read logical_id for blockdev type"

    LD_RADOS ->

      case lid of

        JSArray [driver, path] -> do

          driver' <- readJSON driver

          path'   <- readJSON path

          return $ LIDRados driver' path'

        _ -> fail "Can't read logical_id for rdb type"

    LD_EXT ->

      case lid of

        JSArray [extprovider, name] -> do

          extprovider' <- readJSON extprovider

          name'   <- readJSON name

          return $ LIDExt extprovider' name'

        _ -> fail "Can't read logical_id for extstorage type"

-- | Disk data structure.

--

-- This is declared manually as it's a recursive structure, and our TH

-- code currently can't build it.

data Disk = Disk

  { diskLogicalId  :: DiskLogicalId

--  , diskPhysicalId :: String

  , diskChildren   :: [Disk]

  , diskIvName     :: String

  , diskSize       :: Int

  , diskMode       :: DiskMode

  } deriving (Show, Eq)

$(buildObjectSerialisation "Disk"

  [ customField 'decodeDLId 'encodeFullDLId ["dev_type"] $

      simpleField "logical_id"    [t| DiskLogicalId   |]

--  , simpleField "physical_id" [t| String   |]

  , defaultField  [| [] |] $ simpleField "children" [t| [Disk] |]

  , defaultField [| "" |] $ simpleField "iv_name" [t| String |]

  , simpleField "size" [t| Int |]

  , defaultField [| DiskRdWr |] $ simpleField "mode" [t| DiskMode |]

  ])

-- * Instance definitions

$(declareSADT "AdminState"

  [ ("AdminOffline", 'C.adminstOffline)

  , ("AdminDown",    'C.adminstDown)

  , ("AdminUp",      'C.adminstUp)

  ])

$(makeJSONInstance ''AdminState)

$(buildParam "Be" "bep"

  [ simpleField "minmem"       [t| Int  |]

  , simpleField "maxmem"       [t| Int  |]

  , simpleField "vcpus"        [t| Int  |]

  , simpleField "auto_balance" [t| Bool |]

  ])

$(buildObject "Instance" "inst" $

  [ simpleField "name"           [t| String             |]

  , simpleField "primary_node"   [t| String             |]

  , simpleField "os"             [t| String             |]

  , simpleField "hypervisor"     [t| Hypervisor         |]

  , simpleField "hvparams"       [t| HvParams           |]

  , simpleField "beparams"       [t| PartialBeParams    |]

  , simpleField "osparams"       [t| OsParams           |]

  , simpleField "admin_state"    [t| AdminState         |]

  , simpleField "nics"           [t| [PartialNic]       |]

  , simpleField "disks"          [t| [Disk]             |]

  , simpleField "disk_template"  [t| DiskTemplate       |]

  , optionalField $ simpleField "network_port" [t| Int  |]

  ]

  ++ timeStampFields

  ++ uuidFields

  ++ serialFields

  ++ tagsFields)

instance TimeStampObject Instance where

  cTimeOf = instCtime

  mTimeOf = instMtime

instance UuidObject Instance where

  uuidOf = instUuid

instance SerialNoObject Instance where

  serialOf = instSerial

instance TagsObject Instance where

  tagsOf = instTags

-- * IPolicy definitions

$(buildParam "ISpec" "ispec"

  [ simpleField C.ispecMemSize     [t| Int |]

  , simpleField C.ispecDiskSize    [t| Int |]

  , simpleField C.ispecDiskCount   [t| Int |]

  , simpleField C.ispecCpuCount    [t| Int |]

  , simpleField C.ispecNicCount    [t| Int |]

  , simpleField C.ispecSpindleUse  [t| Int |]

  ])

-- | Custom partial ipolicy. This is not built via buildParam since it

-- has a special 2-level inheritance mode.

$(buildObject "PartialIPolicy" "ipolicy"

  [ renameField "MinSpecP" $ simpleField "min" [t| PartialISpecParams |]

  , renameField "MaxSpecP" $ simpleField "max" [t| PartialISpecParams |]

  , renameField "StdSpecP" $ simpleField "std" [t| PartialISpecParams |]

  , optionalField . renameField "SpindleRatioP"

                    $ simpleField "spindle-ratio"  [t| Double |]

  , optionalField . renameField "VcpuRatioP"

                    $ simpleField "vcpu-ratio"     [t| Double |]

  , optionalField . renameField "DiskTemplatesP"

                    $ simpleField "disk-templates" [t| [DiskTemplate] |]

  ])

-- | Custom filled ipolicy. This is not built via buildParam since it

-- has a special 2-level inheritance mode.

$(buildObject "FilledIPolicy" "ipolicy"

  [ renameField "MinSpec" $ simpleField "min" [t| FilledISpecParams |]

  , renameField "MaxSpec" $ simpleField "max" [t| FilledISpecParams |]

  , renameField "StdSpec" $ simpleField "std" [t| FilledISpecParams |]

  , simpleField "spindle-ratio"  [t| Double |]

  , simpleField "vcpu-ratio"     [t| Double |]

  , simpleField "disk-templates" [t| [DiskTemplate] |]

  ])

-- | Custom filler for the ipolicy types.

fillIPolicy :: FilledIPolicy -> PartialIPolicy -> FilledIPolicy

fillIPolicy (FilledIPolicy { ipolicyMinSpec       = fmin

                           , ipolicyMaxSpec       = fmax

                           , ipolicyStdSpec       = fstd

                           , ipolicySpindleRatio  = fspindleRatio

                           , ipolicyVcpuRatio     = fvcpuRatio

                           , ipolicyDiskTemplates = fdiskTemplates})

            (PartialIPolicy { ipolicyMinSpecP       = pmin

                            , ipolicyMaxSpecP       = pmax

                            , ipolicyStdSpecP       = pstd

                            , ipolicySpindleRatioP  = pspindleRatio

                            , ipolicyVcpuRatioP     = pvcpuRatio

                            , ipolicyDiskTemplatesP = pdiskTemplates}) =

  FilledIPolicy { ipolicyMinSpec       = fillISpecParams fmin pmin

                , ipolicyMaxSpec       = fillISpecParams fmax pmax

                , ipolicyStdSpec       = fillISpecParams fstd pstd

                , ipolicySpindleRatio  = fromMaybe fspindleRatio pspindleRatio

                , ipolicyVcpuRatio     = fromMaybe fvcpuRatio pvcpuRatio

                , ipolicyDiskTemplates = fromMaybe fdiskTemplates

                                         pdiskTemplates

                }

-- * Node definitions

$(buildParam "ND" "ndp"

  [ simpleField "oob_program"   [t| String |]

  , simpleField "spindle_count" [t| Int    |]

  , simpleField "exclusive_storage" [t| Bool |]

  ])

$(buildObject "Node" "node" $

  [ simpleField "name"             [t| String |]

  , simpleField "primary_ip"       [t| String |]

  , simpleField "secondary_ip"     [t| String |]

  , simpleField "master_candidate" [t| Bool   |]

  , simpleField "offline"          [t| Bool   |]

  , simpleField "drained"          [t| Bool   |]

  , simpleField "group"            [t| String |]

  , simpleField "master_capable"   [t| Bool   |]

  , simpleField "vm_capable"       [t| Bool   |]

  , simpleField "ndparams"         [t| PartialNDParams |]

  , simpleField "powered"          [t| Bool   |]

  ]

  ++ timeStampFields

  ++ uuidFields

  ++ serialFields

  ++ tagsFields)

instance TimeStampObject Node where

  cTimeOf = nodeCtime

  mTimeOf = nodeMtime

instance UuidObject Node where

  uuidOf = nodeUuid

instance SerialNoObject Node where

  serialOf = nodeSerial

instance TagsObject Node where

  tagsOf = nodeTags

-- * NodeGroup definitions

-- | The disk parameters type.

type DiskParams = Container (Container JSValue)

-- | A mapping from network UUIDs to nic params of the networks.

type Networks = Container PartialNic

$(buildObject "NodeGroup" "group" $

  [ simpleField "name"         [t| String |]

  , defaultField [| [] |] $ simpleField "members" [t| [String] |]

  , simpleField "ndparams"     [t| PartialNDParams |]

  , simpleField "alloc_policy" [t| AllocPolicy     |]

  , simpleField "ipolicy"      [t| PartialIPolicy  |]

  , simpleField "diskparams"   [t| DiskParams      |]

  , simpleField "networks"     [t| Networks        |]

  ]

  ++ timeStampFields

  ++ uuidFields

  ++ serialFields

  ++ tagsFields)

instance TimeStampObject NodeGroup where

  cTimeOf = groupCtime

  mTimeOf = groupMtime

instance UuidObject NodeGroup where

  uuidOf = groupUuid

instance SerialNoObject NodeGroup where

  serialOf = groupSerial

instance TagsObject NodeGroup where

  tagsOf = groupTags

-- | IP family type

$(declareIADT "IpFamily"

  [ ("IpFamilyV4", 'C.ip4Family)

  , ("IpFamilyV6", 'C.ip6Family)

  ])

$(makeJSONInstance ''IpFamily)

-- | Conversion from IP family to IP version. This is needed because

-- Python uses both, depending on context.

ipFamilyToVersion :: IpFamily -> Int

ipFamilyToVersion IpFamilyV4 = C.ip4Version

ipFamilyToVersion IpFamilyV6 = C.ip6Version

-- | Cluster HvParams (hvtype to hvparams mapping).

type ClusterHvParams = Container HvParams

-- | Cluster Os-HvParams (os to hvparams mapping).

type OsHvParams = Container ClusterHvParams

-- | Cluser BeParams.

type ClusterBeParams = Container FilledBeParams

-- | Cluster OsParams.

type ClusterOsParams = Container OsParams

-- | Cluster NicParams.

type ClusterNicParams = Container FilledNicParams

-- | Cluster UID Pool, list (low, high) UID ranges.

type UidPool = [(Int, Int)]

-- * Cluster definitions

$(buildObject "Cluster" "cluster" $

  [ simpleField "rsahostkeypub"           [t| String           |]

  , simpleField "highest_used_port"       [t| Int              |]

  , simpleField "tcpudp_port_pool"        [t| [Int]            |]

  , simpleField "mac_prefix"              [t| String           |]

  , simpleField "volume_group_name"       [t| String           |]

  , simpleField "reserved_lvs"            [t| [String]         |]

  , optionalField $

    simpleField "drbd_usermode_helper"    [t| String           |]

  , simpleField "master_node"             [t| String           |]

  , simpleField "master_ip"               [t| String           |]

  , simpleField "master_netdev"           [t| String           |]

  , simpleField "master_netmask"          [t| Int              |]

  , simpleField "use_external_mip_script" [t| Bool             |]

  , simpleField "cluster_name"            [t| String           |]

  , simpleField "file_storage_dir"        [t| String           |]

  , simpleField "shared_file_storage_dir" [t| String           |]

  , simpleField "enabled_hypervisors"     [t| [Hypervisor]     |]

  , simpleField "hvparams"                [t| ClusterHvParams  |]

  , simpleField "os_hvp"                  [t| OsHvParams       |]

  , simpleField "beparams"                [t| ClusterBeParams  |]

  , simpleField "osparams"                [t| ClusterOsParams  |]

  , simpleField "nicparams"               [t| ClusterNicParams |]

  , simpleField "ndparams"                [t| FilledNDParams   |]

  , simpleField "diskparams"              [t| DiskParams       |]

  , simpleField "candidate_pool_size"     [t| Int              |]

  , simpleField "modify_etc_hosts"        [t| Bool             |]

  , simpleField "modify_ssh_setup"        [t| Bool             |]

  , simpleField "maintain_node_health"    [t| Bool             |]

  , simpleField "uid_pool"                [t| UidPool          |]

  , simpleField "default_iallocator"      [t| String           |]

  , simpleField "hidden_os"               [t| [String]         |]

  , simpleField "blacklisted_os"          [t| [String]         |]

  , simpleField "primary_ip_family"       [t| IpFamily         |]

  , simpleField "prealloc_wipe_disks"     [t| Bool             |]

  , simpleField "ipolicy"                 [t| FilledIPolicy    |]

 ]

 ++ timeStampFields

 ++ uuidFields

 ++ serialFields

 ++ tagsFields)

instance TimeStampObject Cluster where

  cTimeOf = clusterCtime

  mTimeOf = clusterMtime

instance UuidObject Cluster where

  uuidOf = clusterUuid

instance SerialNoObject Cluster where

  serialOf = clusterSerial

instance TagsObject Cluster where

  tagsOf = clusterTags

-- * ConfigData definitions

$(buildObject "ConfigData" "config" $

--  timeStampFields ++

  [ simpleField "version"    [t| Int                 |]

  , simpleField "cluster"    [t| Cluster             |]

  , simpleField "nodes"      [t| Container Node      |]

  , simpleField "nodegroups" [t| Container NodeGroup |]

  , simpleField "instances"  [t| Container Instance  |]

  ]

  ++ serialFields)

instance SerialNoObject ConfigData where

  serialOf = configSerial