On-premise deployment guide

This guide provides detailed instructions for deploying the Artemis platform in an on-premise Kubernetes environment. It includes prerequisites, supported environments, configuration steps, and image registry details to help you deploy Artemis seamlessly, even in air-gapped setups.

Prerequisites

Note below the minimum and recommended hardware and software requirements to deploy Artemis.

Hardware

Minimum Requirements

Suitable for basic deployments on a single machine:

Resources	Requirements
CPU	16 Cores
Memory	At least 32GB of RAM
Storage	At least 300GB (SSD/HDD)

If your system does not meet these requirements, please contact our support team for alternatives.

Recommended Requirements

For optimal performance and scalability:

Resources	Requirements
CPU	32 Cores
Memory	At least 64GB of RAM
Storage	At least 300GB (SSD/HDD)

Optional: Self-Hosted LLM Support

Running large language models locally requires enhanced resources:

Resources	Requirements
GPU	Nvidia CUDA-capable GPU / Intel® Data Center GPU Max 1550 / Gaudi 2
CPU	64 Cores
Memory	At least 128GB of RAM
Storage	At least 1TB (SSD/HDD)

For LLM VRAM requirements, see LLM VRAM Specs

Operating System

• Linux-based distributions supported for Kubernetes clusters

GPU Support (Optional)

Install the following on each node:

• NVIDIA CUDA Drivers
• NVIDIA Container Toolkit

Container Image Registry

For air-gapped deployments, a private container registry is required. Recommended registries:

• Sonatype Nexus
• JFrog Artifactory
• Docker Registry (self-hosted)

We provide:

• Docker Hub for public images
• AWS ECR and private Docker Hub repositories for proprietary images
• Secure credentials for authenticated pulls

Deployment Options

Single Machine/VM

Artemis can run on a bare metal host or VM using Docker or Podman.

Containerized Runtimes

• Docker
• Podman

We can support installing this software in offline environments.

Configuration and Deployment

Artemis provides a collection of Docker Compose files required for deploying this version of the platform. These configuration files are orchestrated using a Makefile, which leverages either Docker Compose or Podman Compose under the hood.

The Makefile offers simple, CLI-like commands to streamline common tasks such as building, starting, and stopping services making deployment easy and consistent across environments.

Available Commands

• make - Display all available commands
• make info - Display VM details and super admin credentials
• make deploy - Deploy all services
• make down - Stop all containers
• make destroy - Remove containers and volumes
• make deploy service=SERVICE_NAME - Deploy a specific service

Kubernetes Cluster

Artemis supports the following Kubernetes environments:

Cloud

• Amazon AWS
• Microsoft Azure
• Google Cloud
• Inter Developer Cloud
• OpenShift Cloud

On Premise

• Kubeadm
• K3d
• MicroK8s
• Okd
• Other Clusters

Configuration files and Deployment

Artemis uses a mix of public Helm charts (mainly from Bitnami) and proprietary charts developed in-house for its core components, which are embedded directly into the CLI.

To simplify image transfers to your internal registry, we provide a deployment CLI that wraps around Skopeo, making the process fast and reliable.

Built with Node.js, the CLI includes kubectl, helm, and skopeo, streamlining configuration and deployment to Kubernetes. It’s packaged as a cross-platform executable, ensuring compatibility across operating systems. Our goal is to make Artemis deployment straightforward and accessible for all users.

Installation Scenarios

Artemis is designed for a smooth installation experience, whether your machine has internet access or is in an air-gapped environment. Below, we outline the installation steps for Artemis on both single machine and Kubernetes cluster setups, covering scenarios with internet connectivity and isolated (air-gapped) environments.

A. Single Machine/VM (Online)

1. Create VM per hardware requirements
2. Download the latest deployment package (Credentials will be provided separately.)
3. Authenticate with remote registry: docker login (Credentials will be provided separately.)
4. Extract configuration: mkdir artemis && tar -xvf artemis-<version>.tar -C artemis
5. Run:
   • cd artemis
   • make deploy
   • make create-users
6. Access Artemis: http://<machine-ip>:80

B. Single Machine/VM (AirGapped)

1. Set up VM per hardware requirements
2. Download the latest deployment package (Credentials will be provided separately.)
3. Push all the images required to your internal image registry
4. Authenticate with local registry: docker login your.internal.registry.domain.org:port
5. Extract configuration: mkdir artemis && tar -xvf artemis-<version>.tar -C artemis
6. Update .env.production with registry details

