v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the core v1alpha1 API group

Index

• Variables
• func Resource(resource string) schema.GroupResource
• type Condition
  • func (in *Condition) DeepCopy() *Condition
  • func (in *Condition) DeepCopyInto(out *Condition)
• type ConditionStatus
• type ConditionType
• type Project
  • func (in *Project) DeepCopy() *Project
  • func (in *Project) DeepCopyInto(out *Project)
  • func (in *Project) DeepCopyObject() runtime.Object
• type ProjectList
  • func (in *ProjectList) DeepCopy() *ProjectList
  • func (in *ProjectList) DeepCopyInto(out *ProjectList)
  • func (in *ProjectList) DeepCopyObject() runtime.Object
• type ProjectSpec
  • func (in *ProjectSpec) DeepCopy() *ProjectSpec
  • func (in *ProjectSpec) DeepCopyInto(out *ProjectSpec)
• type ProjectStatus
  • func (in *ProjectStatus) DeepCopy() *ProjectStatus
  • func (in *ProjectStatus) DeepCopyInto(out *ProjectStatus)
  • func (s *ProjectStatus) SetCondition(condType ConditionType, condStatus ConditionStatus, reason string, ...) *Condition
  • func (s *ProjectStatus) SetReadyCondition(condStatus ConditionStatus, state State, message string)
• type State

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "core.cs.sap.com", Version: "v1alpha1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

var (
	// Needed by kubernetes/code-generator
	SchemeGroupVersion = GroupVersion
)

Functions

func Resource

func Resource(resource string) schema.GroupResource

Needed by kubernetes/code-generator

Types

type Condition

type Condition struct {
	// Condition type (such as 'Ready', ...)
	Type ConditionType `json:"type"`
	// Condition status (one of True, False, Unknown)
	// +kubebuilder:validation:Enum=True;False;Unknown
	Status ConditionStatus `json:"status"`
	// Timestamp of the last change of ConditionStatus
	// +optional
	LastTransitionTime *metav1.Time `json:"lastTransitionTime,omitempty"`
	// Reason is a programmatically usable identifier explaining the current ConditionStatus.
	// +optional
	Reason string `json:"reason,omitempty"`
	// Message is a human readable explanation of the current ConditionStatus.
	// +optional
	Message string `json:"message,omitempty"`
}

Project Condition

func (*Condition) DeepCopy

func (in *Condition) DeepCopy() *Condition

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

func (*Condition) DeepCopyInto

func (in *Condition) DeepCopyInto(out *Condition)

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

type ConditionStatus

type ConditionStatus string

Condition Status. Can be one of 'True', 'False', 'Unknown'.

const (
	// Condition status 'True'
	ConditionTrue ConditionStatus = "True"
	// Condition status 'False'
	ConditionFalse ConditionStatus = "False"
	// Condition status 'Unknown'
	ConditionUnknown ConditionStatus = "Unknown"
)

type ConditionType

type ConditionType string

Condition type. Currently, only the 'Ready' type is used.

const (
	// Condition type representing the 'Ready' condition
	ConditionTypeReady ConditionType = "Ready"
)

type Project

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

	Spec ProjectSpec `json:"spec,omitempty"`
	// +kubebuilder:default={"observedGeneration":-1}
	Status ProjectStatus `json:"status,omitempty"`
}

Project is the Schema for the projects API.

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.

type ProjectList

type ProjectList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Project `json:"items"`
}

ProjectList contains a list of Project.

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.

type ProjectSpec

type ProjectSpec struct {
	// AdminUsers contains users that will be granted admin privileges on the project namespace.
	AdminUsers []string `json:"adminUsers,omitempty"`
	// AdminGroups contains groups that will be granted admin privileges on the project namespace.
	AdminGroups []string `json:"adminGroups,omitempty"`
	// ViewerUsers contains users that will be granted display privileges on the project namespace.
	ViewerUsers []string `json:"viewerUsers,omitempty"`
	// ViewerGroups contains groups that will be granted display privileges on the project namespace.
	ViewerGroups []string `json:"viewerGroups,omitempty"`
	// Additional labels that should be set on the on the project namespace
	Labels map[string]string `json:"labels,omitempty"`
	// Additional annotations that should be set on on the project namespace
	Annotations map[string]string `json:"annotations,omitempty"`
}

ProjectSpec defines the desired state of 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.

type ProjectStatus

type ProjectStatus struct {
	// Observed generation
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
	// Timestamp when this resource was last observed
	LastObservedAt *metav1.Time `json:"lastObservedAt,omitempty"`
	// Conditions
	Conditions []Condition `json:"conditions,omitempty"`
	// Overall resource state
	State State `json:"state,omitempty"`
	// Project namespace
	Namespace string `json:"namespace,omitempty"`
}

ProjectStatus defines the observed state of 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) SetCondition

func (s *ProjectStatus) SetCondition(condType ConditionType, condStatus ConditionStatus, reason string, message string) *Condition

Set condition on ProjectStatus

func (*ProjectStatus) SetReadyCondition

func (s *ProjectStatus) SetReadyCondition(condStatus ConditionStatus, state State, message string)

Set 'Ready' condition and State on ProjectStatus; provided state will be equally stored as condition reason.

type State

type State string

Project state. Can be one of 'Ready', 'Processing', 'Error', 'Deleting'.

const (
	// Project state 'Ready'
	StateReady State = "Ready"
	// Project state 'Processing'
	StateProcessing State = "Processing"
	// Project state 'Error'
	StateError State = "Error"
	// Project state 'DeletionBlocked'
	StateDeletionBlocked State = "DeletionBlocked"
	// Project state 'Deleting'
	StateDeleting State = "Deleting"
)