reserved_instance_coverage.pt

name "AWS Reserved Instances Coverage"
rs_pt_ver 20180301
type "policy"
short_description "Reports on AWS Reserved Instances coverage. See the [README](https://github.com/flexera-public/policy_templates/tree/master/cost/aws/reserved_instances/coverage) and [docs.flexera.com/flexera/EN/Automation](https://docs.flexera.com/flexera/EN/Automation/AutomationGS.htm) to learn more."
long_description ""
severity "low"
category "Cost"
default_frequency "weekly"
info(
  version: "3.0.0",
  provider: "AWS",
  service: "Compute",
  policy_set: "Reserved Instances"
)

###############################################################################
# Parameters
###############################################################################

parameter "param_email" do
  type "list"
  category "Policy Settings"
  label "Email Addresses"
  description "A list of email addresses to notify."
  default []
end

parameter "param_aws_account_number" do
  type "string"
  category "Policy Settings"
  label "Account Number"
  description "Leave blank; this is for automated use with Meta Policies. See README for more details."
  default ""
end

parameter "param_lookback" do
  type "number"
  category "Policy Settings"
  label "Look Back Period (Days)"
  description "Number of days in the past to assess AWS Reserved Instances coverage."
  min_value 7
  max_value 365
  default 7
end

###############################################################################
# Authentication
###############################################################################

credentials "auth_aws" do
  schemes "aws", "aws_sts"
  label "AWS"
  description "Select the AWS Credential from the list"
  tags "provider=aws"
  aws_account_number $param_aws_account_number
end

credentials "auth_flexera" do
  schemes "oauth2"
  label "Flexera"
  description "Select Flexera One OAuth2 credentials"
  tags "provider=flexera"
end

###############################################################################
# Datasources & Scripts
###############################################################################

# Get applied policy metadata for use later
datasource "ds_applied_policy" do
  request do
    auth $auth_flexera
    host rs_governance_host
    path join(["/api/governance/projects/", rs_project_id, "/applied_policies/", policy_id])
    header "Api-Version", "1.0"
  end
end

datasource "ds_reservations_coverage" do
  request do
    run_script $js_reservations_coverage, $param_lookback
  end
  result do
    encoding "json"
    field "total_coverage_hours_percentage", jmes_path(response, "Total.CoverageHours.CoverageHoursPercentage")
    field "total_on_demand_hours", jmes_path(response, "Total.CoverageHours.OnDemandHours")
    field "total_reserved_hours", jmes_path(response, "Total.CoverageHours.ReservedHours")
    field "total_running_hours", jmes_path(response, "Total.CoverageHours.TotalRunningHours")
  end
end

script "js_reservations_coverage", type: "javascript" do
  parameters "param_lookback"
  result "request"
  code <<-EOS
  end_date = new Date().toISOString().split('T')[0]

  start_date = new Date()
  start_date.setDate(start_date.getDate() - param_lookback)
  start_date = start_date.toISOString().split('T')[0]

  var request = {
    auth: "auth_aws",
    verb: "POST",
    host: "ce.us-east-1.amazonaws.com",
    path: "/",
    headers: {
      "X-Amz-Target": "AWSInsightsIndexService.GetReservationCoverage",
      "Content-Type": "application/x-amz-json-1.1",
    },
    body_fields: { "TimePeriod": { "Start": start_date, "End": end_date } }
  }
EOS
end

datasource "ds_coverage_report" do
  run_script $js_coverage_report, $ds_reservations_coverage, $ds_applied_policy, $param_lookback
end

script "js_coverage_report", type: "javascript" do
  parameters "ds_reservations_coverage", "ds_applied_policy", "param_lookback"
  result "result"
  code <<-EOS
  end_date = new Date().toISOString().split('T')[0]

  start_date = new Date()
  start_date.setDate(start_date.getDate() - param_lookback)
  start_date = start_date.toISOString().split('T')[0]

  result = [{
    total_coverage_hours_percentage: ds_reservations_coverage['total_coverage_hours_percentage'],
    total_on_demand_hours: ds_reservations_coverage['total_on_demand_hours'],
    total_reserved_hours: ds_reservations_coverage['total_reserved_hours'],
    total_running_hours: ds_reservations_coverage['total_running_hours'],
    start_date: start_date,
    end_date: end_date,
    policy_name: ds_applied_policy['name'],
    lookback_period: param_lookback
  }]
EOS
end

###############################################################################
# Policy
###############################################################################

policy "pol_coverage_report" do
  validate_each $ds_coverage_report do
    summary_template "{{ with index data 0 }}{{ .policy_name }}{{ end }}"
    detail_template <<-EOS
# AWS Reserved Instances Coverage Report
## Date Range: {{ with index data 0 }}{{ .start_date }}{{ end }} -> {{ with index data 0 }}{{ .end_date }}{{ end }}

**Coverage:** {{ with index data 0 }}{{ .total_coverage_hours_percentage }}{{ end }}%\n
**On Demand Hours:** {{ with index data 0 }}{{ .total_on_demand_hours }}{{ end }}\n
**Reserved Hours:** {{ with index data 0 }}{{ .total_reserved_hours }}{{ end }}\n
**Total Running Hours:** {{ with index data 0 }}{{ .total_running_hours }}{{ end }}\n
EOS
    check eq(0, 1)
    escalate $esc_email
    export do
      resource_level false
      field "total_coverage_hours_percentage" do
        label "Coverage (%)"
      end
      field "total_on_demand_hours" do
        label "On Demand Hours"
      end
      field "total_reserved_hours" do
        label "Reserved Hours"
      end
      field "total_running_hours" do
        label "Total Running Hours"
      end
      field "start_date" do
        label "Start Date"
      end
      field "end_date" do
        label "End Date"
      end
    end
  end
end

###############################################################################
# Escalations
###############################################################################

escalation "esc_email" do
  automatic true
  label "Send Email"
  description "Send incident email"
  email $param_email
end