Safe Haskell	None
Language	Haskell2010

Kubernetes.Client.KubeConfig

Description

This module contains the definition of the data model of the kubeconfig.

The official definition of the kubeconfig is defined in https://github.com/kubernetes/client-go/blob/master/tools/clientcmd/api/v1/types.go.

This is a mostly straightforward translation into Haskell, with FromJSON and ToJSON instances defined.

Synopsis

camelToWithOverrides :: Char -> Map String String -> Options
data Config = Config {
- kind :: Maybe Text
- apiVersion :: Maybe Text
- preferences :: Maybe Preferences
- clusters :: [NamedEntity Cluster "cluster"]
- authInfos :: [NamedEntity AuthInfo "user"]
- contexts :: [NamedEntity Context "context"]
- currentContext :: Text
}
configJSONOptions :: Options
newtype Preferences = Preferences {
- colors :: Maybe Bool
}
data Cluster = Cluster {
- server :: Text
- insecureSkipTLSVerify :: Maybe Bool
- certificateAuthority :: Maybe Text
- certificateAuthorityData :: Maybe Text
}
data NamedEntity a (typeKey :: Symbol) = NamedEntity {
- name :: Text
- entity :: a
}
toMap :: [NamedEntity a s] -> Map Text a
data AuthInfo = AuthInfo {
- clientCertificate :: Maybe FilePath
- clientCertificateData :: Maybe Text
- clientKey :: Maybe FilePath
- clientKeyData :: Maybe Text
- token :: Maybe Text
- tokenFile :: Maybe FilePath
- impersonate :: Maybe Text
- impersonateGroups :: Maybe [Text]
- impersonateUserExtra :: Maybe (Map Text [Text])
- username :: Maybe Text
- password :: Maybe Text
- authProvider :: Maybe AuthProviderConfig
}
authInfoJSONOptions :: Options
data Context = Context {
- cluster :: Text
- authInfo :: Text
- namespace :: Maybe Text
}
contextJSONOptions :: Options
data AuthProviderConfig = AuthProviderConfig {
- name :: Text
- config :: Maybe (Map Text Text)
}
getContext :: Config -> Either String Context
getAuthInfo :: Config -> Either String (Text, AuthInfo)
getCluster :: Config -> Either String Cluster

Documentation

camelToWithOverrides :: Char -> Map String String -> Options Source #

data Config Source #

Represents a kubeconfig.

Constructors

Config
Fields kind :: Maybe Text apiVersion :: Maybe Text preferences :: Maybe Preferences clusters :: [NamedEntity Cluster "cluster"] authInfos :: [NamedEntity AuthInfo "user"] contexts :: [NamedEntity Context "context"] currentContext :: Text

Instances

Instances details

