v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the v1alpha1 API group +kubebuilder:object:generate=true +groupName=workspaces.konflux-ci.dev

Index

• Constants
• Variables
• type InternalWorkspace
  • func (in *InternalWorkspace) DeepCopy() *InternalWorkspace
  • func (in *InternalWorkspace) DeepCopyInto(out *InternalWorkspace)
  • func (in *InternalWorkspace) DeepCopyObject() runtime.Object
• type InternalWorkspaceList
  • func (in *InternalWorkspaceList) DeepCopy() *InternalWorkspaceList
  • func (in *InternalWorkspaceList) DeepCopyInto(out *InternalWorkspaceList)
  • func (in *InternalWorkspaceList) DeepCopyObject() runtime.Object
• type InternalWorkspaceSpec
  • func (in *InternalWorkspaceSpec) DeepCopy() *InternalWorkspaceSpec
  • func (in *InternalWorkspaceSpec) DeepCopyInto(out *InternalWorkspaceSpec)
• type InternalWorkspaceStatus
  • func (in *InternalWorkspaceStatus) DeepCopy() *InternalWorkspaceStatus
  • func (in *InternalWorkspaceStatus) DeepCopyInto(out *InternalWorkspaceStatus)
• type InternalWorkspaceVisibility
• type JwtInfo
  • func (in *JwtInfo) DeepCopy() *JwtInfo
  • func (in *JwtInfo) DeepCopyInto(out *JwtInfo)
• type SpaceInfo
  • func (in *SpaceInfo) DeepCopy() *SpaceInfo
  • func (in *SpaceInfo) DeepCopyInto(out *SpaceInfo)
• type UserInfo
  • func (in *UserInfo) DeepCopy() *UserInfo
  • func (in *UserInfo) DeepCopyInto(out *UserInfo)
• type UserInfoStatus
  • func (in *UserInfoStatus) DeepCopy() *UserInfoStatus
  • func (in *UserInfoStatus) DeepCopyInto(out *UserInfoStatus)

Constants

const (
	// PublicViewerName the name of the KubeSaw's PublicViewer user
	PublicViewerName string = "kubesaw-authenticated"
	// DisplayNameDefaultWorkspace display name for the default Workspace
	DisplayNameDefaultWorkspace string = "default"

	// InternalWorkspaceVisibilityCommunity Community value for InternalWorkspaces visibility
	InternalWorkspaceVisibilityCommunity InternalWorkspaceVisibility = "community"
	// InternalWorkspaceVisibilityPrivate Private value for InternalWorkspaces visibility
	InternalWorkspaceVisibilityPrivate InternalWorkspaceVisibility = "private"

	// LabelInternalDomain domain for internal labels
	LabelInternalDomain string = "internal.workspaces.konflux-ci.dev/"

	// ConditionTypeReady indicates whether an InternalWorkspace is Ready
	ConditionTypeReady string = "Ready"
	// ConditionReasonEverythingFine indicates "everything is fine"
	ConditionReasonEverythingFine string = "EverythingFine"
	// ConditionReasonOwnerNotFound means that the UserSignup for the InternalWorkspace
	// was not found
	ConditionReasonOwnerNotFound string = "OwnerNotFound"
	// ConditionReasonSpaceNotFound means that the Space for the InternalWorkspace
	// was not found
	ConditionReasonSpaceNotFound string = "SpaceNotFound"
)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "workspaces.konflux-ci.dev", 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
)

Types

type InternalWorkspace

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

	Spec   InternalWorkspaceSpec   `json:"spec,omitempty"`
	Status InternalWorkspaceStatus `json:"status,omitempty"`
}

InternalWorkspace is the Schema for the workspaces API

func (*InternalWorkspace) DeepCopy

func (in *InternalWorkspace) DeepCopy() *InternalWorkspace

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

func (*InternalWorkspace) DeepCopyInto

func (in *InternalWorkspace) DeepCopyInto(out *InternalWorkspace)

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

func (*InternalWorkspace) DeepCopyObject

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

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

