K8s.Conn (k8s v1.0.0-rc1) View Source

Handles authentication and connection configuration details for a Kubernetes cluster.

Link to this section Summary

Types

t()

cluster_name - The cluster name if read from a kubeconfig file
user_name - The user name if read from a kubeconfig file
url - The Kubernetes API URL

Functions

from_file(config_file, opts \\ [])

Reads configuration details from a kubernetes config file.

from_service_account()

Generates configuration from kubernetes service account.

from_service_account(service_account_path)

Link to this section Types

t()

Specs

t() :: %K8s.Conn{
  auth: auth_t(),
  ca_cert: String.t() | nil,
  cluster_name: String.t() | nil,
  discovery_driver: module(),
  discovery_opts: Keyword.t(),
  http_provider: module(),
  insecure_skip_tls_verify: boolean(),
  middleware: K8s.Middleware.Stack.t(),
  url: String.t(),
  user_name: String.t() | nil
}

cluster_name - The cluster name if read from a kubeconfig file
user_name - The user name if read from a kubeconfig file
url - The Kubernetes API URL

Link to this section Functions

from_file(config_file, opts \\ [])

Specs

from_file(binary(), keyword()) :: {:ok, t()} | {:error, atom()}

Reads configuration details from a kubernetes config file.

Defaults to current-context.

Options

context sets an alternate context
cluster set or override the cluster read from the context
user set or override the user read from the context
discovery_driver module name to use for discovery
discovery_opts options for discovery module

from_service_account()

Specs

from_service_account() :: {:ok, t()} | {:error, atom()}

Generates configuration from kubernetes service account.

Links

kubernetes.io :: Accessing the API from a Pod

from_service_account(service_account_path)

Specs

from_service_account(String.t()) :: {:ok, t()} | {:error, atom()}