https://github.com/product-os/transformer-worker

Transformer Worker
https://github.com/product-os/transformer-worker

product-os transformers

Last synced: 6 days ago
JSON representation

Transformer Worker

• Host: GitHub
• URL: https://github.com/product-os/transformer-worker
• Owner: product-os
• License: agpl-3.0
• Created: 2021-01-15T16:34:40.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2022-12-13T02:27:30.000Z (almost 2 years ago)
• Last Synced: 2023-02-28T06:11:23.940Z (over 1 year ago)
• Topics: product-os, transformers
• Language: TypeScript
• Homepage:
• Size: 1.98 MB
• Stars: 2
• Watchers: 15
• Forks: 0
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
**CI/CD reimagined Balena-style. Reactive. Scalable. Batteries included.**

## Highlights

- **adds CI/CD capabilities to [ProductOS](https://github.com/product-os/)**: using a primitive that we call a "Transformer". 

- **A Transformer is a piece of code, wrapped in a container, that takes input and produces output**: Input and output can be anything but must be described with some our own meta-data format which we call "contracts" and which you typically find in a file called `balena.yml`. Transformers have an input filter, which is a JSON schema which gets matched against any contract that gets picked up by our GitHub integration. If it matches the Transformer gets executed with the input and its contract.

## Motivation

Because other CI/CD systems just didn't cut it...

## Building and deploying

### Using Github Actions

This repository can be set to automatically deploy to a balena fleet using 

Github actions. Any push or merge to master will be deployed to the target

fleet.

To enable automatic deployments using Github Actions, you will need to create a

production environment in the repository settings and add the following

environment secrets:

* `BALENA_FLEET`: the slug of the balena fleet. Follows the format `/`.

* `BALENA_API_KEY_PUSH`: a balena API key for pushing the code to the balena builders.

Please refer to [this guide][github-repository-environments] for setting up

an environment and the required secrets.

The Github workflow uses the [deploy-to-balena][deploy-to-balena] Github action.

### Manual Deployments

* Run `BALENA_APP= ./push-to-balena.sh`

## Environment Variables

### fleet-launcher required env-variables

* `FLEET_HOSTNAME`: Url to `transformers-fleet` server

* `FLEET_ENROLL_SECRET`: Secret used to enroll to the device to `transformers-fleet`

* `FLEET_EXTRA_ARGS`: Extra arguments that should be passed to `fleet-launcher` at start time. 

### transformer-runner required env variables

* `JF_API_URL`: Url to the JellyFish API server

* `JF_API_PREFIX`: JellyFish API prefix

* `REGISTRY_URL`: Url to the transformers private registry

* `REGISTRY_PORT`: Port to be used when connecting to the registry. Default: 80

### garbage-collector required env variables

* `GC_MAX_STORAGE_THRESHOLD`: GC will kick in when the disk space is below this threshold

## License

transformer-worker is free software, and may be redistributed under the terms specified in the [license](https://github.com/product-os/transformer-worker/blob/master/LICENSE).

[github-repository-environments]: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment

[deploy-to-balena]: https://github.com/balena-io/deploy-to-balena-action