v1alpha1

Documentation

Overview

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

Index

• Constants
• Variables
• func RegisterDefaults(scheme *runtime.Scheme) error
• func SetDefaults_ClientConnectionConfiguration(obj *componentbaseconfigv1alpha1.ClientConnectionConfiguration)
• func SetDefaults_DebuggingConfiguration(obj *componentbaseconfigv1alpha1.DebuggingConfiguration)
• func SetDefaults_HealthEndpoint(obj *HealthEndpoint)
• func SetDefaults_LeaderElectionConfiguration(obj *componentbaseconfigv1alpha1.LeaderElectionConfiguration)
• func SetDefaults_MetricsEndpoint(obj *MetricsEndpoint)
• func SetDefaults_WebhostingOperatorConfig(obj *WebhostingOperatorConfig)
• func SetObjectDefaults_WebhostingOperatorConfig(in *WebhostingOperatorConfig)
• type HealthEndpoint
  • func (in *HealthEndpoint) DeepCopy() *HealthEndpoint
  • func (in *HealthEndpoint) DeepCopyInto(out *HealthEndpoint)
• type IngressConfiguration
  • func (in *IngressConfiguration) DeepCopy() *IngressConfiguration
  • func (in *IngressConfiguration) DeepCopyInto(out *IngressConfiguration)
• type MetricsEndpoint
  • func (in *MetricsEndpoint) DeepCopy() *MetricsEndpoint
  • func (in *MetricsEndpoint) DeepCopyInto(out *MetricsEndpoint)
• type WebhostingOperatorConfig
  • func (in *WebhostingOperatorConfig) DeepCopy() *WebhostingOperatorConfig
  • func (in *WebhostingOperatorConfig) DeepCopyInto(out *WebhostingOperatorConfig)
  • func (in *WebhostingOperatorConfig) DeepCopyObject() runtime.Object

Constants

const GroupName = "config.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, addDefaultingFuncs)
	// AddToScheme is a reference to the Scheme Builder's AddToScheme function.
	AddToScheme = SchemeBuilder.AddToScheme
)

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

SchemeGroupVersion is group version used to register these objects

Functions

func RegisterDefaults

func RegisterDefaults(scheme *runtime.Scheme) error

RegisterDefaults adds defaulters functions to the given scheme. Public to allow building arbitrary schemes. All generated defaulters are covering - they call all nested defaulters.

func SetDefaults_ClientConnectionConfiguration

func SetDefaults_ClientConnectionConfiguration(obj *componentbaseconfigv1alpha1.ClientConnectionConfiguration)

func SetDefaults_DebuggingConfiguration

func SetDefaults_DebuggingConfiguration(obj *componentbaseconfigv1alpha1.DebuggingConfiguration)

func SetDefaults_HealthEndpoint

func SetDefaults_HealthEndpoint(obj *HealthEndpoint)

func SetDefaults_LeaderElectionConfiguration

func SetDefaults_LeaderElectionConfiguration(obj *componentbaseconfigv1alpha1.LeaderElectionConfiguration)

func SetDefaults_MetricsEndpoint

func SetDefaults_MetricsEndpoint(obj *MetricsEndpoint)

func SetDefaults_WebhostingOperatorConfig

func SetDefaults_WebhostingOperatorConfig(obj *WebhostingOperatorConfig)

func SetObjectDefaults_WebhostingOperatorConfig

func SetObjectDefaults_WebhostingOperatorConfig(in *WebhostingOperatorConfig)

Types

type HealthEndpoint

type HealthEndpoint struct {
	// BindAddress is the TCP address that the controller should bind to
	// for serving health probes
	// It can be set to "0" to disable serving the health probe.
	// Defaults to :8081
	// +optional
	BindAddress string `json:"bindAddress,omitempty"`
}

HealthEndpoint defines the health configs.

func (*HealthEndpoint) DeepCopy

func (in *HealthEndpoint) DeepCopy() *HealthEndpoint

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

