Deployment Guideline Template

1. Introduction

This document describes the supported software and hardware configurations for the reference component as well as providing guidelines on how to install and configure such reference system.

The audience of this document is assumed to have good knowledge in AI/ML tools, Kubernetes and Linux system

2. Minimum Requirements

Detail the hardware and software requirements necessary for the installation

16 cpu cores
32 GB RAM
60 GB harddisk
Operating System Ubuntu 22.04 server

3. Installation

step-by-step instructions for deployment

3.1) Software Installation and Deployment

git clone "https://gerrit.o-ran-sc.org/r/aiml-fw/aimlfw-dep"
cd aimlfw-dep

Update recipe file RECIPE_EXAMPLE/example_recipe_latest_stable.yaml which includes update of VM IP and datalake details.

Note: In case the Influx DB datalake is not available, this can be skipped at this stage and can be updated after installing datalake.

bin/install_traininghost.sh

Check running state of all pods and services using below command

kubectl get pods --all-namespaces
kubectl get svc --all-namespaces

Check the AIMLFW dashboard by using the following url

http://localhost:32005/

In case of any change required in the RECIPE_EXAMPLE/example_recipe_latest_stable.yaml file after installation, the following steps can be followed to reinstall with new changes.

bin/uninstall.sh
bin/install.sh -f RECIPE_EXAMPLE/example_recipe_latest_stable.yaml

Expected Result:

3.2) Step 2:

Expected Result:

 NAMESPACE      NAME                                               READY   STATUS    RESTARTS          AGE
default        my-release-influxdb-85888dfd97-d5twd               1/1     Running   0                 11d
default        nfs-subdir-external-provisioner-77c48bb875-68s7w   1/1     Running   12 (9h ago)       11d
default        sample-df5c96544-wtt97                             1/1     Running   0                 4d3h
kube-system    calico-kube-controllers-658d97c59c-n8gzg           1/1     Running   3 (2d21h ago)     11d
kube-system    calico-node-vcvjc                                  1/1     Running   1 (2d21h ago)     11d
kube-system    coredns-5dd5756b68-28ftd                           1/1     Running   0                 11d
kube-system    coredns-5dd5756b68-mffdc                           1/1     Running   0                 11d
kube-system    etcd-aiml-test-subhash                             1/1     Running   0                 11d
kube-system    kube-apiserver-aiml-test-subhash                   1/1     Running   0                 11d
kube-system    kube-controller-manager-aiml-test-subhash          1/1     Running   12 (9h ago)       11d
kube-system    kube-proxy-wkmlc                                   1/1     Running   0                 11d
kube-system    kube-scheduler-aiml-test-subhash                   1/1     Running   11 (9h ago)       11d
kubeflow       cache-deployer-deployment-cf9646b9c-7452b          1/1     Running   0                 11d
kubeflow       cache-server-56d4959c9-kdgx4                       1/1     Running   2 (2d1h ago)      11d
kubeflow       leofs-bfc4794f5-hbgcd                              1/1     Running   0                 11d
kubeflow       metadata-envoy-deployment-9c7db86d8-ldvq5          1/1     Running   0                 11d
kubeflow       metadata-grpc-deployment-d94cc8676-w6xth           1/1     Running   6 (11d ago)       11d
kubeflow       metadata-writer-cd5dd8f7-thckp                     1/1     Running   1 (11d ago)       11d
kubeflow       minio-5dc6ff5b96-mzr6l                             1/1     Running   0                 11d
kubeflow       ml-pipeline-85b6bf5f67-5wjgn                       1/1     Running   10 (43h ago)      11d
kubeflow       ml-pipeline-persistenceagent-fc7c944d4-5ckvl       1/1     Running   0                 11d
kubeflow       ml-pipeline-scheduledworkflow-676478b778-xvxtt     1/1     Running   0                 11d
kubeflow       ml-pipeline-ui-76bc4d6c99-j67t5                    1/1     Running   19 (43h ago)      11d
kubeflow       ml-pipeline-viewer-crd-8574556b89-9pfs5            1/1     Running   0                 11d
kubeflow       ml-pipeline-visualizationserver-5d7c54f495-ldkhr   1/1     Running   18 (43h ago)      11d
kubeflow       mysql-5b446b5744-njplz                             1/1     Running   0                 11d
kubeflow       workflow-controller-679dcfdd4f-859sz               1/1     Running   14 (9h ago)       11d
traininghost   aiml-dashboard-56b6b6987c-n9pmd                    1/1     Running   0                 11d
traininghost   aiml-notebook-6b5b49bf55-xbtqt                     1/1     Running   0                 11d
traininghost   cassandra-0                                        1/1     Running   2 (2d21h ago)     11d
traininghost   data-extraction-677d964b74-ghwr5                   1/1     Running   0                 11d
traininghost   kfadapter-594c44755b-trqhq                         1/1     Running   0                 11d
traininghost   modelmgmtservice-5b7b6cbc4f-m66vz                  1/1     Running   0                 11d
traininghost   tm-db-postgresql-0                                 1/1     Running   1 (2d21h ago)     11d
traininghost   tm-f4564cf87-swbrv                                 1/1     Running   4 (5m17s ago)   42h

4. Post-Installation Verification

Outline how to verify that the installation was successful.

4.1) Step 1:

Expected Result:

4.2) Step 2:

Expected Result:

5. Troubleshooting

Provide common issues and their solutions.

Issue 1: (Describe the issue.)
Solution: (Provide the solution.)

6. Additional Resources

List of additional documentation, links, or resources that may be helpful.

Documentation: https://docs.o-ran-sc.org/projects/o-ran-sc-aiml-fw-aimlfw-dep/en/latest/installation-guide.html#installation-guide
Support: Slack #AIMLFW