https://github.com/raystack/entropy
Entropy is a framework to safely and predictably create, change, and improve modern cloud applications and infrastructure using familiar languages, tools, and engineering practices.
https://github.com/raystack/entropy
dataops
Last synced: 7 months ago
JSON representation
Entropy is a framework to safely and predictably create, change, and improve modern cloud applications and infrastructure using familiar languages, tools, and engineering practices.
- Host: GitHub
- URL: https://github.com/raystack/entropy
- Owner: raystack
- License: apache-2.0
- Created: 2021-09-21T00:10:38.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-02-23T11:14:49.000Z (over 1 year ago)
- Last Synced: 2024-07-30T17:59:43.263Z (10 months ago)
- Topics: dataops
- Language: Go
- Homepage:
- Size: 762 KB
- Stars: 19
- Watchers: 10
- Forks: 7
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Entropy
[](https://goreportcard.com/report/github.com/odpf/entropy)
[](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](./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](https://github.com/odpf/entropy/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
```sh
# 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](./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.
```shell
$ entropy serve --config ./my_config.yaml
```
## Development
### Running locally
```sh
# 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
```sh
# 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](https://odpf.github.io/entropy/docs/contribute/contributing) 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](https://github.com/odpf/entropy/labels/good%20first%20issue) 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](https://github.com/odpf/entropy/graphs/contributors).
## License
Entropy is [Apache 2.0](LICENSE) licensed.