Ganeti.Objects

Contents

• Generic definitions
• Network definitions
  • Ipv4 types
  • Address pools
  • Ganeti "network" config object.
• NIC definitions
• Datacollector definitions
• Disk definitions
• Instance definitions
• IPolicy definitions
• Node definitions
• NodeGroup definitions
• Job scheduler filtering definitions
• Cluster definitions
• ConfigData definitions
• Master network parameters

Description

Synopsis

• fillDict :: Ord k => Map k v -> Map k v -> [k] -> Map k v
• type HvParams = Container JSValue
• type OsParams = Container String
• type OsParamsPrivate = Container (Private String)
• class TimeStampObject a where
  • cTimeOf :: a -> ClockTime
  • mTimeOf :: a -> ClockTime
• class UuidObject a where
  • uuidOf :: a -> String
• class SerialNoObject a where
  • serialOf :: a -> Int
• class TagsObject a where
  • tagsOf :: a -> Set String
• data Ip4Address = Ip4Address Word8 Word8 Word8 Word8
• mkIp4Address :: (Word8, Word8, Word8, Word8) -> Ip4Address
• readIp4Address :: (Applicative m, Monad m) => String -> m Ip4Address
• ip4AddressToList :: Ip4Address -> [Word8]
• ip4AddressToNumber :: Ip4Address -> Integer
• ip4AddressFromNumber :: Integer -> Ip4Address
• nextIp4Address :: Ip4Address -> Ip4Address
• data Ip4Network = Ip4Network {
  • ip4netAddr :: Ip4Address
  • ip4netMask :: Word8
  }
• mkIp4Network :: Ip4Address -> Word8 -> Ip4Network
• newtype AddressPool = AddressPool {
  • apReservations :: BitArray
  }
• data Network = Network {
  • networkName :: NonEmptyString
  • networkMacPrefix :: Maybe String
  • networkNetwork :: Ip4Network
  • networkNetwork6 :: Maybe String
  • networkGateway :: Maybe Ip4Address
  • networkGateway6 :: Maybe String
  • networkReservations :: Maybe AddressPool
  • networkExtReservations :: Maybe AddressPool
  • networkUuid :: String
  • networkCtime :: ClockTime
  • networkMtime :: ClockTime
  • networkSerial :: Int
  • networkTags :: TagSet
  }
• loadNetwork :: JSValue -> Result Network
• saveNetwork :: Network -> JSValue
• data FilledNicParams = FilledNicParams {
  • nicpMode :: NICMode
  • nicpLink :: String
  • nicpVlan :: String
  }
• data PartialNicParams = PartialNicParams {
  • nicpModeP :: Maybe NICMode
  • nicpLinkP :: Maybe String
  • nicpVlanP :: Maybe String
  }
• allNicParamFields :: [String]
• fillNicParams :: FilledNicParams -> PartialNicParams -> FilledNicParams
• loadPartialNicParams :: JSValue -> Result PartialNicParams
• savePartialNicParams :: PartialNicParams -> JSValue
• loadFilledNicParams :: JSValue -> Result FilledNicParams
• saveFilledNicParams :: FilledNicParams -> JSValue
• data PartialNic = PartialNic {
  • nicMac :: String
  • nicIp :: Maybe String
  • nicNicparams :: PartialNicParams
  • nicNetwork :: Maybe String
  • nicName :: Maybe String
  • nicUuid :: String
  }
• loadPartialNic :: JSValue -> Result PartialNic
• savePartialNic :: PartialNic -> JSValue
• type MicroSeconds = Integer
• data DataCollectorConfig = DataCollectorConfig {
  • dataCollectorActive :: Bool
  • dataCollectorInterval :: MicroSeconds
  }
• loadDataCollectorConfig :: JSValue -> Result DataCollectorConfig
• saveDataCollectorConfig :: DataCollectorConfig -> JSValue
• devType :: String
• type DiskParams = Container JSValue
• type DRBDSecret = String
• data LogicalVolume = LogicalVolume {
  • lvGroup :: String
  • lvVolume :: String
  }
• data DiskLogicalId
  • = LIDPlain LogicalVolume
  • | LIDDrbd8 String String Int Int Int (Private DRBDSecret)
  • | LIDFile FileDriver String
  • | LIDSharedFile FileDriver String
  • | LIDGluster FileDriver String
  • | LIDBlockDev BlockDriver String
  • | LIDRados String String
  • | LIDExt String String
