v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the webhosting v1alpha1 API group +kubebuilder:object:generate=true +groupName=webhosting.timebertt.dev

Index

• Constants
• Variables
• type Theme
  • func (in *Theme) DeepCopy() *Theme
  • func (in *Theme) DeepCopyInto(out *Theme)
  • func (in *Theme) DeepCopyObject() runtime.Object
• type ThemeList
  • func (in *ThemeList) DeepCopy() *ThemeList
  • func (in *ThemeList) DeepCopyInto(out *ThemeList)
  • func (in *ThemeList) DeepCopyObject() runtime.Object
• type ThemeSpec
  • func (in *ThemeSpec) DeepCopy() *ThemeSpec
  • func (in *ThemeSpec) DeepCopyInto(out *ThemeSpec)
• type ThemeStatus
  • func (in *ThemeStatus) DeepCopy() *ThemeStatus
  • func (in *ThemeStatus) DeepCopyInto(out *ThemeStatus)
• type Website
  • func (in *Website) DeepCopy() *Website
  • func (in *Website) DeepCopyInto(out *Website)
  • func (in *Website) DeepCopyObject() runtime.Object
• type WebsiteList
  • func (in *WebsiteList) DeepCopy() *WebsiteList
  • func (in *WebsiteList) DeepCopyInto(out *WebsiteList)
  • func (in *WebsiteList) DeepCopyObject() runtime.Object
• type WebsitePhase
• type WebsiteSpec
  • func (in *WebsiteSpec) DeepCopy() *WebsiteSpec
  • func (in *WebsiteSpec) DeepCopyInto(out *WebsiteSpec)
• type WebsiteStatus
  • func (in *WebsiteStatus) DeepCopy() *WebsiteStatus
  • func (in *WebsiteStatus) DeepCopyInto(out *WebsiteStatus)

Constants

const (
	// LabelKeyProject is the label key on Namespaces for identifying webhosting projects.
	LabelKeyProject = "webhosting.timebertt.dev/project"
	// LabelValueProject is the label value for LabelKeyProject on Namespaces for identifying webhosting projects.
	LabelValueProject = "true"
)

const GroupName = "webhosting.timebertt.dev"

GroupName is the group name used in this package.

Variables

var (
	// SchemeBuilder is a new Scheme Builder which registers our API.
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	// AddToScheme is a reference to the Scheme Builder's AddToScheme function.
	AddToScheme = SchemeBuilder.AddToScheme
)

var AllWebsitePhases = []WebsitePhase{PhasePending, PhaseReady, PhaseError, PhaseTerminating}

AllWebsitePhases is a list of all Website phases.

var (
	// LabelSelectorProject is a selector for webhosting project namespaces.
	LabelSelectorProject = labels.SelectorFromSet(labels.Set{LabelKeyProject: LabelValueProject})
)

var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1alpha1"}

SchemeGroupVersion is group version used to register these objects

Types

type Theme

