v1

Documentation

Overview

Package v1 contains API Schema definitions for the view v1 API group +kubebuilder:object:generate=true +groupName=view.satoru-takeuchi.github.io

Index

• Constants
• Variables
• type MarkDownView
  • func (in *MarkDownView) DeepCopy() *MarkDownView
  • func (in *MarkDownView) DeepCopyInto(out *MarkDownView)
  • func (in *MarkDownView) DeepCopyObject() runtime.Object
  • func (r *MarkDownView) Default()
  • func (r *MarkDownView) SetupWebhookWithManager(mgr ctrl.Manager) error
  • func (r *MarkDownView) ValidateCreate() error
  • func (r *MarkDownView) ValidateDelete() error
  • func (r *MarkDownView) ValidateUpdate(old runtime.Object) error
• type MarkDownViewList
  • func (in *MarkDownViewList) DeepCopy() *MarkDownViewList
  • func (in *MarkDownViewList) DeepCopyInto(out *MarkDownViewList)
  • func (in *MarkDownViewList) DeepCopyObject() runtime.Object
• type MarkDownViewSpec
  • func (in *MarkDownViewSpec) DeepCopy() *MarkDownViewSpec
  • func (in *MarkDownViewSpec) DeepCopyInto(out *MarkDownViewSpec)
• type MarkDownViewStatus

Constants

const (
	MarkDownViewNotReady  = MarkDownViewStatus("NotReady")
	MarkDownViewAvailable = MarkDownViewStatus("Available")
	MarkDownViewHealthy   = MarkDownViewStatus("Healthy")
)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "view.satoru-takeuchi.github.io", Version: "v1"}

	// 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 MarkDownView

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

	Spec   MarkDownViewSpec   `json:"spec,omitempty"`
	Status MarkDownViewStatus `json:"status,omitempty"`
}

MarkDownView is the Schema for the markdownviews API

func (*MarkDownView) DeepCopy

func (in *MarkDownView) DeepCopy() *MarkDownView

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

func (*MarkDownView) DeepCopyInto

func (in *MarkDownView) DeepCopyInto(out *MarkDownView)

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

func (*MarkDownView) DeepCopyObject

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

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

func (*MarkDownView) Default

func (r *MarkDownView) Default()

Default implements webhook.Defaulter so a webhook will be registered for the type

func (*MarkDownView) SetupWebhookWithManager

func (r *MarkDownView) SetupWebhookWithManager(mgr ctrl.Manager) error

func (*MarkDownView) ValidateCreate

func (r *MarkDownView) ValidateCreate() error

ValidateCreate implements webhook.Validator so a webhook will be registered for the type

func (*MarkDownView) ValidateDelete

func (r *MarkDownView) ValidateDelete() error

ValidateDelete implements webhook.Validator so a webhook will be registered for the type

func (*MarkDownView) ValidateUpdate

func (r *MarkDownView) ValidateUpdate(old runtime.Object) error

ValidateUpdate implements webhook.Validator so a webhook will be registered for the type

type MarkDownViewList

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

MarkDownViewList contains a list of MarkDownView

func (*MarkDownViewList) DeepCopy

func (in *MarkDownViewList) DeepCopy() *MarkDownViewList

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

func (*MarkDownViewList) DeepCopyInto

func (in *MarkDownViewList) DeepCopyInto(out *MarkDownViewList)

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

func (*MarkDownViewList) DeepCopyObject

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

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

type MarkDownViewSpec

type MarkDownViewSpec struct {
	// MarkDowns contain the markdown files you want to display.
	// The key indicates the file name and must not overlap with the the keys.
	// The value is the content in markdown format.
	//+kubebuilder:validation:Required
	MarkDowns map[string]string `json:"markDowns,omitempty"`

	// Replicas is the number of viewers.
	// +kubebuilder:default=1
	// +optional
	Replicas int32 `json:"replicas,omitempty"`

	// ViewerImage is the image name of the viewer.
	// +optional
	ViewerImage string `json:"viewerImage,omitempty"`
}

MarkDownViewSpec defines the desired state of MarkDownView

func (*MarkDownViewSpec) DeepCopy

func (in *MarkDownViewSpec) DeepCopy() *MarkDownViewSpec

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

func (*MarkDownViewSpec) DeepCopyInto

func (in *MarkDownViewSpec) DeepCopyInto(out *MarkDownViewSpec)

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

type MarkDownViewStatus

type MarkDownViewStatus string

MarkDownViewStatus defines the observed state of MarkDownView +kubebuilder:validation:Enum=NotReady;Available;Healthy