type InternalWorkspaceList

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

InternalWorkspaceList contains a list of Workspace

func (*InternalWorkspaceList) DeepCopy

func (in *InternalWorkspaceList) DeepCopy() *InternalWorkspaceList

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

func (*InternalWorkspaceList) DeepCopyInto

func (in *InternalWorkspaceList) DeepCopyInto(out *InternalWorkspaceList)

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

func (*InternalWorkspaceList) DeepCopyObject

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

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

type InternalWorkspaceSpec

type InternalWorkspaceSpec struct {
	//+required
	DisplayName string `json:"displayName"`
	//+required
	//+kubebuilder:validation:Enum:=community;private
	Visibility InternalWorkspaceVisibility `json:"visibility"`
	//+required
	Owner UserInfo `json:"owner"`
}

InternalWorkspaceSpec defines the desired state of Workspace

func (*InternalWorkspaceSpec) DeepCopy

func (in *InternalWorkspaceSpec) DeepCopy() *InternalWorkspaceSpec

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

func (*InternalWorkspaceSpec) DeepCopyInto

func (in *InternalWorkspaceSpec) DeepCopyInto(out *InternalWorkspaceSpec)

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

type InternalWorkspaceStatus

type InternalWorkspaceStatus struct {
	//+optional
	Conditions []metav1.Condition `json:"conditions,omitempty"`

	// Space contains information about the underlying Space
	//+optional
	Space SpaceInfo `json:"space,omitempty"`

	// Owner contains information on the owner
	//+optional
	Owner UserInfoStatus `json:"owner,omitempty"`
}

InternalWorkspaceStatus defines the observed state of Workspace

func (*InternalWorkspaceStatus) DeepCopy

func (in *InternalWorkspaceStatus) DeepCopy() *InternalWorkspaceStatus

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

func (*InternalWorkspaceStatus) DeepCopyInto

func (in *InternalWorkspaceStatus) DeepCopyInto(out *InternalWorkspaceStatus)

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

type InternalWorkspaceVisibility

type InternalWorkspaceVisibility string

type JwtInfo

type JwtInfo struct {
	//+required
	Email string `json:"email"`
	//+required
	UserId string `json:"userId"`
	//+required
	Sub string `json:"sub"`
}

JwtInfo contains information extracted from the user JWT Token

func (*JwtInfo) DeepCopy

func (in *JwtInfo) DeepCopy() *JwtInfo

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

func (*JwtInfo) DeepCopyInto

func (in *JwtInfo) DeepCopyInto(out *JwtInfo)

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

type SpaceInfo

type SpaceInfo struct {
	//+required
	IsHome bool `json:"isHome"`
	//+required
	Name string `json:"name"`
	// TargetCluster contains the URL to the cluster where the workspace's namespaces live
	//+optional
	TargetCluster string `json:"targetCluster,omitempty"`
}

SpaceInfo Information about a Space

func (*SpaceInfo) DeepCopy

func (in *SpaceInfo) DeepCopy() *SpaceInfo

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

func (*SpaceInfo) DeepCopyInto

func (in *SpaceInfo) DeepCopyInto(out *SpaceInfo)

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

type UserInfo

type UserInfo struct {
	//+required
	JwtInfo JwtInfo `json:"jwtInfo"`
}

UserInfo contains information about a user identity

func (*UserInfo) DeepCopy

func (in *UserInfo) DeepCopy() *UserInfo

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

func (*UserInfo) DeepCopyInto

func (in *UserInfo) DeepCopyInto(out *UserInfo)

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

type UserInfoStatus

type UserInfoStatus struct {
	//+optional
	Username string `json:"username,omitempty"`
}

UserInfoStatus User info stored in the status

func (*UserInfoStatus) DeepCopy

func (in *UserInfoStatus) DeepCopy() *UserInfoStatus

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

func (*UserInfoStatus) DeepCopyInto

func (in *UserInfoStatus) DeepCopyInto(out *UserInfoStatus)

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