Terraform module to deploy a Bypass Censorship Smart Proxy Instance in AWS.

Architecture diagram

Requirements

NameVersion
terraform>= 1.3.0
acme>= 2.11.1
aws>= 4.41.0
cloudinit>= 2.2.0
time>= 0.7.0
tls>= 4.0.4

Providers

NameVersion
acme2.13.1
aws4.56.0
cloudinit2.3.2
time0.9.1
tls4.0.4

Modules

NameSourceVersion
conf_logsr2c/ec2-conf-log/aws0.0.3
instancecloudposse/ec2-instance/aws0.42.0
thiscloudposse/label/null0.25.0

Resources

NameType
acme_certificate.thisresource
acme_registration.regresource
aws_cloudwatch_metric_alarm.high_bandwidthresource
aws_cloudwatch_metric_alarm.high_cpuresource
aws_iam_access_key.dns_validationresource
aws_iam_policy.dns_validationresource
aws_iam_user.dns_validationresource
aws_iam_user_policy_attachment.dns_validationresource
aws_route53_record.thisresource
aws_s3_object.smart_configresource
time_sleep.wait_for_iam_propagationresource
tls_cert_request.reqresource
tls_private_key.cert_private_keyresource
tls_private_key.reg_private_keyresource
aws_ami.ubuntudata source
aws_availability_zones.availabledata source
aws_route53_zone.thisdata source
aws_subnet.defaultdata source
aws_vpc.defaultdata source
cloudinit_config.thisdata source

Inputs

NameDescriptionTypeDefaultRequired
additional_tag_mapAdditional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.
map(string){}no
attributesID element. Additional attributes (e.g. workers or cluster) to add to id,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the delimiter
and treated as a single ID element.
list(string)[]no
config_filenameFilename of the nginx configuration to install into the smart proxy instance.stringn/ayes
contextSingle object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as null to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.
any
{
“additional_tag_map”: {},
“attributes”: [],
“delimiter”: null,
“descriptor_formats”: {},
“enabled”: true,
“environment”: null,
“id_length_limit”: null,
“label_key_case”: null,
“label_order”: [],
“label_value_case”: null,
“labels_as_tags”: [
“unset”
],
“name”: null,
“namespace”: null,
“regex_replace_chars”: null,
“stage”: null,
“tags”: {},
“tenant”: null
}
no
delimiterDelimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.
stringnullno
descriptor_formatsDescribe additional descriptors to be output in the descriptors output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
{<br> format = string<br> labels = list(string)<br>}
(Type is any so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to the format() function.
labels is a list of labels, in order, to pass to format() function.
Label values will be normalized before being passed to format() so they will be
identical to how they appear in id.
Default is {} (descriptors output will be empty).
any{}no
disable_api_terminationEnable EC2 Instance Termination Protectionbooln/ayes
dns_zoneThis name must exist as a zone in Route 53. A wildcard DNS record will be created to point at the smart proxy instance, and a wildcard certificate will be created based on this name and used by the smart proxy.stringn/ayes
enabledSet to false to prevent the module from creating any resourcesboolnullno
environmentID element. Usually used for region e.g. ‘uw2’, ‘us-west-2’, OR role ‘prod’, ‘staging’, ‘dev’, ‘UAT’stringnullno
id_length_limitLimit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for keep the existing setting, which defaults to 0.
Does not affect id_full.
numbernullno
label_key_caseControls the letter case of the tags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags input.
Possible values: lower, title, upper.
Default value: title.
stringnullno
label_orderThe order in which the labels (ID elements) appear in the id.
Defaults to [“namespace”, “environment”, “stage”, “name”, “attributes”].
You can omit any of the 6 labels (“tenant” is the 6th), but at least one must be present.
list(string)nullno
label_value_caseControls the letter case of ID elements (labels) as included in id,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the tags input.
Possible values: lower, title, upper and none (no transformation).
Set this to title and set delimiter to "" to yield Pascal Case IDs.
Default value: lower.
stringnullno
labels_as_tagsSet of labels (ID elements) to include as tags in the tags output.
Default is to include all labels.
Tags with empty values will not be included in the tags output.
Set to [] to suppress all generated tags.
Notes:
The value of the name tag, if included, will be the id, not the name.
Unlike other null-label inputs, the initial setting of labels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.
set(string)
[
“default”
]
no
letsencrypt_email_addressn/astringn/ayes
max_transfer_per_hourThe maximum number of bytes that can be sent out per hour.string"6442450944"no
nameID element. Usually the component or solution name, e.g. ‘app’ or ‘jenkins’.
This is the only ID element not also included as a tag.
The “name” tag is set to the full id string. There is no tag with the value of the name input.
stringnullno
namespaceID element. Usually an abbreviation of your organization name, e.g. ’eg’ or ‘cp’, to help ensure generated IDs are globally uniquestringnullno
regex_replace_charsTerraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.
stringnullno
stageID element. Usually used to indicate role, e.g. ‘prod’, ‘staging’, ‘source’, ‘build’, ’test’, ‘deploy’, ‘release’stringnullno
tagsAdditional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.
map(string){}no
tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno

Outputs

NameDescription
config_bucket_nameThe name of the S3 bucket used to update the configuration for the smart proxy instance.
ip_addressesThe public IP addresses of the smart proxy instance.

Tags: aws terraform ec2 bypass-censorship web-mirrors