latest

Documentation

Overview

Package latest defines the default output serializations that code should use and imports the required schemas. It also ensures all previously known and supported API versions are available for conversion. Consumers may import this package in lieu of importing individual versions.

Index

• Constants
• Variables
• func InterfacesFor(version string) (*kmeta.VersionInterfaces, error)
• func OriginKind(kind, apiVersion string) bool

Constants

const OldestVersion = "v1beta3"

OldestVersion is the string that represents the oldest server version supported, for client code that wants to hardcode the lowest common denominator.

const Version = "v1"

Version is the string that represents the current external default version.

Variables

var Codec = v1beta3.Codec

Codec is the default codec for serializing output that should use the latest supported version. Use this Codec when writing to disk, a data store that is not dynamically versioned, or in tests. This codec can decode any object that OpenShift is aware of.

var RESTMapper kmeta.RESTMapper

RESTMapper provides the default mapping between REST paths and the objects declared in api.Scheme and all known Kubernetes versions.

var ResourceVersioner runtime.ResourceVersioner = accessor

ResourceVersioner describes a default versioner that can handle all types of versioning. TODO: when versioning changes, make this part of each API definition.

var SelfLinker runtime.SelfLinker = accessor

SelfLinker can set or get the SelfLink field of all API types. TODO: when versioning changes, make this part of each API definition. TODO(lavalamp): Combine SelfLinker & ResourceVersioner interfaces, force all uses to go through the InterfacesFor method below.

var UserResources = []string{
	"buildConfigs", "builds",
	"imageStreams",
	"deploymentConfigs", "replicationControllers",
	"routes", "services",
	"pods",
}

UserResources are the resource names that apply to the primary, user facing resources used by client tools. They are in deletion-first order - dependent resources should be last.

var Versions = []string{"v1", "v1beta3"}

Versions is the list of versions that are recognized in code. The order provided may be assumed to be least feature rich to most feature rich, and clients may choose to prefer the latter items in the list over the former items when presented with a set of versions to choose.

Functions

func InterfacesFor

func InterfacesFor(version string) (*kmeta.VersionInterfaces, error)

InterfacesFor returns the default Codec and ResourceVersioner for a given version string, or an error if the version is not known.

func OriginKind

func OriginKind(kind, apiVersion string) bool

OriginKind returns true if OpenShift owns the kind described in a given apiVersion.