Before you can use this CLI, you need to Create authentication credentials.
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.
If you want to compile it from the source, you need Go 1.21 or later:
- Create a clone of the target repository:
git clone https://github.com/akamai/cli-terraform.git
- Change to the package directory and compile the binary:
- Linux/macOS/*nix:
go build -o akamai-terraform
- Windows:
go build -o akamai-terraform.exe
- Linux/macOS/*nix:
Usage:
akamai terraform [global flags] command [command flags] [arguments...]
Description:
Export selected resources for faster adoption in Terraform.
Commands:
export-domain (alias: create-domain)
export-zone (alias: create-zone)
export-appsec (alias: create-appsec)
export-clientlist
export-property (alias: create-property)
export-property-include
export-cloudwrapper
export-cloudlets-policy (alias: create-cloudlets-policy)
export-edgekv (alias: create-edgekv)
export-edgeworker (alias: create-edgeworker)
export-iam (alias: create-iam)
export-imaging (alias: create-imaging)
export-cps (alias: create-cps)
export-cloudaccess
list
help
Global Flags:
--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]
--help show help (default: false)
--version Output CLI version (default: false)
akamai terraform [global flags] export-domain [flags] <domain>
Flags:
--tfworkpath path Directory used to store files created when running commands. (default: current directory)
$ akamai terraform export-domain example.akadns.net
Mapping GTM entity names to TF resource names may require normalization. Invalid TF resource name characters are replaced by underscores, '_' in config generation.
akamai terraform [global flags] export-zone [flags] <zone>
Flags:
--tfworkpath path Directory used to store files created when running commands. (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 dnsvars.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.
The command creates a <zone>_resources.json
file.
$ akamai terraform export-zone --resources testprimaryzone.com
Default arguments create these files: <zone>.tf
, <zone>_zoneconfig.json
, and dnsvars.tf
.
$ akamai terraform export-zone --createconfig testprimaryzone.com
The command creates a <zone>_resource_import.script
file.
$ akamai terraform export-zone --importscript testprimaryzone.com
- The resources directive generates a
<zone>_resources.json
file for consumption bycreateconfig
. - The
createconfig
directive generates a<zone>_zoneconfig.json
file for consumption byimportscript
.
recordname
. Filters the generated resources list by a record name or record names.namesonly
. Generates a resource file with record set names only. All associated Types are represented.
namesonly
. Generates resources for all associated Types.segmentconfig
. Generates a modularized configuration.configonly
. Generates a zone configuration without the JSON itemization. The configuration generated varies based on which set of flags you use.
akamai terraform [global flags] export-appsec [flags] <name_of_security_config>
Flags:
--tfworkpath path Directory used to store files created when running commands. (default: current directory)
Certain export conditions require the use of a particular property rule format. Verify whether your rule format matches the use case requirement and update your rule format as needed.
Export condition | Output | Rule format |
---|---|---|
General | Your declarative property configuration and its JSON-formatted rules. | Any supported format. |
Addition of the --rules-as-hcl flag |
Your declarative property configuration and HCL-formatted rules. Does not return includes as includes are JSON-formatted. | Must be a dated rule format ≥ v2023-01-05 . Cannot use latest . |
Addition of the include subcommand |
Your property configuration and its JSON-formatted rules and includes. | Any supported format, but your rules and includes must use the same rule format version. |
akamai terraform [global flags] export-property [subcommand] [flags] <property name>
Subcommand:
include <contract_id> <include_name> Generates Terraform configuration for Include resources. Deprecated, use `export-property-include` instead.
Flags:
--tfworkpath path Directory used to store files created when running commands. (default: current directory)
--version value Property version to import (default: LATEST)
--with-includes Referenced includes will also be exported along with property. Deprecated.
--rules-as-hcl Rules will be exported as `akamai_property_rules_builder` data source in HCL format.
--akamai-property-bootstrap Referenced property will be exported using combination of `akamai-property-bootstrap` and `akamai-property` resources (default: false)
The
rules-as-hcl
flag works now with theinclude
subcommand and thewith-includes
flag.
$ akamai terraform export-property
Certain export conditions require the use of a particular property rule format. Verify your rule format matches the use case requirement and update your rule format as needed.
Export condition | Output | Rule format |
---|---|---|
General | Your declarative include configuration and its JSON-formatted rules. | Any supported format. |
Addition of the --rules-as-hcl flag |
Your declarative include configuration and HCL-formatted rules. Does not return includes as includes are JSON-formatted. | Must be a dated rule format ≥ v2023-01-05 . Cannot use latest . |
akamai terraform [global flags] export-property-include [flags] <contract_id> <include_name>
Flags:
--tfworkpath path Directory used to store files created when running commands. (default: current directory)
--rules-as-hcl Rules will be exported as `akamai_property_rules_builder` data source in HCL format.
$ akamai terraform export-property-include
akamai terraform [global flags] export-cloudlets-policy [flags] <policy_name>
Flags:
--tfworkpath path Directory used to store files created when running commands. (default: current directory)
$ akamai terraform export-cloudlets-policy
akamai terraform [global flags] export-cloudwrapper [flags] <configuration_id>
Flags:
--tfworkpath path Directory used to store files created when running commands. (default: current directory)
$ akamai terraform export-cloudwrapper
akamai terraform [global flags] export-edgekv [flags] <namespace_name> <network>
Flags:
--tfworkpath path Directory used to store files created when running commands. (default: current directory)
$ akamai terraform [global flags] export-edgekv [flags] <namespace_name> <network>
akamai terraform [global flags] export-edgeworker [flags] <edgeworker_id>
Flags:
--bundlepath path Path location for placement of EdgeWorkers tgz code bundle. Default: same value as tfworkpath
--tfworkpath path Directory used to store files created when running commands. (default: current directory)
$ akamai terraform [global flags] export-edgeworker [flags] <edgeworker_id>
akamai terraform [global flags] export-iam [subcommand]
Subcommands:
all Exports all available Terraform Users, Groups, Roles, IP Allowlist and CIDR block resources
allowlist Exports Terraform IP Allowlist and CIDR block resources
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 Directory used to store files created when running commands. (default: current directory)
$ akamai terraform export-iam
akamai terraform [global flags] export-imaging [flags] <contract_id> <policy_set_id>
Flags:
--tfworkpath path Directory used to store files created when running commands. (default: current directory)
--policy-json-dir path Path location for placement of policy jsons. Default: same value as tfworkpath
--policy-as-hcl Generate content of the policy using HCL instead of JSON file (default: false)
$ akamai terraform export-imaging
akamai terraform [global flags] export-cps [flags] <enrollment_id> <contract_id>
Flags:
--tfworkpath path Directory used to store files created when running commands. (default: current directory)
$ akamai terraform export-cps
akamai terraform [global flags] export-clientlist [flags] <list_id>
Flags:
--tfworkpath path Directory used to store files created when running commands. (default: current directory)
akamai terraform [global flags] export-cloudaccess [flags] <cloud_access_key_uid>
Flags:
--tfworkpath path Directory used to store files created when running commands. (default: current directory)
--group_id The unique identifier for the group (without the `grp_` prefix) assigned to the access key.
--contract_id The unique identifier for the contract (without the `ctr_` prefix) assigned to the access key.
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.
Copyright 2024 Akamai Technologies, Inc. All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use these files 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.