v1

package
v4.8.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 16, 2026 License: MPL-2.0 Imports: 2 Imported by: 0

Documentation

Overview

+k8s:openapi-gen=true +k8s:openapi-model-package=com.github.loft-sh.api.v4.pkg.apis.ui.v1 +k8s:deepcopy-gen=package,register +k8s:defaulter-gen=TypeMeta +groupName=ui.loft.sh

Index

Constants

This section is empty.

Variables

This section is empty.

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.

Types

type CspPolicy added in v4.4.0

type CspPolicy struct {
	Script  string
	Connect string
	Frame   string
	Font    string
}

func (*CspPolicy) DeepCopy added in v4.4.0

func (in *CspPolicy) DeepCopy() *CspPolicy

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

func (*CspPolicy) DeepCopyInto added in v4.4.0

func (in *CspPolicy) DeepCopyInto(out *CspPolicy)

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

func (CspPolicy) OpenAPIModelName added in v4.7.0

func (in CspPolicy) OpenAPIModelName() string

OpenAPIModelName returns the OpenAPI model name for this type.

type Csps added in v4.4.0

type Csps map[string]CspPolicy

func (Csps) DeepCopy added in v4.4.0

func (in Csps) DeepCopy() Csps

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

func (Csps) DeepCopyInto added in v4.4.0

func (in Csps) DeepCopyInto(out *Csps)

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

type ExternalURLs added in v4.4.0

type ExternalURLs struct {
	// Block determines if requests to external URLs from the UI should be blocked
	// +optional
	Block bool `json:"block,omitempty"`

	// Allow specifies which external URLs can be called. In addition to the predefined modules,
	// - "vcluster" (license page, feature descriptions, ...)
	// - "gtm" (google tag manager)
	// - "featurebase" (changelog)
	// any URL can be added to this list. This will allow the UI to make any request to this URL.
	// This is only active when Block is true.
	// +optional
	Allow []string `json:"allow,omitempty"`
}

func (*ExternalURLs) DeepCopy added in v4.4.0

func (in *ExternalURLs) DeepCopy() *ExternalURLs

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

func (*ExternalURLs) DeepCopyInto added in v4.4.0

func (in *ExternalURLs) DeepCopyInto(out *ExternalURLs)

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

func (ExternalURLs) OpenAPIModelName added in v4.7.0

func (in ExternalURLs) OpenAPIModelName() string

OpenAPIModelName returns the OpenAPI model name for this type.

type MultiRegion added in v4.8.0

type MultiRegion struct {
	// Enabled indicates whether multi-region is enabled
	Enabled bool `json:"enabled,omitempty"`

	// Region is the region where this vCluster Platform instance is running
	Region string `json:"region,omitempty"`
}

func (*MultiRegion) DeepCopy added in v4.8.0

func (in *MultiRegion) DeepCopy() *MultiRegion

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

func (*MultiRegion) DeepCopyInto added in v4.8.0

func (in *MultiRegion) DeepCopyInto(out *MultiRegion)

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

func (MultiRegion) OpenAPIModelName added in v4.8.0

func (in MultiRegion) OpenAPIModelName() string

OpenAPIModelName returns the OpenAPI model name for this type.

type NavBarButton struct {
	// Position holds the position of the button, can be one of:
	// TopStart, TopEnd, BottomStart, BottomEnd. Defaults to BottomEnd
	// +optional
	Position string `json:"position,omitempty"`
	// Text holds text for the button
	// +optional
	Text string `json:"text,omitempty"`
	// Link holds the link of the navbar button
	// +optional
	Link string `json:"link,omitempty"`
	// Icon holds the url of the icon to display
	// +optional
	Icon string `json:"icon,omitempty"`
}
func (in *NavBarButton) DeepCopy() *NavBarButton

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

func (in *NavBarButton) DeepCopyInto(out *NavBarButton)

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

func (in NavBarButton) OpenAPIModelName() string

OpenAPIModelName returns the OpenAPI model name for this type.

type ProductName

type ProductName string
const (
	ProductNameLoft        ProductName = "Loft"
	ProductNameVClusterPro ProductName = "vCluster Platform"
	ProductNameDevPodPro   ProductName = "DevPod.Pro"
)

type UISettings

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

	Spec   UISettingsSpec   `json:"spec,omitempty"`
	Status UISettingsStatus `json:"status,omitempty"`
}

UISettings holds the loft ui configuration settings +k8s:openapi-gen=true

func (*UISettings) DeepCopy

func (in *UISettings) DeepCopy() *UISettings

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

func (*UISettings) DeepCopyInto

func (in *UISettings) DeepCopyInto(out *UISettings)

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

func (*UISettings) DeepCopyObject

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

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

func (UISettings) OpenAPIModelName added in v4.7.0

func (in UISettings) OpenAPIModelName() string

OpenAPIModelName returns the OpenAPI model name for this type.

type UISettingsConfig

