LogoLogo
1.1.0
1.1.0
  • Maisa System
    • Introduction
    • API Reference
      • Maisa System API Documentation
        • Authentication
      • Users
      • Projects
      • Analytics
      • System
      • Models
    • Architecture
    • How to use it
  • Helm Installation
    • Getting Started
    • Authentication
    • Configuration Reference
Powered by GitBook
On this page
  • Overview
  • Installation Steps
  • Step 1: Add our Helm Repository
  • Step 2: Update the Repository
  • Step 3: Install the Chart
  • Step 4: Verify the Installation
  • Post-Installation
  • Troubleshooting
  • Next Steps
Edit on GitHub
Export as PDF
  1. Helm Installation

Getting Started

PreviousHow to use itNextAuthentication

Last updated 16 days ago

This guide is specific to version 1.1.0 of our system. For newer versions, please switch to the appropriate documentation branch.

Overview

This guide will walk you through the installation process of our system using Helm, the package manager for Kubernetes. Our system is distributed as a Helm chart stored in our private Artifactory repository.

Before you begin, ensure you have the following:

  • Kubernetes cluster (version 1.18 or higher)

  • Helm (version 3.6 or higher)

  • Access to our Artifactory repository (see )

  • Minimum system requirements:

    • 2 CPU cores

    • 4GB RAM

    • 10GB disk space

You can verify your Helm version with:

helm version

Our system has been tested and validated on the following platforms:

Platform
Versions

Kubernetes

1.18, 1.19, 1.20, 1.21, 1.22

OpenShift

4.6, 4.7, 4.8

Amazon EKS

1.19, 1.20, 1.21

Azure AKS

1.19, 1.20, 1.21

Google GKE

1.19, 1.20, 1.21

Installation Steps

Please complete the steps before proceeding with installation.

Step 1: Add our Helm Repository

helm repo add maisa-repo https://artifactory.company.com/artifactory/helm-repo \
  --username YOUR_USERNAME \
  --password YOUR_PASSWORD

Step 2: Update the Repository

helm repo update

Step 3: Install the Chart

For a basic installation with default values:

helm install my-release maisa-repo/maisa-system

To customize the installation with a values file:

  1. Install with the custom values:

helm install my-release maisa-repo/maisa-system -f values.yaml

Step 4: Verify the Installation

Check that all pods are running:

kubectl get pods -l app.kubernetes.io/name=maisa-system

Expected output:

NAME                           READY   STATUS    RESTARTS   AGE
maisa-system-api-5b7d56c465-8f2xm       1/1     Running   0          2m
maisa-system-db-0                       1/1     Running   0          2m
maisa-system-worker-7d56f64d9b-zk4np    1/1     Running   0          2m

If all pods are in the "Running" state, your installation was successful! 🎉

Post-Installation

Troubleshooting

Pods Stuck in "Pending" State

This usually indicates insufficient resources. Check resource availability:

kubectl describe pods -l app.kubernetes.io/name=maisa-system

Connection Refused Errors

Ensure your firewall allows traffic to the required ports:

  • API: 8080

  • Database: 5432

View logs for specific components:

# API logs
kubectl logs -l app.kubernetes.io/component=api

# Database logs
kubectl logs -l app.kubernetes.io/component=database

# Worker logs
kubectl logs -l app.kubernetes.io/component=worker

If you encounter issues not covered here:

  1. Collect diagnostic information:

kubectl get events
kubectl describe pods -l app.kubernetes.io/name=maisa-system
  1. Contact support at support@company.com with:

    • Kubernetes version

    • Helm version

    • Chart version

    • Diagnostic information

Next Steps

Create a values.yaml file with your custom configurations (see )

for your installation

Review the for advanced settings

Check out our to get started with using the system

Authentication
Authentication
Configuration Reference
Configure authentication
Configuration Reference
User Guide