@spec alpha([binary()]) :: [t()]

Returns only alpha versions

Examples

iex> K8s.Version.alpha(["v1alpha1", "v1", "v2beta1"])
[%K8s.Version{major: 1, minor: "alpha", patch: 1}]

@spec beta([binary()]) :: [t()]

Returns only beta versions

Examples

iex> K8s.Version.beta(["v1alpha1", "v1", "v2beta1"])
[%K8s.Version{major: 2, minor: "beta", patch: 1}]

@spec edge([binary()]) :: [t()]

Retuns all non-stable versions

Examples

iex> K8s.Version.edge(["v1alpha1", "v1", "v2beta1"])
[%K8s.Version{major: 1, minor: "alpha", patch: 1}, %K8s.Version{major: 2, minor: "beta", patch: 1}]

@spec parse(binary()) :: t()

Parses a Kubernetes API version into a K8s.Version struct

Examples

iex> K8s.Version.parse("v1")
%K8s.Version{major: 1, minor: "stable", patch: nil}

iex> K8s.Version.parse("v1beta2")
%K8s.Version{major: 1, minor: "beta", patch: 2}

iex> K8s.Version.parse("v1alpha1")
%K8s.Version{major: 1, minor: "alpha", patch: 1}

@spec recommended([binary()]) :: binary()

Returns the recommended version from a list of versions.

It will return the most stable version if any, otherwise the newest "edge" version.

Examples

iex> K8s.Version.recommended(["v1beta1", "v1", "v2"])
"v2"

iex> K8s.Version.recommended(["v1beta1", "v1"])
"v1"

iex> K8s.Version.recommended(["v1beta2", "v1beta1"])
"v1beta2"

iex> K8s.Version.recommended(["v1alpha1", "v1alpha2", "v1beta1"])
"v1beta1"

@spec serialize(t()) :: binary()

Returns only stable versions

Examples

iex> K8s.Version.serialize(%K8s.Version{major: 1, minor: "stable", patch: nil})
"v1"

iex> K8s.Version.serialize(%K8s.Version{major: 1, minor: "beta", patch: 1})
"v1beta1"

iex> K8s.Version.serialize(%K8s.Version{major: 1, minor: "alpha", patch: 1})
"v1alpha1"

@spec sort([t()]) :: [t()]

Sorts a list of K8s.Versions

Examples

iex> raw_versions = Enum.shuffle(["v1", "v2beta1", "v2", "v1alpha1", "v1alpha2"])
iex> versions = raw_versions |> Enum.map(&(K8s.Version.parse(&1)))
iex> sorted_versions = versions |> K8s.Version.sort()
iex> sorted_versions |> Enum.map(&(K8s.Version.serialize(&1)))
["v2", "v1", "v2beta1", "v1alpha2", "v1alpha1"]

@spec stable([binary()]) :: [t()]

Returns only stable versions

Examples

iex> K8s.Version.stable(["v1alpha1", "v1", "v2beta1"])
[%K8s.Version{major: 1, minor: "stable", patch: nil}]