New module: Terraform (#31214)
* First pass at Terraform module * Support output variables * Support idempotent plan checks and external plan files * Add check mode support * Support custom statefile location & remove color-coding from shell output * Docs * Let missing statefile hard-fail * Update to support present/planned/absent states * PEP8 * Add docs & fix python 2.6 incompatibility * PEP8 * PEP8
This commit is contained in:
Ryan Brown
GitHub
parent
1f2c276481
commit
9233520b31
1 changed files with 285 additions and 0 deletions
285
lib/ansible/modules/cloud/misc/terraform.py
Normal file
285
lib/ansible/modules/cloud/misc/terraform.py
Normal file
|
|
@ -0,0 +1,285 @@
|
|||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# (c) 2017, Ryan Scott Brown <ryansb@redhat.com>
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
|
||||
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
||||
'status': ['preview'],
|
||||
'supported_by': 'community'}
|
||||
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: terraform
|
||||
short_description: Manages a Terraform deployment (and plans)
|
||||
description:
|
||||
- Provides support for deploying resources with Terraform and pulling
|
||||
resource information back into Ansible.
|
||||
version_added: "2.5"
|
||||
options:
|
||||
state:
|
||||
choices: ['planned', 'present', 'absent']
|
||||
description:
|
||||
- Goal state of given stage/project
|
||||
required: false
|
||||
default: present
|
||||
binary_path:
|
||||
description:
|
||||
- The path of a terraform binary to use, relative to the 'service_path'
|
||||
unless you supply an absolute path.
|
||||
required: false
|
||||
project_path:
|
||||
description:
|
||||
- The path to the root of the Terraform directory with the
|
||||
vars.tf/main.tf/etc to use.
|
||||
required: true
|
||||
plan_file:
|
||||
description:
|
||||
- The path to an existing Terraform plan file to apply. If this is not
|
||||
specified, Ansible will build a new TF plan and execute it.
|
||||
required: false
|
||||
state_file:
|
||||
description:
|
||||
- The path to an existing Terraform state file to use when building plan.
|
||||
If this is not specified, the default `terraform.tfstate` will be used.
|
||||
- This option is ignored when plan is specified.
|
||||
required: false
|
||||
variables_file:
|
||||
description:
|
||||
- The path to a variables file for Terraform to fill into the TF
|
||||
configurations.
|
||||
required: false
|
||||
variables:
|
||||
description:
|
||||
- A group of key-values to override template variables or those in
|
||||
variables files.
|
||||
required: false
|
||||
targets:
|
||||
description:
|
||||
- A list of specific resources to target in this plan/application. The
|
||||
resources selected here will also auto-include any dependencies.
|
||||
required: false
|
||||
lock:
|
||||
description:
|
||||
- Enable statefile locking, if you use a service that accepts locks (such
|
||||
as S3+DynamoDB) to store your statefile.
|
||||
required: false
|
||||
lock_timeout:
|
||||
description:
|
||||
- How long to maintain the lock on the statefile, if you use a service
|
||||
that accepts locks (such as S3+DynamoDB).
|
||||
required: false
|
||||
force_init:
|
||||
description:
|
||||
- To avoid duplicating infra, if a state file can't be found this will
|
||||
force a `terraform init`. Generally, this should be turned off unless
|
||||
you intend to provision an entirely new Terraform deployment.
|
||||
required: false
|
||||
default: false
|
||||
notes:
|
||||
- To just run a `terraform plan`, use check mode.
|
||||
requirements: [ "terraform" ]
|
||||
author: "Ryan Scott Brown @ryansb"
|
||||
'''
|
||||
|
||||
EXAMPLES = """
|
||||
# Basic deploy of a service
|
||||
- terraform:
|
||||
project_path: '{{ project_dir }}'
|
||||
state: present
|
||||
"""
|
||||
|
||||
RETURN = """
|
||||
outputs:
|
||||
type: complex
|
||||
description: A dictionary of all the TF outputs by their assigned name. Use `.outputs.MyOutputName.value` to access the value.
|
||||
returned: on success
|
||||
sample: '{"bukkit_arn": {"sensitive": false, "type": "string", "value": "arn:aws:s3:::tf-test-bukkit"}'
|
||||
contains:
|
||||
sensitive:
|
||||
type: bool
|
||||
returned: always
|
||||
description: Whether Terraform has marked this value as sensitive
|
||||
type:
|
||||
type: string
|
||||
returned: always
|
||||
description: The type of the value (string, int, etc)
|
||||
value:
|
||||
returned: always
|
||||
description: The value of the output as interpolated by Terraform
|
||||
stdout:
|
||||
type: string
|
||||
description: Full `terraform` command stdout, in case you want to display it or examine the event log
|
||||
returned: always
|
||||
sample: ''
|
||||
command:
|
||||
type: string
|
||||
description: Full `terraform` command built by this module, in case you want to re-run the command outside the module or debug a problem.
|
||||
returned: always
|
||||
sample: terraform apply ...
|
||||
"""
|
||||
|
||||
import os
|
||||
import json
|
||||
import tempfile
|
||||
import traceback
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
|
||||
DESTROY_ARGS = ('destroy', '-no-color', '-force')
|
||||
APPLY_ARGS = ('apply', '-no-color', '-auto-approve=true')
|
||||
module = None
|
||||
|
||||
|
||||
def preflight_validation(bin_path, project_path, variables_file=None, plan_file=None):
|
||||
if not os.path.exists(bin_path):
|
||||
module.fail_json(msg="Path for Terraform binary '{0}' doesn't exist on this host - check the path and try again please.".format(project_path))
|
||||
if not os.path.isdir(project_path):
|
||||
module.fail_json(msg="Path for Terraform project '{0}' doesn't exist on this host - check the path and try again please.".format(project_path))
|
||||
|
||||
rc, out, err = module.run_command([bin_path, 'validate'], cwd=project_path)
|
||||
if rc != 0:
|
||||
module.fail_json(msg="Failed to validate Terraform configuration files:\r\n{0}".format(err))
|
||||
|
||||
|
||||
def _state_args(state_file):
|
||||
if state_file and os.path.exists(state_file):
|
||||
return ['-state', state_file]
|
||||
if state_file and not os.path.exists(state_file):
|
||||
module.fail_json(msg='Could not find state_file "{0}", check the path and try again.'.format(state_file))
|
||||
return []
|
||||
|
||||
|
||||
def build_plan(bin_path, project_path, variables_args, state_file, plan_path=None):
|
||||
if plan_path is None:
|
||||
f, plan_path = tempfile.mkstemp(suffix='.tfplan')
|
||||
|
||||
command = [bin_path, 'plan', '-no-color', '-detailed-exitcode', '-out', plan_path]
|
||||
command.extend(_state_args(state_file))
|
||||
|
||||
rc, out, err = module.run_command(command + variables_args, cwd=project_path)
|
||||
|
||||
if rc == 0:
|
||||
# no changes
|
||||
return plan_path, False
|
||||
elif rc == 1:
|
||||
# failure to plan
|
||||
module.fail_json(msg='Terraform plan could not be created\r\nSTDOUT: {0}\r\n\r\nSTDERR: {1}'.format(out, err))
|
||||
elif rc == 2:
|
||||
# changes, but successful
|
||||
return plan_path, True
|
||||
|
||||
module.fail_json(msg='Terraform plan failed with unexpected exit code {0}. \r\nSTDOUT: {1}\r\n\r\nSTDERR: {2}'.format(rc, out, err))
|
||||
|
||||
|
||||
def main():
|
||||
global module
|
||||
module = AnsibleModule(
|
||||
argument_spec=dict(
|
||||
project_path=dict(required=True, type='path'),
|
||||
binary_path=dict(type='path'),
|
||||
state=dict(default='present', choices=['present', 'absent', 'planned']),
|
||||
variables=dict(type='dict'),
|
||||
variables_file=dict(type='path'),
|
||||
plan_file=dict(type='path'),
|
||||
state_file=dict(type='path'),
|
||||
targets=dict(type='list', default=[]),
|
||||
lock=dict(type='bool', default=True),
|
||||
lock_timeout=dict(type='int',),
|
||||
),
|
||||
required_if=[('state', 'planned', ['plan_file'])],
|
||||
supports_check_mode=True,
|
||||
)
|
||||
|
||||
project_path = module.params.get('project_path')
|
||||
bin_path = module.params.get('binary_path')
|
||||
state = module.params.get('state')
|
||||
variables = module.params.get('variables') or {}
|
||||
variables_file = module.params.get('variables_file')
|
||||
plan_file = module.params.get('plan_file')
|
||||
state_file = module.params.get('state_file')
|
||||
|
||||
if bin_path is not None:
|
||||
command = [bin_path]
|
||||
else:
|
||||
command = [module.get_bin_path('terraform')]
|
||||
|
||||
preflight_validation(command[0], project_path)
|
||||
|
||||
if state == 'present':
|
||||
command.extend(APPLY_ARGS)
|
||||
elif state == 'absent':
|
||||
command.extend(DESTROY_ARGS)
|
||||
|
||||
if module.params.get('lock') is not None:
|
||||
if module.params.get('lock'):
|
||||
command.append('-lock=true')
|
||||
else:
|
||||
command.append('-lock=true')
|
||||
if module.params.get('lock_timeout') is not None:
|
||||
command.append('-lock-timeout=%ds' % module.params.get('lock_timeout'))
|
||||
|
||||
variables_args = []
|
||||
for k, v in variables.items():
|
||||
variables_args.extend([
|
||||
'-var',
|
||||
'{0}={1}'.format(k, v)
|
||||
])
|
||||
if variables_file:
|
||||
variables_args.append('-var-file', variables_file)
|
||||
|
||||
for t in (module.params.get('targets') or []):
|
||||
command.extend(['-target', t])
|
||||
|
||||
# we aren't sure if this plan will result in changes, so assume yes
|
||||
needs_application, changed = True, True
|
||||
|
||||
if state == 'planned':
|
||||
plan_file, needs_application = build_plan(command[0], project_path, variables_args, state_file)
|
||||
if state == 'absent':
|
||||
# deleting cannot use a statefile
|
||||
needs_application = True
|
||||
elif plan_file and os.path.exists(plan_file):
|
||||
command.append(plan_file)
|
||||
elif plan_file and not os.path.exists(plan_file):
|
||||
module.fail_json(msg='Could not find plan_file "{0}", check the path and try again.'.format(plan_file))
|
||||
else:
|
||||
plan_file, needs_application = build_plan(command[0], project_path, variables_args, state_file)
|
||||
command.append(plan_file)
|
||||
|
||||
if needs_application and not module.check_mode and not state == 'planned':
|
||||
rc, out, err = module.run_command(command, cwd=project_path)
|
||||
if state == 'absent' and 'Resources: 0' in out:
|
||||
changed = False
|
||||
if rc != 0:
|
||||
module.fail_json(
|
||||
msg="Failure when executing Terraform command. Exited {0}.\nstdout: {1}\nstderr: {2}".format(rc, out, err),
|
||||
command=' '.join(command)
|
||||
)
|
||||
else:
|
||||
changed = False
|
||||
out, err = '', ''
|
||||
|
||||
outputs_command = [command[0], 'output', '-no-color', '-json'] + _state_args(state_file)
|
||||
rc, outputs_text, outputs_err = module.run_command(outputs_command, cwd=project_path)
|
||||
if rc == 1:
|
||||
module.warn("Could not get Terraform outputs. This usually means none have been defined.\nstdout: {0}\nstderr: {1}".format(outputs_text, outputs_err))
|
||||
outputs = {}
|
||||
elif rc != 0:
|
||||
module.fail_json(
|
||||
msg="Failure when getting Terraform outputs. "
|
||||
"Exited {0}.\nstdout: {1}\nstderr: {2}".format(rc, outputs_text, outputs_err),
|
||||
command=' '.join(outputs_command))
|
||||
else:
|
||||
outputs = json.loads(outputs_text)
|
||||
|
||||
module.exit_json(changed=changed, state=state, outputs=outputs, sdtout=out, stderr=err, command=' '.join(command))
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
Loading…
Add table
Reference in a new issue