Better names for kube config making functions

Author: akshaymankar

kubernetes-client/README.md

@@ -6,7 +6,7 @@
 
 ```haskell
 import Control.Concurrent.STM (atomically, newTVar)
-import Kubernetes.Client      (KubeConfigSource (..), kubeClient)
+import Kubernetes.Client      (KubeConfigSource (..), mkKubeClientConfig)
 import Kubernetes.OpenAPI     (Accept (..), MimeJSON (..), dispatchMime)
 
 import qualified Data.Map                      as Map
@@ -15,7 +15,7 @@ import qualified Kubernetes.OpenAPI.API.CoreV1 as CoreV1
 main :: IO ()
 main = do
     oidcCache <- atomically $ newTVar $ Map.fromList []
-    (mgr, kcfg) <- kubeClient oidcCache $ KubeConfigFile "/path/to/kubeconfig"
+    (mgr, kcfg) <- mkKubeClientConfig oidcCache $ KubeConfigFile "/path/to/kubeconfig"
     dispatchMime
             mgr
             kcfg
@@ -28,7 +28,7 @@ main = do
 ```haskell
 import Control.Concurrent.STM (atomically, newTVar)
 import Data.Function          ((&))
-import Kubernetes.Client      (KubeConfigSource (..), kubeClient)
+import Kubernetes.Client      (KubeConfigSource (..), mkKubeClientConfig)
 import Kubernetes.OpenAPI     (Accept (..), MimeJSON (..), dispatchMime)
 import Network.TLS            (credentialLoadX509)
 
@@ -38,7 +38,7 @@ import qualified Kubernetes.OpenAPI.API.CoreV1 as CoreV1
 main :: IO ()
 main = do
     oidcCache <- atomically $ newTVar $ Map.fromList []
-    (mgr, kcfg) <- kubeClient oidcCache KubeConfigCluster
+    (mgr, kcfg) <- mkKubeClientConfig oidcCache KubeConfigCluster
     dispatchMime
             mgr
             kcfg

kubernetes-client/example/App.hs

@@ -7,7 +7,7 @@ import Data.Function          ((&))
 import Kubernetes.Client      (KubeConfigSource (..), defaultTLSClientParams,
                                disableServerCertValidation,
                                disableServerNameValidation,
-                               disableValidateAuthMethods, kubeClient,
+                               disableValidateAuthMethods, mkKubeClientConfig,
                                loadPEMCerts, newManager, setCAStore,
                                setClientCert, setMasterURI, setTokenAuth)
 import Kubernetes.OpenAPI     (Accept (..), MimeJSON (..), dispatchMime,
@@ -47,7 +47,7 @@ example = do
 exampleWithKubeConfig :: IO ()
 exampleWithKubeConfig = do
     oidcCache <- atomically $ newTVar $ Map.fromList []
-    (mgr, kcfg) <- kubeClient oidcCache $ KubeConfigFile "/path/to/kubeconfig"
+    (mgr, kcfg) <- mkKubeClientConfig oidcCache $ KubeConfigFile "/path/to/kubeconfig"
     dispatchMime
             mgr
             kcfg
@@ -57,7 +57,7 @@ exampleWithKubeConfig = do
 exampleWithInClusterConfig :: IO ()
 exampleWithInClusterConfig = do
     oidcCache <- atomically $ newTVar $ Map.fromList []
-    (mgr, kcfg) <- kubeClient oidcCache KubeConfigCluster
+    (mgr, kcfg) <- mkKubeClientConfig oidcCache KubeConfigCluster
     dispatchMime
             mgr
             kcfg

kubernetes-client/src/Kubernetes/Client/Config.hs

@@ -6,13 +6,13 @@ module Kubernetes.Client.Config
   , addCACertFile
   , applyAuthSettings
   , clientHooksL
-  , Kubernetes.Client.Config.cluster
   , defaultTLSClientParams
   , disableServerCertValidation
   , disableServerNameValidation
   , disableValidateAuthMethods
-  , kubeClient
   , loadPEMCerts
+  , mkInClusterClientConfig
+  , mkKubeClientConfig
   , newManager
   , onCertificateRequestL
   , onServerCertificateL
@@ -63,11 +63,11 @@ data KubeConfigSource = KubeConfigFile FilePath
   across an application share an 'OIDCCache', this makes sure updation of OAuth
   token is synchronized across all the different clients being used.
 -}
-kubeClient
+mkKubeClientConfig
   :: OIDCCache
   -> KubeConfigSource
   -> IO (NH.Manager, K.KubernetesClientConfig)
-kubeClient oidcCache (KubeConfigFile f) = do
+mkKubeClientConfig oidcCache (KubeConfigFile f) = do
   kubeConfigFile <- decodeFileThrow f
   masterURI <- getCluster kubeConfigFile
          & fmap server
@@ -83,11 +83,11 @@ kubeClient oidcCache (KubeConfigFile f) = do
       Right (_, auth) -> applyAuthSettings oidcCache auth (tlsParams, clientConfig)
   mgr <- newManager tlsParamsWithAuth
   return (mgr, clientConfigWithAuth)
-kubeClient _ (KubeConfigCluster) = Kubernetes.Client.Config.cluster
+mkKubeClientConfig _ (KubeConfigCluster) = mkInClusterClientConfig
 
 -- |Creates 'NH.Manager' and 'K.KubernetesClientConfig' assuming it is being executed in a pod
-cluster :: (MonadIO m, MonadThrow m) => m (NH.Manager, K.KubernetesClientConfig)
-cluster = do
+mkInClusterClientConfig :: (MonadIO m, MonadThrow m) => m (NH.Manager, K.KubernetesClientConfig)
+mkInClusterClientConfig = do
   caStore <- loadPEMCerts $ serviceAccountDir ++ "/ca.crt"
   defTlsParams <- liftIO defaultTLSClientParams
   mgr <- liftIO . newManager . setCAStore caStore $ disableServerNameValidation defTlsParams