k8c.io/api/v3@v3.0.0-20230904060738-b0a93889c0b6/pkg/apis/kubermatic/v1/dashboard_configuration.go

/*
Copyright 2023 The Kubermatic Kubernetes Platform contributors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package v1

import (
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

const GlobalSettingsName = "globalsettings"

// +genclient
// +kubebuilder:resource:scope=Cluster
// +kubebuilder:object:generate=true
// +kubebuilder:object:root=true
// +kubebuilder:printcolumn:JSONPath=".metadata.creationTimestamp",name="Age",type="date"

// DashboardConfiguration is the type representing a DashboardConfiguration.
type DashboardConfiguration struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec DashboardConfigurationSpec `json:"spec,omitempty"`
}

type DashboardConfigurationSpec struct {
	// CustomLinks are additional links that can be shown the dashboard's footer.
	CustomLinks CustomLinks `json:"customLinks"`
	// DefaultNodeCount is the default number of replicas for the initial MachineDeployment.
	DefaultNodeCount int8 `json:"defaultNodeCount"`
	// DisplayDemoInfo controls whether a "Demo System" hint is shown in the footer.
	DisplayDemoInfo bool `json:"displayDemoInfo"`
	// DisplayDemoInfo controls whether a a link to the KKP API documentation is shown in the footer.
	DisplayAPIDocs bool `json:"displayAPIDocs"`
	// DisplayDemoInfo controls whether a a link to TOS is shown in the footer.
	DisplayTermsOfService bool `json:"displayTermsOfService"`
	// EnableDashboard enables the link to the Kubernetes dashboard for a user cluster.
	EnableDashboard bool `json:"enableDashboard"`

	// +kubebuilder:default=false

	// EnableWebTerminal enables the Web Terminal feature for the user clusters.
	EnableWebTerminal bool `json:"enableWebTerminal,omitempty"`

	// +kubebuilder:default=true

	// EnableShareCluster enables the Share Cluster feature for the user clusters.
	EnableShareCluster bool `json:"enableShareCluster,omitempty"`

	EnableOIDCKubeconfig bool `json:"enableOIDCKubeconfig"` //nolint:tagliatelle
	// UserProjectsLimit is the maximum number of projects a user can create.
	UserProjectsLimit       int64 `json:"userProjectsLimit"`
	RestrictProjectCreation bool  `json:"restrictProjectCreation"`
	RestrictProjectDeletion bool  `json:"restrictProjectDeletion"`

	EnableExternalClusterImport bool `json:"enableExternalClusterImport"`

	// CleanupOptions control what happens when a cluster is deleted via the dashboard.
	// +optional
	CleanupOptions *CleanupOptions `json:"cleanupOptions,omitempty"`
	// +optional
	OpaOptions *OpaOptions `json:"opaOptions,omitempty"`
	// +optional
	MlaOptions *MlaOptions `json:"mlaOptions,omitempty"`

	MlaAlertmanagerPrefix string `json:"mlaAlertmanagerPrefix"`
	MlaGrafanaPrefix      string `json:"mlaGrafanaPrefix"`

	// Notifications are the configuration for notifications on dashboard.
	// +optional
	Notifications *NotificationsOptions `json:"notifications,omitempty"`

	// ProviderConfiguration are the cloud provider specific configurations on dashboard.
	// +optional
	ProviderConfiguration *ProviderConfiguration `json:"providerConfiguration,omitempty"`

	// MachineDeploymentVMResourceQuota is used to filter out allowed machine flavors based on the specified resource limits like CPU, Memory, and GPU etc.
	MachineDeploymentVMResourceQuota *MachineFlavorFilter `json:"machineDeploymentVMResourceQuota,omitempty"`

	// AllowedOperatingSystems controls if a given operating system is allowed to be used in a MachineDeployment.
	AllowedOperatingSystems map[OperatingSystem]bool `json:"allowedOperatingSystems,omitempty"`

	// DefaultProjectResourceQuota allows to configure a default project resource quota which
	// will be set for all projects that do not have a custom quota already set. EE-version only.
	// +optional
	DefaultProjectResourceQuota *DefaultProjectResourceQuota `json:"defaultQuota,omitempty"`

	// +optional
	MachineDeploymentOptions MachineDeploymentOptions `json:"machineDeploymentOptions,omitempty"`

	// DisableChangelogPopup disables the changelog popup in KKP dashboard.
	DisableChangelogPopup bool `json:"disableChangelogPopup,omitempty"`

	// TODO: Datacenters, presets, user management, Google Analytics and default addons.
}

func (s DashboardConfigurationSpec) HasDefaultProjectResourceQuota() bool {
	return s.DefaultProjectResourceQuota != nil && !s.DefaultProjectResourceQuota.Quota.IsEmpty()
}

type CustomLinks []CustomLink

type CustomLink struct {
	Label    string `json:"label"`
	URL      string `json:"url"`
	Icon     string `json:"icon"`
	Location string `json:"location"`
}

type CleanupOptions struct {
	// Enable checkboxes that allow the user to ask for LoadBalancers and PVCs
	// to be deleted in order to not leave potentially expensive resources behind.
	Enabled bool `json:"enabled,omitempty"`
	// If enforced is set to true, the cleanup of LoadBalancers and PVCs is
	// enforced.
	Enforced bool `json:"enforced,omitempty"`
}

type OpaOptions struct {
	Enabled  bool `json:"enabled,omitempty"`
	Enforced bool `json:"enforced,omitempty"`
}

type MlaOptions struct {
	LoggingEnabled     bool `json:"loggingEnabled,omitempty"`
	LoggingEnforced    bool `json:"loggingEnforced,omitempty"`
	MonitoringEnabled  bool `json:"monitoringEnabled,omitempty"`
	MonitoringEnforced bool `json:"monitoringEnforced,omitempty"`
}

type NotificationsOptions struct {
	// HideErrors will silence error notifications for the dashboard.
	HideErrors bool `json:"hideErrors,omitempty"`
	// HideErrorEvents will silence error events for the dashboard.
	HideErrorEvents bool `json:"hideErrorEvents,omitempty"`
}

type ProviderConfiguration struct {
	// OpenStack are the configurations for OpenStack provider.
	OpenStack *OpenStack `json:"openStack,omitempty"`
}

type OpenStack struct {
	// EnforceCustomDisk will enforce the custom disk option for machines for the dashboard.
	EnforceCustomDisk bool `json:"enforceCustomDisk,omitempty"`
}

type MachineDeploymentOptions struct {
	// AutoUpdatesEnabled enables the auto updates option for machine deployments on the dashboard.
	// In case of flatcar linux, this will enable automatic updates through update engine and for other operating systems,
	// this will enable package updates on boot for the machines.
	AutoUpdatesEnabled bool `json:"autoUpdatesEnabled,omitempty"`
	// AutoUpdatesEnforced enforces the auto updates option for machine deployments on the dashboard.
	// In case of flatcar linux, this will enable automatic updates through update engine and for other operating systems,
	// this will enable package updates on boot for the machines.
	AutoUpdatesEnforced bool `json:"autoUpdatesEnforced,omitempty"`
}

// DefaultProjectResourceQuota contains the default resource quota which will be set for all
// projects that do not have a custom quota already set.
type DefaultProjectResourceQuota struct {
	Quota *ResourceDetails `json:"quota,omitempty"`
}

// +kubebuilder:object:generate=true
// +kubebuilder:object:root=true

// DashboardConfigurationList is a list of settings.
type DashboardConfigurationList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	Items []DashboardConfiguration `json:"items"`
}