• lidDiskType :: DiskLogicalId -> DiskTemplate
• lidEncodeType :: DiskLogicalId -> [(String, JSValue)]
• encodeDLId :: DiskLogicalId -> JSValue
• encodeFullDLId :: DiskLogicalId -> (JSValue, [(String, JSValue)])
• decodeDLId :: [(String, JSValue)] -> JSValue -> Result DiskLogicalId
• data Disk = Disk {
  • diskLogicalId :: DiskLogicalId
  • diskChildren :: [Disk]
  • diskIvName :: String
  • diskSize :: Int
  • diskMode :: DiskMode
  • diskName :: Maybe String
  • diskSpindles :: Maybe Int
  • diskParams :: Maybe DiskParams
  • diskUuid :: String
  • diskSerial :: Int
  • diskCtime :: ClockTime
  • diskMtime :: ClockTime
  }
• loadDisk :: JSValue -> Result Disk
• saveDisk :: Disk -> JSValue
• includesLogicalId :: LogicalVolume -> Disk -> Bool
• data FilledBeParams = FilledBeParams {
  • bepMinmem :: Int
  • bepMaxmem :: Int
  • bepVcpus :: Int
  • bepAutoBalance :: Bool
  • bepAlwaysFailover :: Bool
  • bepSpindleUse :: Int
  }
• data PartialBeParams = PartialBeParams {
  • bepMinmemP :: Maybe Int
  • bepMaxmemP :: Maybe Int
  • bepVcpusP :: Maybe Int
  • bepAutoBalanceP :: Maybe Bool
  • bepAlwaysFailoverP :: Maybe Bool
  • bepSpindleUseP :: Maybe Int
  }
• allBeParamFields :: [String]
• fillBeParams :: FilledBeParams -> PartialBeParams -> FilledBeParams
• loadPartialBeParams :: JSValue -> Result PartialBeParams
• savePartialBeParams :: PartialBeParams -> JSValue
• loadFilledBeParams :: JSValue -> Result FilledBeParams
• saveFilledBeParams :: FilledBeParams -> JSValue
• data Instance = Instance {
  • instName :: String
  • instPrimaryNode :: String
  • instOs :: String
  • instHypervisor :: Hypervisor
  • instHvparams :: HvParams
  • instBeparams :: PartialBeParams
  • instOsparams :: OsParams
  • instOsparamsPrivate :: OsParamsPrivate
  • instAdminState :: AdminState
  • instAdminStateSource :: AdminStateSource
  • instNics :: [PartialNic]
  • instDisks :: [String]
  • instDiskTemplate :: DiskTemplate
  • instDisksActive :: Bool
  • instNetworkPort :: Maybe Int
  • instCtime :: ClockTime
  • instMtime :: ClockTime
  • instUuid :: String
  • instSerial :: Int
  • instTags :: TagSet
  }
• loadInstance :: JSValue -> Result Instance
• saveInstance :: Instance -> JSValue
• data FilledISpecParams = FilledISpecParams {
  • ispecMemorySize :: Int
  • ispecDiskSize :: Int
  • ispecDiskCount :: Int
  • ispecCpuCount :: Int
  • ispecNicCount :: Int
  • ispecSpindleUse :: Int
  }
• data PartialISpecParams = PartialISpecParams {
  • ispecMemorySizeP :: Maybe Int
  • ispecDiskSizeP :: Maybe Int
  • ispecDiskCountP :: Maybe Int
  • ispecCpuCountP :: Maybe Int
  • ispecNicCountP :: Maybe Int
  • ispecSpindleUseP :: Maybe Int
  }
• allISpecParamFields :: [String]
• fillISpecParams :: FilledISpecParams -> PartialISpecParams -> FilledISpecParams
• loadPartialISpecParams :: JSValue -> Result PartialISpecParams
• savePartialISpecParams :: PartialISpecParams -> JSValue
• loadFilledISpecParams :: JSValue -> Result FilledISpecParams
• saveFilledISpecParams :: FilledISpecParams -> JSValue
• data MinMaxISpecs = MinMaxISpecs {
  • mmisMinSpec :: FilledISpecParams
  • mmisMaxSpec :: FilledISpecParams
  }
• loadMinMaxISpecs :: JSValue -> Result MinMaxISpecs
• saveMinMaxISpecs :: MinMaxISpecs -> JSValue
• data PartialIPolicy = PartialIPolicy {
  • ipolicyMinMaxISpecsP :: Maybe [MinMaxISpecs]
  • ipolicyStdSpecP :: Maybe PartialISpecParams
  • ipolicySpindleRatioP :: Maybe Double
  • ipolicyVcpuRatioP :: Maybe Double
  • ipolicyDiskTemplatesP :: Maybe [DiskTemplate]
  }
