Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/HubSpot/Singularity

Scheduler (HTTP API and webapp) for running Mesos tasks—long running processes, one-off tasks, and scheduled jobs. #hubspot-open-source
https://github.com/HubSpot/Singularity

mesos

Last synced: 7 days ago
JSON representation

Scheduler (HTTP API and webapp) for running Mesos tasks—long running processes, one-off tasks, and scheduled jobs. #hubspot-open-source

Awesome Lists containing this project

README 

        
***IMPORTANT DEPRECATION NOTICE***



This project is no longer actively maintained



As of April 2022, the HubSpot team has stopped new contributions to the open source version of Singularity. The slack channel will remain open for the time being for additional questions or support but no further releases will be published.



------------------



![Singularity](Docs/images/singularity.png)



**Latest Release Version:** [1.5.0](https://github.com/HubSpot/Singularity/releases/tag/Singularity-1.5.0)



**Mesos Version:** [1.9.0](http://mesos.apache.org/documentation/latest/upgrades/)



[![Build Status](https://travis-ci.org/HubSpot/Singularity.svg?branch=master)](https://travis-ci.org/HubSpot/Singularity)



## Overview ##



Singularity is an API and web application for running and scheduling [Apache Mesos](http://mesos.apache.org/) tasks — including long running processes, scheduled jobs, and one-off tasks.



It focuses on a batteries-included approach: Singularity and its components provide an entire Platform as a Service (PaaS) to end-users. It has many features which have been introduced to reduce developer friction and ensure proper operation and reliable deployment of tasks. Users may even be unfamiliar with and shielded from the details of Mesos.



For a more thorough explanation of the concepts behind Singularity and Mesos click [here](Docs/about/how-it-works.md).



----------



### Features ###



 - [Native Docker Support](Docs/reference/container-options.md)

 - [JSON REST API and Java Client](Docs/reference/apidocs/api-index.md)

 - [Fully featured web application (replaces and improves Mesos Master UI)](Docs/about/ui.md)

 - Rich load balancer integration with [Baragon](https://github.com/HubSpot/Baragon)

 - [Deployments, automatic rollbacks, and healthchecks](Docs/about/how-it-works.md#deploys)

 - [Webhooks for third party integrations](Docs/reference/webhooks.md)

 - Configurable email alerts to service owners

 - [Historical deployment and task data](Docs/reference/database.md)

 - [Custom executor with extended log features](Docs/about/how-it-works.md#optional-components)



----------



### Try It Out! ###



If you want to give Singularity a try, you can install [docker](https://docs.docker.com/installation/) and [docker-compose](https://docs.docker.com/compose/#installation-and-set-up) to run our example cluster.



Run `docker-compose pull` first to get all of the needed images. *Note: This may take a few minutes*



Then simply run `docker-compose up` and it will start containers for...

- mesos master

- mesos slave (docker/mesos containerizers enabled)

- zookeeper

- Singularity

- [Baragon Service](https://github.com/HubSpot/Baragon) for load balancer management

- [Baragon Agent](https://github.com/HubSpot/Baragon) + Nginx as a load balancer



...and the following UIs will be available:

- Singularity UI => [http://localhost:7099/singularity](http://localhost:7099/singularity)

- Baragon UI => [http://localhost:8080/baragon/v2/ui](http://localhost:8080/baragon/v2/ui)



*if using [boot2docker](http://boot2docker.io/) or another vm, replace localhost with the ip of your vm*



----------



## Getting Started ##

##### Requirements #####



 - [Mesos](https://mesos.apache.org/getting-started/)

 - [ZooKeeper](https://zookeeper.apache.org/doc/r3.4.6/zookeeperStarted.html) 

 - Java 7+

 - [MySQL](https://dev.mysql.com/doc/mysql-getting-started/en/) (optional)

 - PostgreSQL (optional)



##### Contact #####



- [[email protected]](mailto:[email protected]) // [singularity-users](https://groups.google.com/forum/#!topic/singularity-users/)

- \#singularity-framework on freenode



----------



## Reference ##



#### Installation ####



 - [Installation Instructions](Docs/getting-started/install.md)



#### Deployment ####



 - [API](Docs/reference/api.html)

 - [Configuration](Docs/reference/configuration.md)

 - [Examples](Docs/getting-started/basic-examples.md)

 - [`Request` and `Deploy` Concepts](Docs/about/requests-and-deploys.md)

 - [Custom Executor Components](Docs/about/how-it-works.md#optional-components)



#### Development ####



- [Local Development with Docker](Docs/development/developing-with-docker.md)

- [Hacking on the UI](Docs/development/ui.md)

- [Understanding the basepom / Maven structure](Docs/development/basepom.md)

- [Third-party load balancer API design requirements](Docs/development/load-balancer-integration.md)



----------



Singularity is built and used by a number of different companies. Check out the list of adopters [here](Docs/about/adopters.md).