api

Documentation

Overview

+groupName=project.openshift.io Package api is the internal version of the API.

Index

• Constants
• Variables
• func DeepCopy_api_Project(in interface{}, out interface{}, c *conversion.Cloner) error
• func DeepCopy_api_ProjectList(in interface{}, out interface{}, c *conversion.Cloner) error
• func DeepCopy_api_ProjectRequest(in interface{}, out interface{}, c *conversion.Cloner) error
• func DeepCopy_api_ProjectSpec(in interface{}, out interface{}, c *conversion.Cloner) error
• func DeepCopy_api_ProjectStatus(in interface{}, out interface{}, c *conversion.Cloner) error
• func IsKindOrLegacy(kind string, gk schema.GroupKind) bool
• func IsResourceOrLegacy(resource string, gr schema.GroupResource) bool
• func Kind(kind string) schema.GroupKind
• func LegacyKind(kind string) schema.GroupKind
• func LegacyResource(resource string) schema.GroupResource
• func RegisterDeepCopies(scheme *runtime.Scheme) error
• func Resource(resource string) schema.GroupResource
• type Project
• type ProjectList
• type ProjectRequest
• type ProjectSpec
• type ProjectStatus

Constants

const (
	GroupName       = "project.openshift.io"
	LegacyGroupName = ""
)

const (
	// ProjectNodeSelector is an annotation that holds the node selector;
	// the node selector annotation determines which nodes will have pods from this project scheduled to them
	ProjectNodeSelector = "openshift.io/node-selector"
	// ProjectRequester is the username that requested a given project.  Its not guaranteed to be present,
	// but it is set by the default project template.
	ProjectRequester = "openshift.io/requester"
)

These constants represent annotations keys affixed to projects

const (
	// These are internal finalizer values to Origin
	FinalizerOrigin kapi.FinalizerName = "openshift.io/origin"
)

Variables

var (
	SchemeGroupVersion       = schema.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal}
	LegacySchemeGroupVersion = schema.GroupVersion{Group: LegacyGroupName, Version: runtime.APIVersionInternal}

	LegacySchemeBuilder    = runtime.NewSchemeBuilder(addLegacyKnownTypes)
	AddToSchemeInCoreGroup = LegacySchemeBuilder.AddToScheme

	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	AddToScheme   = SchemeBuilder.AddToScheme
)

SchemeGroupVersion is group version used to register these objects

Functions

func DeepCopy_api_Project

func DeepCopy_api_Project(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_ProjectList

func DeepCopy_api_ProjectList(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_ProjectRequest

func DeepCopy_api_ProjectRequest(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_ProjectSpec

func DeepCopy_api_ProjectSpec(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_ProjectStatus

func DeepCopy_api_ProjectStatus(in interface{}, out interface{}, c *conversion.Cloner) error

func IsKindOrLegacy

func IsKindOrLegacy(kind string, gk schema.GroupKind) bool

IsKindOrLegacy checks if the provided GroupKind matches with the given kind by looking up the API group and also the legacy API.

func IsResourceOrLegacy

func IsResourceOrLegacy(resource string, gr schema.GroupResource) bool

IsResourceOrLegacy checks if the provided GroupResources matches with the given resource by looking up the API group and also the legacy API.

func Kind

func Kind(kind string) schema.GroupKind

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

func LegacyKind

func LegacyKind(kind string) schema.GroupKind

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

func LegacyResource

func LegacyResource(resource string) schema.GroupResource

func RegisterDeepCopies

func RegisterDeepCopies(scheme *runtime.Scheme) error

RegisterDeepCopies adds deep-copy functions to the given scheme. Public to allow building arbitrary schemes.

func Resource

func Resource(resource string) schema.GroupResource

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

Types

type Project

type Project struct {
	metav1.TypeMeta
	metav1.ObjectMeta

	Spec   ProjectSpec
	Status ProjectStatus
}

Project is a logical top-level container for a set of origin resources

type ProjectList

type ProjectList struct {
	metav1.TypeMeta
	metav1.ListMeta
	Items []Project
}

ProjectList is a list of Project objects.

type ProjectRequest

type ProjectRequest struct {
	metav1.TypeMeta
	metav1.ObjectMeta
	DisplayName string
	Description string
}

type ProjectSpec

type ProjectSpec struct {
	// Finalizers is an opaque list of values that must be empty to permanently remove object from storage
	Finalizers []kapi.FinalizerName
}

ProjectSpec describes the attributes on a Project

type ProjectStatus

type ProjectStatus struct {
	Phase kapi.NamespacePhase
}

ProjectStatus is information about the current status of a Project