Safe Haskell	None
Language	Haskell2010

OM.Kubernetes

Contents

Creating a handle
Operations
Types

Description

This module provides functions that access and operate on the Kubernetes API. It is designed to be used from pods running within the K8s cluster itself and it won't work otherwise.

Synopsis

newK8s :: MonadIO m => m K8s
data K8s
listPods :: MonadIO m => K8s -> Namespace -> m [PodName]
postPod :: MonadIO m => K8s -> Namespace -> PodSpec -> m ()
deletePod :: MonadIO m => K8s -> Namespace -> PodName -> m ()
getPodSpec :: MonadIO m => K8s -> Namespace -> PodName -> m PodSpec
patchService :: MonadIO m => K8s -> Namespace -> ServiceName -> JsonPatch -> m ()
getServiceSpec :: MonadIO m => K8s -> Namespace -> ServiceName -> m ServiceSpec
postService :: MonadIO m => K8s -> Namespace -> ServiceSpec -> m ()
postRoleBinding :: MonadIO m => K8s -> Namespace -> RoleBindingSpec -> m ()
postRole :: MonadIO m => K8s -> Namespace -> RoleSpec -> m ()
postServiceAccount :: MonadIO m => K8s -> Namespace -> ServiceAccountSpec -> m ()
postNamespace :: MonadIO m => K8s -> NamespaceSpec -> m ()
getPodTemplate :: MonadIO m => K8s -> Namespace -> PodTemplateName -> m PodTemplateSpec
queryPods :: MonadIO m => K8s -> Namespace -> [(Text, Text)] -> m [Pod]
newtype JsonPatch = JsonPatch {
- unJsonPatch :: Value
}
newtype PodName = PodName {
- unPodName :: Text
}
newtype PodSpec = PodSpec {
- unPodSpec :: Value
}
newtype ServiceName = ServiceName {
- unServiceName :: Text
}
newtype ServiceSpec = ServiceSpec {
- unServiceSpec :: Value
}
newtype RoleBindingSpec = RoleBindingSpec {
- unRoleBindingSpec :: Value
}
newtype RoleSpec = RoleSpec {
- unRoleSpec :: Value
}
newtype ServiceAccountSpec = ServiceAccountSpec {
- unServiceAccountSpec :: Value
}
newtype NamespaceSpec = NamespaceSpec {
- unNamespaceSpec :: Value
}
newtype Namespace = Namespace {
- unNamespace :: Text
}
newtype PodTemplateName = PodTemplateName {
- unPodTemplateName :: Text
}
newtype PodTemplateSpec = PodTempalteSpec {
- unPodTemplateSpec :: Value
}
newtype Pod = Pod {
- unPod :: Value
}

Creating a handle

newK8s :: MonadIO m => m K8s Source #

Create a new K8s.

data K8s Source #

A handle on the kubernetes service.

Operations

listPods :: MonadIO m => K8s -> Namespace -> m [PodName] Source #

List the pods, returning a list of names.

postPod :: MonadIO m => K8s -> Namespace -> PodSpec -> m () Source #

Create a new pod.

deletePod :: MonadIO m => K8s -> Namespace -> PodName -> m () Source #

Delete a pod.

getPodSpec :: MonadIO m => K8s -> Namespace -> PodName -> m PodSpec Source #

Get the spec of a specific pod.

patchService :: MonadIO m => K8s -> Namespace -> ServiceName -> JsonPatch -> m () Source #

Patch a service.

getServiceSpec :: MonadIO m => K8s -> Namespace -> ServiceName -> m ServiceSpec Source #

Get the service spec.

postService :: MonadIO m => K8s -> Namespace -> ServiceSpec -> m () Source #

Post a new service.

postRoleBinding :: MonadIO m => K8s -> Namespace -> RoleBindingSpec -> m () Source #

Post a role binding.

postRole :: MonadIO m => K8s -> Namespace -> RoleSpec -> m () Source #

Post a Role.

postServiceAccount :: MonadIO m => K8s -> Namespace -> ServiceAccountSpec -> m () Source #

Post a service account.

