Introduction to The Eye

theeye.io

What is TheEye?

The Eye works as an automation platform. Depending on your use case it can be both an automation platform as a service or an automation service platform,. You may use it as:

  • A remote server management and a monitoring tool (Devops)
  • A server provisioning tool
  • A task manager (with scheduler)
  • A Workflow creation tool (IFTTT)
  • A technical knowledge base repository
  • An integration and automation platform
  • A Real time support tool

It allows you to monitor and manage resources, launch and schedule tasks, write and/or upload scripts, build workflows through a series of task results or even trigger specific tasks or workflows as a response to one of your monitor events. All this is done from the web interface or the mobile app.

The bolded keywords in the above paragraph are all core concepts of The Eye.

Domain vocabulary

The Eye consists on the core orchestation platform running in a SaaS infrastructure. The orchestrator receives bots and clients connections. It works as a finite-state machine to keeps track of monitors and indicators states, tasks and workflows execution results, and trigger notifications on events. It helps maintains scripts and files.

Monitors.

Bots/Agents.

Tasks.

Workflows.

A client is any means capable of connecting to the core platform through a secure protocol and gain access with valid credentials. The Eye provides a web UI as it's main client, but alternative connection mechanisms can be implemented and any of them would fall under the client category.

A host is any instance, server or machine the user wants to monitor or control. The host must have internet access, the agent installed and configured and be able to reach the core platform.

A user is any valid identification registered on the core platform. Active users have a unique email address and are responsible for their own passwords to be strong and secure.

Once a user registers, a unique key/secret pair is assigned to his/her account. This key/secret pair must be used to configure any agent installed by the user so the core platform can secure the encrypted communication between the host, the client and the core platform itself.

Tasks are, well, tasks. They are the means of the core platform to instruct agents to execute scripts and routines. When a user creates a task the core platform stores any scripts and/or options for the task and assigns it to the host. Tasks can be launched, scheduled for one time or periodic execution, or even be triggered by some monitor event or workflow.

The user can upload or write scripts. Scripts are stored on the core platform and provided to the agent when a task needs to be executed.

A monitor event is...

A trigger is what happens when...

A workflow consists in a...