Skip to content

Latest commit

 

History

History
56 lines (35 loc) · 2.9 KB

INSTALL.md

File metadata and controls

56 lines (35 loc) · 2.9 KB

QuantumServerless Installation Guide

Project is arranged as monorepository. Each of sub-modules has it's own installation instructions.

Client (QuantumServerless) library

pip install quantum_serverless

Installation from source

  1. Run
cd client
pip install -e .

Infrastructure

To follow the installation steps you will need the proper tools setup. We describe them in the infrastructure's README:

  1. Docker
  2. Configure helm values
  3. Terraform / Run helm

Docker

First of all you will need to build the docker images inside the docker folder. You can follow the docker build examples described in the docker's README for that.

Configure helm values

Once time you have your docker images built you must configure the values for helm. In the values file you will find several placeholders where you can fill with the needed value what image you will use for each service.

For more information you have every variable described in the README in case you need more configurations.

Terraform / Run helm

At this step you are going to need to have decided where are you going to deploy the services. You have mostly two options:

  1. Locally
  2. Cloud provider

For the first one, Locally. You will need to have a k8s approach installed in your machine. You have several options for that: Docker desktop, Minikube, kind, k3s, etc...

If this is your case you just need to execute the helm configuration on you k8s instance following the installation step described in the helm's README.

If you are interested into manage the infrastructure in a cloud provider the project supports two of them, currently: IBM Cloud, AWS.

Once time you select one you will need to run the terraform configuration as is described in the terraform's README. Depending of the provider that you decide to use you will neeed to refer to the documentation of each provider to see if you need to configure something:

⚠️ Each provider has a values.yaml with the configuration for the helm execution. In case you use terraform you will need to fill those files with the information from the second step.

Manager

All you will need to build the docker image inside the manager folder. You can follow the docker build examples described in the docker's README for that or simply run make build-manager.