Eq Config Source #
Instance details Defined in Kubernetes.Client.KubeConfig Methods (==) :: Config -> Config -> Bool # (/=) :: Config -> Config -> Bool #
Show Config Source #
Instance details Defined in Kubernetes.Client.KubeConfig Methods showsPrec :: Int -> Config -> ShowS # show :: Config -> String # showList :: [Config] -> ShowS #
Generic Config Source #
Instance details Defined in Kubernetes.Client.KubeConfig Associated Types type Rep Config :: Type -> Type # Methods from :: Config -> Rep Config x # to :: Rep Config x -> Config #
ToJSON Config Source #
Instance details Defined in Kubernetes.Client.KubeConfig Methods toJSON :: Config -> Value # toEncoding :: Config -> Encoding # toJSONList :: [Config] -> Value # toEncodingList :: [Config] -> Encoding #
FromJSON Config Source #
Instance details Defined in Kubernetes.Client.KubeConfig Methods parseJSON :: Value -> Parser Config # parseJSONList :: Value -> Parser [Config] #
type Rep Config Source #
Instance details Defined in Kubernetes.Client.KubeConfig type Rep Config = D1 ('MetaData "Config" "Kubernetes.Client.KubeConfig" "kubernetes-client-0.3.2.0-BdfSu8KopF7nBe87u0bGe" 'False) (C1 ('MetaCons "Config" 'PrefixI 'True) ((S1 ('MetaSel ('Just "kind") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "apiVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "preferences") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Preferences)))) :: ((S1 ('MetaSel ('Just "clusters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [NamedEntity Cluster "cluster"]) :: S1 ('MetaSel ('Just "authInfos") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [NamedEntity AuthInfo "user"])) :: (S1 ('MetaSel ('Just "contexts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [NamedEntity Context "context"]) :: S1 ('MetaSel ('Just "currentContext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))))

configJSONOptions :: Options Source #

newtype Preferences Source #

Constructors

Preferences
Fields colors :: Maybe Bool

Instances

Instances details

Eq Preferences Source #
Instance details Defined in Kubernetes.Client.KubeConfig Methods (==) :: Preferences -> Preferences -> Bool # (/=) :: Preferences -> Preferences -> Bool #
Show Preferences Source #
Instance details Defined in Kubernetes.Client.KubeConfig Methods showsPrec :: Int -> Preferences -> ShowS # show :: Preferences -> String # showList :: [Preferences] -> ShowS #
Generic Preferences Source #
Instance details Defined in Kubernetes.Client.KubeConfig Associated Types type Rep Preferences :: Type -> Type # Methods from :: Preferences -> Rep Preferences x # to :: Rep Preferences x -> Preferences #
ToJSON Preferences Source #
Instance details Defined in Kubernetes.Client.KubeConfig Methods toJSON :: Preferences -> Value # toEncoding :: Preferences -> Encoding # toJSONList :: [Preferences] -> Value # toEncodingList :: [Preferences] -> Encoding #
FromJSON Preferences Source #
Instance details Defined in Kubernetes.Client.KubeConfig Methods parseJSON :: Value -> Parser Preferences # parseJSONList :: Value -> Parser [Preferences] #
type Rep Preferences Source #
Instance details Defined in Kubernetes.Client.KubeConfig type Rep Preferences = D1 ('MetaData "Preferences" "Kubernetes.Client.KubeConfig" "kubernetes-client-0.3.2.0-BdfSu8KopF7nBe87u0bGe" 'True) (C1 ('MetaCons "Preferences" 'PrefixI 'True) (S1 ('MetaSel ('Just "colors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))))

data Cluster Source #

Constructors

Cluster
Fields server :: Text insecureSkipTLSVerify :: Maybe Bool certificateAuthority :: Maybe Text certificateAuthorityData :: Maybe Text

Instances

Instances details

Eq Cluster Source #
Instance details Defined in Kubernetes.Client.KubeConfig Methods (==) :: Cluster -> Cluster -> Bool # (/=) :: Cluster -> Cluster -> Bool #
Show Cluster Source #
Instance details Defined in Kubernetes.Client.KubeConfig Methods showsPrec :: Int -> Cluster -> ShowS # show :: Cluster -> String # showList :: [Cluster] -> ShowS #
Generic Cluster Source #
Instance details Defined in Kubernetes.Client.KubeConfig Associated Types type Rep Cluster :: Type -> Type # Methods from :: Cluster -> Rep Cluster x # to :: Rep Cluster x -> Cluster #
ToJSON Cluster Source #
Instance details Defined in Kubernetes.Client.KubeConfig Methods toJSON :: Cluster -> Value # toEncoding :: Cluster -> Encoding # toJSONList :: [Cluster] -> Value # toEncodingList :: [Cluster] -> Encoding #
FromJSON Cluster Source #
Instance details Defined in Kubernetes.Client.KubeConfig Methods parseJSON :: Value -> Parser Cluster # parseJSONList :: Value -> Parser [Cluster] #
type Rep Cluster Source #
Instance details Defined in Kubernetes.Client.KubeConfig type Rep Cluster = D1 ('MetaData "Cluster" "Kubernetes.Client.KubeConfig" "kubernetes-client-0.3.2.0-BdfSu8KopF7nBe87u0bGe" 'False) (C1 ('MetaCons "Cluster" 'PrefixI 'True) ((S1 ('MetaSel ('Just "server") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "insecureSkipTLSVerify") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "certificateAuthority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "certificateAuthorityData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))))

data NamedEntity a (typeKey :: Symbol) Source #

Constructors

NamedEntity
Fields name :: Text entity :: a

Instances

Instances details

Eq a => Eq (NamedEntity a typeKey) Source #
Instance details Defined in Kubernetes.Client.KubeConfig Methods (==) :: NamedEntity a typeKey -> NamedEntity a typeKey -> Bool # (/=) :: NamedEntity a typeKey -> NamedEntity a typeKey -> Bool #
Show a => Show (NamedEntity a typeKey) Source #
Instance details Defined in Kubernetes.Client.KubeConfig Methods showsPrec :: Int -> NamedEntity a typeKey -> ShowS # show :: NamedEntity a typeKey -> String # showList :: [NamedEntity a typeKey] -> ShowS #
Generic (NamedEntity a typeKey) Source #
Instance details Defined in Kubernetes.Client.KubeConfig Associated Types type Rep (NamedEntity a typeKey) :: Type -> Type # Methods from :: NamedEntity a typeKey -> Rep (NamedEntity a typeKey) x # to :: Rep (NamedEntity a typeKey) x -> NamedEntity a typeKey #
(ToJSON a, KnownSymbol s) => ToJSON (NamedEntity a s) Source #
Instance details Defined in Kubernetes.Client.KubeConfig Methods toJSON :: NamedEntity a s -> Value # toEncoding :: NamedEntity a s -> Encoding # toJSONList :: [NamedEntity a s] -> Value # toEncodingList :: [NamedEntity a s] -> Encoding #
(FromJSON a, Typeable a, KnownSymbol s) => FromJSON (NamedEntity a s) Source #
Instance details Defined in Kubernetes.Client.KubeConfig Methods parseJSON :: Value -> Parser (NamedEntity a s) # parseJSONList :: Value -> Parser [NamedEntity a s] #
type Rep (NamedEntity a typeKey) Source #
Instance details Defined in Kubernetes.Client.KubeConfig type Rep (NamedEntity a typeKey) = D1 ('MetaData "NamedEntity" "Kubernetes.Client.KubeConfig" "kubernetes-client-0.3.2.0-BdfSu8KopF7nBe87u0bGe" 'False) (C1 ('MetaCons "NamedEntity" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "entity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)))

toMap :: [NamedEntity a s] -> Map Text a Source #

data AuthInfo Source #

Constructors

AuthInfo
Fields clientCertificate :: Maybe FilePath clientCertificateData :: Maybe Text clientKey :: Maybe FilePath clientKeyData :: Maybe Text token :: Maybe Text tokenFile :: Maybe FilePath impersonate :: Maybe Text impersonateGroups :: Maybe [Text] impersonateUserExtra :: Maybe (Map Text [Text]) username :: Maybe Text password :: Maybe Text authProvider :: Maybe AuthProviderConfig

Instances

Instances details

Eq AuthInfo Source #
Instance details Defined in Kubernetes.Client.KubeConfig Methods (==) :: AuthInfo -> AuthInfo -> Bool # (/=) :: AuthInfo -> AuthInfo -> Bool #
Show AuthInfo Source #
Instance details Defined in Kubernetes.Client.KubeConfig Methods showsPrec :: Int -> AuthInfo -> ShowS # show :: AuthInfo -> String # showList :: [AuthInfo] -> ShowS #
Generic AuthInfo Source #
Instance details Defined in Kubernetes.Client.KubeConfig Associated Types type Rep AuthInfo :: Type -> Type # Methods from :: AuthInfo -> Rep AuthInfo x # to :: Rep AuthInfo x -> AuthInfo #
ToJSON AuthInfo Source #
Instance details Defined in Kubernetes.Client.KubeConfig Methods toJSON :: AuthInfo -> Value # toEncoding :: AuthInfo -> Encoding # toJSONList :: [AuthInfo] -> Value # toEncodingList :: [AuthInfo] -> Encoding #
FromJSON AuthInfo Source #
Instance details Defined in Kubernetes.Client.KubeConfig Methods parseJSON :: Value -> Parser AuthInfo # parseJSONList :: Value -> Parser [AuthInfo] #
type Rep AuthInfo Source #
Instance details Defined in Kubernetes.Client.KubeConfig type Rep AuthInfo = D1 ('MetaData "AuthInfo" "Kubernetes.Client.KubeConfig" "kubernetes-client-0.3.2.0-BdfSu8KopF7nBe87u0bGe" 'False) (C1 ('MetaCons "AuthInfo" 'PrefixI 'True) (((S1 ('MetaSel ('Just "clientCertificate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FilePath)) :: (S1 ('MetaSel ('Just "clientCertificateData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "clientKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FilePath)))) :: (S1 ('MetaSel ('Just "clientKeyData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "token") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tokenFile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FilePath))))) :: ((S1 ('MetaSel ('Just "impersonate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "impersonateGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "impersonateUserExtra") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text [Text]))))) :: (S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "password") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "authProvider") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe AuthProviderConfig)))))))

authInfoJSONOptions :: Options Source #

data Context Source #

Constructors

Context
Fields cluster :: Text authInfo :: Text namespace :: Maybe Text

Instances

Instances details

Eq Context Source #
Instance details Defined in Kubernetes.Client.KubeConfig Methods (==) :: Context -> Context -> Bool # (/=) :: Context -> Context -> Bool #
Show Context Source #
Instance details Defined in Kubernetes.Client.KubeConfig Methods showsPrec :: Int -> Context -> ShowS # show :: Context -> String # showList :: [Context] -> ShowS #
Generic Context Source #
Instance details Defined in Kubernetes.Client.KubeConfig Associated Types type Rep Context :: Type -> Type # Methods from :: Context -> Rep Context x # to :: Rep Context x -> Context #
ToJSON Context Source #
Instance details Defined in Kubernetes.Client.KubeConfig Methods toJSON :: Context -> Value # toEncoding :: Context -> Encoding # toJSONList :: [Context] -> Value # toEncodingList :: [Context] -> Encoding #
FromJSON Context Source #
Instance details Defined in Kubernetes.Client.KubeConfig Methods parseJSON :: Value -> Parser Context # parseJSONList :: Value -> Parser [Context] #
type Rep Context Source #
Instance details Defined in Kubernetes.Client.KubeConfig type Rep Context = D1 ('MetaData "Context" "Kubernetes.Client.KubeConfig" "kubernetes-client-0.3.2.0-BdfSu8KopF7nBe87u0bGe" 'False) (C1 ('MetaCons "Context" 'PrefixI 'True) (S1 ('MetaSel ('Just "cluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: (S1 ('MetaSel ('Just "authInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))))

contextJSONOptions :: Options Source #

data AuthProviderConfig Source #

Constructors

AuthProviderConfig
Fields name :: Text config :: Maybe (Map Text Text)

Instances

Instances details

Eq AuthProviderConfig Source #
Instance details Defined in Kubernetes.Client.KubeConfig Methods (==) :: AuthProviderConfig -> AuthProviderConfig -> Bool # (/=) :: AuthProviderConfig -> AuthProviderConfig -> Bool #
Show AuthProviderConfig Source #
Instance details Defined in Kubernetes.Client.KubeConfig Methods showsPrec :: Int -> AuthProviderConfig -> ShowS # show :: AuthProviderConfig -> String # showList :: [AuthProviderConfig] -> ShowS #
Generic AuthProviderConfig Source #
Instance details Defined in Kubernetes.Client.KubeConfig Associated Types type Rep AuthProviderConfig :: Type -> Type # Methods from :: AuthProviderConfig -> Rep AuthProviderConfig x # to :: Rep AuthProviderConfig x -> AuthProviderConfig #
ToJSON AuthProviderConfig Source #
Instance details Defined in Kubernetes.Client.KubeConfig Methods toJSON :: AuthProviderConfig -> Value # toEncoding :: AuthProviderConfig -> Encoding # toJSONList :: [AuthProviderConfig] -> Value # toEncodingList :: [AuthProviderConfig] -> Encoding #
FromJSON AuthProviderConfig Source #
Instance details Defined in Kubernetes.Client.KubeConfig Methods parseJSON :: Value -> Parser AuthProviderConfig # parseJSONList :: Value -> Parser [AuthProviderConfig] #
type Rep AuthProviderConfig Source #
Instance details Defined in Kubernetes.Client.KubeConfig type Rep AuthProviderConfig = D1 ('MetaData "AuthProviderConfig" "Kubernetes.Client.KubeConfig" "kubernetes-client-0.3.2.0-BdfSu8KopF7nBe87u0bGe" 'False) (C1 ('MetaCons "AuthProviderConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "config") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text Text)))))

getContext :: Config -> Either String Context Source #

Returns the currently active context.

getAuthInfo :: Config -> Either String (Text, AuthInfo) Source #

Returns the currently active user.

getCluster :: Config -> Either String Cluster Source #

Returns the currently active cluster.