Skip to content

Project for managing ML model and deploying ML module. It can deploy the Rekcurd service to Kubernetes cluster.

License

Notifications You must be signed in to change notification settings

rekcurd/dashboard

Repository files navigation

Rekcurd-dashboard

Build Status PyPI version codecov pypi supported versions

Rekcurd dashboard is the project for managing ML model and deploying ML module. Any Rekcurd service is manageable. It can deploy the Rekcurd service to Kubernetes cluster and can control traffic weights which Istio manages.

Parent Project

https://github.com/rekcurd/community

Components

Screen shot

Environment

Installation

From source:

$ git clone --recursive https://github.com/rekcurd/dashboard.git
$ cd dashboard/frontend
$ yarn install && yarn run build && cd ..
$ pip install -e .

From PyPi directly:

$ pip install rekcurd-dashboard

How to use

Check the belows in detail.

Generate settings

You can generate the template of settings.yml file.

$ rekcurd_dashboard template
Boot command
$ rekcurd_dashboard db --settings settings.yml init
$ rekcurd_dashboard db --settings settings.yml migrate
$ rekcurd_dashboard server --settings settings.yml
docker-compose (Deprecated)
# For dev
$ docker-compose -f docker-compose/docker-compose.develop.yaml up
# For prod
$ docker-compose -f docker-compose/docker-compose.production.yaml up
For AWS users

If you run this on AWS (such as EKS), you need to configure aws-cli setting.
Follow the official document.

Rekcurd-dashboard docker container will mount the configuration files,
so the IAM account used by configuration needs to have enough permissions to access to Kubernetes resources on AWS.

# For dev
$ docker-compose -f docker-compose/aws/docker-compose.develop.yaml up
# For prod
$ docker-compose -f docker-compose/aws/docker-compose.production.yaml up

How to use WebUI

See docs in detail.

Test

Unittest

$ python -m unittest test/*/test_*

e2e test

## sudo sh scripts/kube-init.sh
$ sudo sh e2e_test/startup.sh
$ python -m unittest
$ sudo sh e2e_test/cleanup.sh

Kubernetes support

Rekcurd can be run on Kubernetes. See community repository.