add backend route for storage class metadata

backend/src/routes/api/storage-class/index.ts

@@ -0,0 +1,27 @@
+import { FastifyReply, FastifyRequest } from 'fastify';
+import { StorageClassConfig, KubeFastifyInstance } from '../../../types';
+import { secureAdminRoute } from '../../../utils/route-security';
+import { updateStorageClassConfig } from './utils';
+
+export default async (fastify: KubeFastifyInstance): Promise<void> => {
+  fastify.put(
+    '/:storageClassName/config',
+    secureAdminRoute(fastify)(
+      async (
+        request: FastifyRequest<{
+          Body: StorageClassConfig;
+          Params: { storageClassName: string };
+        }>,
+        reply: FastifyReply,
+      ) => {
+        return updateStorageClassConfig(fastify, request)
+          .then((res) => {
+            return res;
+          })
+          .catch((res) => {
+            reply.send(res);
+          });
+      },
+    ),
+  );
+};

backend/src/routes/api/storage-class/utils.ts

@@ -0,0 +1,63 @@
+import { FastifyRequest } from 'fastify';
+import {
+  K8sResourceCommon,
+  KubeFastifyInstance,
+  ResponseStatus,
+  StorageClassConfig,
+} from '../../../types';
+import { isHttpError } from '../../../utils';
+import { errorHandler } from '../../../utils';
+
+export async function updateStorageClassConfig(
+  fastify: KubeFastifyInstance,
+  request: FastifyRequest<{ Body: StorageClassConfig; Params: { storageClassName: string } }>,
+): Promise<ResponseStatus> {
+  const params = request.params;
+  const body = request.body;
+
+  try {
+    // Fetch the existing custom object for the StorageClass
+    const storageClass = await fastify.kube.customObjectsApi.getClusterCustomObject(
+      'storage.k8s.io',
+      'v1',
+      'storageclasses',
+      params.storageClassName,
+    );
+
+    // Extract and update the annotations
+    const annotations = (storageClass.body as K8sResourceCommon).metadata.annotations || {};
+    annotations['opendatahub.io/sc-config'] = JSON.stringify(body);
+
+    // Patch the StorageClass with the new annotations
+    await fastify.kube.customObjectsApi.patchClusterCustomObject(
+      'storage.k8s.io',
+      'v1',
+      'storageclasses',
+      params.storageClassName,
+      {
+        metadata: {
+          annotations,
+        },
+      },
+      undefined,
+      undefined,
+      undefined,
+      {
+        headers: {
+          'Content-Type': 'application/merge-patch+json',
+        },
+      },
+    );
+
+    return { success: true, error: '' };
+  } catch (e) {
+    if (!isHttpError(e) || e.statusCode !== 404) {
+      fastify.log.error(e, 'Unable to update storage class metadata.');
+      return {
+        success: false,
+        error: `Unable to update storage class metadata: ${errorHandler(e)}`,
+      };
+    }
+    throw e;
+  }
+}

backend/src/types.ts

@@ -624,6 +624,14 @@ export type ImageTagInfo = {
 
 export type ImageType = 'byon' | 'jupyter' | 'other';
 
+export type StorageClassConfig = {
+  displayName: string;
+  isEnabled: boolean;
+  isDefault: boolean;
+  lastModified: string;
+  description?: string;
+};
+
 export type PersistentVolumeClaimKind = {
   apiVersion?: string;
   kind?: string;
@@ -1191,3 +1199,8 @@ export type ModelRegistryKind = K8sResourceCommon & {
     conditions?: K8sCondition[];
   };
 };
+
+export type ResponseStatus = {
+  success: boolean;
+  error: string;
+};

frontend/src/services/StorageClassService.ts

@@ -0,0 +1,16 @@
+import axios from '~/utilities/axios';
+import { StorageClassConfig } from '~/k8sTypes';
+import { ResponseStatus } from '~/types';
+
+export const updateStorageClassConfig = (
+  name: string,
+  spec: StorageClassConfig,
+): Promise<ResponseStatus> => {
+  const url = `/api/storage-class/${name}/config`;
+  return axios
+    .put(url, spec)
+    .then((response) => response.data)
+    .catch((e) => {
+      throw new Error(e.response.data.message);
+    });
+};

manifests/core-bases/base/role.yaml

@@ -3,6 +3,15 @@ apiVersion: rbac.authorization.k8s.io/v1
 metadata:
   name: odh-dashboard
 rules:
+  - verbs:
+      - get
+      - list
+      - update
+      - patch
+    apiGroups:
+      - storage.k8s.io
+    resources:
+      - storageclasses
   - verbs:
       - create
       - get