postNamespace :: MonadIO m => K8s -> NamespaceSpec -> m () Source #

Post a Namespace.

getPodTemplate :: MonadIO m => K8s -> Namespace -> PodTemplateName -> m PodTemplateSpec Source #

Get the pod template.

queryPods :: MonadIO m => K8s -> Namespace -> [(Text, Text)] -> m [Pod] Source #

Query the pods, returning the full JSON for each.

Types

newtype JsonPatch Source #

Specify how to patch the pod template spec.

Constructors

JsonPatch
Fields unJsonPatch :: Value

Instances

Instances details

ToJSON JsonPatch Source #
Instance details Defined in OM.Kubernetes Methods toJSON :: JsonPatch -> Value # toEncoding :: JsonPatch -> Encoding # toJSONList :: [JsonPatch] -> Value # toEncodingList :: [JsonPatch] -> Encoding # omitField :: JsonPatch -> Bool #
Accept JsonPatch Source #
Instance details Defined in OM.Kubernetes Methods contentType :: Proxy JsonPatch -> MediaType # contentTypes :: Proxy JsonPatch -> NonEmpty MediaType #
MimeRender JsonPatch JsonPatch Source #
Instance details Defined in OM.Kubernetes Methods mimeRender :: Proxy JsonPatch -> JsonPatch -> ByteString #

newtype PodName Source #

The name of a pod.

Constructors

PodName
Fields unPodName :: Text

Instances

Instances details

FromJSON PodName Source #
Instance details Defined in OM.Kubernetes Methods parseJSON :: Value -> Parser PodName # parseJSONList :: Value -> Parser [PodName] # omittedField :: Maybe PodName #
FromJSONKey PodName Source #
Instance details Defined in OM.Kubernetes Methods fromJSONKey :: FromJSONKeyFunction PodName # fromJSONKeyList :: FromJSONKeyFunction [PodName] #
ToJSON PodName Source #
Instance details Defined in OM.Kubernetes Methods toJSON :: PodName -> Value # toEncoding :: PodName -> Encoding # toJSONList :: [PodName] -> Value # toEncodingList :: [PodName] -> Encoding # omitField :: PodName -> Bool #
ToJSONKey PodName Source #
Instance details Defined in OM.Kubernetes Methods toJSONKey :: ToJSONKeyFunction PodName # toJSONKeyList :: ToJSONKeyFunction [PodName] #
IsString PodName Source #
Instance details Defined in OM.Kubernetes Methods fromString :: String -> PodName #
Show PodName Source #
Instance details Defined in OM.Kubernetes Methods showsPrec :: Int -> PodName -> ShowS # show :: PodName -> String # showList :: [PodName] -> ShowS #
Eq PodName Source #
Instance details Defined in OM.Kubernetes Methods (==) :: PodName -> PodName -> Bool # (/=) :: PodName -> PodName -> Bool #
Ord PodName Source #
Instance details Defined in OM.Kubernetes Methods compare :: PodName -> PodName -> Ordering # (<) :: PodName -> PodName -> Bool # (<=) :: PodName -> PodName -> Bool # (>) :: PodName -> PodName -> Bool # (>=) :: PodName -> PodName -> Bool # max :: PodName -> PodName -> PodName # min :: PodName -> PodName -> PodName #
FromHttpApiData PodName Source #
Instance details Defined in OM.Kubernetes Methods parseUrlPiece :: Text -> Either Text PodName # parseHeader :: ByteString -> Either Text PodName # parseQueryParam :: Text -> Either Text PodName #
ToHttpApiData PodName Source #
Instance details Defined in OM.Kubernetes Methods toUrlPiece :: PodName -> Text # toEncodedUrlPiece :: PodName -> Builder # toHeader :: PodName -> ByteString # toQueryParam :: PodName -> Text # toEncodedQueryParam :: PodName -> Builder #

newtype PodSpec Source #

A pod specification.

Constructors

PodSpec
Fields unPodSpec :: Value

Instances

Instances details

