Getting started¶

This page will guide you through the steps to run the project locally.

Install Docker¶

Docker "delivers software in packages called containers". Follow the Install Docker Engine - docs.docker.com guide to install and configure Docker.

Install minikube¶

minikube "quickly sets up a local Kubernetes cluster on macOS, Linux, and Windows". Follow the Get Started! - minikube.sigs.k8s.io guide to install and configure minikube.

Kubernetes tips¶

To visualize pods (= containers), use the following command.

1
2

# View pods
kubectl get pods

To visualize pod's logs, use the following command.

1
2
3
4
5
6
7

# View pod's logs
kubectl logs <name of the pod>

# or

# Follow the pod's logs (CTRL+C to exit)
kubectl logs --follow <name of the pod>

Start minikube¶

In order to start minikube, execute the following command.

1
2

# Start minikube
minikube start

Validate minikube has successfully started with the following command.

1
2

# Validate minikube has started
kubectl get pods --all-namespaces

Start the Core Engine¶

Follow the instructions described in the Core Engine documentation - Run locally using Kubernetes (with minikube) and official Docker images.

Start the Webapp¶

Follow the instructions described in the Webapp documentation - Run locally using Kubernetes (with minikube) and a local Docker image.

Start a machine learning service¶

A machine learning service is a service that will register to the Core Engine in order to accept tasks to execute.

Refer to the Services documentation for all the available machine learning backend services.