Skip to content

Latest commit

 

History

History
97 lines (64 loc) · 3.58 KB

README.md

File metadata and controls

97 lines (64 loc) · 3.58 KB
Raw

Entropy

test workflow Go Report Card Version License

Entropy is an extensible infrastructure orchestration and application deployment tool. Entropy provides features required for deploying and managing complex applications like resource versioning, config schema versioning, rollbacks dry runs etc.

Key Features

  • No Dependency: Written in Go. It compiles into a single binary with no external dependency.
  • Extensible: Entropy provides framework to easily write and deploy applications to your choice of cloud
  • Runtime: Entropy can run inside VMs or containers with minimal memory footprint.

Refer docs for more on capabilites, internals, etc.

Installation

Install Entropy on macOS, Windows, Linux, OpenBSD, FreeBSD, and on any machine.

Binary (Cross-platform)

Download the appropriate version for your platform from releases page. Once downloaded, the binary can be run from anywhere. You don’t need to install it into a global location. This works well for shared hosts and other systems where you don’t have a privileged account. Ideally, you should install it somewhere in your PATH for easy use. /usr/local/bin is the most probable location.

Homebrew

# Install entropy (requires homebrew installed)
$ brew install odpf/tap/entropy

# Check for installed entropy version
$ entropy version

Usage

Entropy typically runs as a service and requires a Postgres to store its state.

Refer entropy.yaml for sample configuration values.

  • You can override the configurations by directly editing the entropy.yaml file or by setting environment variables.
  • Environment variable name will be uppercased version of the complete path in YAML along with . replaced with _ character. For example, the service.host can be overriden by setting SERVICE_HOST.
  • It is also possible to create a copy of the sample configuration file with different name and provide that path to entropy.
$ entropy serve --config ./my_config.yaml

Development

Running locally

# Clone the repo
$ git clone https://github.com/odpf/entropy.git

# Build entropy binary file
$ make build

# Start a MongoDB instance
$ docker-compose up

# Run entropy on a recipe file
$ ./dist/entropy serve

Running tests

# Running all unit tests, excluding extractors
$ make test

Contribute

Development of Entropy happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving Entropy.

Read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Entropy.

To help you get your feet wet and get you familiar with our contribution process, we have a list of good first issues that contain bugs which have a relatively limited scope. This is a great place to get started.

This project exists thanks to all the contributors.

License

Entropy is Apache 2.0 licensed.