api

package
v3.6.37-1+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 18, 2017 License: Apache-2.0 Imports: 21 Imported by: 0

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

View Source
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

View Source
const (
	LegacyPrefix = "/osapi"
	Prefix       = "/oapi"
	GroupPrefix  = "/apis"
	GroupName    = ""
)

Variables

View Source
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 added in v1.1.3

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 added in v1.1.3

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 added in v1.0.8

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 added in v0.6.1

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 added in v1.5.0

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 added in v1.1.2

func Kind(kind string) unversioned.GroupKind

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

func ListOptionsToSelectors added in v1.1.2

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

func Resource added in v1.1.2

func Resource(resource string) unversioned.GroupResource

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

Types

This section is empty.

Directories

Path Synopsis
Package latest defines the default output serializations that code should use and imports the required schemas.
Package latest defines the default output serializations that code should use and imports the required schemas.
Package v1 is the v1 version of the API.
Package v1 is the v1 version of the API.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL