AWS Cost Optimization Instructions

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

Pre-Requesites

  • Cloudcheckr API access using an Access and Secret Keys with client roles Cloudcheckr API Access and User and Client Access Management
  • Powershell version 5.1 or better
  • Internet Connectivity

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 Cost Optimization
  • Click the link to "AWS Cost Optimization Gather Script" 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
    • You may have to right click the file and check the box to unblock it before it will run

Running the gather script

  • Browse to where you saved the gather script
  • 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
  • The script will prompt you for the following information Cloudcheckr Client ID Cloudcheckr Secret Key A pop up will ask if this is a multi-view account with a yes or no which will determine the data to be extracted Next you will receive a pop up to select the customer you want to collect data from
  • The original PowerShell window will use the above information to extract the required JSON from Cloudcheckr
    • Note: After it completes the export it will open a window to your file
  • If you do not see the window with your file, navigate to the folder where you saved the gather script 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
    • 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 an error that a bearer key couldn't be generated, make sure your API access keys are still active in the Cloudcheckr dashboard as they can expire