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.

Prerequisites

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

Supported Platforms

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

Platform	Versions
Kubernetes	1.20, 1.21, 1.22, 1.23, 1.24, 1.25
OpenShift	4.8, 4.9, 4.10
Amazon EKS	1.21, 1.22, 1.23
Azure AKS	1.22, 1.23, 1.24
Google GKE	1.22, 1.23, 1.24

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

Basic Installation

For a basic installation with default values:

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

Custom Installation

To customize the installation with a values file:

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

2. Install with the custom values:

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

Air-gapped Installation

For air-gapped environments:

1. Download the chart package:

helm pull maisa-repo/maisa-system --version 1.2.0

1. Transfer the package to your air-gapped environment

2. Install from the local package:

helm install my-release ./maisa-system-1.2.0.tgz

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

Common Issues

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

Logs

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

Support

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 [email protected] with:

   • Kubernetes version

   • Helm version

   • Chart version

   • Diagnostic information

Next Steps

• Configure authentication for your installation

• Review the Configuration Reference for advanced settings

• Check out our User Guide to get started with using the system

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.