cli-terraform

README

Akamai CLI for Akamai Terraform Provider

An Akamai CLI package for administering and managing Akamai Terraform configurations

Getting Started

Creating authentication credentials

Before you can use this CLI, you need to Create authentication credentials.

Installing

To install this package, use Akamai CLI:

$ akamai install terraform

You may also use this as a stand-alone command by downloading the latest release binary for your system, or by cloning this repository and compiling it yourself.

Compiling from Source

If you want to compile it from source, you will need Go 1.12 or later:

1. Fetch the package:
   go get github.com/akamai/cli-terraform
2. Change to the package directory:
   cd $GOPATH/src/github.com/akamai/cli-terraform
3. Compile the binary:

• Linux/macOS/*nix: go build -o akamai-terraform
• Windows: go build -o akamai-terraform.exe

1. Move the binary (akamai-terraform or akamai-terraform.exe) in to your PATH

General Usage

  akamai terraform [global flags] command [command flags] [arguments...]

Description:
   Administer and manage available Akamai resources with Terraform

Built-In Commands:
  create-domain
  create-zone
  create-appsec
  create-property
  create-cloudlets-policy
  create-edgekv
  create-edgeworker
  create-iam
  create-imaging
  list
  help

Global Flags:
   --help                                   show help (default: false)
   --edgerc value, -e value                 Location of the credentials file (default: "/home/user/.edgerc") [$AKAMAI_EDGERC]
   --section value, -s value                Section of the credentials file (default: "default") [$AKAMAI_EDGERC_SECTION]
   --accountkey value, --account-key value  Account switch key [$AKAMAI_EDGERC_ACCOUNT_KEY]
   --version                                Output CLI version (default: false)

GTM Domains

Usage

   akamai terraform [global flags] create-domain [flags] <domain>

Flags:
   --tfworkpath path       Path location for placement of created and modified artifacts. Default: current directory
   --resources             Creates a JSON-formatted resource file for import: <domain>_resources.json. The createconfig flag uses this file as an input. (default: false)
   --createconfig          Creates these Terraform configuration files based on the values in <domain>_resources.json: <domain>.tf and gtmvars.tf. Also creates this import script: <domain>_import.script. (default: false)

Create list of all domain objects. Written in json format to _resources.json

$ akamai terraform create-domain --resources example.akadns.net

Generate Terraform GTM Domain configuration file .tf, vars config file, gtmvars.tf, and import script, _resource_import.script

$ akamai terraform create-domain --createconfig example.akadns.net

Domain Notes:

1. Mapping GTM entity names to TF resource names may require normalization. Invalid TF resource name characters will be replaced by underscores, '_' in config generation.

EdgeDNS Zones

Usage

   akamai terraform [global flags] create-zone [flags] <zone>

Flags: 
   --tfworkpath path       Path location for placement of created and modified artifacts. Default: current directory
   --resources             Creates a JSON-formatted resource file for import: <zone>_resources.json. The createconfig flag uses this file as an input. (default: false)
   --createconfig          Creates these Terraform configuration files based on the values in <zone>_resources.json: <zone>.tf and gtmvars.tf. (default: false)
   --importscript          Creates import script for generated Terraform configuration script (<zone>_import.script) files. (default: false)
   --segmentconfig         Use with the createconfig flag to group and segment records by name into separate config files. (default: false)
   --configonly            Directive for createconfig. Create entire Terraform zone and recordsets configuration (<zone>.tf), dnsvars.tf. Saves zone config for 
                           importscript. Ignores any existing resource JSON file. (default: false)
   --namesonly             Directive for both resource gathering and config generation. All record set types assumed. (default: false)
   --recordname value      Used in resources gathering or with configonly to filter recordsets. Multiple recordname flags may be specified.

Create List of Zone Recordsets. Written in json format to _resources.json

$ akamai terraform create-zone --resources testprimaryzone.com

Generate Terraform Zone configuration file. Default args create .tf, vars config file, dnsvars.tf

$ akamai terraform create-zone --createconfig testprimaryzone.com

Generate Zone import script, _resource_import.script

$ akamai terraform create-zone --importscript testprimaryzone.com

Zone Notes

1. The resources directive generates a _resources.json file for consumption by createconfig
2. The createconfig directive generates a _zoneconfig.json file for consumption by importscript

Advanced options for --resources

1. recordname - filters generated resources list by record name(s)
2. namesonly - Generates resource file with recordset names only. All associated Types will be represented.

Advanced options for --createconfig

1. namesonly - Resources for all associated Types will be generated
2. segmentconfig - Generate a modularized configuration.
3. configonly - Generates a zone configuration without JSON itemization. The configuration generated varies based on which set of flags you use.

Appsec

Usage

   akamai terraform [global flags] create-appsec [flags] <name_of_security_config>
   
Flags:
   --tfworkpath path      Path location for placement of created artifacts. Default: current directory

Property Manager Properties

Usage

   akamai terraform [global flags] create-property [flags] <property name>

Flags:
   --tfworkpath path      Path location for placement of created artifacts (default: current directory)
   --version value        Property version to import  (default: LATEST)

Create property manager property configuration.

$ akamai terraform create-property

Cloudlets

Usage

   akamai terraform [global flags] create-cloudlets-policy [flags] <policy_name>

Flags:
   --tfworkpath path      Path location for placement of created artifacts. Default: current directory

Create policy configuration.

$ akamai terraform create-cloudlets-policy

Edgeworkers

Create EdgeKV Usage

   akamai terraform [global flags] create-edgekv [flags] <namespace_name> <network>

Flags:
   --tfworkpath path      Path location for placement of created artifacts. Default: current directory

Create edgekv configuration.

$ akamai terraform create-edgekv

Create EdgeWorker Usage

   akamai terraform [global flags] create-edgeworker [flags] <edgeworker_id>

Flags:
   --bundlepath path      Path location for placement of EdgeWorkers tgz code bundle. Default: same value as tfworkpath
   --tfworkpath path      Path location for placement of created artifacts. Default: current directory

Create edgeworker configuration.

$ akamai terraform create-edgekv

Identity and Access Management

Create Identity and Access Management usage

   akamai terraform [global flags] create-iam [subcommand]

Subcommands:
    all                     Create all available Terraform Users, Groups and Roles
    group [group id]        Exports group by id with relevant users and their roles
    role [role id]          Exports role by id with relevant users and their groups
    user [user's email]     Exports user by email with relevant user's groups and roles

Flags:
   --tfworkpath path        Path location for placement of created artifacts. Default: current directory

Create Identity and Access Management configuration.

$ akamai terraform create-iam

Image and Video Manager

Create Image and Video policy usage

   akamai terraform [global flags] create-imaging [flags] <contract_id> <policy_set_id>

Flags:
   --tfworkpath path         Path location for placement of created artifacts. Default: current directory
   --policy-json-dir path    Path location for placement of policy jsons. Default: same value as tfworkpath

Create Image and Video policy configuration.

$ akamai terraform create-imaging

General Notes

1. Terraform variable configuration is generated in a separately named TF file for each Akamai entity type. These files will need to be merged by the Admin in the case where multiple entities are managed concurrently with the Terraform client.

License

This package is licensed under the Apache 2.0 License. See LICENSE for details.