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

• Variables
• 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 *unversioned.ListOptions) (labels.Selector, fields.Selector)
• func MinimalNameRequirements(name string, prefix bool) (bool, string)
• func Resource(resource string) unversioned.GroupResource

Variables

var Codec = runtime.CodecFor(api.Scheme, SchemeGroupVersion.String())

Codec is the identity codec for this package - it can only convert itself to itself.

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

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

var SchemeGroupVersion = unversioned.GroupVersion{Group: "", Version: ""}

SchemeGroupVersion is group version used to register these objects

Functions

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 *unversioned.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