cli-terraform

README

Akamai CLI for Akamai Terraform Provider

An Akamai CLI package for administering and managing Akamai Terraform configurations

Getting Started

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.8 or later, and the Dep package manager installed:

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. Install dependencies using dep:
   dep ensure
4. 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 [--edgerc] [--section] <command> [sub-command]

Description:
   Manage Akamai Terraform configurations and assoc objects. Current support includes Akamai GTM domains and EdgeDNS zones.

Built-In Commands:
  create-domain
  list
  help

GTM Domains

Usage

   akamai-terraform create-domain [domain] [--tfworkpath] [--resources] [--createconfig] 

Flags: 
   --tfworkpath value      file path location for placement of created and/or modified artifacts. Default: current directory
   --resources             Create json formatted resource import list file, <domain>_resources.json. Used as input by createconfig.
   --createconfig          Create Terraform configuration (<domain>.tf), gtmvars.tf, and import command script (<domain>_import.script) files using resources json

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

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

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

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

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.

Edgegrid Zones

Usage

   akamai-terraform create-zone [zone] [--tfworkpath] [--resources] [--createconfig] [--importscript] [--segmentconfig] [--configonly] [--namesonly] [--recordname]

Flags: 
   --tfworkpath value      file path location for placement of created and/or modified artifacts. Default: current directory
   --resources             Create json formatted resource import list file, <zone>_resources.json. Used as input by createconfig.
   --createconfig          Create Terraform configuration (<zone>.tf), dnsvars.tf from generated resources file. Saves zone config for import.
   --importscript          Create import script for generated Terraform configuration script (<zone>_import.script) files
   --segmentconfig         Directive for createconfig. Group and segment records by name into separate config files.
   --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.
   --namesonly             Directive for both resource gathering and config generation. All record set types assumed.
   --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 testprimaryzone.com --resources

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

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

Generate Zone import script, _resource_import.script

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

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. Generate zone configuration directly without json itemization. Scope limited by additional specified flags.

License

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

Documentation

Overview

Copyright 2019. Akamai Technologies, Inc

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2019. Akamai Technologies, Inc

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.