version

Documentation

Overview

+kubebuilder:object:generate=true

Index

• Variables
• type Version
  • func MustNewVersionFromString(v string) *Version
  • func NewVersionFromString(v string) (*Version, error)
  • func (in *Version) DeepCopy() *Version
  • func (in *Version) DeepCopyInto(out *Version)
  • func (v *Version) GreaterOrEqual(compare *Version) bool
  • func (v Version) MarshalJSON() ([]byte, error)
  • func (Version) OpenAPISchemaFormat() string
  • func (Version) OpenAPISchemaType() []string
  • func (v *Version) ToUnstructured() any
  • func (v *Version) UnmarshalJSON(b []byte) error
  • func (v *Version) UpgradeConstraint() (*semver.Constraints, error)
  • func (v *Version) Validate() error

Variables

var (
	// SupportedVersionsRange holds all supported temporal versions.
	SupportedVersionsRange = mustNewConstraint(">= 1.14.0 < 1.21.0")
	V1_18_0                = MustNewVersionFromString("1.18.0") //nolint:stylecheck,revive
	V1_20_0                = MustNewVersionFromString("1.20.0") //nolint:stylecheck,revive
)

Types

type Version

type Version struct {
	*semver.Version
}

Version is a wrapper around semver.Version which supports correct marshaling to YAML and JSON. In particular, it marshals into strings. +kubebuilder:validation:Type=string

func MustNewVersionFromString

func MustNewVersionFromString(v string) *Version

func NewVersionFromString

func NewVersionFromString(v string) (*Version, error)

func (*Version) DeepCopy

func (in *Version) DeepCopy() *Version

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Version.

func (*Version) DeepCopyInto

func (in *Version) DeepCopyInto(out *Version)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Version) GreaterOrEqual

func (v *Version) GreaterOrEqual(compare *Version) bool

GreaterOrEqual returns whenever version is greater or equal than the provided version.

func (Version) MarshalJSON

func (v Version) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface.

func (Version) OpenAPISchemaFormat

func (Version) OpenAPISchemaFormat() string

OpenAPISchemaFormat is used by the kube-openapi generator when constructing the OpenAPI spec of this type.

func (Version) OpenAPISchemaType

func (Version) OpenAPISchemaType() []string

OpenAPISchemaType is used by the kube-openapi generator when constructing the OpenAPI spec of this type.

See: https://github.com/kubernetes/kube-openapi/tree/master/pkg/generators

func (*Version) ToUnstructured

func (v *Version) ToUnstructured() any

ToUnstructured implements the value.UnstructuredConverter interface.

func (*Version) UnmarshalJSON

func (v *Version) UnmarshalJSON(b []byte) error

UnmarshalJSON implements the json.Unmarshaller interface.

func (*Version) UpgradeConstraint

func (v *Version) UpgradeConstraint() (*semver.Constraints, error)

UpgradeConstraint returns the Temporal Server upgrade constraint. Users should upgrade Temporal Server sequentially. The returned constraint ensures that, we're could only upgrade to upgrade from v1.n.x to v1.n+1.x.

func (*Version) Validate

func (v *Version) Validate() error

Validate checks if the current version is in the supported temporal cluster version range.