kubeflow
/
model-registry
mirror of https://github.com/kubeflow/model-registry.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
model-registry/clients/ui/README.md

5.6 KiB
Raw Blame History

Model Registry UI

Overview

The Model Registry UI is a standalone web app for Kubeflow Model Registry. In this repository, you will find the frontend and backend for the Model Registry UI.

Contributing

You can check the contributing guidelines for more information on how to contribute to the Model Registry UI.

OpenAPI Specification

You can find the OpenAPI specification for the Model Registry UI in the openapi directory. A live version of the OpenAPI specification can be found here.

Targeted environments

There's two main environments that the Model Registry UI is targeted for:

  1. Standalone: This is the default environment for local development. The UI is served by the BFF and the BFF is responsible for serving the API requests. The BFF exposes a /namespace endpoint that returns all the namespaces in the cluster and the UI sends a user header kubeflow-user to authenticate the calls.

  2. Kubeflow: This is the environment where the UI is served by the Kubeflow Ingress and the BFF is served by the Kubeflow API Gateway. The BFF is responsible for serving the API requests and namespace selection is leveraged from Kubeflow.

Environment Variables

The following environment variables are used to configure the deployment and development environment for the Model Registry UI. These variables should be defined in a .env.local file in the clients/ui directory of the project. This values will affect the build and push commands.

CONTAINER_TOOL

  • Description: Specifies the container tool to be used for building and running containers.
  • Default Value: docker
  • Possible Values: docker, podman, etc.
  • Example: CONTAINER_TOOL=docker

IMG_UI

  • Description: Specifies the image name and tag for the UI (with BFF).
  • Default Value: ghcr.io/kubeflow/model-registry/ui:latest
  • Example: IMG_UI=ghcr.io/kubeflow/model-registry/ui:latest

IMG_UI_STANDALONE

  • Description: Specifies the image name and tag for the UI (with BFF) in standalone mode, used for local kind deployment.
  • Default Value: ghcr.io/kubeflow/model-registry/ui-standalone:latest
  • Example: IMG_UI_STANDALONE=ghcr.io/kubeflow/model-registry/ui-standalone:latest

IMG_UI_FEDERATED

  • Description: Specifies the image name and tag for the UI (with BFF) in federated mode, used for federated mode outside kubeflow.
  • Default Value: ghcr.io/kubeflow/model-registry/ui-federated:latest
  • Example: IMG_UI_FEDERATED=ghcr.io/kubeflow/model-registry/ui-federated:latest

PLATFORM

  • Description: Specifies the platform for a docker buildx build.
  • Default Value: linux/amd64
  • Example: PLATFORM=linux/amd64

DEPLOYMENT_MODE

  • Description: Specifies the deployment mode for the UI.
  • Default Value: standalone
  • Note: This variable is used to determine how the UI is built and deployed.
  • Possible Values: standalone, kubeflow, federated
  • Example: DEPLOYMENT_MODE=standalone

STYLE_THEME

  • Description: Specifies the theme/styling framework to be used for the UI.
  • Default Value: mui-theme
  • Possible Values: mui-theme, patternfly-theme
  • Example: STYLE_THEME=mui-theme

Example .env.local File

Here is an example of what your .env.local file might look like:

CONTAINER_TOOL=docker
IMG_UI=quay.io/<personal-registry>/model-registry-ui:latest
IMG_UI_STANDALONE=quay.io/<personal-registry>/model-registry-ui-standalone:latest
PLATFORM=linux/amd64

Build and Push Commands

The following Makefile targets are used to build and push the Docker images the UI images. These targets utilize the environment variables defined in the .env.local file.

Build Commands

  • docker-build: Builds the Docker image for the UI platform.

    • Command: make docker-build
    • This command uses the CONTAINER_TOOL and IMG_UI environment variables to push the image.

  • docker-buildx: Builds the Docker image with buildX for multiarch support.

    • Command: make docker-buildx
    • This command uses the CONTAINER_TOOL and IMG_UI environment variables to push the image.

  • docker-build-standalone: Builds the Docker image for the UI platform in standalone mode.

    • Command: make docker-build-standalone
    • This command uses the CONTAINER_TOOL and IMG_UI_STANDALONE environment variables to push the image.

  • docker-buildx-standalone: Builds the Docker image with buildX for multiarch support in standalone mode.

    • Command: make docker-buildx-standalone
    • This command uses the CONTAINER_TOOL and IMG_UI_STANDALONE environment variables to push the image.

Push Commands

  • docker-push: Pushes the Docker image for the UI service to the container registry.

    • Command: make docker-push
    • This command uses the CONTAINER_TOOL and IMG_UI environment variables to push the image.

  • docker-push-standalone: Pushes the Docker image for the UI service to the container registry in standalone mode.

    • Command: make docker-push-standalone
    • This command uses the CONTAINER_TOOL and IMG_UI_STANDALONE environment variables to push the image.

Deployments

For more information on how to deploy the Model Registry UI, please refer to the Model registry UI documentation.