cool-sharedservices-freeipa

This is a Terraform module for creating a FreeIPA server cluster in the COOL shared services environment. This deployment should be laid down on top of cisagov/cool-sharedservices-networking.

Pre-requisites

Terraform installed on your system.
An accessible AWS S3 bucket to store Terraform state (specified in backend.tf).
An accessible AWS DynamoDB database to store the Terraform state lock (specified in backend.tf).
Access to all of the Terraform remote states specified in remote_states.tf.

Usage

module "example" {
  source = "github.com/cisagov/cool-sharedservices-freeipa"

  aws_region          = "us-east-1"
  cool_domain         = "example.com"
  trusted_cidr_blocks = [
    "10.99.49.0/24",
    "10.99.52.0/24"
  ]
}

Requirements

Name	Version
terraform	~> 1.0
aws	~> 4.9

Providers

Name	Version
aws	~> 4.9
aws.organizationsreadonly	~> 4.9
aws.sharedservicesprovisionaccount	~> 4.9
terraform	n/a

Modules

Name	Source	Version
cw_alarms_ipa	github.com/cisagov/instance-cw-alarms-tf-module	n/a
ipa0	github.com/cisagov/freeipa-server-tf-module	n/a
ipa1	github.com/cisagov/freeipa-server-tf-module	n/a
ipa2	github.com/cisagov/freeipa-server-tf-module	n/a
security_groups	./security_groups	n/a

Resources

Name	Type
aws_iam_policy.provisionfreeipa_policy	resource
aws_iam_role_policy_attachment.provisionfreeipa_policy_attachment	resource
aws_route53_health_check.instance_status_check	resource
aws_route53_health_check.overall	resource
aws_route53_health_check.system_status_check	resource
aws_route53_record.ca_A	resource
aws_route53_record.ipa_A	resource
aws_route53_record.kerberos_TXT	resource
aws_route53_record.ldap_SRV	resource
aws_route53_record.ldaps_SRV	resource
aws_route53_record.master_tcp_SRV	resource
aws_route53_record.master_udp_SRV	resource
aws_route53_record.password_tcp_SRV	resource
aws_route53_record.password_udp_SRV	resource
aws_route53_record.server_A	resource
aws_route53_record.server_PTR	resource
aws_route53_record.server_tcp_SRV	resource
aws_route53_record.server_udp_SRV	resource
aws_caller_identity.current	data source
aws_caller_identity.sharedservices	data source
aws_iam_policy_document.provisionfreeipa_policy_doc	data source
aws_organizations_organization.cool	data source
terraform_remote_state.cdm	data source
terraform_remote_state.images_parameterstore	data source
terraform_remote_state.master	data source
terraform_remote_state.networking	data source
terraform_remote_state.sharedservices	data source

Inputs

Name	Description	Type	Default	Required
aws_region	The AWS region where the shared services account is to be created (e.g. "us-east-1").	`string`	`"us-east-1"`	no
cool_domain	The domain where the COOL resources reside (e.g. "cool.cyber.dhs.gov").	`string`	`"cool.cyber.dhs.gov"`	no
crowdstrike_falcon_sensor_customer_id_key	The SSM Parameter Store key whose corresponding value contains the customer ID for CrowdStrike Falcon (e.g. /cdm/falcon/customer_id).	`string`	`"/cdm/falcon/customer_id"`	no
crowdstrike_falcon_sensor_tags_key	The SSM Parameter Store key whose corresponding value contains a comma-delimited list of tags that are to be applied to CrowdStrike Falcon (e.g. /cdm/falcon/tags).	`string`	`"/cdm/falcon/tags"`	no
nessus_hostname_key	The SSM Parameter Store key whose corresponding value contains the hostname of the CDM Tenable Nessus server to which the Nessus Agent should link (e.g. /cdm/nessus/hostname).	`string`	`"/cdm/nessus_hostname"`	no
nessus_key_key	The SSM Parameter Store key whose corresponding value contains the secret key that the Nessus Agent should use when linking with the CDM Tenable Nessus server (e.g. /cdm/nessus/key).	`string`	`"/cdm/nessus_key"`	no
nessus_port_key	The SSM Parameter Store key whose corresponding value contains the port to which the Nessus Agent should connect when linking with the CDM Tenable Nessus server (e.g. /cdm/nessus/port).	`string`	`"/cdm/nessus_port"`	no
netbios_name	The NetBIOS name to be used by the server (e.g. EXAMPLE). Note that NetBIOS names are restricted to at most 15 characters. These characters must consist only of uppercase letters, numbers, and dashes.	`string`	`"COOL"`	no
provisionaccount_role_name	The name of the IAM role that allows sufficient permissions to provision all AWS resources in the Shared Services account.	`string`	`"ProvisionAccount"`	no
provisionfreeipa_policy_description	The description to associate with the IAM policy that allows provisioning of FreeIPA in the Shared Services account.	`string`	`"Allows provisioning of FreeIPA in the Shared Services account."`	no
provisionfreeipa_policy_name	The name to assign the IAM policy that allows provisioning of FreeIPA in the Shared Services account.	`string`	`"ProvisionFreeIPA"`	no
root_disk_size	The size of the IPA instance's root disk in GiB.	`number`	`8`	no
tags	Tags to apply to all AWS resources created.	`map(string)`	`{}`	no
trusted_cidr_blocks	A list of the CIDR blocks outside the VPC that are allowed to access the IPA servers (e.g. ["10.10.0.0/16", "10.11.0.0/16"]).	`list(string)`	`[]`	no
ttl	The TTL value to use for Route53 DNS records (e.g. 60).	`number`	`60`	no

Outputs

Name	Description
client_security_group	The IPA client security group.
server0	The first IPA server EC2 instance.
server1	The second IPA server EC2 instance.
server2	The third IPA server EC2 instance.
server_security_group	The IPA server security group.

Notes

Running pre-commit requires running terraform init in every directory that contains Terraform code. In this repository, that is only the main directory.

Contributing

We welcome contributions! Please see CONTRIBUTING.md for details.

License

This project is in the worldwide public domain.

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.

cisagov / cool-sharedservices-freeipa

readme