type Theme struct {
	metav1.TypeMeta `json:",inline"`
	// Standard object's metadata.
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`
	// Spec contains the specification of the desired behavior of the Theme.
	// +optional
	Spec ThemeSpec `json:"spec,omitempty"`
	// Status contains the most recently observed status of the Theme.
	// +optional
	Status ThemeStatus `json:"status,omitempty"`
}

Theme is the Schema for the themes API.

func (*Theme) DeepCopy

func (in *Theme) DeepCopy() *Theme

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

func (*Theme) DeepCopyInto

func (in *Theme) DeepCopyInto(out *Theme)

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

func (*Theme) DeepCopyObject

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

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

type ThemeList

type ThemeList struct {
	metav1.TypeMeta `json:",inline"`
	// Standard list metadata.
	// +optional
	metav1.ListMeta `json:"metadata,omitempty"`
	// Items is the list of Themes.
	Items []Theme `json:"items"`
}

ThemeList contains a list of Themes.

func (*ThemeList) DeepCopy

func (in *ThemeList) DeepCopy() *ThemeList

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

func (*ThemeList) DeepCopyInto

func (in *ThemeList) DeepCopyInto(out *ThemeList)

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

func (*ThemeList) DeepCopyObject

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

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

type ThemeSpec

type ThemeSpec struct {
	// Color is a CSS color for a Website.
	Color string `json:"color"`
	// FontFamily is a font family for a Website.
	FontFamily string `json:"fontFamily"`
}

ThemeSpec defines the desired state of a Theme.

func (*ThemeSpec) DeepCopy

func (in *ThemeSpec) DeepCopy() *ThemeSpec

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

func (*ThemeSpec) DeepCopyInto

func (in *ThemeSpec) DeepCopyInto(out *ThemeSpec)

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

type ThemeStatus

type ThemeStatus struct {
}

ThemeStatus defines the observed state of a Theme.

func (*ThemeStatus) DeepCopy

func (in *ThemeStatus) DeepCopy() *ThemeStatus

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

func (*ThemeStatus) DeepCopyInto

func (in *ThemeStatus) DeepCopyInto(out *ThemeStatus)

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

type Website

type Website struct {
	metav1.TypeMeta `json:",inline"`
	// Standard object's metadata.
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`
	// Spec contains the specification of the desired behavior of the Website.
	// +optional
	Spec WebsiteSpec `json:"spec,omitempty"`
	// Status contains the most recently observed status of the Website.
	// +optional
	Status WebsiteStatus `json:"status,omitempty"`
}

Website enables declarative management of hosted websites.

func (*Website) DeepCopy

func (in *Website) DeepCopy() *Website

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

func (*Website) DeepCopyInto

func (in *Website) DeepCopyInto(out *Website)

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

func (*Website) DeepCopyObject

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

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

type WebsiteList

type WebsiteList struct {
	metav1.TypeMeta `json:",inline"`
	// Standard list metadata.
	// +optional
	metav1.ListMeta `json:"metadata,omitempty"`
	// Items is the list of Websites.
	Items []Website `json:"items"`
}

WebsiteList contains a list of Websites.

func (*WebsiteList) DeepCopy

func (in *WebsiteList) DeepCopy() *WebsiteList

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

func (*WebsiteList) DeepCopyInto

func (in *WebsiteList) DeepCopyInto(out *WebsiteList)

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

func (*WebsiteList) DeepCopyObject

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

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

type WebsitePhase

type WebsitePhase string

WebsitePhase describes the phase of a Website.

const (
	// PhasePending means that the Website is not ready yet.
	PhasePending WebsitePhase = "Pending"
	// PhaseReady means that the Website is ready and available.
	PhaseReady WebsitePhase = "Ready"
	// PhaseError means that there is a problem running the Website.
	PhaseError WebsitePhase = "Error"
	// PhaseTerminating means that the Website is shutting down.
	PhaseTerminating WebsitePhase = "Terminating"
)

type WebsiteSpec

type WebsiteSpec struct {
	// Theme references a Theme object to be used for this Website.
	Theme string `json:"theme"`
}

WebsiteSpec defines the desired state of a Website.

func (*WebsiteSpec) DeepCopy

func (in *WebsiteSpec) DeepCopy() *WebsiteSpec

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

func (*WebsiteSpec) DeepCopyInto

func (in *WebsiteSpec) DeepCopyInto(out *WebsiteSpec)

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

type WebsiteStatus

type WebsiteStatus struct {
	// The generation observed by the Website controller.
	// +optional
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
	// Phase is the current phase of this Website.
	// +optional
	Phase WebsitePhase `json:"phase,omitempty"`
	// LastTransitionTime is the last time the observedGeneration or phase transitioned from one value to another.
	// +optional
	LastTransitionTime *metav1.MicroTime `json:"lastTransitionTime,omitempty"`
}

WebsiteStatus defines the observed state of a Website.

func (*WebsiteStatus) DeepCopy

func (in *WebsiteStatus) DeepCopy() *WebsiteStatus

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

func (*WebsiteStatus) DeepCopyInto

func (in *WebsiteStatus) DeepCopyInto(out *WebsiteStatus)

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