To install the AWS provider, create a YAML file (called provider.yml in this example) with the specification of the provider:

# AWS Telemetry Provider
name: AWSProvider
description: Imports price metrics from AWS.
dockerImage: 485790562880.dkr.ecr.us-east-2.amazonaws.com/akamas/telemetry-providers/aws-provider:3.2.0

Then you can install the provider with the Akamas CLI:

akamas install telemetry-provider provider.yaml

The installed provider is shared with all users of your Akamas installation and can monitor many different systems, by configuring appropriate telemetry provider instances.

The AWS provider collects price metrics for Amazon Elastic Compute Cloud (EC2) from Amazon’s own APIs.

This provider imports just one metricaws_ec2_price which is available in the EC2 component type of the AWS Optimization pack.

Prerequisites

This section provides the minimum requirements that you should match before using the AWS telemetry provider.

AWS users and policy requirements

• An IAM user who has been granted the AWSPriceListServiceFullAccess policy, that is the following permissions:

  • DescribeServices

  • GetAttributeValues

  • GetProducts

You may find more information on AWS cost permissions here.

Akamas supported version

• Versions >= 2.0.0 are compatible with Akamas from version 1.9.0

Supported component types

• EC2

Components configuration

In order to gather price information about a component you’re required to input an extra field in its definition:

• region, which tells the provider the AWS region of the modeled instance

Please note this field is mandatory and must be specified as follows:

# Specification for a component, whose metrics should be collected by the AWS Provider
name: aws_1 # name of the component
description: aws_1 instance to tune # description of the component
properties:
    ec2:
        region: us-east-1 # AWS region of the component

Here is a complete list of AWS region names, together with their Akamas-compatible codes:

To create an instance of the CSV provider, build a YAML file (instance.yml in this example) with the definition of the instance:

# AWS Telemetry Instance
provider: AWS
config:
  accessKeyId: access_key_id
  secretAccessKey: secret_access_key

Then you can create the instance for the aws-system using the Akamas CLI:

akamas create telemetry-instance instance.yml aws-system

Configuration options

When you create an instance of the AWS provider, you should specify some configuration information to allow the provider to correctly extract and process metrics from your CSV files.

You can specify configuration information within the config part of the YAML of the instance definition.

Required properties

• accessKeyId - the access key id of your chosen IAM use

• secretAccessKey - the secret access key of your chosen IAM user

Telemetry instance reference

The following represents the complete configuration reference for the telemetry provider instance.

provider: AWS                                # This is an instance of the AWS provider
config:
  accessKeyId: access_key_id                 # The access key id of your IAM user
  secretAccessKey: secret_access_key         # The secret access key of your IAM user

Then you can create the instance for the aws-system using the Akamas CLI:

akamas create telemetry-instance instance.yml aws-system

Configuration options

When you create an instance of the AWS provider, you should specify some configuration information to allow the provider to correctly extract and process metrics from your CSV files.

You can specify configuration information within the config part of the YAML of the instance definition.

Required properties

• accessKeyId - the access key id of your chosen IAM use

• secretAccessKey - the secret access key of your chosen IAM user

Telemetry instance reference

The following YAML file represents a template to define the telemetry provider instance.

provider: AWS                                # This is an instance of the AWS provider
config:
  accessKeyId: access_key_id                 # The access key id of your IAM user
  secretAccessKey: secret_access_key         # The secret access key of your IAM user

The following table describes the configuration reference for the config section