api

Documentation

Overview

Package api includes all OpenShift-specific types used to communicate between the various parts of the OpenShift and the Kubernetes systems.

Unlike the upstream Kubernetes, API objects in OpenShift are separated into individual packages.

Index

• Constants
• Variables
• func Convert_runtime_Object_To_runtime_RawExtension(in runtime.Object, out *runtime.RawExtension, s conversion.Scope) error
• func Convert_runtime_RawExtension_To_runtime_Object(in *runtime.RawExtension, out runtime.Object, s conversion.Scope) error
• func GetFieldLabelConversionFunc(supportedLabels map[string]string, overrideLabels map[string]string) func(label, value string) (string, string, error)
• func GetNameValidationFunc(nameFunc validation.ValidateNameFunc) validation.ValidateNameFunc
• func Kind(kind string) unversioned.GroupKind
• func ListOptionsToSelectors(options *kapi.ListOptions) (labels.Selector, fields.Selector)
• func MinimalNameRequirements(name string, prefix bool) (bool, string)
• func Resource(resource string) unversioned.GroupResource

Constants

const GroupName = ""

Variables

var NameMayNotBe = []string{".", ".."}

var NameMayNotContain = []string{"/", "%"}

var SchemeGroupVersion = unversioned.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal}

SchemeGroupVersion is group version used to register these objects

Functions

func Convert_runtime_Object_To_runtime_RawExtension

func Convert_runtime_Object_To_runtime_RawExtension(in runtime.Object, out *runtime.RawExtension, s conversion.Scope) error

Convert_runtime_Object_To_runtime_RawExtension is conversion function that assumes that the runtime.Object you've embedded is in the same GroupVersion that your containing type is in. This is signficantly better than simply breaking. Given an ordered list of preferred external versions for a given encode or conversion call, the behavior of this function could be made generic, predictable, and controllable.

func Convert_runtime_RawExtension_To_runtime_Object

func Convert_runtime_RawExtension_To_runtime_Object(in *runtime.RawExtension, out runtime.Object, s conversion.Scope) error

Convert_runtime_RawExtension_To_runtime_Object well, this is the reason why there was runtime.Embedded. The `out` here is hopeless. The caller doesn't know the type ahead of time and that means this method can't communicate the return value. This sucks really badly. I'm going to set the `in.Object` field can have callers to this function do magic to pull it back out. I'm also going to bitch about it.

func GetFieldLabelConversionFunc

func GetFieldLabelConversionFunc(supportedLabels map[string]string, overrideLabels map[string]string) func(label, value string) (string, string, error)

GetFieldLabelConversionFunc returns a field label conversion func, which does the following: * returns overrideLabels[label], value, nil if the specified label exists in the overrideLabels map * returns label, value, nil if the specified label exists as a key in the supportedLabels map (values in this map are unused, it is intended to be a prototypical label/value map) * otherwise, returns an error

func GetNameValidationFunc

func GetNameValidationFunc(nameFunc validation.ValidateNameFunc) validation.ValidateNameFunc

GetNameValidationFunc returns a name validation function that includes the standard restrictions we want for all types

func Kind

func Kind(kind string) unversioned.GroupKind

Kind takes an unqualified kind and returns back a Group qualified GroupKind

func ListOptionsToSelectors

func ListOptionsToSelectors(options *kapi.ListOptions) (labels.Selector, fields.Selector)

func MinimalNameRequirements

func MinimalNameRequirements(name string, prefix bool) (bool, string)

func Resource

func Resource(resource string) unversioned.GroupResource

Resource takes an unqualified resource and returns back a Group qualified GroupResource