version

Documentation

Index

• func DeserializeFromMetadata(meta *metav1.ObjectMeta, to interface{}, key string) error
• func SerializeToMetadata(meta *metav1.ObjectMeta, field interface{}, key string) error
• func ValidateEnabledAPIFields(ctx context.Context, featureName string, wantVersion string) *apis.FieldError

Functions

func DeserializeFromMetadata

func DeserializeFromMetadata(meta *metav1.ObjectMeta, to interface{}, key string) error

DeserializeFromMetadata takes the value of the input key from the metadata's annotations, deserializes it into "to", and removes the key from the metadata's annotations. Returns nil if the key is not present in the annotations.

func SerializeToMetadata

func SerializeToMetadata(meta *metav1.ObjectMeta, field interface{}, key string) error

SerializeToMetadata serializes the input field and adds it as an annotation to the metadata under the input key.

func ValidateEnabledAPIFields

func ValidateEnabledAPIFields(ctx context.Context, featureName string, wantVersion string) *apis.FieldError

ValidateEnabledAPIFields checks that the enable-api-fields feature gate is set to a version at most as stable as wantVersion, if not, returns an error stating which feature is dependent on the version and what the current version actually is.