v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the plex v1alpha1 API group +kubebuilder:object:generate=true +groupName=plex.adambkaplan.com

Index

• Variables
• type PlexMediaServer
  • func (in *PlexMediaServer) DeepCopy() *PlexMediaServer
  • func (in *PlexMediaServer) DeepCopyInto(out *PlexMediaServer)
  • func (in *PlexMediaServer) DeepCopyObject() runtime.Object
• type PlexMediaServerList
  • func (in *PlexMediaServerList) DeepCopy() *PlexMediaServerList
  • func (in *PlexMediaServerList) DeepCopyInto(out *PlexMediaServerList)
  • func (in *PlexMediaServerList) DeepCopyObject() runtime.Object
• type PlexMediaServerSpec
  • func (in *PlexMediaServerSpec) DeepCopy() *PlexMediaServerSpec
  • func (in *PlexMediaServerSpec) DeepCopyInto(out *PlexMediaServerSpec)
• type PlexMediaServerStatus
  • func (in *PlexMediaServerStatus) DeepCopy() *PlexMediaServerStatus
  • func (in *PlexMediaServerStatus) DeepCopyInto(out *PlexMediaServerStatus)
• type PlexNetworkSpec
  • func (in *PlexNetworkSpec) DeepCopy() *PlexNetworkSpec
  • func (in *PlexNetworkSpec) DeepCopyInto(out *PlexNetworkSpec)
• type PlexStorageOptions
  • func (in *PlexStorageOptions) DeepCopy() *PlexStorageOptions
  • func (in *PlexStorageOptions) DeepCopyInto(out *PlexStorageOptions)
• type PlexStorageSpec
  • func (in *PlexStorageSpec) DeepCopy() *PlexStorageSpec
  • func (in *PlexStorageSpec) DeepCopyInto(out *PlexStorageSpec)

Variables

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

Types

type PlexMediaServer

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

	Spec   PlexMediaServerSpec   `json:"spec,omitempty"`
	Status PlexMediaServerStatus `json:"status,omitempty"`
}

PlexMediaServer is the Schema for the plexmediaservers API

func (*PlexMediaServer) DeepCopy

func (in *PlexMediaServer) DeepCopy() *PlexMediaServer

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

func (*PlexMediaServer) DeepCopyInto

func (in *PlexMediaServer) DeepCopyInto(out *PlexMediaServer)

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

func (*PlexMediaServer) DeepCopyObject

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

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

type PlexMediaServerList

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

PlexMediaServerList contains a list of PlexMediaServer

func (*PlexMediaServerList) DeepCopy

func (in *PlexMediaServerList) DeepCopy() *PlexMediaServerList

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

func (*PlexMediaServerList) DeepCopyInto

func (in *PlexMediaServerList) DeepCopyInto(out *PlexMediaServerList)

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

func (*PlexMediaServerList) DeepCopyObject

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

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

type PlexMediaServerSpec

type PlexMediaServerSpec struct {

	// Version is the version of Plex Media server deployed on the cluster
	// +optional
	Version string `json:"version,omitempty"`

	// ClaimToken is the claim token needed to register the Plex Media Server
	// +optional
	ClaimToken string `json:"claimToken,omitempty"`

	// Storage configures the persistent volume claim attributes for Plex Media Server's backing
	// volumes:
	//
	// 1. Config - Plex's configuration database
	// 2. Transcode - Plex's space for transcoded media files
	// 3. Data - Plex's volume for user-provided media
	// +optional
	Storage PlexStorageSpec `json:"storage,omitempty"`

	// Networking configures network options for the Plex Media Server, such as an external-facing service.
	// +optional
	Networking PlexNetworkSpec `json:"networking,omitempty"`
}

PlexMediaServerSpec defines the desired state of PlexMediaServer

func (*PlexMediaServerSpec) DeepCopy

func (in *PlexMediaServerSpec) DeepCopy() *PlexMediaServerSpec

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

func (*PlexMediaServerSpec) DeepCopyInto

func (in *PlexMediaServerSpec) DeepCopyInto(out *PlexMediaServerSpec)

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

