api

Documentation

Index

• Constants
• Variables
• func DisplayNameAndNameForProject(project *Project) string
• func Kind(kind string) unversioned.GroupKind
• func Resource(resource string) unversioned.GroupResource
• type Project
  • func (*Project) IsAnAPIObject()
• type ProjectList
  • func (*ProjectList) IsAnAPIObject()
• type ProjectRequest
  • func (*ProjectRequest) IsAnAPIObject()
• type ProjectSpec
• type ProjectStatus

Constants

const (
	// ProjectDisplayName is an annotation that stores the name displayed when querying for projects
	ProjectDisplayName = "openshift.io/display-name"
	// ProjectDescription is an annotatoion that holds the description of the project
	ProjectDescription = "openshift.io/description"
	// 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 = unversioned.GroupVersion{Group: "", Version: ""}

SchemeGroupVersion is group version used to register these objects

Functions

func DisplayNameAndNameForProject

func DisplayNameAndNameForProject(project *Project) string

DisplayNameAndNameForProject returns a formatted string containing the name of the project and includes the display name if it differs.

func Kind

func Kind(kind string) unversioned.GroupKind

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

func Resource

func Resource(resource string) unversioned.GroupResource

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

Types

type Project

type Project struct {
	unversioned.TypeMeta
	kapi.ObjectMeta

	Spec   ProjectSpec
	Status ProjectStatus
}

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

func (*Project) IsAnAPIObject

func (*Project) IsAnAPIObject()

type ProjectList

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

ProjectList is a list of Project objects.

func (*ProjectList) IsAnAPIObject

func (*ProjectList) IsAnAPIObject()

type ProjectRequest

type ProjectRequest struct {
	unversioned.TypeMeta
	kapi.ObjectMeta
	DisplayName string
	Description string
}

func (*ProjectRequest) IsAnAPIObject

func (*ProjectRequest) IsAnAPIObject()

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