Skip to content

Commit

Permalink
docs: add plan's submition documentation in readme (#209)
Browse files Browse the repository at this point in the history
docs: add plan's submition documentation in readme
  • Loading branch information
hbollon committed Aug 30, 2021
1 parent 35d73c0 commit d9e29ff
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Expand Up @@ -54,6 +54,7 @@
- [GitLab Options](#gitlab-options)
- [Web](#web)
- [Help Options](#help-options)
- [Push plans to Terraboard](#push-plans-to-terraboard)
- [Use with Docker](#use-with-docker)
- [Docker-compose](#docker-compose)
- [Docker command line](#docker-command-line)
Expand Down Expand Up @@ -329,6 +330,23 @@ You can find a ready-to-use Docker example with two *MinIO* buckets in the `test

- `-h`, `--help` Show this help message

## Push plans to Terraboard

In order to send Terraform plans to Terraboard, you must wrap it in this JSON format:
```json
{
"lineage": "<Plan's lineage>",
"terraform_version": "<Terraform version>",
"git_remote": "<The URL of the remote that generated this plan>",
"git_commit": "<Commit hash>",
"ci_url": "<The URL of the CI that sent this plan>",
"source": "<Free field for the triggering event>",
"plan_json": "<Terraform plan JSON export>"
}
```

And send it to `/api/plans` using **POST** method

## Use with Docker

### Docker-compose
Expand Down

0 comments on commit d9e29ff

Please sign in to comment.