View Source K8s.Discovery.ResourceFinder (k8s v2.4.2)

Kubernetes API Groups

Summary

Types

error_t()

Functions

find_resource(conn, api_version, name_or_kind)

Finds a resource definition by api version and (name or kind).

resource_name_for_kind(conn, api_version, name_or_kind)

Get the REST resource name for a kubernetes Kind.

Types

Link to this type

error_t()

View Source 
@type error_t() :: {:error, K8s.Discovery.Error.t()}

Functions

Link to this function

find_resource(conn, api_version, name_or_kind)

View Source 
@spec find_resource(K8s.Conn.t(), binary(), atom() | binary()) ::
  {:ok, map()} | error_t()

Finds a resource definition by api version and (name or kind).

Link to this function

resource_name_for_kind(conn, api_version, name_or_kind)

View Source 
@spec resource_name_for_kind(K8s.Conn.t(), binary(), binary()) ::
  {:ok, binary()} | error_t()

Get the REST resource name for a kubernetes Kind.

Since K8s.Operation is abstracted away from a specific cluster, when working with kubernetes resource Maps and specifying "kind" the K8s.Operation.Path module isn't able to determine the correct path. (It will generate things like /api/v1/Pod instead of api/v1/pods).

Also accepts REST resource name in the event they are provided, as it may be known in the event of subresources.