v1alpha1

Documentation

Overview

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

Index

• Variables
• type Site
  • func (in *Site) DeepCopy() *Site
  • func (in *Site) DeepCopyInto(out *Site)
  • func (in *Site) DeepCopyObject() runtime.Object
• type SiteList
  • func (in *SiteList) DeepCopy() *SiteList
  • func (in *SiteList) DeepCopyInto(out *SiteList)
  • func (in *SiteList) DeepCopyObject() runtime.Object
• type SitePermission
  • func (in *SitePermission) DeepCopy() *SitePermission
  • func (in *SitePermission) DeepCopyInto(out *SitePermission)
• type SitePermissions
  • func (in *SitePermissions) DeepCopy() *SitePermissions
  • func (in *SitePermissions) DeepCopyInto(out *SitePermissions)
• type SiteRevision
  • func (in *SiteRevision) DeepCopy() *SiteRevision
  • func (in *SiteRevision) DeepCopyInto(out *SiteRevision)
  • func (in *SiteRevision) DeepCopyObject() runtime.Object
• type SiteRevisionConditionType
• type SiteRevisionList
  • func (in *SiteRevisionList) DeepCopy() *SiteRevisionList
  • func (in *SiteRevisionList) DeepCopyInto(out *SiteRevisionList)
  • func (in *SiteRevisionList) DeepCopyObject() runtime.Object
• type SiteRevisionSpec
  • func (in *SiteRevisionSpec) DeepCopy() *SiteRevisionSpec
  • func (in *SiteRevisionSpec) DeepCopyInto(out *SiteRevisionSpec)
• type SiteRevisionStatus
  • func (in *SiteRevisionStatus) DeepCopy() *SiteRevisionStatus
  • func (in *SiteRevisionStatus) DeepCopyInto(out *SiteRevisionStatus)
• type SiteSpec
  • func (in *SiteSpec) DeepCopy() *SiteSpec
  • func (in *SiteSpec) DeepCopyInto(out *SiteSpec)
• type SiteStatus
  • func (in *SiteStatus) DeepCopy() *SiteStatus
  • func (in *SiteStatus) DeepCopyInto(out *SiteStatus)
• type SiteVisibility

Variables

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

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

	Spec   SiteSpec   `json:"spec"`
	Status SiteStatus `json:"status,omitempty"`
}

Site is the Schema for the sites API

func (*Site) DeepCopy

func (in *Site) DeepCopy() *Site

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

func (*Site) DeepCopyInto

func (in *Site) DeepCopyInto(out *Site)

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

func (*Site) DeepCopyObject

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

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

type SiteList

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

SiteList contains a list of Site

func (*SiteList) DeepCopy

func (in *SiteList) DeepCopy() *SiteList

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

func (*SiteList) DeepCopyInto

func (in *SiteList) DeepCopyInto(out *SiteList)

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

func (*SiteList) DeepCopyObject

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

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

type SitePermission

type SitePermission struct {
	// +kubebuilder:validation:MinLength:=1
	UserID string `json:"userId"`
}

func (*SitePermission) DeepCopy

func (in *SitePermission) DeepCopy() *SitePermission

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

func (*SitePermission) DeepCopyInto

func (in *SitePermission) DeepCopyInto(out *SitePermission)

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

type SitePermissions

type SitePermissions struct {
	// +kubebuilder:validation:MinItems=1
	Admins []SitePermission `json:"admins,omitempty"`

	Editors []SitePermission `json:"editors,omitempty"`

	Viewers []SitePermission `json:"viewers,omitempty"`
}

func (*SitePermissions) DeepCopy

func (in *SitePermissions) DeepCopy() *SitePermissions

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

func (*SitePermissions) DeepCopyInto

func (in *SitePermissions) DeepCopyInto(out *SitePermissions)

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

type SiteRevision

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

	Spec   SiteRevisionSpec   `json:"spec,omitempty"`
	Status SiteRevisionStatus `json:"status,omitempty"`
}