• loadPartialIPolicy :: JSValue -> Result PartialIPolicy
• savePartialIPolicy :: PartialIPolicy -> JSValue
• data FilledIPolicy = FilledIPolicy {
  • ipolicyMinMaxISpecs :: [MinMaxISpecs]
  • ipolicyStdSpec :: FilledISpecParams
  • ipolicySpindleRatio :: Double
  • ipolicyVcpuRatio :: Double
  • ipolicyDiskTemplates :: [DiskTemplate]
  }
• loadFilledIPolicy :: JSValue -> Result FilledIPolicy
• saveFilledIPolicy :: FilledIPolicy -> JSValue
• fillIPolicy :: FilledIPolicy -> PartialIPolicy -> FilledIPolicy
• data FilledNDParams = FilledNDParams {
  • ndpOobProgram :: String
  • ndpSpindleCount :: Int
  • ndpExclusiveStorage :: Bool
  • ndpOvs :: Bool
  • ndpOvsName :: String
  • ndpOvsLink :: String
  • ndpSshPort :: Int
  • ndpCpuSpeed :: Double
  }
• data PartialNDParams = PartialNDParams {
  • ndpOobProgramP :: Maybe String
  • ndpSpindleCountP :: Maybe Int
  • ndpExclusiveStorageP :: Maybe Bool
  • ndpOvsP :: Maybe Bool
  • ndpOvsNameP :: Maybe String
  • ndpOvsLinkP :: Maybe String
  • ndpSshPortP :: Maybe Int
  • ndpCpuSpeedP :: Maybe Double
  }
• allNDParamFields :: [String]
• fillNDParams :: FilledNDParams -> PartialNDParams -> FilledNDParams
• loadPartialNDParams :: JSValue -> Result PartialNDParams
• savePartialNDParams :: PartialNDParams -> JSValue
• loadFilledNDParams :: JSValue -> Result FilledNDParams
• saveFilledNDParams :: FilledNDParams -> JSValue
• type DiskState = Container JSValue
• type HypervisorState = Container JSValue
• data Node = Node {
  • nodeName :: String
  • nodePrimaryIp :: String
  • nodeSecondaryIp :: String
  • nodeMasterCandidate :: Bool
  • nodeOffline :: Bool
  • nodeDrained :: Bool
  • nodeGroup :: String
  • nodeMasterCapable :: Bool
  • nodeVmCapable :: Bool
  • nodeNdparams :: PartialNDParams
  • nodePowered :: Bool
  • nodeHvStateStatic :: HypervisorState
  • nodeDiskStateStatic :: DiskState
  • nodeCtime :: ClockTime
  • nodeMtime :: ClockTime
  • nodeUuid :: String
  • nodeSerial :: Int
  • nodeTags :: TagSet
  }
• loadNode :: JSValue -> Result Node
• saveNode :: Node -> JSValue
• type GroupDiskParams = Container DiskParams
• type Networks = Container PartialNicParams
• data NodeGroup = NodeGroup {
  • groupName :: String
  • groupMembers :: [String]
  • groupNdparams :: PartialNDParams
  • groupAllocPolicy :: AllocPolicy
  • groupIpolicy :: PartialIPolicy
  • groupDiskparams :: GroupDiskParams
  • groupNetworks :: Networks
  • groupHvStateStatic :: HypervisorState
  • groupDiskStateStatic :: DiskState
  • groupCtime :: ClockTime
  • groupMtime :: ClockTime
  • groupUuid :: String
  • groupSerial :: Int
  • groupTags :: TagSet
  }
• loadNodeGroup :: JSValue -> Result NodeGroup
• saveNodeGroup :: NodeGroup -> JSValue
• data FilterAction
  • = Accept
  • | Pause
  • | Reject
  • | Continue
  • | RateLimit Int
• data FilterPredicate
  • = FPJobId (Filter FilterField)
  • | FPOpCode (Filter FilterField)
  • | FPReason (Filter FilterField)
• data FilterRule = FilterRule {
  • frWatermark :: JobId
  • frPriority :: NonNegative Int
  • frPredicates :: [FilterPredicate]
  • frAction :: FilterAction
  • frReasonTrail :: ReasonTrail
  • frUuid :: String
  }
• loadFilterRule :: JSValue -> Result FilterRule
• saveFilterRule :: FilterRule -> JSValue
• filterRuleOrder :: FilterRule -> FilterRule -> Ordering
• data IpFamily
  • = IpFamilyV4
  • | IpFamilyV6
