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 GetResourceKey(obj kapi.ObjectMeta) string
• func Kind(kind string) unversioned.GroupKind
• func ListOptionsToSelectors(options *kapi.ListOptions) (labels.Selector, fields.Selector)
• func Resource(resource string) unversioned.GroupResource

Constants

const (
	// OpenShiftDisplayName is a common, optional annotation that stores the name displayed by a UI when referencing a resource.
	OpenShiftDisplayName = "openshift.io/display-name"

	// OpenShiftDescription is a common, optional annotation that stores the description for a resource.
	OpenShiftDescription = "openshift.io/description"
)

annotation keys

const (
	LegacyPrefix = "/osapi" // TODO: make configurable
	Prefix       = "/oapi"  // TODO: make configurable
	GroupName    = ""
)

Variables

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 ensures an object is converted to the destination version of the conversion.

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 ensures an object is converted to the destination version of the conversion.

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 GetResourceKey

func GetResourceKey(obj kapi.ObjectMeta) string

GetResourceKey returns a string of the form [namespace]/[name] for the given resource. This is a common way of ensuring a key for a resource that is unique across the cluster.

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 Resource

func Resource(resource string) unversioned.GroupResource

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