Skip to content

Commit f1b939e

Browse files
committed
📝 : add README.md
1 parent 6a1977e commit f1b939e

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# gaia-runner
2+
3+
gaia-runner is the service that runs the Terraform jobs in Gaia.
4+
5+
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=gaia-app%3Arunner&metric=alert_status)](https://sonarcloud.io/dashboard?id=gaia-app%3Arunner)
6+
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=gaia-app%3Arunner&metric=coverage)](https://sonarcloud.io/dashboard?id=gaia-app%3Arunner)
7+
![Docker Pulls](https://img.shields.io/docker/pulls/gaiaapp/runner)
8+
9+
## What is it?
10+
11+
Gaia is a web application to import and run your Terraform modules. See [Gaia on Github](https://github.com/gaia-app/gaia).
12+
13+
This service works in conjonction with Gaia.
14+
15+
It features :
16+
* running modules (plan/apply/destroy) in a dedicated docker container
17+
* publish state to Gaia
18+
19+
## Documentation
20+
21+
Go to [docs.gaia-app.io](https://docs.gaia-app.io) for the full documentation.
22+
23+
## Requirements
24+
25+
Gaia-runner needs :
26+
* a docker daemon (used to run Terraform itself)
27+
* a running Gaia instance
28+
29+
## Quick start
30+
31+
See the documentation at [https://docs.gaia-app.io/](https://docs.gaia-app.io/getting-started/quick-start/) for quick-start instructions.
32+
33+
## Contributors
34+
35+
Gaia is made with ❤️ in 🇫🇷 by [Cyril DUBUISSON](https://github.com/cdubuisson) and [Julien WITTOUCK](https://github.com/juwit)

0 commit comments

Comments
 (0)