feat: add Account and User CRDs for Slurm accounting

PROJECT

@@ -83,6 +83,30 @@ resources:
   webhooks:
     validation: true
     webhookVersion: v1beta1
+- api:
+    crdVersion: v1beta1
+    namespaced: true
+  controller: true
+  domain: slurm.net
+  group: slinky
+  kind: Account
+  path: github.com/SlinkyProject/slurm-operator/api/v1beta1
+  version: v1beta1
+  webhooks:
+    validation: true
+    webhookVersion: v1beta1
+- api:
+    crdVersion: v1beta1
+    namespaced: true
+  controller: true
+  domain: slurm.net
+  group: slinky
+  kind: User
+  path: github.com/SlinkyProject/slurm-operator/api/v1beta1
+  version: v1beta1
+  webhooks:
+    validation: true
+    webhookVersion: v1beta1
 - api:
     crdVersion: v1
     namespaced: true

api/v1beta1/account_types.go

@@ -0,0 +1,98 @@
+// SPDX-FileCopyrightText: Copyright (C) SchedMD LLC.
+// SPDX-License-Identifier: Apache-2.0
+
+package v1beta1
+
+import (
+	corev1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+const (
+	AccountKind = "Account"
+)
+
+var (
+	AccountGVK        = GroupVersion.WithKind(AccountKind)
+	AccountAPIVersion = GroupVersion.String()
+)
+
+// DeletionPolicy controls what happens to the Slurm entity when the CR is deleted.
+// +kubebuilder:validation:Enum=Delete;Orphan
+type DeletionPolicy string
+
+const (
+	DeletionPolicyDelete DeletionPolicy = "Delete"
+	DeletionPolicyOrphan DeletionPolicy = "Orphan"
+)
+
+// AccountSpec defines the desired state of Account.
+type AccountSpec struct {
+	// controllerRef references the target Controller CR.
+	// +required
+	ControllerRef corev1.LocalObjectReference `json:"controllerRef"`
+
+	// accountName in Slurm; defaults to metadata.name if empty.
+	// +optional
+	AccountName string `json:"accountName,omitempty"`
+
+	// description of the account; defaults to accountName if empty.
+	// +optional
+	Description string `json:"description,omitempty"`
+
+	// organization to which the account belongs; defaults to "root" if empty.
+	// +optional
+	Organization string `json:"organization,omitempty"`
+
+	// parentAccount for hierarchy; defaults to "root".
+	// +optional
+	ParentAccount *string `json:"parentAccount,omitempty"`
+
+	// deletionPolicy controls the Slurm-side entity on CR deletion.
+	// +optional
+	// +default:="Delete"
+	DeletionPolicy DeletionPolicy `json:"deletionPolicy,omitempty"`
+
+	// limits applied to this account's association.
+	// +optional
+	Limits AssociationLimits `json:"limits,omitempty"`
+}
+
+// AccountStatus defines the observed state of Account.
+type AccountStatus struct {
+	// +optional
+	// +patchMergeKey=type
+	// +patchStrategy=merge
+	// +listType=map
+	// +listMapKey=type
+	Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"`
+}
+
+// +kubebuilder:object:root=true
+// +kubebuilder:subresource:status
+// +kubebuilder:resource:shortName=acct
+// +kubebuilder:printcolumn:name="ACCOUNT",type="string",JSONPath=".spec.accountName",description="The Slurm account name."
+// +kubebuilder:printcolumn:name="PARENT",type="string",JSONPath=".spec.parentAccount",description="The parent account."
+// +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp"
+
+// Account is the Schema for the accounts API.
+type Account struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	Spec   AccountSpec   `json:"spec,omitempty"`
+	Status AccountStatus `json:"status,omitempty"`
+}
+
+// +kubebuilder:object:root=true
+
+// AccountList contains a list of Account.
+type AccountList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []Account `json:"items"`
+}
+
+func init() {
+	SchemeBuilder.Register(&Account{}, &AccountList{})
+}

api/v1beta1/account_types_test.go

@@ -0,0 +1,18 @@
+package v1beta1
+
+import "testing"
+
+func TestAccount_GVK(t *testing.T) {
+	if AccountKind != "Account" {
+		t.Fatalf("AccountKind = %q", AccountKind)
+	}
+	if AccountGVK.Kind != "Account" {
+		t.Fatalf("AccountGVK.Kind = %q", AccountGVK.Kind)
+	}
+}
+
+func TestDeletionPolicyConstants(t *testing.T) {
+	if DeletionPolicyDelete != "Delete" || DeletionPolicyOrphan != "Orphan" {
+		t.Fatalf("unexpected DeletionPolicy values")
+	}
+}

api/v1beta1/association_types.go