FromJSON PodSpec Source #
Instance details Defined in OM.Kubernetes Methods parseJSON :: Value -> Parser PodSpec # parseJSONList :: Value -> Parser [PodSpec] # omittedField :: Maybe PodSpec #
ToJSON PodSpec Source #
Instance details Defined in OM.Kubernetes Methods toJSON :: PodSpec -> Value # toEncoding :: PodSpec -> Encoding # toJSONList :: [PodSpec] -> Value # toEncodingList :: [PodSpec] -> Encoding # omitField :: PodSpec -> Bool #

newtype ServiceName Source #

The name of a service.

Constructors

ServiceName
Fields unServiceName :: Text

Instances

Instances details

ToHttpApiData ServiceName Source #
Instance details Defined in OM.Kubernetes Methods toUrlPiece :: ServiceName -> Text # toEncodedUrlPiece :: ServiceName -> Builder # toHeader :: ServiceName -> ByteString # toQueryParam :: ServiceName -> Text # toEncodedQueryParam :: ServiceName -> Builder #

newtype ServiceSpec Source #

The specification of a service.

Constructors

ServiceSpec
Fields unServiceSpec :: Value

Instances

Instances details

FromJSON ServiceSpec Source #
Instance details Defined in OM.Kubernetes Methods parseJSON :: Value -> Parser ServiceSpec # parseJSONList :: Value -> Parser [ServiceSpec] # omittedField :: Maybe ServiceSpec #
ToJSON ServiceSpec Source #
Instance details Defined in OM.Kubernetes Methods toJSON :: ServiceSpec -> Value # toEncoding :: ServiceSpec -> Encoding # toJSONList :: [ServiceSpec] -> Value # toEncodingList :: [ServiceSpec] -> Encoding # omitField :: ServiceSpec -> Bool #

newtype RoleBindingSpec Source #

The representation of Role Binding.

Constructors

RoleBindingSpec
Fields unRoleBindingSpec :: Value

Instances

Instances details

FromJSON RoleBindingSpec Source #
Instance details Defined in OM.Kubernetes Methods parseJSON :: Value -> Parser RoleBindingSpec # parseJSONList :: Value -> Parser [RoleBindingSpec] # omittedField :: Maybe RoleBindingSpec #
ToJSON RoleBindingSpec Source #
Instance details Defined in OM.Kubernetes Methods toJSON :: RoleBindingSpec -> Value # toEncoding :: RoleBindingSpec -> Encoding # toJSONList :: [RoleBindingSpec] -> Value # toEncodingList :: [RoleBindingSpec] -> Encoding # omitField :: RoleBindingSpec -> Bool #

newtype RoleSpec Source #

The representation of a Role.

Constructors

RoleSpec
Fields unRoleSpec :: Value

Instances

Instances details

FromJSON RoleSpec Source #
Instance details Defined in OM.Kubernetes Methods parseJSON :: Value -> Parser RoleSpec # parseJSONList :: Value -> Parser [RoleSpec] # omittedField :: Maybe RoleSpec #
ToJSON RoleSpec Source #
Instance details Defined in OM.Kubernetes Methods toJSON :: RoleSpec -> Value # toEncoding :: RoleSpec -> Encoding # toJSONList :: [RoleSpec] -> Value # toEncodingList :: [RoleSpec] -> Encoding # omitField :: RoleSpec -> Bool #

newtype ServiceAccountSpec Source #

The representation of a service account.

Constructors

ServiceAccountSpec
Fields unServiceAccountSpec :: Value

Instances

Instances details

FromJSON ServiceAccountSpec Source #
Instance details Defined in OM.Kubernetes Methods parseJSON :: Value -> Parser ServiceAccountSpec # parseJSONList :: Value -> Parser [ServiceAccountSpec] # omittedField :: Maybe ServiceAccountSpec #
ToJSON ServiceAccountSpec Source #
Instance details Defined in OM.Kubernetes Methods toJSON :: ServiceAccountSpec -> Value # toEncoding :: ServiceAccountSpec -> Encoding # toJSONList :: [ServiceAccountSpec] -> Value # toEncodingList :: [ServiceAccountSpec] -> Encoding # omitField :: ServiceAccountSpec -> Bool #

newtype NamespaceSpec Source #

