com.coralogix.zio.k8s.client.config
Contains data structures, ZIO layers and zio-config descriptors for configuring the zio-k8s client.
Each zio-k8s client module depends on two ZIO modules:
com.coralogix.zio.k8s.client.model.K8sCluster and an sttp.client3.SttpBackend. To use
the default configuration (use kubeconfig if available, otherwise fallback to service account
token), use either asynchttpclient.k8sDefault or httpclient.k8sDefault depending on your
chosen sttp backend.
Manual configuration is possible by providing a K8sClusterConfig value to both the
k8sCluster layer and either asynchttpclient.k8sSttpClient or httpclient.k8sSttpClient.
Instead of manually providing the configuration, zio-config descriptors are available to load them from any supported source.
Type members
Classlikes
Defines ZIO Config descriptors for all the configuration data types of zio-k8s
Defines ZIO Config descriptors for all the configuration data types of zio-k8s
Type of authentication to use with the Kubernetes cluster
Type of authentication to use with the Kubernetes cluster
- Companion:
- object
Configuration for the HTTP connection towards the Kubernetes API
Configuration for the HTTP connection towards the Kubernetes API
- Value parameters:
- debug
Enables detailed debug logging
- serverCertificate
The server certificate to use
Configures the zio-k8s client
Configures the zio-k8s client
This is the top level configuration class.
- Value parameters:
- authentication
Authentication method to use
- client
HTTP client configuration
- host
URL of the Kubernetes API
Configured Kubernetes server certifications
Configured Kubernetes server certifications
K8sServerCertificate.Insecure should only be used for testing purposes.
- Companion:
- object
- Companion:
- object
Value members
Concrete methods
Layer producing a K8sClusterConfig by loading a kubeconfig file
Layer producing a K8sClusterConfig by loading a kubeconfig file
If the KUBECONFIG environment variable is set, that will be used as the kubeconfig file's path, otherwise ~/.kube/config based on the current user's home directory.
To use a specific kubeconfig file path, use kubeconfigFile.
- Value parameters:
- context
Override the current context in the configuration file and use another one
- debug
Enable debug request/response logging
- disableHostnameVerification
Disables hostname verification on the SSL connection
Layer setting up a com.coralogix.zio.k8s.client.model.K8sCluster by loading a specific kubeconfig file
Layer setting up a com.coralogix.zio.k8s.client.model.K8sCluster by loading a specific kubeconfig file
- Value parameters:
- configPath
Path to the kubeconfig file to load
- context
Override the current context in the configuration file and use another one
- debug
Enable debug request/response logging
- disableHostnameVerification
Disables hostname verification on the SSL connection
Layer producing a K8sClusterConfig using the default service account when running from inside a pod.
Layer producing a K8sClusterConfig using the default service account when running from inside a pod.
- Value parameters:
- debug
Enable debug request/response logging
Concrete fields
Layer producing a K8sClusterConfig that first tries to load a kubeconfig and if it cannot find one fallbacks to using the default service account token.
Layer producing a K8sClusterConfig that first tries to load a kubeconfig and if it cannot find one fallbacks to using the default service account token.
For more customization see kubeconfig and serviceAccount or provide a K8sClusterConfig manually.
Layer producing a com.coralogix.zio.k8s.client.model.K8sCluster from a provided K8sClusterConfig
Layer producing a com.coralogix.zio.k8s.client.model.K8sCluster from a provided K8sClusterConfig
This can be used to either set up from a configuration source with zio-config or provide the hostname and token programmatically for the Kubernetes client.
Inherited fields
ZIO Config descriptor for K8sClusterConfig
ZIO Config descriptor for K8sClusterConfig
- Inherited from:
- Descriptors