aws_security_viz 0.2.2.pre.alpha.pre.397 → 0.2.2.pre.alpha.pre.402

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a01dc1014a5930cf9443e21dbb4e73779bcbe4b37b43d4db17f9af236617e947
-  data.tar.gz: 8927b542e228bb8edd72bf67ba10c9b4cdbd008f6ba8a3fbdabd3a7cc07bb308
+  metadata.gz: 5a88234a7497023f017c54ccdebc08e5c9fd48f973f12c2140a6923232faa9a0
+  data.tar.gz: 2a00630ffda46e661175b72d479fafed719df5e12a160800313cce6c83a51873
 SHA512:
-  metadata.gz: 034e4a0f9a6ccef0960e11a490d4aba686037d7cfb590023beeb459638ba7bdadd2974f66cbacee472ce5543df7cb3cc5cb9f6b19fd6ea8d73741d63fdf0318c
-  data.tar.gz: 6ff0105ece63da177484e2c62632b55eccf3aa8d33f7ee68e7598c41d67d93940decb60c2c8b040760afbe5da18610e7d41460b589ba82ce81985a1a7dca7982
+  metadata.gz: 2ae1a758cba72164610b22c9c9f1fe571ce9e753c55a6337a2a2b51f671b318efd9fb12c1b08c3bf7f1d498d6346fa98b0de059655d71fb5332c81d9add95204
+  data.tar.gz: 6d7ec7c4a2f0d5880ec48d2e3a4c25e8169bd5b6b9aaf73253a808525e458ae44957c794dc1c129404a4b908c7362cdcb77bc4ceece2a84e3679171adbbfa61b

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.402
 platform: ruby
 authors:
 - Anay Nayak
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-04 00:00:00.000000000 Z
+date: 2020-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler