Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/flosell/iam-policy-json-to-terraform
Small tool to convert an IAM Policy in JSON format into a Terraform aws_iam_policy_document
https://github.com/flosell/iam-policy-json-to-terraform
aws hacktoberfest hcl iam iam-policy infrastructure-as-code terraform
Last synced: 6 days ago
JSON representation
Small tool to convert an IAM Policy in JSON format into a Terraform aws_iam_policy_document
- Host: GitHub
- URL: https://github.com/flosell/iam-policy-json-to-terraform
- Owner: flosell
- License: apache-2.0
- Created: 2018-04-28T12:12:50.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-11-25T08:44:33.000Z (17 days ago)
- Last Synced: 2024-11-28T19:03:52.374Z (14 days ago)
- Topics: aws, hacktoberfest, hcl, iam, iam-policy, infrastructure-as-code, terraform
- Language: JavaScript
- Homepage: https://flosell.github.io/iam-policy-json-to-terraform/
- Size: 2.45 MB
- Stars: 780
- Watchers: 10
- Forks: 57
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-terraform - iam-policy-json-to-terraform - Small tool to convert an IAM Policy in JSON format into a Terraform aws_iam_policy_document (Tools / Miscellaneous)
- awesome-tf - iam-policy-json-to-terraform - Small tool to convert an IAM Policy in JSON format into a Terraform aws_iam_policy_document (Tools / Community providers)
README
# iam-policy-json-to-terraform
[](https://github.com/flosell/iam-policy-json-to-terraform/actions/workflows/main.yml)
Small tool to convert an IAM Policy in JSON format into a Terraform [`aws_iam_policy_document`](https://www.terraform.io/docs/providers/aws/d/iam_policy_document.html)
## Web Version
Check out a web version of the tool [here](https://flosell.github.io/iam-policy-json-to-terraform/).
For command line usage and automation, check out the instructions below.
## Installation
### OSX
```bash
$ brew install iam-policy-json-to-terraform
```
### [asdf](https://github.com/asdf-vm/asdf)
```bash
$ asdf plugin add iam-policy-json-to-terraform https://github.com/carlduevel/asdf-iam-policy-json-to-terraform.git
```
### Other
Download the latest binary from the [releases page](https://github.com/flosell/iam-policy-json-to-terraform/releases) and put it into your `PATH` under the name `iam-policy-json-to-terraform`
### Developer
If you're a go developer and have your `GOPATH` defined and have added your `$GOPATH/bin` directory to your path, you can simply run this command.
```bash testcase=usage
$ go install github.com/flosell/iam-policy-json-to-terraform@latest
```
## Usage
From raw JSON
```bash testcase=usage
$ echo '{"Statement":[{"Effect":"Allow","Action":["ec2:Describe*"],"Resource":"*"}]}' | iam-policy-json-to-terraform
data "aws_iam_policy_document" "policy" {
statement {
sid = ""
effect = "Allow"
resources = ["*"]
actions = ["ec2:Describe*"]
}
}
```
From a JSON policy file
```bash
$ iam-policy-json-to-terraform < some-policy.json
```
If a video demo is more your thing, checkout [this nice 2min introduction](https://www.youtube.com/watch?v=AhtpJII6eaw) by the folks at env0.
## Local development
### Prerequisites
* Clone the repository to a location of your choosing:
```bash testcase=building
$ git clone [email protected]:flosell/iam-policy-json-to-terraform.git
```
* Install dependencies and tools:
```bash testcase=building
$ cd iam-policy-json-to-terraform
$ make tools
```
### Development
#### Entry point
`make` is your primary point of entry for any development activity. Call it without arguments to learn more:
```bash testcase=building
$ make
build Test and build the whole application
clean Remove build artifacts
fmt Format code
fmtcheck Run linter
seccheck Run security checks
test Run all tests
test-readme Run the commands mentioned in the README for sanity-checking
tools Install additional required tooling
tools-main Install additional required tooling for the main version
tools-web Install additional required tooling for the web version
web-build Build the web version
web-deploy Deploy the web version to GitHub pages
web-e2e Run end to end tests for web version (requires web-build)
web-e2e-live Run end to end tests for web version in live mode for development (requires web-build)
web-serve Serve the web version on a local development server
web-visual-regression-approve Accept changes in Web UI visuals
web-visual-regression-test Test for changes in Web UI visuals
```
#### Web Development
To develop the web-frontend, you'll need to first compile the JavaScript version of `iam-policy-json-to-terraform`.
`make web-build` will do that, generating a `web.js` file.
Include it and it'll expose a `convert(policyName,jsonString)` function in the global namespace.
Currently, the complete web-frontend is plain HTML, JS and CSS, all within `web/index.html`.
Edit or refine as needed.
End-To-End Tests for the web frontend exist as [TestCafe](https://testcafe.io/) tests in `web_test.js` and can be run using `make web-e2e`.