func (*HealthEndpoint) DeepCopyInto

func (in *HealthEndpoint) DeepCopyInto(out *HealthEndpoint)

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

type IngressConfiguration

type IngressConfiguration struct {
	// Annotations is a set of annotations to add to all created Ingress objects.
	// +optional
	Annotations map[string]string `json:"annotations,omitempty"`
	// Hosts is a list of hosts, under which Websites shall be available.
	// +optional
	Hosts []string `json:"hosts,omitempty"`
	// TLS configures TLS settings to be used on Ingress objects. Specify this to make Websites serve TLS connections for
	// the given hosts. SecretName is optional. If specified, the given Secret is expected to exist already in all project
	// namespaces. Otherwise, the Website controller will fill the Ingresses secretName field and expects the secret to be
	// created and filled by an external controller (e.g. cert-manager).
	// +optional
	TLS []networkingv1.IngressTLS `json:"tls,omitempty"`
}

IngressConfiguration contains configuration for the Ingress objects created for Websites.

func (*IngressConfiguration) DeepCopy

func (in *IngressConfiguration) DeepCopy() *IngressConfiguration

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

func (*IngressConfiguration) DeepCopyInto

func (in *IngressConfiguration) DeepCopyInto(out *IngressConfiguration)

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

type MetricsEndpoint

type MetricsEndpoint struct {
	// BindAddress is the TCP address that the controller should bind to
	// for serving prometheus metrics.
	// It can be set to "0" to disable the metrics serving.
	// Defaults to :8080
	// +optional
	BindAddress string `json:"bindAddress,omitempty"`
}

MetricsEndpoint defines the metrics configs.

func (*MetricsEndpoint) DeepCopy

func (in *MetricsEndpoint) DeepCopy() *MetricsEndpoint

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

func (*MetricsEndpoint) DeepCopyInto

func (in *MetricsEndpoint) DeepCopyInto(out *MetricsEndpoint)

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

type WebhostingOperatorConfig

type WebhostingOperatorConfig struct {
	metav1.TypeMeta `json:",inline"`

	// ClientConnection holds configuration for the kubernetes API clients.
	// +optional
	ClientConnection *componentbaseconfigv1alpha1.ClientConnectionConfiguration `json:"clientConnection,omitempty"`
	// LeaderElection is the LeaderElection config to be used when configuring
	// the manager.Manager leader election
	// +optional
	LeaderElection *componentbaseconfigv1alpha1.LeaderElectionConfiguration `json:"leaderElection,omitempty"`
	// Debugging holds configuration for Debugging related features.
	// +optional
	Debugging *componentbaseconfigv1alpha1.DebuggingConfiguration `json:"debugging,omitempty"`
	// Health contains the controller health configuration
	Health HealthEndpoint `json:"health"`
	// Metrics contains the controller metrics configuration
	Metrics MetricsEndpoint `json:"metrics"`
	// GracefulShutdownTimeout is the duration given to runnable to stop before the manager actually returns on stop.
	// To disable graceful shutdown, set it to 0s.
	// To use graceful shutdown without timeout, set to a negative duration, e.G. -1s.
	// The graceful shutdown is skipped for safety reasons in case the leader election lease is lost.
	// Defaults to 15s
	GracefulShutdownTimeout *metav1.Duration `json:"gracefulShutDown,omitempty"`

	// Ingress specifies configuration for the Ingress objects created for Websites.
	// +optional
	Ingress *IngressConfiguration `json:"ingress,omitempty"`
}

WebhostingOperatorConfig is the Schema for the controllermanagerconfigs API

func (*WebhostingOperatorConfig) DeepCopy

func (in *WebhostingOperatorConfig) DeepCopy() *WebhostingOperatorConfig

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

func (*WebhostingOperatorConfig) DeepCopyInto

func (in *WebhostingOperatorConfig) DeepCopyInto(out *WebhostingOperatorConfig)

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

func (*WebhostingOperatorConfig) DeepCopyObject

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

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