REGISTRY=<your.internal.registry.domain.org:port>
IMAGE_REPOSITORY=<path_to_image/>turintech/
EVOML_IMAGE_REPOSITORY=<path_to_image/>turintech/
SERVICES_REGISTRY=<your.internal.registry.domain.org:port></path_to_image>

7. Run:
   • cd artemis
   • make deploy
   • make create-users
8. Access Artemis: http://<machine-ip>:80

Non-root Runtimes

Configure socket path in .env.production

• Docker: DOCKER_SOCK=/run/user/<uid>/docker.sock
• Podman: DOCKER_SOCK=/run/user/<uid>/podman/podman.sock

C. Kubernetes Cluster (Online)

1. Provision a cluster with at least one node that meets the hardware requirements
2. Get the latest Artemis deployment CLI. (Credentials will be provided separately.)
3. Run the following command to verify and configure connectivity to your cluster ./cli config cluster
4. Log in to the remote image registry using your credentials ./cli config registry-auth --env production -u <username> -p <password/token>
5. Deploy the Artemis platform to your cluster ./cli deploy up --env production
6. Once deployed, access the Artemis platform at:

• http://<machine-ip>:80 (for single-node setups)
• http://<load-balancer-exposed-ip>:80 (for clusters with a load balancer)

D. Kubernetes Cluster (AirGapped)

1. Set up a Kubernetes cluster with at least one node that meets the hardware requirements
2. Get the latest Artemis deployment CLI (You will be provided with credentials to access the download.)
3. Ensure all required container images are available in your internal image registry
   • Manual Transfer: Pull and push each image manually.
   • Using the CLI: ./cli transfer --dest <your-internal-registry>
4. Run the following command to verify and configure connectivity to your Kubernetes cluster ./cli config cluster
5. Log in to your internal (offline) image registry using the CLI ./cli config registry-auth --env offline -u <username> -p <password/token>
6. Edit the .configrc.json file to reflect your internal deployment configuration

"OVERRIDE": {
    "REGISTRY": "your.internal.registry.domain.org:port",
    "SERVICES_REGISTRY": "your.internal.registry.domain.org:port",
}

7. Deploy the Artemis platform to your cluster ./cli deploy up --env offline
8. Once deployed, access the Artemis platform at:

• http://<machine-ip>:80 (for single-node setups)
• http://<load-balancer-exposed-ip>:80 (for clusters with a load balancer)

Kubernetes dynamic configurations

Our deployment is fully dynamic and flexible, supporting dynamic configurations by editing the .configrc.json file.

1. OpenShift

"OVERRIDE": {
    "OPENSHIFT": "true"
}

2. External service integrations:

"OVERRIDE": {
    "MINIO_HOST": "<host>",
    "MONGO_HOST": "<host>",
    "MINIO_PORT": "<port>",
    "POSTGRES_HOST": "<host>",
    ...
},
"EXCLUDE": ["minio", "redis", "postgresql", "mongo"]

Tip: Use these configurations to customize your deployment for specific environments or external integrations.

Update Scenarios

A. Single Machine/VM

1. Download the latest deployment package (Credentials will be provided separately.)
2. AirGapped only: Push all the images required to your internal image registry
3. Extract configuration: mkdir artemis && tar -xvf artemis-<version>.tar and replace all files except your .env.production file.
4. Run:
   • cd artemis
   • make deploy
5. Access Artemis: http://<machine-ip>:80

B. Kubernetes Cluster

1. Get the latest Artemis deployment CLI. (Credentials will be provided separately.). Ensure that .configrc.json file is present in the same working directory as the CLI.
2. AirGapped only: Ensure all required container images are available in your internal image registry
3. Update the Artemis platform to your cluster ./cli deploy up
4. Once updated, access the Artemis platform at:
   • http://<machine-ip>:80 (for single-node setups)
   • http://<load-balancer-exposed-ip>:80 (for clusters with a load balancer)

Browser Support

Artemis is thoroughly tested and optimized for compatibility with Chrome, Firefox, and Edge. To guarantee an optimal user experience, we strongly advocate using the most recent version of Chrome. While Artemis supports Firefox and Edge, performance may vary, and certain issues may arise when utilizing older versions of these browsers or alternative web browsers. Always keep your browsers updated to benefit from the best experience.