Skip to main content

Convert Cloudformation Templates to Terraform.

Project description

Python Latest Tests Coverage License


Cloudformation 2 Terraform

Convert your Cloudformation templates to Terraform.
Report Bug · Request Feature ·

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. Contact
  7. Acknowledgements

About The Project

cf2tf is a CLI tool that attempts to convert Cloudformation to Terraform. We say attempt because it's not really possible to make the conversion with 100% accuracy (currently) because of several reasons mostly around converting a Map value in Cloudformation to the correct value in HCL.

Getting Started

Prerequisites

Cloudformation 2 Terraform requires python >= 3.8

Installation

cf2tf is available as an easy to install pip package.

pip install cf2tf

If you are a Homebrew user, can you install via brew:

$ brew install cf2tf

Usage

To convert a template to terraform.

cf2tf my_template.yaml

This above command will dump all the terraform resources to stdout. You might want to save the results:

cf2tf my_template.yaml > main.tf

If you prefer to have each resource in its own file then:

cf2tf my_template.yaml -o some_dir

If some_dir doesn't exist, then it will be created for you. Then each resource type will be saved to a specific file (variables.tf, outputs.tf etc.).

Roadmap

  • Better conversion of Cloudformation Maps to Terraform (Maps, Block and json)
  • Allow overides for specific resources
  • Handle more advanced Cloudformation parameter types like SSM/Secrets manager
  • Better handling of Recources/Properties that failed conversion
  • Only download files needed, not entire terraform source code (200MB)

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

This project uses poetry to manage dependencies and pre-commit to run formatting, linting and tests. You will need to have both installed to your system as well as python 3.11.

  1. Fork the Project

  2. Setup the environment. This project uses vscode devcontainer to provide a completly configured development environment. If you are using vscode and have the remote container extension installed, you should be asked to use the devcontainer when you open this project inside of vscode.

    If you are not using devcontainers then you will need to have python installed. Install the poetry, nox, nox_poetry and pre-commit packages. Then run poetry install and pre-commit install commands.

    Most of the steps can be found in the Dockerfile.

  3. Create your Feature Branch (git checkout -b feature/AmazingFeature)

  4. Commit your Changes (git commit -m 'Add some AmazingFeature')

  5. Push to the Branch (git push origin feature/AmazingFeature)

  6. Open a Pull Request

Contact

Levi - @shady_cuz

Acknowledgements

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cf2tf-0.7.1a0.tar.gz (37.9 kB view details)

Uploaded Source

Built Distribution

cf2tf-0.7.1a0-py3-none-any.whl (41.3 kB view details)

Uploaded Python 3

File details

Details for the file cf2tf-0.7.1a0.tar.gz.

File metadata

  • Download URL: cf2tf-0.7.1a0.tar.gz
  • Upload date:
  • Size: 37.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.0 CPython/3.11.9 Linux/6.5.0-1018-azure

File hashes

Hashes for cf2tf-0.7.1a0.tar.gz
Algorithm Hash digest
SHA256 cbd7ae64d4526d4a753279b05bc501161fd5b8db399e1d375fe489a6c64cd354
MD5 0300bd06e1d313eff6a23d92711ea634
BLAKE2b-256 90dd70e4c8c6f39df3d6209a3d17a96a652ee876a5312ab913c9572af062804b

See more details on using hashes here.

File details

Details for the file cf2tf-0.7.1a0-py3-none-any.whl.

File metadata

  • Download URL: cf2tf-0.7.1a0-py3-none-any.whl
  • Upload date:
  • Size: 41.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.0 CPython/3.11.9 Linux/6.5.0-1018-azure

File hashes

Hashes for cf2tf-0.7.1a0-py3-none-any.whl
Algorithm Hash digest
SHA256 c9bcd58d42a874f06d3c30d9d8e1e63201d298126782332498a3bbb263642945
MD5 4853195397a144d4acd4ef25cd7a4b94
BLAKE2b-256 82779470fb7ce27fc5d1abe903ff5347729161d21b0aea7dbff9f1b020890c85

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page