8000 HTML output for large infrastructures and complex usecases · Issue #368 · snyk/driftctl · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

HTML output for large infrastructures and complex usecases #368

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

Closed
sundowndev opened this issue Mar 26, 2021 · 2 comments
Closed

HTML output for large infrastructures and complex usecases #368

sundowndev opened this issue Mar 26, 2021 · 2 comments
Assignees
Labels
kind/enhancement New feature or improvement priority/3
Milestone

Comments

@sundowndev
Copy link
Contributor
sundowndev commented Mar 26, 2021

TL;DR: create a new output to visualize scan result in a web page.

Motivation

We usually see users struggling with the output of the scan in their terminal because it's too large and contain too much information. I was thinking about a new output that allow the user to visualize the output in their browser. Exactly the same way common code coverage tools work, we could generate an HTML file that contain a minimal web UI to display the scan result in a more human-readable way. I think the graphical way of viewing the scan result would be a pretty handy feature, and it could make the user better understand what driftctl is capable of.

Example with go tool :

$ go tool cover -html=coverage.out

The coverage graphic will then look like this in the browser :

image

Examples

$ driftctl scan --output html://result.html

The generated web page would then contain a list of managed, unmanaged, deleted resources, as well as differences that may exist. Since the web page is intended to be minimal, we have to focus more on UX, less on UI.

Here's my first wireframe :

image

Implementation

I pretty familiar with Vuejs & Vuetify so I though about them in the first place. For example we can create a single file Vue app and use it to generate the output, without any Vue compilation. To achieve that we would embed the assets in the binary with the awesome Go 1.16 feature. But we could also create a HTML template from scratch with no UI framework at all. We still have to discuss about that together.

@sundowndev sundowndev added the kind/enhancement New feature or improvement label Mar 26, 2021
@eliecharra eliecharra added this to the v0.9.0 milestone Apr 6, 2021
@eliecharra eliecharra modified the milestones: v0.9.0, v0.8.0 Apr 16, 2021
@sundowndev sundowndev self-assigned this Apr 19, 2021
@eliecharra eliecharra modified the milestones: v0.8.0, v0.9.0 Apr 23, 2021
@sjourdan sjourdan modified the milestones: v0.10.0, v0.11.0 Jun 21, 2021
@sundowndev sundowndev assigned sjourdan and unassigned sundowndev Jun 22, 2021
@sundowndev
Copy link
Contributor Author

For the record, here are a few screenshots of the version that got approved :

image

image

image

@sjourdan
Copy link
Contributor

it's really cool! 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/enhancement New feature or improvement priority/3
Projects
None yet
Development

No branches or pull requests

3 participants
0