type UISettingsConfig struct {
	// LoftVersion holds the current loft version
	// +optional
	LoftVersion string `json:"loftVersion,omitempty"`
	// LogoURL is url pointing to the logo to use in the vCluster Platform UI. This path must be accessible for clients accessing
	// the vCluster Platform UI!
	// +optional
	LogoURL string `json:"logoURL,omitempty"`
	// FaviconURL is url pointing to the favicon to use in the vCluster Platform UI. This path must be accessible for clients accessing
	// the vCluster Platform UI!
	// +optional
	FaviconURL string `json:"faviconURL,omitempty"`
	// SmallLogoURL is url pointing to the small logo to use in the vCluster Platform UI. This path must be accessible for clients accessing
	// the vCluster Platform UI!
	// +optional
	SmallLogoURL string `json:"smallLogoURL,omitempty"`
	// LogoBackgroundColor is the color value (ex: "#12345") to use as the background color for the logo
	// +optional
	LogoBackgroundColor string `json:"logoBackgroundColor,omitempty"`
	// LegalTemplate is a text (html) string containing the legal template to prompt to users when authenticating to Loft
	// +optional
	LegalTemplate string `json:"legalTemplate,omitempty"`
	// PrimaryColor is the color value (ex: "#12345") to use as the primary color
	// +optional
	PrimaryColor string `json:"primaryColor,omitempty"`
	// SidebarColor is the color value (ex: "#12345") to use for the sidebar
	// +optional
	SidebarColor string `json:"sidebarColor,omitempty"`
	// AccentColor is the color value (ex: "#12345") to use for the accent
	// +optional
	AccentColor string `json:"accentColor,omitempty"`
	// CustomCSS holds URLs with custom css files that should be included when loading the UI
	// +optional
	CustomCSS []string `json:"customCss,omitempty"`
	// CustomJavaScript holds URLs with custom js files that should be included when loading the UI
	// +optional
	CustomJavaScript []string `json:"customJavaScript,omitempty"`
	// NavBarButtons holds extra nav bar buttons
	// +optional
	NavBarButtons []NavBarButton `json:"navBarButtons,omitempty"`
	// External URLs that can be called from the UI
	// +optional
	ExternalURLs ExternalURLs `json:"externalURLs,omitempty"`
}

func (*UISettingsConfig) DeepCopy

func (in *UISettingsConfig) DeepCopy() *UISettingsConfig

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

func (*UISettingsConfig) DeepCopyInto

func (in *UISettingsConfig) DeepCopyInto(out *UISettingsConfig)

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

func (UISettingsConfig) OpenAPIModelName added in v4.7.0

func (in UISettingsConfig) OpenAPIModelName() string

OpenAPIModelName returns the OpenAPI model name for this type.

type UISettingsSpec

type UISettingsSpec struct {
	UISettingsConfig `json:",inline"`

	// Name is the name of the product
	// +optional
	ProductName string `json:"productName,omitempty"`

	// Offline is true if loft is running in an airgapped environment
	// +optional
	Offline bool `json:"offline,omitempty"`

	// HasHelmRelease indicates whether the vCluster Platform instance
	// has been installed via Helm
	HasHelmRelease bool `json:"hasHelmRelease,omitempty"`

	// DefaultVClusterVersion is the default version of vClusters
	DefaultVClusterVersion string `json:"defaultVClusterVersion,omitempty"`

	// AvailableVClusterVersions lists all virtual cluster versions available to the platform instance
	// +optional
	AvailableVClusterVersions []VClusterVersion `json:"availableVClusterVersions,omitempty"`

	// LoftHosted indicates whether the vCluster Platform instance
	// is hosted and operated by Loft Labs Inc.
	LoftHosted bool `json:"loftHosted,omitempty"`

	// MultiRegion holds the multi-region configuration
	MultiRegion MultiRegion `json:"multiRegion,omitempty"`

	// AgentNamespace is the namespace where the connected cluster agents are deployed by default
	AgentNamespace string `json:"agentNamespace,omitempty"`
}

UISettingsSpec holds the specification

func (*UISettingsSpec) DeepCopy

func (in *UISettingsSpec) DeepCopy() *UISettingsSpec

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

func (*UISettingsSpec) DeepCopyInto

func (in *UISettingsSpec) DeepCopyInto(out *UISettingsSpec)

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

func (UISettingsSpec) OpenAPIModelName added in v4.7.0

func (in UISettingsSpec) OpenAPIModelName() string

OpenAPIModelName returns the OpenAPI model name for this type.

type UISettingsStatus

type UISettingsStatus struct {
	// Csps holds Content Security Policies
	// +optional
	Csps Csps `json:"csps,omitempty"`

	// CspConfig holds the raw csp config from the user
	// +optional
	CspConfig string `json:"cspConfig,omitempty"`
}

UISettingsStatus holds the status

func (*UISettingsStatus) DeepCopy

func (in *UISettingsStatus) DeepCopy() *UISettingsStatus

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

func (*UISettingsStatus) DeepCopyInto

func (in *UISettingsStatus) DeepCopyInto(out *UISettingsStatus)

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

func (UISettingsStatus) OpenAPIModelName added in v4.7.0

func (in UISettingsStatus) OpenAPIModelName() string

OpenAPIModelName returns the OpenAPI model name for this type.

type VClusterVersion added in v4.4.0

type VClusterVersion struct {
	// TagName is the full tag name
	Tag string `json:"tagName,omitempty"`

	// PreRelease determines if the version is marked as prerelease
	PreRelease bool `json:"prerelease,omitempty"`
}

func (*VClusterVersion) DeepCopy added in v4.4.0

func (in *VClusterVersion) DeepCopy() *VClusterVersion

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

func (*VClusterVersion) DeepCopyInto added in v4.4.0

func (in *VClusterVersion) DeepCopyInto(out *VClusterVersion)

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

func (VClusterVersion) OpenAPIModelName added in v4.7.0

func (in VClusterVersion) OpenAPIModelName() string

OpenAPIModelName returns the OpenAPI model name for this type.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL