https://github.com/shalomb/terrestrial

(Proof-of-concept) REST API framework to *aaSify terraform + ansible stacks
https://github.com/shalomb/terrestrial

ansible celery-task flask-restplus python-celery python-flask terraform

Last synced: about 2 months ago
JSON representation

(Proof-of-concept) REST API framework to *aaSify terraform + ansible stacks

• Host: GitHub
• URL: https://github.com/shalomb/terrestrial
• Owner: shalomb
• License: apache-2.0
• Created: 2019-08-28T11:09:59.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-02-02T06:39:10.000Z (about 2 years ago)
• Last Synced: 2025-01-10T14:52:40.345Z (4 months ago)
• Topics: ansible, celery-task, flask-restplus, python-celery, python-flask, terraform
• Language: Python
• Homepage:
• Size: 38.1 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-2.0.txt

Awesome Lists containing this project

README

        
# terrestrial

Proof-of-Concept: Thin REST API shim for your existing terraform + ansible IaC

codebase.

## Use Cases

- IaaS/PaaS. Exposing IaC code projects over REST APIs such that instances

(your IaC deliverables) can be created, managed, lifecycled, etc. e.g. Port

your Terraform + Ansible that manages PostgreSQL clusters into Terrestrial and

realize your Database-as-a-Service.

- Defining custom operational and system boundaries around IaC. e.g. Use

Terrestrial + $your_favourite_reverse_proxy in place of Gitlab hacked-up

pipelines to manage infrastructure.

# Goals

- Provide a thin "API Service" layer around any (within reason) Terraform and/or

  Ansible IaC codebase to realize a X-as-a-Service offering. Define a nominal

  interface the hosted IaC codebase should implement to be Onboarded into

  Terrestrial.

- Provide a full CRUD Interface using established REST patterns (e.g.

  [POST-PUT](http://restalk-patterns.org/post-put.html) to allow long-running

  terraform/ansible processes to create the technical resource).

- Easy deployment: Build a docker image containing the complete bundle of

  Terrestrial + IaC code to deploy the "service". Allow sourcing of IaC projects

  from remote git repositories.

- Dynamic Inventory: Refactor [shalomb/tofu](https://github.com/shalomb/tofu)

  to provide a dynamic inventory of terraform resources to ansible, etc.

- Allow for integrations into load-balancers/reverse-proxies/ADCs to augment

  system and operational needs. Support for OAuth/OIDC/Logging.

## HOWTO

A write-up required but see scripts in `bin/` to get started.

## IaC Interface

TODO: This section is incomplete.

- Use `tfvars.json` to pass resource attributes as variables from terrestrial

  to terraform.

- Use `terraform outputs` from terraform to state created resources.

- Use the `terraform state` to describe the full IaC inventory to technologies

  further up the stack (e.g. ansible, etc).

- Use `group_vars/all` to pass resource attributes as variables to ansible.

- Use JSON outputs to capture output from terraform's `plan`, `apply`, `destroy`,

  etc.

- Use custom callbacks (and so JSON) to capture output from ansible playbook runs.