SiteRevision is the Schema for the siterevisions API

func (*SiteRevision) DeepCopy

func (in *SiteRevision) DeepCopy() *SiteRevision

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

func (*SiteRevision) DeepCopyInto

func (in *SiteRevision) DeepCopyInto(out *SiteRevision)

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

func (*SiteRevision) DeepCopyObject

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

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

type SiteRevisionConditionType

type SiteRevisionConditionType string

const (
	// RevisionReady means revision is healthy and ready.
	RevisionReady SiteRevisionConditionType = "Ready"

	// RevisionContentUnavailable means revision content is not available yet.
	RevisionContentUnavailable SiteRevisionConditionType = "ContentUnavailable"

	// RevisionStorageUnavailable means network connectivity issue between revision controller and backend storage.
	RevisionStorageUnavailable SiteRevisionConditionType = "StorageUnavailable"
)

type SiteRevisionList

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

SiteRevisionList contains a list of SiteRevision

func (*SiteRevisionList) DeepCopy

func (in *SiteRevisionList) DeepCopy() *SiteRevisionList

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

func (*SiteRevisionList) DeepCopyInto

func (in *SiteRevisionList) DeepCopyInto(out *SiteRevisionList)

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

func (*SiteRevisionList) DeepCopyObject

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

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

type SiteRevisionSpec

type SiteRevisionSpec struct {

	// StoragePath is where site content is stored. This can be file storage (file:///path/to/dir) or object storage (s3://, gs://). See https://gocloud.dev/howto/blob/ for details.
	StoragePath string `json:"storagePath"`
}

SiteRevisionSpec defines the desired state of SiteRevision

func (*SiteRevisionSpec) DeepCopy

func (in *SiteRevisionSpec) DeepCopy() *SiteRevisionSpec

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

func (*SiteRevisionSpec) DeepCopyInto

func (in *SiteRevisionSpec) DeepCopyInto(out *SiteRevisionSpec)

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

type SiteRevisionStatus

type SiteRevisionStatus struct {
	Conditions []metav1.Condition `json:"conditions"`
}

SiteRevisionStatus defines the observed state of SiteRevision

func (*SiteRevisionStatus) DeepCopy

func (in *SiteRevisionStatus) DeepCopy() *SiteRevisionStatus

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

func (*SiteRevisionStatus) DeepCopyInto

func (in *SiteRevisionStatus) DeepCopyInto(out *SiteRevisionStatus)

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

type SiteSpec

type SiteSpec struct {

	// DisplayName is human-readable name of Site.
	// +kubebuilder:validation:MinLength:=1
	DisplayName string `json:"displayName"`

	// Domains are assigned domain names of Site.
	Domains []gatewayv1alpha1.Hostname `json:"domains"`

	Visibility SiteVisibility `json:"visibility"`

	// The Revision to select from
	RevisionRef corev1.LocalObjectReference `json:"revisionRef"`

	Permissions SitePermissions `json:"permissions,omitempty"`
}

SiteSpec defines the desired state of Site

func (*SiteSpec) DeepCopy

func (in *SiteSpec) DeepCopy() *SiteSpec

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

func (*SiteSpec) DeepCopyInto

func (in *SiteSpec) DeepCopyInto(out *SiteSpec)

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

type SiteStatus

type SiteStatus struct {
}

SiteStatus defines the observed state of Site

func (*SiteStatus) DeepCopy

func (in *SiteStatus) DeepCopy() *SiteStatus

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

func (*SiteStatus) DeepCopyInto

func (in *SiteStatus) DeepCopyInto(out *SiteStatus)

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

type SiteVisibility

type SiteVisibility string

+kubebuilder:validation:Enum=Public;Internal;Private;Locked +kubebuilder:default:=Private

const (
	SiteVisibilityPublic   SiteVisibility = "Public"
	SiteVisibilityInternal SiteVisibility = "Internal"
	SiteVisibilityPrivate  SiteVisibility = "Private"
	SiteVisibilityLocked   SiteVisibility = "Locked"
)