Edit

Getting Started

This guide is specific to version 1.2.0 of our system. For previous 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.20 or higher)

  • Helm (version 3.8 or higher)

  • Access to our Artifactory repository (see Authentication)

  • Minimum system requirements:

    • 4 CPU cores

    • 8GB RAM

    • 20GB disk space

You can verify your Helm version with:

helm version

Installation Steps

Please complete the Authentication 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

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
maisa-system-scheduler-6b8b8b8b67-j2k3l 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

  • Metrics: 9090

Next Steps

For production deployments, we recommend reviewing the Production Checklist before going live.

Upgrading from 1.1.0

If you're upgrading from version 1.1.0, follow these steps:

  1. Update your Helm repository:

helm repo update

  1. Check for any configuration changes:

helm show values maisa-repo/maisa-system --version 1.2.0 > new-values.yaml

  1. Compare with your existing configuration and update as needed. Pay special attention to:

    • New scheduler component

    • Updated ingress configuration (changed from annotations to className)

    • Additional metrics port (9090)

  2. Upgrade your installation:

helm upgrade my-release maisa-repo/maisa-system --version 1.2.0 -f your-values.yaml

The upgrade process will cause a brief downtime as pods are restarted with the new configuration.

PreviousHow to use itNextAuthentication

Last updated