Hector

Software tool for workflow orchestration
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Hector is a workflow orchestrator. After the insertion of components and specifications, Hector records the optimal grouped topological order for each workflow and controls the execution of definitions associated with them.

(back to top)

Built With

Hector has been fully implemented in Golang . The high performance and great library support surrounding this programming language builds a truly suitable environment for our orchestrator.

(back to top)

Getting Started

We show a small guide to clarify the installation of our tool.

Prerequisites

As a prerequisite it is only necessary to have Golang installed on the system.

sudo apt install golang-go

Installation

1. Clone repository

   git clone https://github.com/KhaosResearch/Hector.git

2. Install dependencies

   go mod tidy

(back to top)

Usage

1. Raise the api

   go run cmd/api/main.go

2. Submit components

   curl -X POST  -H "Accept: Application/json" -H "Content-Type: application/json" -d @data/hector/toy_components/concat_files/concat-files-component.json localhost:8080/component/submit
   curl -X POST  -H "Accept: Application/json" -H "Content-Type: application/json" -d @data/hector/toy_components/concat_messages/concat-messages-component.json localhost:8080/component/submit
   curl -X POST  -H "Accept: Application/json" -H "Content-Type: application/json" -d @data/hector/toy_components/count_letters/count-letters-component.json localhost:8080/component/submit

3. Submit specification

   curl -X POST  -H "Accept: Application/json" -H "Content-Type: application/json" -d @data/hector/toy_specifications/toy_specification_1.json localhost:8080/specification/submit

4. Execute definition

   curl -X POST  -H "Accept: Application/json" -H "Content-Type: application/json" -d @data/hector/toy_definitions/toy_definition_1.json localhost:8080/definition/execute

5. Get result info (Replace <definition_id> with the identifier returned in console)

   curl -X GET -i -H "Accept: application/json" -H "Content-Type: application/json"  localhost:8080/result/get/<definition_id>

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Adrián Segura Ortiz - adrianseor.99@gmail.com

Project Link: https://github.com/KhaosResearch/Hector

(back to top)