From 6424cbc7cef9185564c5e3574575b4a5e617b9cb Mon Sep 17 00:00:00 2001 From: "bozo.kopic" Date: Fri, 18 Aug 2017 15:24:16 +0200 Subject: documentation --- docs/functionality.rst | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 docs/functionality.rst (limited to 'docs/functionality.rst') diff --git a/docs/functionality.rst b/docs/functionality.rst new file mode 100644 index 0000000..6943f14 --- /dev/null +++ b/docs/functionality.rst @@ -0,0 +1,32 @@ +Functionality +============= + +Hatter is CI tool with emphasis on simple workflow based on virtual machine +work executors. In contrast to most other CI tools, Hatter doesn't have +specialized executors that need to be installed on machines that execute +user defined commands. Each executor is generic VM with SSH daemon which +is used for file transfer and execution of user defined commands. Therefore, +Hatter is implemented as single daemon that orchestrates VMs lifecycle and +remote command execution. + + +Server +------ + +Hatter server daemon provides project execution orchestrator facility with +web-based administration interface. It is configured with single YAML +configuration defined by :ref:`JSON Schema `. Single +server instance can support automation of multiple projects. + + +Project +------- + +Hatter project is represented by single git repository containing project +configuration file - `.hatter.yml`. Configuration file is defined by +:ref:`JSON Schema `. This configuration can define +multiple execution environments with appropriate execution commands. + + +Execution environment +--------------------- -- cgit v1.2.3-70-g09d2