Skip to main content
Skip table of contents

Deployment of AO Platform on MicroK8s

Intended audience: ADMINISTRATORS IT/SECURITY/DEVOPS

AO Platform: 4.3

Overview

This topic provides step-by-step instructions on deploying the AO Platform software stack in a MicroK8s environment. This is the fastest way to get up and running as a solution developer using the full AO Platform stack on a local workstation, or a small team server.

What is MicroK8s?

MicroK8s is a small-footprint Kubernetes environment from Canonical, the publisher of the Ubuntu Operating System. MicroK8s allows the full AO Platform stack with all dependencies to run as a single instance deployment on most workstation environments.

image-20240226-103306.png

System Requirements and Prerequisites

Video

This video shows the installation steps for the complete AO Platform stack and all dependencies being installed on a MicroK8s environment on a Ubuntu 22.04 OS. For full details, see the Step-by-Step Deployment section below.

The video shows a 30 min installation in about 5 minutes. Longer running segments of the installation have been cut out to avoid the wait time.

Step-by-Step Deployment

The full end-2-end installation of MicroK8s and the AO Platform stack is divided into 4 key steps:

  1. Download and install MicroK8s.

  2. Install required software and enable required addons on MicroK8s VM.

  3. AO Platform Helm Chart deployment process.

  4. Access the ao-platform UI in a Browser.

The following deployment steps assumes MicroK8s is installed as a Virtual Machine, using Multipass, on a Windows 10/11 Operating System. If MicroK8s is installed natively on a Ubuntu system, the “multipass” commands in the sections below can be ignored.

Download and Install MicroK8s

  • Install MicroK8s using Multipass virtual machine > https://microk8s.io/docs/install-multipass

  • MicroK8s can be installed in several different ways. See these instructions for all options > https://microk8s.io/docs/install-alternatives

  • With MicroK8s installed, please configure MicroK8s to run large workloads. Configure the CPU, Mem, and Disk with these minimum values as per System Requirements.

    image-20240228-094537.png
  • When MicroK8s installation process is complete, validate by running the following commands:

    • Check MicroK8s VM is running using either command prompt (CMD) or PowerShell:

    • CODE
      multipass list
    • image-20240111-132806.png
    • login to Microk8s VM.

    • CODE
      multipass shell microk8s-vm
    • image-20240110-164026.png
  • Now follow the remaining steps below to complete the deployment.

Installing required software and enabling required addons on MicroK8s VM

  • After the MicroK8s VM is created, you need to install the required prerequisites for smooth Kubernetes or Helm Chart deployment.

  • Run this command in MicroK8s/Ubuntu VM. The file mk8s-prerequisite.sh will be downloaded.

    • CODE
      wget https://aop-devops-automation.s3.amazonaws.com/kubernetes/scripts/mk8s-prerequisite.sh
    • image-20240228-180614.png
  • After downloading the file, execute the file as shown below.

    • CODE
      bash mk8s-prerequisite.sh
    • image-20240228-183455.png
  • Finally, close and reopen the CMD or PowerShell for the changes to reflect.

Deploying the AO Platform Helm Charts

  • Re-login to MicroK8s/Ubuntu VM,

    • CODE
      multipass shell microk8s-vm
  • Then execute the AO Platform deployment script.

    • CODE
      bash aop-mk8s-deployment.sh
    • image-20240228-183625.png
    • image-20240129-162600.png
  • After the last script has been completed, check the status of the Pods:

    • CODE
      microk8s kubectl get pods -n ao-platform
    • image-20240228-174219.png

Accessing the AO Platform UI in a Browser

  • To access the UI we need to map the IP address of The MicroK8s/Ubuntu VM to the hostname/domain name in the hosts file on the Windows machine.

  • Please check the IP address of your MicroK8s/Ubuntu VM by running:

    • CODE
      ifconfig
    • image-20240228-100149.png
  • Follow below commands to add an entry to the etc\hosts file on the Windows machine.

    • Open C:\Windows\System32\drivers\etc\hosts

    • Open the hosts file in your text editor as Administrator.

    • image-20240228-100556.png
    •  Add the IP address and Hostname values, then save the file. The Hostname must be ao-platform.

    • image-20240228-100315.png
  • Now access the AO Platform UI in a Browser using the following URL:

    • CODE
      http://ao-platform:30808
  • …and Sign in with default admin credentials:

    image-20240226-140108.png
  • The AO Platform software stack is now fully deployed!


Contact App Orchid | Disclaimer

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.