constant

Documentation

Index

• Constants
• Variables

Constants

const (
	LLMOSPrefix = "llmos.ai"
	MLPrefix    = "ml.llmos.ai"
	MgmtPrefix  = "management.llmos.ai"

	SystemNamespaceName          = "llmos-system"
	StorageSystemNamespaceName   = "storage-system"
	LLMOSDBNamespaceName         = "llmos-db-system"
	PublicNamespaceName          = "llmos-public"
	LLMOSMonitoringNamespaceName = "llmos-monitoring-system"
	LLMOSGPUStackNamespaceName   = "llmos-gpu-stack-system"
	SUCNamespace                 = "system-upgrade"
	AdminRole                    = "cluster-admin"
	NvidiaGPUKey                 = "nvidia.com/gpu"
	KubeSystemNamespaceName      = "kube-system"

	LLMOSCrdChartName      = "llmos-crd"
	LLMOSOperatorChartName = "llmos-operator"

	TrueStr    = "true"
	TimeLayout = time.RFC3339

	KubeNodeRoleLabelPrefix      = "node-role.kubernetes.io/"
	KubeMasterNodeLabelKey       = KubeNodeRoleLabelPrefix + "master"
	KubeControlPlaneNodeLabelKey = KubeNodeRoleLabelPrefix + "control-plane"
	KubeEtcdNodeLabelKey         = KubeNodeRoleLabelPrefix + "etcd"
	KubeWorkerNodeLabelKey       = KubeNodeRoleLabelPrefix + "worker"

	LabelEnforcePss = "pod-security.kubernetes.io/enforce"
	LabelAppName    = "app.kubernetes.io/name"
	LabelAppVersion = "app.kubernetes.io/version"

	LLMOSVersionLabel         = LLMOSPrefix + "/version"
	LLMOSServerVersionLabel   = LLMOSPrefix + "/server-version"
	LLMOSManagedLabel         = LLMOSPrefix + "/managed"
	ManagedAddonLabel         = LLMOSPrefix + "/managed-addon"
	SystemAddonLabel          = LLMOSPrefix + "/system-addon"
	SystemAddonAllowEditLabel = LLMOSPrefix + "/system-addon-allow-edit"
	TimestampAnno             = LLMOSPrefix + "/timestamp"

	SettingPreConfiguredValueAnno = LLMOSPrefix + "/previous-configured-value"
	SecretNameRefAnno             = LLMOSPrefix + "/secret-name"

	// Secret reference keys of the PostgreSQL, these are defined in the Helm chart values
	DefaultDBSecretName      = "llmos-db-credentials"
	DBUsernameKey            = "pg-username"
	DBDatabaseKey            = "pg-database"
	DBUserPasswordKey        = "pg-password"
	DBAdminPasswordKey       = "pg-admin-password"
	DBReplicationPasswordKey = "pg-replica-password"

	AnnotationResourceStopped          = LLMOSPrefix + "/resource-stopped"
	AnnotationVolumeClaimTemplates     = LLMOSPrefix + "/volume-claim-templates"
	AnnotationClusterPolicyProviderKey = LLMOSPrefix + "/k8s-provider"
	AnnotationSkipWebhook              = LLMOSPrefix + "/skip-webhook"
	AnnotationOnDeleteVolumes          = LLMOSPrefix + "/on-delete-volumes"

	/*
		KubeRay related constant
	*/
	LabelRaySchedulerName           = "ray.io/scheduler-name"
	AnnotationRayClusterInitialized = MLPrefix + "rayClusterInitialized"
	AnnotationRayFTEnabledKey       = "ray.io/ft-enabled"
	RayRedisCleanUpFinalizer        = "ray.io/gcs-ft-redis-cleanup-finalizer"

	RayServiceKind     = "RayService"
	RedisSecretKeyName = "redis-password" // #nosec G101

	/*
		Management related constants
	*/
	DefaultAdminLabelKey       = MgmtPrefix + "/default-admin"
	LabelManagementUsernameKey = MgmtPrefix + "/username"
	LabelManagementUserIdKey   = MgmtPrefix + "/user-id"

	/*
		ML related constants
	*/
	LabelNotebookName            = MLPrefix + "/notebook-name"
	LabelLLMOSMLAppName          = MLPrefix + "/app"
	LabelLLMOSMLType             = MLPrefix + "/type"
	LabelModelServiceName        = MLPrefix + "/model-service-name"
	LabelModelServiceServeEngine = MLPrefix + "/serve-engine"
)

Variables

var (
	ErrUnsupportedAction = errors.New("unsupported action")
	ErrOnlyPostMethod    = errors.New("only POST method is supported")
)