aws_security_viz 0.2.2.pre.alpha.pre.393 → 0.2.2.pre.alpha.pre.400

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ea98a6c4cbfc3b7522b259b891a028e4da4dc58130c95b38ed3a88bb3c4e09c
-  data.tar.gz: f42bb25db27bf6f622db3303f57a8ea9bbb78fa01a43172cdf6ee3cbef8e8103
+  metadata.gz: bf64ee3c9a38791796b296adce6cc20a5bda9e94e6da4ebe285bd714008002c5
+  data.tar.gz: 14f319691b028142394865d573cac232115b02a3677a3cae33b6d9a557fc5d60
 SHA512:
-  metadata.gz: ee40154da3d080ccb2343762e6e4235b3017c890f41c31ffdcbf065325c763f540f96ba9520fe4160129c4c3f58cd7f40b677f4b1e201973a87b65fc305f812e
-  data.tar.gz: cae971a0c09e384d2fad7eb278033e88e12a1f68f5c1a66b7dc1f804b46017dcc3f451b53ae9b6ffa326b7e05c0645ff753b5c182c44ef1e78cdcc17876e3161
+  metadata.gz: c0358c805821acdb6e9ff0b4ffb616d72909bf28f17ed64a3afb82f0ce990e3e594ff482fa8598bd6ec8e048bf6c0df2d5323a625e447350510d8f6cd2aeb95f
+  data.tar.gz: 67e02863e58e68f575f5fe1158f8f20d6e6cde7b96f859e8d2fb0b1e3eb9b507573a0fa4bf0871ccda8a24c8821f369e3b221c25506ead8db550b85f6bd78a6f

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.393
+  version: 0.2.2.pre.alpha.pre.400
 platform: ruby
 authors:
 - Anay Nayak
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-26 00:00:00.000000000 Z
+date: 2020-08-16 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"