Skip to main content

User-side Tools

When interacting with Data Orchestrator as a User, you have several options to choose from:

  • astartectl: astartectl is the main command-line tool to interact with Data Orchestrator clusters, which packs in a number of subcommands to interact with Data Orchestrator API sets. It is a swiss army knife to perform daily operations on Data Orchestrator Clusters, and it abstracts most Data Orchestrator API interactions in a user-friendly way.
  • Data Orchestrator Dashboard: Data Orchestrator provides a built-in UI that can be used for managing Interfaces, Devices and Triggers. It is meant to be a graphical, user-friendly tool to perform daily operations on Realms.
  • Data Orchestrator API Clients: API Clients are provided for a variety of languages. These clients abstract API interaction with language-friendly paradigms, and provide API automations for several operations. Currently, the main API client available is astarte-go.
  • Data Orchestrator APIs: The base APIs are the lower level interaction layer. They are accessible, in standard installations, at api.<base Astarte URL>/<apiset>, and are the main mean of interaction upon which all other clients are based upon.
  • Grafana Datasource Plugin for Data Orchestrator: Thanks to the Data Orchestrator Datasource Plugin, data coming from Data Orchestrator may be visualised in custom dashboards provided by Grafana, the open source observability platform.

Depending on the context, you might want to choose what suits you best. Over the course of the documentation, several examples will be provided with interaction means.

Setting up astartectl​

In the documentation, it is assumed that astartectl is properly configured to interact with your Realm or your Cluster. Please refer to its documentation to make sure all needed configurations are in place.