type PlexMediaServerStatus

type PlexMediaServerStatus struct {

	// ObservedGeneration is the generation last observed by the controller
	// +optional
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`

	// Conditions reports the condition of the Plex Media Server
	// +optional
	Conditions []metav1.Condition `json:"conditions,omitempty"`
}

PlexMediaServerStatus defines the observed state of PlexMediaServer

func (*PlexMediaServerStatus) DeepCopy

func (in *PlexMediaServerStatus) DeepCopy() *PlexMediaServerStatus

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

func (*PlexMediaServerStatus) DeepCopyInto

func (in *PlexMediaServerStatus) DeepCopyInto(out *PlexMediaServerStatus)

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

type PlexNetworkSpec

type PlexNetworkSpec struct {

	// ExternalServiceType configures an external-facing Service for Plex Media Server, in addition
	// to the headless service used for Plex's underlying StatefulSet deployment.
	// Can be one of NodePort or LoadBalancer
	// +optional
	// +kubebuilder:validation:Enum=NodePort;LoadBalancer
	ExternalServiceType corev1.ServiceType `json:"externalServiceType,omitempty"`

	// EnableDiscovery opens ports necessary for GDM network discovery
	// +optional
	EnableDiscovery bool `json:"enableDiscovery,omitempty"`

	// EnableDLNA opens DLNA access ports on all services.
	// +optional
	EnableDLNA bool `json:"enableDNLA,omitempty"`

	// EnableRoku opens Plex Companion ports used to access Plex via Roku devices.
	// +optional
	EnableRoku bool `json:"enableRoku,omitempty"`
}

PlexNetworkSpec specifies network options for the Plex Media Server

func (*PlexNetworkSpec) DeepCopy

func (in *PlexNetworkSpec) DeepCopy() *PlexNetworkSpec

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

func (*PlexNetworkSpec) DeepCopyInto

func (in *PlexNetworkSpec) DeepCopyInto(out *PlexNetworkSpec)

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

type PlexStorageOptions

type PlexStorageOptions struct {

	// AccessMode sets the access mode for the PersistentVolumeClaim used for this Plex volume.
	// +optional
	AccessMode corev1.PersistentVolumeAccessMode `json:"accessMode,omitempty"`

	// Capacity specifies the requested capacity for the PersistentVolumeClaim.
	// The provided volume for this claim may exceed this value.
	// +optional
	Capacity resource.Quantity `json:"capacity,omitempty"`

	// StorageClassName specifies the storage class for the PersistentVolumeClaim.
	// +optional
	StorageClassName *string `json:"storageClassName,omitempty"`

	// Selector is a label selector that can be applied to the PersistentVolumeClaim
	// +optional
	Selector *metav1.LabelSelector `json:"selector,omitempty"`
}

PlexStorageOptions configures a PersistentVolumeClaim used by the Plex Media Server

func (*PlexStorageOptions) DeepCopy

func (in *PlexStorageOptions) DeepCopy() *PlexStorageOptions

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

func (*PlexStorageOptions) DeepCopyInto

func (in *PlexStorageOptions) DeepCopyInto(out *PlexStorageOptions)

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

type PlexStorageSpec

type PlexStorageSpec struct {

	// Config specifics the volume claim attributes for Plex Media Server's database
	// +optional
	Config *PlexStorageOptions `json:"config,omitempty"`

	// Transcode specifies the volume claim attributes for Plex Media Server's transcoded
	// media files
	// +optional
	Transcode *PlexStorageOptions `json:"transcode,omitempty"`

	// Data specifies the volume claim attributes for Plex Media Server's media data
	// +optional
	Data *PlexStorageOptions `json:"data,omitempty"`
}

PlexStorageSpec defines persistent volume claim attributes for the volumes used by the Plex Media Server

func (*PlexStorageSpec) DeepCopy

func (in *PlexStorageSpec) DeepCopy() *PlexStorageSpec

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

func (*PlexStorageSpec) DeepCopyInto

func (in *PlexStorageSpec) DeepCopyInto(out *PlexStorageSpec)

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