• ipFamilyFromRaw :: forall m. Monad m => Int -> m IpFamily
• ipFamilyToRaw :: IpFamily -> Int
• ipFamilyToVersion :: IpFamily -> Int
• type ClusterHvParams = GenericContainer Hypervisor HvParams
• type OsHvParams = Container ClusterHvParams
• type ClusterBeParams = Container FilledBeParams
• type ClusterOsParams = Container OsParams
• type ClusterOsParamsPrivate = Container (Private OsParams)
• type ClusterNicParams = Container FilledNicParams
• type UidRange = (Int, Int)
• formatUidRange :: UidRange -> String
• type UidPool = [UidRange]
• type IAllocatorParams = Container JSValue
• type CandidateCertificates = Container String
• data Cluster = Cluster {
  • clusterRsahostkeypub :: String
  • clusterDsahostkeypub :: Maybe String
  • clusterHighestUsedPort :: Int
  • clusterTcpudpPortPool :: [Int]
  • clusterMacPrefix :: String
  • clusterVolumeGroupName :: Maybe String
  • clusterReservedLvs :: [String]
  • clusterDrbdUsermodeHelper :: Maybe String
  • clusterMasterNode :: String
  • clusterMasterIp :: String
  • clusterMasterNetdev :: String
  • clusterMasterNetmask :: Int
  • clusterUseExternalMipScript :: Bool
  • clusterClusterName :: String
  • clusterFileStorageDir :: String
  • clusterSharedFileStorageDir :: String
  • clusterGlusterStorageDir :: String
  • clusterEnabledHypervisors :: [Hypervisor]
  • clusterHvparams :: ClusterHvParams
  • clusterOsHvp :: OsHvParams
  • clusterBeparams :: ClusterBeParams
  • clusterOsparams :: ClusterOsParams
  • clusterOsparamsPrivateCluster :: ClusterOsParamsPrivate
  • clusterNicparams :: ClusterNicParams
  • clusterNdparams :: FilledNDParams
  • clusterDiskparams :: GroupDiskParams
  • clusterCandidatePoolSize :: Int
  • clusterModifyEtcHosts :: Bool
  • clusterModifySshSetup :: Bool
  • clusterMaintainNodeHealth :: Bool
  • clusterUidPool :: UidPool
  • clusterDefaultIallocator :: String
  • clusterDefaultIallocatorParams :: IAllocatorParams
  • clusterHiddenOs :: [String]
  • clusterBlacklistedOs :: [String]
  • clusterPrimaryIpFamily :: IpFamily
  • clusterPreallocWipeDisks :: Bool
  • clusterIpolicy :: FilledIPolicy
  • clusterHvStateStatic :: HypervisorState
  • clusterDiskStateStatic :: DiskState
  • clusterEnabledDiskTemplates :: [DiskTemplate]
  • clusterCandidateCerts :: CandidateCertificates
  • clusterMaxRunningJobs :: Int
  • clusterMaxTrackedJobs :: Int
  • clusterInstallImage :: String
  • clusterInstanceCommunicationNetwork :: String
  • clusterZeroingImage :: String
  • clusterCompressionTools :: [String]
  • clusterEnabledUserShutdown :: Bool
  • clusterDataCollectors :: Container DataCollectorConfig
  • clusterCtime :: ClockTime
  • clusterMtime :: ClockTime
  • clusterUuid :: String
  • clusterSerial :: Int
  • clusterTags :: TagSet
  }
• loadCluster :: JSValue -> Result Cluster
• saveCluster :: Cluster -> JSValue
• data ConfigData = ConfigData {
  • configVersion :: Int
  • configCluster :: Cluster
  • configNodes :: Container Node
  • configNodegroups :: Container NodeGroup
  • configInstances :: Container Instance
  • configNetworks :: Container Network
  • configDisks :: Container Disk
  • configFilters :: Container FilterRule
  • configCtime :: ClockTime
  • configMtime :: ClockTime
  • configSerial :: Int
  }
• loadConfigData :: JSValue -> Result ConfigData
• saveConfigData :: ConfigData -> JSValue
• data MasterNetworkParameters = MasterNetworkParameters {
  • masterNetworkParametersUuid :: String
  • masterNetworkParametersIp :: String
  • masterNetworkParametersNetmask :: Int
  • masterNetworkParametersNetdev :: String
  • masterNetworkParametersIpFamily :: IpFamily
  }
• loadMasterNetworkParameters :: JSValue -> Result MasterNetworkParameters
• saveMasterNetworkParameters :: MasterNetworkParameters -> JSValue

Generic definitions

Network definitions

Ipv4 types

Address pools

Ganeti "network" config object.

NIC definitions

Datacollector definitions

Disk definitions

Instance definitions

IPolicy definitions

Node definitions

NodeGroup definitions

Job scheduler filtering definitions

Cluster definitions

ConfigData definitions

Master network parameters