Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README: Update general documentations and mention some WIP #9

Merged
merged 1 commit into from
Jul 16, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ $ git rebase upstream/master

#### Build from sources

Since InfraMap is a Go project, Go must be installed and configured on your machine (really ?). We currently support Go1.14 and go `modules` as dependency manager. You can simply pull all necessaries dependencies by running an initial.
Since InfraMap is a Go project, Go must be installed and configured on your machine (really ?). We currently support Go1.13+ and go `modules` as dependency manager. You can simply pull all necessaries dependencies by running an initial.

```shell
$ make build
Expand Down
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,21 @@ If your state file or HCL is from a provider we do not support, the resulting re

Support:

Terraform: 0.12.28

| Provider | State | HCL |
|--|:--:|:--:|
| AWS | Yes | Yes |
| FlexibleEngine | Yes | Yes |
| OpenStack | Yes | Yes |
| [Google](https://github.com/cycloidio/inframap/issues/7) | WIP | WIP |
| [AzureRM](https://github.com/cycloidio/inframap/issues/8) | WIP | WIP |

## Installation

### Development

You can build and install with the latest sources, you will enjoy the new features and bug fixes. It uses Go Modules
You can build and install with the latest sources, you will enjoy the new features and bug fixes. It uses Go Modules (1.13+)

```shell
$ git clone https://github.com/cycloidio/inframap
Expand All @@ -39,20 +43,20 @@ The `inframap --help` will show you the basics.
The most important subcommands are:

* `generate`: generates the graph from STDIN or file.
* `prune`: removes all unecessary information from the state or HCL (not supported yet) so it can be shared without any security concerns
* `prune`: removes all unnecessary information from the state or HCL (not supported yet) so it can be shared without any security concerns

### Example

Visualizing with dot

```shell
$ inframap generate --tfstate state.json | dot -Tsvg > graph.svg
$ inframap generate --tfstate state.tfstate | dot -Tsvg > graph.svg
```

or from the terminal itself

```shell
$ inframap generate --tfstate state.json | graph-easy
$ inframap generate --tfstate state.tfstate | graph-easy
```

or from HCL
Expand All @@ -77,6 +81,8 @@ apply specific provider logic if supported. If not supported, then basic graph i

### AWS

**Note:** We are currently investigating/trying to implement the grouping (https://github.com/cycloidio/inframap/issues/6) and connections based on iam resources (https://github.com/cycloidio/inframap/issues/11).

* `aws_security_group`
* `aws_security_group_rule`

Expand Down
2 changes: 1 addition & 1 deletion cmd/generate.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ var (
Use: "generate [FILE]",
Short: "Generates the Graph",
Long: "Generates the Graph from TFState or HCL",
Example: "inframap generate --tfstate state.json",
Example: "inframap generate --tfstate state.tfstate",
Args: cobra.MaximumNArgs(1),
PreRunE: preRunFile,
RunE: func(cmd *cobra.Command, args []string) error {
Expand Down
2 changes: 1 addition & 1 deletion cmd/prune.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ var (
Use: "prune [FILE]",
Short: "Prunes the file",
Long: "Prunes the TFState or HCL file",
Example: "inframap prune --tfstate state.json",
Example: "inframap prune --tfstate state.tfstate",
Args: cobra.MaximumNArgs(1),
PreRunE: preRunFile,
RunE: func(cmd *cobra.Command, args []string) error {
Expand Down