The representation of a Namespace specification.

Constructors

NamespaceSpec
Fields unNamespaceSpec :: Value

Instances

Instances details

FromJSON NamespaceSpec Source #
Instance details Defined in OM.Kubernetes Methods parseJSON :: Value -> Parser NamespaceSpec # parseJSONList :: Value -> Parser [NamespaceSpec] # omittedField :: Maybe NamespaceSpec #
ToJSON NamespaceSpec Source #
Instance details Defined in OM.Kubernetes Methods toJSON :: NamespaceSpec -> Value # toEncoding :: NamespaceSpec -> Encoding # toJSONList :: [NamespaceSpec] -> Value # toEncodingList :: [NamespaceSpec] -> Encoding # omitField :: NamespaceSpec -> Bool #

newtype Namespace Source #

A Kubernetes namespace.

Constructors

Namespace
Fields unNamespace :: Text

Instances

Instances details

FromJSON Namespace Source #
Instance details Defined in OM.Kubernetes Methods parseJSON :: Value -> Parser Namespace # parseJSONList :: Value -> Parser [Namespace] # omittedField :: Maybe Namespace #
FromJSONKey Namespace Source #
Instance details Defined in OM.Kubernetes Methods fromJSONKey :: FromJSONKeyFunction Namespace # fromJSONKeyList :: FromJSONKeyFunction [Namespace] #
ToJSON Namespace Source #
Instance details Defined in OM.Kubernetes Methods toJSON :: Namespace -> Value # toEncoding :: Namespace -> Encoding # toJSONList :: [Namespace] -> Value # toEncodingList :: [Namespace] -> Encoding # omitField :: Namespace -> Bool #
ToJSONKey Namespace Source #
Instance details Defined in OM.Kubernetes Methods toJSONKey :: ToJSONKeyFunction Namespace # toJSONKeyList :: ToJSONKeyFunction [Namespace] #
IsString Namespace Source #
Instance details Defined in OM.Kubernetes Methods fromString :: String -> Namespace #
Show Namespace Source #
Instance details Defined in OM.Kubernetes Methods showsPrec :: Int -> Namespace -> ShowS # show :: Namespace -> String # showList :: [Namespace] -> ShowS #
Eq Namespace Source #
Instance details Defined in OM.Kubernetes Methods (==) :: Namespace -> Namespace -> Bool # (/=) :: Namespace -> Namespace -> Bool #
Ord Namespace Source #
Instance details Defined in OM.Kubernetes Methods compare :: Namespace -> Namespace -> Ordering # (<) :: Namespace -> Namespace -> Bool # (<=) :: Namespace -> Namespace -> Bool # (>) :: Namespace -> Namespace -> Bool # (>=) :: Namespace -> Namespace -> Bool # max :: Namespace -> Namespace -> Namespace # min :: Namespace -> Namespace -> Namespace #
FromHttpApiData Namespace Source #
Instance details Defined in OM.Kubernetes Methods parseUrlPiece :: Text -> Either Text Namespace # parseHeader :: ByteString -> Either Text Namespace # parseQueryParam :: Text -> Either Text Namespace #
ToHttpApiData Namespace Source #
Instance details Defined in OM.Kubernetes Methods toUrlPiece :: Namespace -> Text # toEncodedUrlPiece :: Namespace -> Builder # toHeader :: Namespace -> ByteString # toQueryParam :: Namespace -> Text # toEncodedQueryParam :: Namespace -> Builder #

newtype PodTemplateName Source #

The name of a pod template.

Constructors

PodTemplateName
Fields unPodTemplateName :: Text

Instances

Instances details

