aws_security_viz 0.2.2.pre.alpha.pre.396 → 0.2.2.pre.alpha.pre.401

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e334a68086d626897da307bfc7937f9c94a1d8220ec33c562fbe786b0b8fe12
-  data.tar.gz: c02f058d73ecb932fabcb6f748dca345ba08bbc6d11f86a086a8db7809439478
+  metadata.gz: 8a751b8216004489aa2c4e395b5801a79f46c384085405a993877d5794c21264
+  data.tar.gz: 4a5eca2a0916f6a8b54e769988e20515fb3d825d1dc21c381266e99cc1ff3543
 SHA512:
-  metadata.gz: '09d4dd1276af55a5ebf7ec577dca054b1120be6f01acabda1295147045706c8a3349914fea6ad010126ffc927be5746426c2059b001b272e3f95b8fa0efcade4'
-  data.tar.gz: ed46228cc4997eb6c336223170897672f6474e591378492dcfb890a77e44aa89f2dab3a971cde8f5ceece5fb270d686b819bc0591113ea05cba15f1cb1205469
+  metadata.gz: 535f53f1e26cbe8518658d0b1f782fb685d664e5d7e509cdc3f8f3848150ca51c73665a48c968f79d673b44804a824cb057b05163499f8e6f72a6559cd51035d
+  data.tar.gz: 718cc4d01f161c86b3485dcad0e020df03b3ee308c8fd0d53d6a695bbcc9f523321acc96343bb56420892a7e930a1227034fcc0a2b56e77108d957b51d464313

data/.dockerignore

@@ -0,0 +1,7 @@
+.git
+.bundle
+*.svg
+*.dot
+*.png
+.DS_Store
+navigator.html

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.396
+  version: 0.2.2.pre.alpha.pre.401
 platform: ruby
 authors:
 - Anay Nayak
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-02 00:00:00.000000000 Z
+date: 2020-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -174,6 +174,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".dockerignore"
 - ".editorconfig"
 - ".gitignore"
 - ".travis.yml"