Added types for notebookimage and status (opendatahub-io#147)

Updated with REST api notebook image endpoints and new notebook image types. Updated REST API (opendatahub-io#155) * Updated with REST API design changes. Fixed formatting error. * Update backend/src/types.ts Co-authored-by: Tom Coufal <[email protected]> Co-authored-by: Tom Coufal <[email protected]> Updated type.ts in front end with Succeeded [byon] Implement backend (opendatahub-io#156) * feat(byon): List all notebooks Signed-off-by: Tomas Coufal <[email protected]> * feat(byon): Get single notebook Signed-off-by: Tomas Coufal <[email protected]> * fix(byon): Update api spec to include software and id Signed-off-by: Tomas Coufal <[email protected]> * feat(byon): Schedule new notebook import Signed-off-by: Tomas Coufal <[email protected]> * feat(byon): Delete notebook Signed-off-by: Tomas Coufal <[email protected]> * feat(byon): Update notebook Signed-off-by: Tomas Coufal <[email protected]> Rebased BYON from master (opendatahub-io#162) * Updated way that to detect an admin. (opendatahub-io#137) Fixed linting error. * Update backend port setting and makefile dev commands. (opendatahub-io#133) * Update README.md (opendatahub-io#96) Updated Readme to specify that a build is required prior to running the development server. * Fix for input not allowing blank spaces.: Fix to allow a user to enter an empty string. Fixed with review comment. * Add culler timeout settings feature (opendatahub-io#134) * Added types for notebookimage and status (opendatahub-io#147) Updated with REST api notebook image endpoints and new notebook image types. * Updated REST API (opendatahub-io#155) * Updated with REST API design changes. Fixed formatting error. * Update backend/src/types.ts Co-authored-by: Tom Coufal <[email protected]> Co-authored-by: Tom Coufal <[email protected]> * Updated type.ts in front end with Succeeded * [byon] Implement backend (opendatahub-io#156) * feat(byon): List all notebooks Signed-off-by: Tomas Coufal <[email protected]> * feat(byon): Get single notebook Signed-off-by: Tomas Coufal <[email protected]> * fix(byon): Update api spec to include software and id Signed-off-by: Tomas Coufal <[email protected]> * feat(byon): Schedule new notebook import Signed-off-by: Tomas Coufal <[email protected]> * feat(byon): Delete notebook Signed-off-by: Tomas Coufal <[email protected]> * feat(byon): Update notebook Signed-off-by: Tomas Coufal <[email protected]> Co-authored-by: Christopher Chase <[email protected]> Co-authored-by: Chad Roberts <[email protected]> Co-authored-by: Juntao Wang <[email protected]> Co-authored-by: Tom Coufal <[email protected]> fix(byon): Use notebook-image label for visibility toggle (opendatahub-io#169) Signed-off-by: Tomas Coufal <[email protected]> feat(byon): Feat add creator annotation (opendatahub-io#170) Signed-off-by: Tomas Coufal <[email protected]> feat(byon): Allow to patch name and description on notebook (opendatahub-io#172) Signed-off-by: Tomas Coufal <[email protected]> feat(byon): Allow python dependency visibility field changes (opendatahub-io#173) Signed-off-by: Tomas Coufal <[email protected]> Added code for importing byon image. (opendatahub-io#171) Updated front end code with import and start of table. Updated with byon changes Updated code with byon ui changes. Integrated import, delete, and get functionality for notebooks. Added start of edit panel. Updated build error fixes. Updates to edit dialog and linting cleanup. Added sort to table. Added filtering. Added failure warning to allow user to click Add check disable enabling failed notebook images Fixed with review comments. Fixed time bug. Removed admin
dlabaj · Apr 8, 2022 · 05ab574 · 05ab574
1 parent cf6e7d6
commit 05ab574
Show file tree

Hide file tree

Showing 18 changed files with 1,441 additions and 7 deletions.
diff --git a/backend/src/routes/api/notebook/index.ts b/backend/src/routes/api/notebook/index.ts
@@ -0,0 +1,60 @@
+import { FastifyInstance, FastifyReply, FastifyRequest } from 'fastify';
+import {
+  addNotebook,
+  deleteNotebook,
+  getNotebook,
+  getNotebooks,
+  updateNotebook,
+} from './notebooksUtils';
+
+export default async (fastify: FastifyInstance): Promise<void> => {
+  fastify.get('/', async (request: FastifyRequest, reply: FastifyReply) => {
+    return getNotebooks(fastify)
+      .then((res) => {
+        return res;
+      })
+      .catch((res) => {
+        reply.send(res);
+      });
+  });
+
+  fastify.get('/:notebook', async (request: FastifyRequest, reply: FastifyReply) => {
+    return getNotebook(fastify, request)
+      .then((res) => {
+        return res;
+      })
+      .catch((res) => {
+        reply.send(res);
+      });
+  });
+
+  fastify.delete('/:notebook', async (request: FastifyRequest, reply: FastifyReply) => {
+    return deleteNotebook(fastify, request)
+      .then((res) => {
+        return res;
+      })
+      .catch((res) => {
+        reply.send(res);
+      });
+  });
+
+  fastify.put('/:notebook', async (request: FastifyRequest, reply: FastifyReply) => {
+    return updateNotebook(fastify, request)
+      .then((res) => {
+        return res;
+      })
+      .catch((res) => {
+        reply.send(res);
+      });
+  });
+
+  fastify.post('/', async (request: FastifyRequest, reply: FastifyReply) => {
+    return addNotebook(fastify, request)
+      .then((res) => {
+        return res;
+      })
+      .catch((res) => {
+        reply.send(res);
+      });
+  });
+};
diff --git a/backend/src/routes/api/notebook/notebooksUtils.ts b/backend/src/routes/api/notebook/notebooksUtils.ts
@@ -0,0 +1,321 @@
+import { FastifyRequest } from 'fastify';
+import createError from 'http-errors';
+import {
+  KubeFastifyInstance,
+  Notebook,
+  ImageStreamListKind,
+  ImageStreamKind,
+  NotebookStatus,
+  PipelineRunListKind,
+  PipelineRunKind,
+  NotebookCreateRequest,
+  NotebookUpdateRequest,
+  NotebookPackage,
+} from '../../../types';
+
+const mapImageStreamToNotebook = (is: ImageStreamKind): Notebook => ({
+  id: is.metadata.name,
+  name: is.metadata.annotations['opendatahub.io/notebook-image-name'],
+  description: is.metadata.annotations['opendatahub.io/notebook-image-desc'],
+  phase: is.metadata.annotations['opendatahub.io/notebook-image-phase'] as NotebookStatus,
+  visible: is.metadata.labels['opendatahub.io/notebook-image'] === 'true',
+  error: is.metadata.annotations['opendatahub.io/notebook-image-messages']
+    ? JSON.parse(is.metadata.annotations['opendatahub.io/notebook-image-messages'])
+    : [],
+  packages:
+    is.spec.tags &&
+    (JSON.parse(
+      is.spec.tags[0].annotations['opendatahub.io/notebook-python-dependencies'],
+    ) as NotebookPackage[]),
+  software:
+    is.spec.tags &&
+    (JSON.parse(
+      is.spec.tags[0].annotations['opendatahub.io/notebook-software'],
+    ) as NotebookPackage[]),
+  uploaded: is.metadata.creationTimestamp,
+  url: is.metadata.annotations['opendatahub.io/notebook-image-url'],
+  user: is.metadata.annotations['opendatahub.io/notebook-image-creator'],
+});
+
+const mapPipelineRunToNotebook = (plr: PipelineRunKind): Notebook => ({
+  id: plr.metadata.name,
+  name: plr.spec.params.find((p) => p.name === 'name')?.value,
+  description: plr.spec.params.find((p) => p.name === 'desc')?.value,
+  url: plr.spec.params.find((p) => p.name === 'url')?.value,
+  user: plr.spec.params.find((p) => p.name === 'creator')?.value,
+  phase: 'Importing',
+});
+
+export const getNotebooks = async (
+  fastify: KubeFastifyInstance,
+): Promise<{ notebooks: Notebook[]; error: string }> => {
+  const customObjectsApi = fastify.kube.customObjectsApi;
+  const namespace = fastify.kube.namespace;
+
+  try {
+    const imageStreams = await customObjectsApi
+      .listNamespacedCustomObject(
+        'image.openshift.io',
+        'v1',
+        namespace,
+        'imagestreams',
+        undefined,
+        undefined,
+        undefined,
+        'app.kubernetes.io/created-by=byon',
+      )
+      .then((r) => r.body as ImageStreamListKind);
+    const pipelineRuns = await customObjectsApi
+      .listNamespacedCustomObject(
+        'tekton.dev',
+        'v1beta1',
+        namespace,
+        'pipelineruns',
+        undefined,
+        undefined,
+        undefined,
+        'app.kubernetes.io/created-by=byon',
+      )
+      .then((r) => r.body as PipelineRunListKind);
+
+    const imageStreamNames = imageStreams.items.map((is) => is.metadata.name);
+    const notebooks: Notebook[] = [
+      ...imageStreams.items.map((is) => mapImageStreamToNotebook(is)),
+      ...pipelineRuns.items
+        .filter((plr) => !imageStreamNames.includes(plr.metadata.name))
+        .map((plr) => mapPipelineRunToNotebook(plr)),
+    ];
+
+    return { notebooks: notebooks, error: null };
+  } catch (e) {
+    if (e.response?.statusCode !== 404) {
+      fastify.log.error('Unable to retrieve notebook image(s): ' + e.toString());
+      return { notebooks: null, error: 'Unable to retrieve notebook image(s): ' + e.message };
+    }
+  }
+};
+
+export const getNotebook = async (
+  fastify: KubeFastifyInstance,
+  request: FastifyRequest,
+): Promise<{ notebooks: Notebook; error: string }> => {
+  const customObjectsApi = fastify.kube.customObjectsApi;
+  const namespace = fastify.kube.namespace;
+  const params = request.params as { notebook: string };
+
+  try {
+    const imageStream = await customObjectsApi
+      .getNamespacedCustomObject(
+        'image.openshift.io',
+        'v1',
+        namespace,
+        'imagestreams',
+        params.notebook,
+      )
+      .then((r) => r.body as ImageStreamKind)
+      .catch((r) => null);
+
+    if (imageStream) {
+      return { notebooks: mapImageStreamToNotebook(imageStream), error: null };
+    }
+
+    const pipelineRun = await customObjectsApi
+      .getNamespacedCustomObject(
+        'tekton.dev',
+        'v1beta1',
+        namespace,
+        'pipelineruns',
+        params.notebook,
+      )
+      .then((r) => r.body as PipelineRunKind)
+      .catch((r) => null);
+
+    if (pipelineRun) {
+      return { notebooks: mapPipelineRunToNotebook(pipelineRun), error: null };
+    }
+
+    throw new createError.NotFound(`Notebook ${params.notebook} does not exist.`);
+  } catch (e) {
+    if (e.response?.statusCode !== 404) {
+      fastify.log.error('Unable to retrieve notebook image(s): ' + e.toString());
+      return { notebooks: null, error: 'Unable to retrieve notebook image(s): ' + e.message };
+    }
+  }
+};
+
+export const addNotebook = async (
+  fastify: KubeFastifyInstance,
+  request: FastifyRequest,
+): Promise<{ success: boolean; error: string }> => {
+  const customObjectsApi = fastify.kube.customObjectsApi;
+  const namespace = fastify.kube.namespace;
+  const body = request.body as NotebookCreateRequest;
+
+  const payload: PipelineRunKind = {
+    apiVersion: 'tekton.dev/v1beta1',
+    kind: 'PipelineRun',
+    metadata: {
+      generateName: 'byon-import-jupyterhub-image-run-',
+    },
+    spec: {
+      params: [
+        { name: 'desc', value: body.description },
+        { name: 'name', value: body.name },
+        { name: 'url', value: body.url },
+        // FIXME: This shouldn't be a user defined value consumed from the request payload but should be a controlled value from an authentication middleware.
+        { name: 'creator', value: body.user },
+      ],
+      pipelineRef: {
+        name: 'byon-import-jupyterhub-image',
+      },
+      workspaces: [
+        {
+          name: 'data',
+          volumeClaimTemplate: {
+            spec: {
+              accessModes: ['ReadWriteOnce'],
+              resources: {
+                requests: {
+                  storage: '10Mi',
+                },
+              },
+            },
+          },
+        },
+      ],
+    },
+  };
+
+  try {
+    await customObjectsApi.createNamespacedCustomObject(
+      'tekton.dev',
+      'v1beta1',
+      namespace,
+      'pipelineruns',
+      payload,
+    );
+    return { success: true, error: null };
+  } catch (e) {
+    if (e.response?.statusCode !== 404) {
+      fastify.log.error('Unable to add notebook image: ' + e.toString());
+      return { success: false, error: 'Unable to add notebook image: ' + e.message };
+    }
+  }
+};
+
+export const deleteNotebook = async (
+  fastify: KubeFastifyInstance,
+  request: FastifyRequest,
+): Promise<{ success: boolean; error: string }> => {
+  const customObjectsApi = fastify.kube.customObjectsApi;
+  const namespace = fastify.kube.namespace;
+  const params = request.params as { notebook: string };
+
+  try {
+    await customObjectsApi
+      .deleteNamespacedCustomObject(
+        'image.openshift.io',
+        'v1',
+        namespace,
+        'imagestreams',
+        params.notebook,
+      )
+      .catch((e) => {
+        throw createError(e.statusCode, e?.body?.message);
+      });
+    // Cleanup in case the pipelinerun is still present and was not garbage collected yet
+    await customObjectsApi
+      .deleteNamespacedCustomObject(
+        'tekton.dev',
+        'v1beta1',
+        namespace,
+        'pipelineruns',
+        params.notebook,
+      )
+      .catch(() => {});
+    return { success: true, error: null };
+  } catch (e) {
+    if (e.response?.statusCode !== 404) {
+      fastify.log.error('Unable to delete notebook image: ' + e.toString());
+      return { success: false, error: 'Unable to delete notebook image: ' + e.message };
+    }
+  }
+};
+
+export const updateNotebook = async (
+  fastify: KubeFastifyInstance,
+  request: FastifyRequest,
+): Promise<{ success: boolean; error: string }> => {
+  const customObjectsApi = fastify.kube.customObjectsApi;
+  const namespace = fastify.kube.namespace;
+  const params = request.params as { notebook: string };
+  const body = request.body as NotebookUpdateRequest;
+
+  try {
+    const imageStream = await customObjectsApi
+      .getNamespacedCustomObject(
+        'image.openshift.io',
+        'v1',
+        namespace,
+        'imagestreams',
+        params.notebook,
+      )
+      .then((r) => r.body as ImageStreamKind)
+      .catch((e) => {
+        throw createError(e.statusCode, e?.body?.message);
+      });
+
+    if (body.packages && imageStream.spec.tags) {
+      const packages = JSON.parse(
+        imageStream.spec.tags[0].annotations['opendatahub.io/notebook-python-dependencies'],
+      ) as NotebookPackage[];
+
+      body.packages.map((update) => {
+        const original = packages.find((p) => p.name === update.name);
+        if (original) {
+          original.visible = update.visible;
+        }
+      });
+
+      imageStream.spec.tags[0].annotations['opendatahub.io/notebook-python-dependencies'] =
+        JSON.stringify(packages);
+    }
+    if (typeof body.visible !== 'undefined') {
+      if (body.visible) {
+        imageStream.metadata.labels['opendatahub.io/notebook-image'] = 'true';
+      } else {
+        imageStream.metadata.labels['opendatahub.io/notebook-image'] = null;
+      }
+    }
+    if (body.name) {
+      imageStream.metadata.annotations['opendatahub.io/notebook-image-name'] = body.name;
+    }
+    if (body.description) {
+      imageStream.metadata.annotations['opendatahub.io/notebook-image-desc'] = body.description;
+    }
+
+    await customObjectsApi
+      .patchNamespacedCustomObject(
+        'image.openshift.io',
+        'v1',
+        namespace,
+        'imagestreams',
+        params.notebook,
+        imageStream,
+        undefined,
+        undefined,
+        undefined,
+        {
+          headers: { 'Content-Type': 'application/merge-patch+json' },
+        },
+      )
+      .catch((e) => console.log(e));
+
+    return { success: true, error: null };
+  } catch (e) {
+    if (e.response?.statusCode !== 404) {
+      fastify.log.error('Unable to update notebook image: ' + e.toString());
+      return { success: false, error: 'Unable to update notebook image: ' + e.message };
+    }
+  }
+};
diff --git a/backend/src/routes/api/status/index.ts b/backend/src/routes/api/status/index.ts
@@ -4,10 +4,6 @@ import { KubeFastifyInstance, KubeStatus } from '../../../types';
 import { DEV_MODE } from '../../../utils/constants';
 import { addCORSHeader } from '../../../utils/responseUtils';
 
-type groupObjResponse = {
-  users: string[];
-};
-
 const status = async (
   fastify: KubeFastifyInstance,
   request: FastifyRequest,