v1

package
v0.0.0-...-c98acdb Latest Latest
Warning

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

 Go to latest Published: Nov 21, 2024 License: Apache-2.0 Imports: 11 Imported by: 803

Documentation

Overview

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

Index

Constants

View Source 
const (
	// These are internal finalizer values to Origin
	FinalizerOrigin corev1.FinalizerName = "openshift.io/origin"
	// 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"

	// ProjectRequesterAnnotation is the username that requested a given project.  Its not guaranteed to be present,
	// but it is set by the default project template.
	ProjectRequesterAnnotation = "openshift.io/requester"
)

Variables

View Source 
var (
	ErrInvalidLengthGenerated        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowGenerated          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupGenerated = fmt.Errorf("proto: unexpected end of group")
)
View Source 
var (
	GroupName    = "project.openshift.io"
	GroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1"}

	// Install is a function which adds this version to a scheme
	Install = schemeBuilder.AddToScheme

	// SchemeGroupVersion generated code relies on this name
	// Deprecated
	SchemeGroupVersion = GroupVersion
	// AddToScheme exists solely to keep the old generators creating valid code
	// DEPRECATED
	AddToScheme = schemeBuilder.AddToScheme
)
View Source 
var (
	DeprecatedInstallWithoutGroup = legacySchemeBuilder.AddToScheme
)

Functions

func Resource 

func Resource(resource string) schema.GroupResource

Resource generated code relies on this being here, but it logically belongs to the group DEPRECATED

Types

type Project 

type Project struct {
	metav1.TypeMeta `json:",inline"`

	// metadata is the standard object's metadata.
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
	metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`

	// Spec defines the behavior of the Namespace.
	Spec ProjectSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`

	// Status describes the current status of a Namespace
	// +optional
	Status ProjectStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"`
}

Projects are the unit of isolation and collaboration in OpenShift. A project has one or more members, a quota on the resources that the project may consume, and the security controls on the resources in the project. Within a project, members may have different roles - project administrators can set membership, editors can create and manage the resources, and viewers can see but not access running containers. In a normal cluster project administrators are not able to alter their quotas - that is restricted to cluster administrators.

Listing or watching projects will return only projects the user has the reader role on.

An OpenShift project is an alternative representation of a Kubernetes namespace. Projects are exposed as editable to end users while namespaces are not. Direct creation of a project is typically restricted to administrators, while end users should use the requestproject resource.

Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=1

func (*Project) DeepCopy 

func (in *Project) DeepCopy() *Project

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Project.

func (*Project) DeepCopyInto 

func (in *Project) DeepCopyInto(out *Project)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Project) DeepCopyObject 

func (in *Project) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*Project) Descriptor 

func (*Project) Descriptor() ([]byte, []int)

func (*Project) Marshal 

func (m *Project) Marshal() (dAtA []byte, err error)

func (*Project) MarshalTo 

func (m *Project) MarshalTo(dAtA []byte) (int, error)

func (*Project) MarshalToSizedBuffer 

func (m *Project) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Project) ProtoMessage 

func (*Project) ProtoMessage()

func (*Project) Reset 

func (m *Project) Reset()

func (*Project) Size 

func (m *Project) Size() (n int)

func (*Project) String 

func (this *Project) String() string

func (Project) SwaggerDoc 

func (Project) SwaggerDoc() map[string]string

func (*Project) Unmarshal 

func (m *Project) Unmarshal(dAtA []byte) error

func (*Project) XXX_DiscardUnknown 

func (m *Project) XXX_DiscardUnknown()

func (*Project) XXX_Marshal 

func (m *Project) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Project) XXX_Merge 

func (m *Project) XXX_Merge(src proto.Message)

func (*Project) XXX_Size 

func (m *Project) XXX_Size() int

func (*Project) XXX_Unmarshal 

func (m *Project) XXX_Unmarshal(b []byte) error

type ProjectList 

