Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tfxor/terrahub
Terraform Automation and Orchestration Tool (Open Source)
https://github.com/tfxor/terrahub
automation cloud containers continuous-delivery continuous-deployment continuous-integration continuous-testing devops infrastructure orchestration serverless terraform
Last synced: 30 days ago
JSON representation
Terraform Automation and Orchestration Tool (Open Source)
- Host: GitHub
- URL: https://github.com/tfxor/terrahub
- Owner: tfxor
- License: mpl-2.0
- Created: 2018-04-14T18:21:27.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2022-04-16T16:05:23.000Z (over 2 years ago)
- Last Synced: 2024-05-23T02:31:52.389Z (7 months ago)
- Topics: automation, cloud, containers, continuous-delivery, continuous-deployment, continuous-integration, continuous-testing, devops, infrastructure, orchestration, serverless, terraform
- Language: Twig
- Homepage: https://docs.terrahub.io
- Size: 412 MB
- Stars: 223
- Watchers: 11
- Forks: 19
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: docs/CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-list - terrahub
- awesome-tf - terrahub - TerraHub is terraform automation and orchestration tool. Seamlessly integrated into console.terrahub.io, enterprise friendly GUI to show realtime terraform executions, as well as auditing and reporting capabilities for historical terraform runs. :heavy_dollar_sign: (Tools / Community providers)
README
# Welcome to TerraHub
## Quick Links
[TerraHub CLI](#terrahub-cli) | [TerraHub API](#terrahub-api) | [TerraHub Console](#terrahub-console) | [Install CLI](#install-cli) | [Examples and More](#examples)
Official TerraHub Documentation: https://docs.terrahub.io
## TerraHub CLI
terraform automation and orchestration tool
( built using [node.js](https://nodejs.org)
| published using [npm](https://www.npmjs.com/package/terrahub)
| managed using [github](https://github.com/tfxor/terrahub)
| documented using [gitbook](https://docs.terrahub.io) )
## TerraHub API
data and logs management, requires token to collect anything
( built using [node.js](https://nodejs.org)
| managed using [swagger](https://www.terrahub.io/api)
| deployed using [aws serverless](https://aws.amazon.com/serverless)
| documented using [swagger ui](https://www.terrahub.io/api) )
## TerraHub Console
enterprise friendly GUI to show realtime terraform executions, as well as
auditing and reporting capabilities for historical terraform runs
( built using [vue.js](https://vuejs.org)
| managed using [webpack](https://webpack.js.org)
| deployed using [aws serverless](https://aws.amazon.com/serverless)
| published using [terrahub](https://console.terrahub.io) )
## Install CLI
Getting started with TerraHub CLI is pretty straightforward:
1. Check if `npm` is installed:
```shell
npm --version
```
The output should look similar to the one below (no need to copy paste):
```text
v5.6.0
```
> NOTE: If `npm` is missing, check out [Downloading and Installing Node.js and npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
2. Install `terrahub` globally using `npm`:
```shell
npm install --global terrahub
```
The output should look similar to the one below (no need to copy paste):
```text
~/.nvm/versions/node/v8.10.0/lib
└── [email protected]
```
3. Test if `terrahub` cli was installed properly:
```shell
terrahub --help
```
### TerraHub Token
[TerraHub CLI](https://www.npmjs.com/package/terrahub) doesn't magically collect your data and upload to [TerraHub API](https://www.terrahub.io/api), which is further visualized in [TerraHub Console](https://console.terrahub.io). In order to do that, please sign up for a free account at [console.terrahub.io](https://console.terrahub.io) and navigate to [Settings](https://console.terrahub.io/settings) page to copy TerraHub Token. Next, setup TerraHub Token as `TERRAHUB_TOKEN` environmental variable or update `token` value in global config file - `$HOME/.terrahub/.terrahub.json`.
## Examples
More Examples:
* [Terraform Automation Demo using AWS Cloud Provider](https://github.com/tfxor/terraform-aws-automation-demo)
* [Terraform Automation Demo using Google Cloud Provider](https://github.com/tfxor/terraform-google-automation-demo)
Official TerraHub Documentation: https://docs.terrahub.io