FromJSON PodTemplateName Source #
Instance details Defined in OM.Kubernetes Methods parseJSON :: Value -> Parser PodTemplateName # parseJSONList :: Value -> Parser [PodTemplateName] # omittedField :: Maybe PodTemplateName #
FromJSONKey PodTemplateName Source #
Instance details Defined in OM.Kubernetes Methods fromJSONKey :: FromJSONKeyFunction PodTemplateName # fromJSONKeyList :: FromJSONKeyFunction [PodTemplateName] #
ToJSON PodTemplateName Source #
Instance details Defined in OM.Kubernetes Methods toJSON :: PodTemplateName -> Value # toEncoding :: PodTemplateName -> Encoding # toJSONList :: [PodTemplateName] -> Value # toEncodingList :: [PodTemplateName] -> Encoding # omitField :: PodTemplateName -> Bool #
ToJSONKey PodTemplateName Source #
Instance details Defined in OM.Kubernetes Methods toJSONKey :: ToJSONKeyFunction PodTemplateName # toJSONKeyList :: ToJSONKeyFunction [PodTemplateName] #
IsString PodTemplateName Source #
Instance details Defined in OM.Kubernetes Methods fromString :: String -> PodTemplateName #
Show PodTemplateName Source #
Instance details Defined in OM.Kubernetes Methods showsPrec :: Int -> PodTemplateName -> ShowS # show :: PodTemplateName -> String # showList :: [PodTemplateName] -> ShowS #
Eq PodTemplateName Source #
Instance details Defined in OM.Kubernetes Methods (==) :: PodTemplateName -> PodTemplateName -> Bool # (/=) :: PodTemplateName -> PodTemplateName -> Bool #
Ord PodTemplateName Source #
Instance details Defined in OM.Kubernetes Methods compare :: PodTemplateName -> PodTemplateName -> Ordering # (<) :: PodTemplateName -> PodTemplateName -> Bool # (<=) :: PodTemplateName -> PodTemplateName -> Bool # (>) :: PodTemplateName -> PodTemplateName -> Bool # (>=) :: PodTemplateName -> PodTemplateName -> Bool # max :: PodTemplateName -> PodTemplateName -> PodTemplateName # min :: PodTemplateName -> PodTemplateName -> PodTemplateName #
FromHttpApiData PodTemplateName Source #
Instance details Defined in OM.Kubernetes Methods parseUrlPiece :: Text -> Either Text PodTemplateName # parseHeader :: ByteString -> Either Text PodTemplateName # parseQueryParam :: Text -> Either Text PodTemplateName #
ToHttpApiData PodTemplateName Source #
Instance details Defined in OM.Kubernetes Methods toUrlPiece :: PodTemplateName -> Text # toEncodedUrlPiece :: PodTemplateName -> Builder # toHeader :: PodTemplateName -> ByteString # toQueryParam :: PodTemplateName -> Text # toEncodedQueryParam :: PodTemplateName -> Builder #

newtype PodTemplateSpec Source #

The specification of a pod template.

Constructors

PodTempalteSpec
Fields unPodTemplateSpec :: Value

Instances

Instances details

FromJSON PodTemplateSpec Source #
Instance details Defined in OM.Kubernetes Methods parseJSON :: Value -> Parser PodTemplateSpec # parseJSONList :: Value -> Parser [PodTemplateSpec] # omittedField :: Maybe PodTemplateSpec #
ToJSON PodTemplateSpec Source #
Instance details Defined in OM.Kubernetes Methods toJSON :: PodTemplateSpec -> Value # toEncoding :: PodTemplateSpec -> Encoding # toJSONList :: [PodTemplateSpec] -> Value # toEncodingList :: [PodTemplateSpec] -> Encoding # omitField :: PodTemplateSpec -> Bool #

newtype Pod Source #

Constructors

Pod
Fields unPod :: Value

Instances

Instances details

FromJSON Pod Source #
Instance details Defined in OM.Kubernetes Methods parseJSON :: Value -> Parser Pod # parseJSONList :: Value -> Parser [Pod] # omittedField :: Maybe Pod #
ToJSON Pod Source #
Instance details Defined in OM.Kubernetes Methods toJSON :: Pod -> Value # toEncoding :: Pod -> Encoding # toJSONList :: [Pod] -> Value # toEncodingList :: [Pod] -> Encoding # omitField :: Pod -> Bool #
Show Pod Source #
Instance details Defined in OM.Kubernetes Methods showsPrec :: Int -> Pod -> ShowS # show :: Pod -> String # showList :: [Pod] -> ShowS #