In this short tutorial you will learn:
  1. How to download and run the Opereto agent 
  2. How to import a predefined example service and run it on your remote agent host 
This tutorial assumes that you already have an Opereto server installed and accessible. Let us begin:

① Login to the server via https://SERVER_URL/ui

② Download & run the Opereto agent on your host

  • Make sure you have a running JAVA on your host
  • Download the agent jar file (no need to install the agent as a service on your host for now, only run it in batch mode)
  • Run it from the command line providing a unique AGENT_NAME


java -XX:MaxPermSize=128m -XX:MinHeapFreeRatio=15 -XX:MaxHeapFreeRatio=30 -Xms128m -Xmx256m -jar opereto-agent-latest.jar -host https://OPERETO_SERVER_URL -name my_first_agent -u OPERETO_USERNAME -p OPERETO_PASSWORD -loglevel info -log console


Go to the Environments screen and verify that the agent is connected. If the agent is not connected:
  • Check the connectivity from the agent to the Opereto cluster via https
  • If connection is fine, check the agent log on the host running the agent in .opereto directory inside the home directory of the user initiated the agent (e.g. ~/.opereto/logs/) for errors
For more information about agent troubleshooting, please look at the agent troubleshooting section.   

bell-2x.png To learn how to install the agent as a service on Windows or Linux host, please go to the Downloads Page.

③ Add a sample service and run it

Opereto sample service is a short JAVA program that prints the input parameters passed to it, some operating system data and the environment variables created by the agent. You may notice that some of those environment variables are the input parameters passed to the service upon initiation and some are special variables that Opereto passes to each service execution. To learn more about input parameters and environment variables please refer to the micro services input/output article.

You can check out the service code at GitHub. To add the example service to Opereto cluster, please do the following: 
  • Go to the Opereto web UI –> Services -> Test Orchestration
  • Select the Import tab
  • Select 'GIT' as a repository
  • Copy the following and paste into the Import JSON test area (override the existing json):


"branch": "master",
"ot_dir": "microservices/simple_example",
"repo_type": "git",
"url": "https://github.com/opereto/opereto_examples.git"


  • Click on “Import Service” button 
  • You will see a new service in your service tree called: simple example
  • To run the service example on your agent:
    • Select the service in the services tree
    • Click on the play icon  in the vertical service toolbar
    • Fill in some data in the input form and select your agent
    • Click on “Run Process” button


Next, we recommend reading the Opereto Overview article. The article provides a high-level description regarding how opereto works and also provides useful links to get a deeper knowledge about Opereto major mechanisms. 
In addition, you can find a few useful developer's tutorials here: Developing with Opereto.