type ProjectList struct {
	metav1.TypeMeta `json:",inline"`

	// metadata is the standard list's metadata.
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
	metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`

	// Items is the list of projects
	Items []Project `json:"items" protobuf:"bytes,2,rep,name=items"`
}

ProjectList is a list of Project objects.

Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=1

func (*ProjectList) DeepCopy 

func (in *ProjectList) DeepCopy() *ProjectList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProjectList.

func (*ProjectList) DeepCopyInto 

func (in *ProjectList) DeepCopyInto(out *ProjectList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ProjectList) DeepCopyObject 

func (in *ProjectList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*ProjectList) Descriptor 

func (*ProjectList) Descriptor() ([]byte, []int)

func (*ProjectList) Marshal 

func (m *ProjectList) Marshal() (dAtA []byte, err error)

func (*ProjectList) MarshalTo 

func (m *ProjectList) MarshalTo(dAtA []byte) (int, error)

func (*ProjectList) MarshalToSizedBuffer 

func (m *ProjectList) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ProjectList) ProtoMessage 

func (*ProjectList) ProtoMessage()

func (*ProjectList) Reset 

func (m *ProjectList) Reset()

func (*ProjectList) Size 

func (m *ProjectList) Size() (n int)

func (*ProjectList) String 

func (this *ProjectList) String() string

func (ProjectList) SwaggerDoc 

func (ProjectList) SwaggerDoc() map[string]string

func (*ProjectList) Unmarshal 

func (m *ProjectList) Unmarshal(dAtA []byte) error

func (*ProjectList) XXX_DiscardUnknown 

func (m *ProjectList) XXX_DiscardUnknown()

func (*ProjectList) XXX_Marshal 

func (m *ProjectList) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ProjectList) XXX_Merge 

func (m *ProjectList) XXX_Merge(src proto.Message)

func (*ProjectList) XXX_Size 

func (m *ProjectList) XXX_Size() int

func (*ProjectList) XXX_Unmarshal 

func (m *ProjectList) XXX_Unmarshal(b []byte) error

type ProjectRequest 

type ProjectRequest struct {
	metav1.TypeMeta `json:",inline"`

	// metadata is the standard object's metadata.
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
	metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`

	// DisplayName is the display name to apply to a project
	DisplayName string `json:"displayName,omitempty" protobuf:"bytes,2,opt,name=displayName"`
	// Description is the description to apply to a project
	Description string `json:"description,omitempty" protobuf:"bytes,3,opt,name=description"`
}

ProjectRequest is the set of options necessary to fully qualify a project request

Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +openshift:compatibility-gen:level=1

func (*ProjectRequest) DeepCopy 

func (in *ProjectRequest) DeepCopy() *ProjectRequest

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProjectRequest.

func (*ProjectRequest) DeepCopyInto 

func (in *ProjectRequest) DeepCopyInto(out *ProjectRequest)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ProjectRequest) DeepCopyObject 

func (in *ProjectRequest) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*ProjectRequest) Descriptor 

func (*ProjectRequest) Descriptor() ([]byte, []int)

func (*ProjectRequest) Marshal 

func (m *ProjectRequest) Marshal() (dAtA []byte, err error)

func (*ProjectRequest) MarshalTo 

func (m *ProjectRequest) MarshalTo(dAtA []byte) (int, error)

func (*ProjectRequest) MarshalToSizedBuffer 

func (m *ProjectRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ProjectRequest) ProtoMessage 

func (*ProjectRequest) ProtoMessage()

func (*ProjectRequest) Reset 

func (m *ProjectRequest) Reset()

func (*ProjectRequest) Size 

func (m *ProjectRequest) Size() (n int)

func (*ProjectRequest) String 

func (this *ProjectRequest) String() string

func (ProjectRequest) SwaggerDoc 

func (ProjectRequest) SwaggerDoc() map[string]string

func (*ProjectRequest) Unmarshal 

func (m *ProjectRequest) Unmarshal(dAtA []byte) error

func (*ProjectRequest) XXX_DiscardUnknown 

func (m *ProjectRequest) XXX_DiscardUnknown()

func (*ProjectRequest) XXX_Marshal 

func (m *ProjectRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ProjectRequest) XXX_Merge 

func (m *ProjectRequest) XXX_Merge(src proto.Message)

func (*ProjectRequest) XXX_Size 

func (m *ProjectRequest) XXX_Size() int

func (*ProjectRequest) XXX_Unmarshal 

func (m *ProjectRequest) XXX_Unmarshal(b []byte) error

type ProjectSpec 

type ProjectSpec struct {
	// Finalizers is an opaque list of values that must be empty to permanently remove object from storage
	Finalizers []corev1.FinalizerName `json:"finalizers,omitempty" protobuf:"bytes,1,rep,name=finalizers,casttype=k8s.io/api/core/v1.FinalizerName"`
}

