k8s v0.3.2 K8s.Resource.FieldAccessors
Helper functions for accessing common fields
Link to this section Summary
Functions
Returns the value of a k8s resource's annotation.
Returns the annotations of k8s resource.
Returns the apiVersion of k8s resource.
Check if an annotation is present.
Check if a label is present.
Returns the kind of k8s resource.
Returns the value of a k8s resource's label.
Returns the labels of k8s resource.
Returns the metadata of k8s resource.
Returns the name of k8s resource.
Returns the namespace of k8s resource.
Link to this section Functions
annotation(resource, name)
Returns the value of a k8s resource's annotation.
Examples
iex> K8s.Resource.FieldAccessors.annotation(%{"metadata" => %{"annotations" => %{"env" => "test"}}}, "env")
"test"
annotations(resource)
Returns the annotations of k8s resource.
Examples
iex> K8s.Resource.FieldAccessors.annotations(%{"metadata" => %{"annotations" => %{"env" => "test"}}})
%{"env" => "test"}
api_version(resource)
Returns the apiVersion of k8s resource.
Examples
iex> K8s.Resource.FieldAccessors.api_version(%{"apiVersion" => "apps/v1"})
"apps/v1"
has_annotation?(resource, name)
Check if an annotation is present.
Examples
iex> K8s.Resource.FieldAccessors.has_annotation?(%{"metadata" => %{"annotations" => %{"env" => "test"}}}, "env")
true
iex> K8s.Resource.FieldAccessors.has_annotation?(%{"metadata" => %{"annotations" => %{"env" => "test"}}}, "foo")
false
has_label?(resource, name)
Check if a label is present.
Examples
iex> K8s.Resource.FieldAccessors.has_label?(%{"metadata" => %{"labels" => %{"env" => "test"}}}, "env")
true
iex> K8s.Resource.FieldAccessors.has_label?(%{"metadata" => %{"labels" => %{"env" => "test"}}}, "foo")
false
kind(resource)
Returns the kind of k8s resource.
Examples
iex> K8s.Resource.FieldAccessors.kind(%{"kind" => "Deployment"})
"Deployment"
label(resource, name)
Returns the value of a k8s resource's label.
Examples
iex> K8s.Resource.FieldAccessors.label(%{"metadata" => %{"labels" => %{"env" => "test"}}}, "env")
"test"
labels(resource)
Returns the labels of k8s resource.
Examples
iex> K8s.Resource.FieldAccessors.labels(%{"metadata" => %{"labels" => %{"env" => "test"}}})
%{"env" => "test"}
metadata(resource)
Returns the metadata of k8s resource.
Examples
iex> K8s.Resource.FieldAccessors.metadata(%{"metadata" => %{"name" => "nginx", "namespace" => "foo"}})
%{"name" => "nginx", "namespace" => "foo"}
name(resource)
Returns the name of k8s resource.
Examples
iex> K8s.Resource.FieldAccessors.name(%{"metadata" => %{"name" => "nginx", "namespace" => "foo"}})
"nginx"
namespace(resource)
Returns the namespace of k8s resource.
Examples
iex> K8s.Resource.FieldAccessors.namespace(%{"metadata" => %{"name" => "nginx", "namespace" => "foo"}})
"foo"