Connecting VM Agent

Documentation Index

Fetch the complete documentation index at: https://docs.odigos.io/llms.txt

Use this file to discover all available pages before exploring further.

​

Prerequisites

• Install VM Agent on your Linux hosts. If VM Agent is not installed yet, start with VM Agent installation.
• Expose Odigos Central externally (for example, via an Ingress, LoadBalancer Service, or another supported exposure method).
• Have a Central endpoint URL that is reachable from your VM hosts.

• odictl
• YAML

Use odictl to connect the VM Agent to Odigos Central.

1

Open odictl on the host

odictl

2

Go to the Configuration screen

Press c to navigate to the configuration screen.

3

Navigate to the Tower section

Use the arrow keys or mouse to navigate to the Tower section on the left side of the screen.

4

Configure Tower settings

Use the Tab key or mouse to navigate and configure the following fields:

​

tower.enabled

boolean

required

Enable the Central controller. If false, the controller will not start.
Set this value to true.

​

tower.endpoint

string

required

WebSocket endpoint of the Central server in host:port or URL format.
Set this to the Central endpoint URL from the Prerequisites section above.

​

tower.agent_name

string

Agent name identifier for this VM Agent instance. (Defaults to IP of the host where dots are replaced with dashes, with an ip- prefix)
Set this to the display name you want to see in Odigos Central.

5

Save the configuration

Press Ctrl+S to save the configuration.

6

Exit odictl

Press Ctrl+C to exit odictl.

7

Restart the odigos-vmagent service

Restart the VM Agent service:

sudo systemctl restart odigos-vmagent.service

Use YAML configuration files to connect VM Agent to Odigos Central.

1

Navigate to the /etc/odigos-vmagent folder

cd /etc/odigos-vmagent

2

Edit the config.yaml file

Edit the config.yaml file using an editor of your choice. The example below uses vi.

sudo vi config.yaml

3

Add Odigos Central to the configuration

Modify the following fields:

​

enabled

boolean

required

Enable the Central controller. If false, the controller will not start.
Set this value to true.

​

endpoint

string

required

WebSocket endpoint of the Central server in host:port or URL format.
Set this to the Central endpoint URL from the Prerequisites section above.

​

agent_name

string

Agent name identifier for this VM Agent instance. (Defaults to IP of the host where dots are replaced with dashes, with an ip- prefix)
Set this to the display name you want to see in Odigos Central.

log_level: info
log_format: console
cli:
  port: 23678
tower:
  enabled: true
  endpoint: "odigoscentral.example.com"
  agent_name: ip-10-0-1-51
  platform_type: vm
  version: v1.6.0
...

The YAML above is only a snippet of the full config.yaml file.

4

Save the file

:wq!

5

Restart the odigos-vmagent service

Restart the VM Agent service:

sudo systemctl restart odigos-vmagent.service

​

Next steps