Kubernetes.Client.Config

Documentation

data KubeConfigSource

Constructors

KubeConfigFile FilePath

KubeConfigCluster

addCACertData :: MonadThrow m => Config -> ClientParams -> m ClientParams

addCACertFile :: Config -> FilePath -> ClientParams -> IO ClientParams

applyAuthSettings :: OIDCCache -> AuthInfo -> (ClientParams, KubernetesClientConfig) -> IO (ClientParams, KubernetesClientConfig)

clientHooksL :: Lens' ClientParams ClientHooks

defaultTLSClientParams :: IO ClientParams

Default TLS settings using the system CA store.

disableServerCertValidation :: ClientParams -> ClientParams

Insecure mode. The client will not validate the server cert at all.

disableServerNameValidation :: ClientParams -> ClientParams

Don't check whether the cert presented by the server matches the name of the server you are connecting to. This is necessary if you specify the server host by its IP address.

disableValidateAuthMethods :: KubernetesClientConfig -> KubernetesClientConfig

Disables the client-side auth methods validation. This is necessary if you are using client cert authentication.

loadPEMCerts :: (MonadIO m, MonadThrow m) => FilePath -> m [SignedCertificate]

Loads certificates from a PEM-encoded file.

mkInClusterClientConfig :: (MonadIO m, MonadThrow m) => m (Manager, KubernetesClientConfig)

Creates Manager and KubernetesClientConfig assuming it is being executed in a pod

mkKubeClientConfig :: OIDCCache -> KubeConfigSource -> IO (Manager, KubernetesClientConfig)

Creates Manager and KubernetesClientConfig for a given KubeConfigSource. It is recommended that multiple kubeClient invocations across an application share an OIDCCache, this makes sure updation of OAuth token is synchronized across all the different clients being used.

newManager :: ClientParams -> IO Manager

Creates a Manager that can handle TLS.

onCertificateRequestL :: Lens' ClientParams (([CertificateType], Maybe [HashAndSignatureAlgorithm], [DistinguishedName]) -> IO (Maybe (CertificateChain, PrivKey)))

onServerCertificateL :: Lens' ClientParams (CertificateStore -> ValidationCache -> ServiceID -> CertificateChain -> IO [FailedReason])

parsePEMCerts :: ByteString -> Either ParseCertException [SignedCertificate]

Parses a PEM-encoded ByteString into a list of certificates.

serviceAccountDir :: FilePath

setCAStore :: [SignedCertificate] -> ClientParams -> ClientParams

Use a custom CA store.

setClientCert :: Credential -> ClientParams -> ClientParams

Use a client cert for authentication.

setMasterURI

Arguments

:: Text

Master URI

-> KubernetesClientConfig

-> KubernetesClientConfig

Sets the master URI in the KubernetesClientConfig.

setTokenAuth

Arguments

:: Text

Authentication token

-> KubernetesClientConfig

-> KubernetesClientConfig

Configures the KubernetesClientConfig to use token authentication.

tlsValidation :: Config -> ClientParams -> ClientParams