@@ -0,0 +1,63 @@
+// SPDX-FileCopyrightText: Copyright (C) SchedMD LLC.
+// SPDX-License-Identifier: Apache-2.0
+
+package v1beta1
+
+import metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+
+// AssociationLimits captures the common Slurm association limits/QoS/fairshare.
+// Unset fields are not managed by the operator.
+type AssociationLimits struct {
+	// Fairshare is an integer number of shares, or the literal "parent".
+	// +optional
+	Fairshare *string `json:"fairshare,omitempty"`
+
+	// Priority added to jobs using this association.
+	// +optional
+	Priority *int32 `json:"priority,omitempty"`
+
+	// QOS is the list of QOS names allowed for this association.
+	// +optional
+	QOS []string `json:"qos,omitempty"`
+
+	// DefaultQOS for this association; must be present in QOS.
+	// +optional
+	DefaultQOS *string `json:"defaultQos,omitempty"`
+
+	// GrpTRES is the aggregate TRES limit, e.g. {"cpu":"10","gres/gpu":"4"}.
+	// +optional
+	GrpTRES map[string]string `json:"grpTRES,omitempty"`
+
+	// +optional
+	GrpJobs *int32 `json:"grpJobs,omitempty"`
+	// +optional
+	GrpSubmitJobs *int32 `json:"grpSubmitJobs,omitempty"`
+	// +optional
+	GrpWall *metav1.Duration `json:"grpWall,omitempty"`
+
+	// +optional
+	MaxJobs *int32 `json:"maxJobs,omitempty"`
+	// +optional
+	MaxSubmitJobs *int32 `json:"maxSubmitJobs,omitempty"`
+	// MaxTRESPerJob is the per-job TRES limit, e.g. {"cpu":"4"}.
+	// +optional
+	MaxTRESPerJob map[string]string `json:"maxTRESPerJob,omitempty"`
+	// +optional
+	MaxWallPerJob *metav1.Duration `json:"maxWallPerJob,omitempty"`
+}
+
+// UserAssociation is a single account membership for a User.
+type UserAssociation struct {
+	// account name this user belongs to.
+	// +required
+	// +kubebuilder:validation:MaxLength=64
+	Account string `json:"account"`
+
+	// partition scopes this association to a Slurm partition.
+	// +optional
+	Partition *string `json:"partition,omitempty"`
+
+	// limits for this specific membership.
+	// +optional
+	Limits AssociationLimits `json:"limits,omitempty"`
+}

api/v1beta1/user_types.go

@@ -0,0 +1,101 @@
+// SPDX-FileCopyrightText: Copyright (C) SchedMD LLC.
+// SPDX-License-Identifier: Apache-2.0
+
+package v1beta1
+
+import (
+	corev1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+const (
+	UserKind = "User"
+)
+
+var (
+	UserGVK        = GroupVersion.WithKind(UserKind)
+	UserAPIVersion = GroupVersion.String()
+)
+
+// AdminLevel is the Slurm administrator level granted to a user.
+// +kubebuilder:validation:Enum=None;Operator;Administrator
+type AdminLevel string
+
+const (
+	AdminLevelNone          AdminLevel = "None"
+	AdminLevelOperator      AdminLevel = "Operator"
+	AdminLevelAdministrator AdminLevel = "Administrator"
+)
+
+// UserSpec defines the desired state of User.
+// +kubebuilder:validation:XValidation:rule="self.defaultAccount == '' || self.associations.exists(a, a.account == self.defaultAccount)", message="defaultAccount must match one of the associations"
+type UserSpec struct {
+	// controllerRef references the target Controller CR.
+	// +required
+	ControllerRef corev1.LocalObjectReference `json:"controllerRef"`
+
+	// userName in Slurm; defaults to metadata.name if empty.
+	// +optional
+	UserName string `json:"userName,omitempty"`
+
+	// adminLevel granted to the user.
+	// +optional
+	// +default:="None"
+	AdminLevel AdminLevel `json:"adminLevel,omitempty"`
+
+	// defaultAccount must match one of the associations' account.
+	// Defaults to the first association's account if empty.
+	// +optional
+	// +kubebuilder:validation:MaxLength=64
+	DefaultAccount string `json:"defaultAccount,omitempty"`
+
+	// associations are the account memberships for this user.
+	// +required
+	// +kubebuilder:validation:MinItems=1
+	// +kubebuilder:validation:MaxItems=128
+	Associations []UserAssociation `json:"associations"`
+
+	// deletionPolicy controls the Slurm-side entity on CR deletion.
+	// +optional
+	// +default:="Delete"
+	DeletionPolicy DeletionPolicy `json:"deletionPolicy,omitempty"`
+}
+
+// UserStatus defines the observed state of User.
+type UserStatus struct {
+	// +optional
+	// +patchMergeKey=type
+	// +patchStrategy=merge
+	// +listType=map
+	// +listMapKey=type
+	Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"`
+}
+
+// +kubebuilder:object:root=true
+// +kubebuilder:subresource:status
+// +kubebuilder:resource:shortName=slurmuser
+// +kubebuilder:printcolumn:name="USER",type="string",JSONPath=".spec.userName",description="The Slurm user name."
+// +kubebuilder:printcolumn:name="DEFAULT ACCOUNT",type="string",JSONPath=".spec.defaultAccount",description="The user's default account."
+// +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp"
+
+// User is the Schema for the users API.
+type User struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	Spec   UserSpec   `json:"spec,omitempty"`
+	Status UserStatus `json:"status,omitempty"`
+}
+
+// +kubebuilder:object:root=true
+
+// UserList contains a list of User.
+type UserList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []User `json:"items"`
+}
+
+func init() {
+	SchemeBuilder.Register(&User{}, &UserList{})
+}

api/v1beta1/user_types_test.go

@@ -0,0 +1,18 @@
+package v1beta1
+
+import "testing"
+
+func TestUser_GVK(t *testing.T) {
+	if UserKind != "User" {
+		t.Fatalf("UserKind = %q", UserKind)
+	}
+	if UserGVK.Kind != "User" {
+		t.Fatalf("UserGVK.Kind = %q", UserGVK.Kind)
+	}
+}
+
+func TestAdminLevelConstants(t *testing.T) {
+	if AdminLevelNone != "None" || AdminLevelOperator != "Operator" || AdminLevelAdministrator != "Administrator" {
+		t.Fatalf("unexpected AdminLevel values")
+	}
+}