add basic README

Signed-off-by: Jakub Sokołowski <jakub@status.im>
This commit is contained in:
Jakub Sokołowski 2019-03-18 16:05:34 +01:00
parent e542af2c4b
commit 89adcbbf47
No known key found for this signature in database
GPG Key ID: 4EF064D0E6D63020
1 changed files with 37 additions and 0 deletions

37
README.md Normal file
View File

@ -0,0 +1,37 @@
# Description
This repo defines infrasctructure for Rinkeby and Ropsten Ethereum faucets.
The endpoints are:
* https://faucet-rinkeby.status.im/
* https://faucet-ropsten.status.im/
# Requirements
In order to use this you will need secrets(passwords, certs, keys) contained within the [infra-pass](https://github.com/status-im/infra-pass) repository. If you can't see it ask jakub@status.im to get you access for it.
In order for this to work first you need to install necessary Terraform plugins and get the right secrets from the [infra-pass](https://github.com/status-im/infra-pass) repo, to do that simply run:
```
make
# alternatively
make plugins
make secrets
```
This will put the necessary certificates, keys, and passwords are in place so you can deploy and configure hosts.
# Usage
To deploy hosts simply:
```
terraform plan
terraform apply
```
Then configure hosts:
```
ansible-playbook ansible/main.yml
```
# Details
Read the [Terraform and Ansible](https://github.com/status-im/infra-docs/blob/master/articles/ansible_terraform.md) article in our `infra-docs` repo.