Skip to main content

Demo guide

Test LMOS locally​

The LMOS Demo serves as a starting point for testing LMOS. While we are still in the process of migrating projects to Open Source and adopting Open Standards, the core concepts are already available for testing.
The LMOS Demo launches a container that internally sets up Kubernetes (Minikube), along with Istio, Kiali, Grafana, and Prometheus, into which the LMOS components are installed.

Prerequisites​

Before you begin, ensure the following tools are installed and running on your local machine:

Using the Development Container​

Step 1: Open the Repository in a Dev Container​

  1. Clone the repository:

    git clone https://github.com/eclipse-lmos/lmos-demo.git
    cd lmos-demo

  2. Open the repository in Visual Studio Code:

  3. Open the Command Palette (F1 or Ctrl+Shift+P) and select Remote-Containers: Reopen in Container. This will build and open the repository in a Docker-based development container, in which Minikube is already installed and started.

Step 2: Set OpenAI Connection Details​

Once inside the development container, set up the necessary environment variables for OpenAI API access in the .env file. This OpenAPI access is used by the lmos-runtime and the agents.

OPENAI_APIKEY="<your-openai-api-key>"
OPENAI_CLIENTNAME="openai"
OPENAI_MODELNAME="gpt-4o-mini"
OPENAI_URL="https://api.openai.com"
OPENAI_PROVIDER="openai"

Step 3: Install LMOS​

Run the following commands to install LMOS onto Minikube:

./install.sh

Step 4: Check the Setup​

To verify the installation of LMOS, run:

kubectl get pods

Output:

NAME                                   READY   STATUS    RESTARTS   AGE
arc-view-web-db8d87c59-54k7b           2/2     Running   0          87s
lmos-operator-64bfb9b569-4l9qv         2/2     Running   0          2m22s
lmos-runtime-59ffdbdc6f-v5jtr          2/2     Running   0          2m21s

The status has to be 2/2 Running for all three of them.

Step 5: Install a demo​

In the demos folder, you can find various demo setups. To install a demo, run the corresponding install.sh script, e.g. for the starter demo:

./demos/starter/install.sh

Step 6: Access the demo​

To access the demo, ports to the installed services and agents have been forwarded from the Minikube cluster and should be accessible from your browser. A dashboard provides a simple entry point to the different services and can be accessed as follows:

On the dashboard, you find links to the Arc View (a graphical user interface to interact with the installed agents), as well as links to some tools (Prometheus and Grafana for monitoring, Kiali for inspecting the
Istio service mesh). In case you are interested in the GraphQL API of the installed agents, the dashboard also provides links to interfaces for interacting with these APIs.

Using ArgoCD for deployment​

You can add the argocd-apps folder as new ArgoCD application to your existing cluster ArgoCD managed cluster. You only need to adapt the secrets.yaml.

Develop Your Own Agent​

With ARC, we offer a Kotlin-based framework for developing agents. There is an extensive documentation about ARC.