ProjectSpec describes the attributes on a Project

func (*ProjectSpec) DeepCopy 

func (in *ProjectSpec) DeepCopy() *ProjectSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProjectSpec.

func (*ProjectSpec) DeepCopyInto 

func (in *ProjectSpec) DeepCopyInto(out *ProjectSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ProjectSpec) Descriptor 

func (*ProjectSpec) Descriptor() ([]byte, []int)

func (*ProjectSpec) Marshal 

func (m *ProjectSpec) Marshal() (dAtA []byte, err error)

func (*ProjectSpec) MarshalTo 

func (m *ProjectSpec) MarshalTo(dAtA []byte) (int, error)

func (*ProjectSpec) MarshalToSizedBuffer 

func (m *ProjectSpec) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ProjectSpec) ProtoMessage 

func (*ProjectSpec) ProtoMessage()

func (*ProjectSpec) Reset 

func (m *ProjectSpec) Reset()

func (*ProjectSpec) Size 

func (m *ProjectSpec) Size() (n int)

func (*ProjectSpec) String 

func (this *ProjectSpec) String() string

func (ProjectSpec) SwaggerDoc 

func (ProjectSpec) SwaggerDoc() map[string]string

func (*ProjectSpec) Unmarshal 

func (m *ProjectSpec) Unmarshal(dAtA []byte) error

func (*ProjectSpec) XXX_DiscardUnknown 

func (m *ProjectSpec) XXX_DiscardUnknown()

func (*ProjectSpec) XXX_Marshal 

func (m *ProjectSpec) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ProjectSpec) XXX_Merge 

func (m *ProjectSpec) XXX_Merge(src proto.Message)

func (*ProjectSpec) XXX_Size 

func (m *ProjectSpec) XXX_Size() int

func (*ProjectSpec) XXX_Unmarshal 

func (m *ProjectSpec) XXX_Unmarshal(b []byte) error

type ProjectStatus 

type ProjectStatus struct {
	// Phase is the current lifecycle phase of the project
	// +optional
	Phase corev1.NamespacePhase `json:"phase,omitempty" protobuf:"bytes,1,opt,name=phase,casttype=k8s.io/api/core/v1.NamespacePhase"`

	// Represents the latest available observations of the project current state.
	// +optional
	// +patchMergeKey=type
	// +patchStrategy=merge
	Conditions []corev1.NamespaceCondition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,2,rep,name=conditions"`
}

ProjectStatus is information about the current status of a Project

func (*ProjectStatus) DeepCopy 

func (in *ProjectStatus) DeepCopy() *ProjectStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProjectStatus.

func (*ProjectStatus) DeepCopyInto 

func (in *ProjectStatus) DeepCopyInto(out *ProjectStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ProjectStatus) Descriptor 

func (*ProjectStatus) Descriptor() ([]byte, []int)

func (*ProjectStatus) Marshal 

func (m *ProjectStatus) Marshal() (dAtA []byte, err error)

func (*ProjectStatus) MarshalTo 

func (m *ProjectStatus) MarshalTo(dAtA []byte) (int, error)

func (*ProjectStatus) MarshalToSizedBuffer 

func (m *ProjectStatus) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ProjectStatus) ProtoMessage 

func (*ProjectStatus) ProtoMessage()

func (*ProjectStatus) Reset 

func (m *ProjectStatus) Reset()

func (*ProjectStatus) Size 

func (m *ProjectStatus) Size() (n int)

func (*ProjectStatus) String 

func (this *ProjectStatus) String() string

func (ProjectStatus) SwaggerDoc 

func (ProjectStatus) SwaggerDoc() map[string]string

func (*ProjectStatus) Unmarshal 

func (m *ProjectStatus) Unmarshal(dAtA []byte) error

func (*ProjectStatus) XXX_DiscardUnknown 

func (m *ProjectStatus) XXX_DiscardUnknown()

func (*ProjectStatus) XXX_Marshal 

func (m *ProjectStatus) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ProjectStatus) XXX_Merge 

func (m *ProjectStatus) XXX_Merge(src proto.Message)

func (*ProjectStatus) XXX_Size 

func (m *ProjectStatus) XXX_Size() int

func (*ProjectStatus) XXX_Unmarshal 

func (m *ProjectStatus) XXX_Unmarshal(b []byte) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.