AWS Summary Instructions

This guide will walk through the requirements and steps to successfully generate documentation using Documentation as a Service.

Pre-Requesites

  • AWS CLI v2 https://awscli.amazonaws.com/AWSCLIV2.msi
  • Powershell version 5.1 or better
  • Internet Connectivity
  • Read access or higher to the AWS account
  • API access using an AWS Access and Secret Keys

Downloading the latest Gather Script

  • Open a Browser and navigate to https://DocumentationAsCode.com
  • Log in with your Softchoice account
  • On the services dashboard, under Documentation as Code, select AWS
  • Click the link to download the latest version of the gather script, it will be a zip folder
  • Open your downloads folder and extract the file in the Get-AWS.zip to a new folder on your C: drive
    • Make sure to save the gather script somewhere you can find it later on your computer

Running the gather script

  1. Browse to where you saved the gather script
  2. Right-click on the file and select "Run with Powershell", If you don't have this prompt, open the file with PowerShell ISE and run the script
    • If you get a security warning, click open. Optionally, you can uncheck the "Always ask before opening this file" box to ignore this warning in the future
  3. Accept execution policy for the script.
  4. A GUI window should open to help you go through the process of gathering data. Make sure the GUI page is not oppening under the rest of your windows.
  5. On the first page it will provide the option to download AWS CLI v2. This installation is required, if you don't have this installed already, click on the download button, the gui will get closed and the file will be downloaded for you. Install the AWS CLI v2 and reboot your computer. You can also download and install it from the link mentioned above.
  6. If you just finished installing AWS CLI v2 you need to go through steps of 1 to 4 again.
  7. Now that you have AWS CLI v2 press the "Next" button. A new page will appearing asking you for your Token keys and Account ID, enter them and press "Set Profile" button. An AWS profile will be set on your computer and a new page will appear for you to select regions, if you input incorrect or invalid credentials an empty page will appear saying "No Account Selected", you should close the script and double check your credentials.
  8. Select the regions that you want to gather data for and click on "GO" button to run the script.
  9. After a while an explorer window should open including the json with the results of your gather script. You can upload this file to DAC to generate your documents.
    • If you do not see the window with your file, navigate to the folder where you saved the gather script or DAC folder under your "Documents" and locate the JSON file

Generating Documentation

  • Return to https://DocumentationAsCode.com
  • Login with your Softchoice account
  • On the services dashboard, under Documentation as Code, select AWS
  • Under Generate Reports:
    • Enter the customer's name
    • Enter your name
    • Choose the type of document(s) you want to generate. The options are:
      1. Word
      2. Visio
      3. Network Visio
      4. Diagram.io
    • Click the "Browse" button and navigate to the JSON file that the script created. It will be in the same folder as the gather script unless you moved it somewhere else
  • Click Generate Document
  • You'll see a notification that the file has been uploaded and will be delivered shortly
  • Check your email for the documentation, coming from dac@softchoice.com
    • Note: Check your Other or Junk folders if you do not recieve your document within 5 minutes
  • Click the Download Document button in the email to download your documentation

Common Errors/Issues

  • If you get aws is not recognized as the name of a cmdlet, reboot as AWS CLI didn't update your paths to the executable
  • If you want to install the required modules, open PowerShell as an Administrator and run "Install-Module -Name AWSPowerShell.NetCore -Force", then select "Yes to All [A]"
  • If you get a zero byte JSON file, check that you entered the correct region where AWS Security Hub is running or that you didn't make an error on entry

Diagram.io (Diagrams.net) document release notes

release 0.1.0

  • Draws network diagram. Below resources supported
    • VPCs
    • VPC peers
    • Subnets
    • VPN Gateways
    • VPN Customer Gateways
    • VPN Connections