aws_security_viz 0.2.2.pre.alpha.pre.397 → 0.2.2.pre.alpha.pre.398

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a01dc1014a5930cf9443e21dbb4e73779bcbe4b37b43d4db17f9af236617e947
-  data.tar.gz: 8927b542e228bb8edd72bf67ba10c9b4cdbd008f6ba8a3fbdabd3a7cc07bb308
+  metadata.gz: d74773df36cb3a6a3d2045bdedef77da3753874f7c7d328b052aba0d71338ac0
+  data.tar.gz: 709d4284ebcf564618652cb6734dca4c7a3adbbb5d1447caf6ccfbd2c8e1feb6
 SHA512:
-  metadata.gz: 034e4a0f9a6ccef0960e11a490d4aba686037d7cfb590023beeb459638ba7bdadd2974f66cbacee472ce5543df7cb3cc5cb9f6b19fd6ea8d73741d63fdf0318c
-  data.tar.gz: 6ff0105ece63da177484e2c62632b55eccf3aa8d33f7ee68e7598c41d67d93940decb60c2c8b040760afbe5da18610e7d41460b589ba82ce81985a1a7dca7982
+  metadata.gz: e7ce40fdddee3e97d3e7bb620e66273735cf73f712f349f21c547beb4441e2a02c8ba8a672662485d3d752d9ec63e66994ca71a0cfce5bd544fe4f6dccfe31d0
+  data.tar.gz: 376fefd96b96ad75998a5815555524626b5b953d9dba3c84896e023a35ed576ccc6f6edb7efb42db999eac8d13142fa0890524136a42d9ace0e0dd3a9df030a1

data/README.md

@@ -51,16 +51,32 @@ To generate a web view
 
 ## DOCKER USAGE
 
-
-## Cleanup + add Docker from off the shelf image
 If you don't want to install the dependencies and ruby libs you can execute aws-security-viz inside a docker container. To do so, follow these steps:
 
 1. Clone this repository, open it in a console.
 2. Build the docker container: `docker build -t sec-viz .`
-3. Run the container: `docker run -i --rm -t -p 3000:3000 -v $(pwd)/aws-viz:/aws-security-viz  --name sec-viz sec-viz` (Description: `-i` interactive shell, `--rm` remove the container after usage, `-t` attach this terminal to it, `-p 3000:3000` we expose port 3000 for the HTTP server, `-v $(pwd)/aws-viz:aws-security-viz` mount tmp directory for generated artifacts, `-name sec-viz` the container will have the same name as the image we will start)
-4. Now you can use the tool as described in [usage](#USAGE). Make sure that you use the commands with `bundler exec ` as prefix. For example: `aws_security_viz -a your_aws_key -s your_aws_secret_key -f aws.json`.
-5. To start the web view, execute `ruby -run -e httpd -- -p 3000` in the container. You can open it with your local browser at `http://0.0.0.0:3000/`. There you can view the generated images and the graph. Use `Ctrl+C` to close the HTTP server.
-6. Terminate the docker container by typing `exit` in the console.
+
+3.a With aws-vault (Recommended):
+
+```aws-vault exec tldev -- docker run -i -e AWS_REGION -e AWS_ACCESS_KEY_ID -e AWS_SECRET_ACCESS_KEY -e AWS_SESSION_TOKEN -e AWS_SECURITY_TOKEN --rm -t -p 3000:3000 -v (pwd)/aws-viz:/aws-security-viz --name  sec-viz sec-viz /usr/local/bundle/bin/aws_security_viz --renderer navigator --serve 3000``` . 
+
+You can open it with your local browser at `http://localhost:3000/navigator.html#aws-security-viz.png`. 
+
+3.b With AWS credentials passed as parameters:
+
+```docker run -i --rm -t -p 3000:3000 -v (pwd)/aws-viz:/aws-security-viz --name  sec-viz sec-viz /usr/local/bundle/bin/aws_security_viz -a REPLACE_AWS_ACCESS_KEY_ID -s REPLACE_SECRET --renderer navigator --serve 3000```. 
+
+You can open it with your local browser at `http://localhost:3000/navigator.html#aws-security-viz.png`. 
+
+Parameters passed to the docker command:
+* `-v $(pwd)/aws-viz:aws-security-viz` local directory where output will be generated.
+* `-i` interactive shell
+* `--rm` remove the container after usage
+* `-t` attach this terminal to it
+* `-p 3000:3000` we expose port 3000 for the HTTP server
+* `-name sec-viz` the container will have the same name as the image we will start
+
+You can also use other parameters as specified in [usage](#USAGE)
 
 ### Help
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws_security_viz
 version: !ruby/object:Gem::Version
-  version: 0.2.2.pre.alpha.pre.397
+  version: 0.2.2.pre.alpha.pre.398
 platform: ruby
 authors:
 - Anay Nayak
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-04 00:00:00.000000000 Z
+date: 2020-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler