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


It’s 100% Open Source and licensed under the BSD 2-clause License.

Requirements

NameVersion
acme>= 2.11.1
aws>= 4.41.0
cloudinit>= 2.2.0
tls>= 4.0.4

Providers

NameVersion
acme2.11.1
aws4.41.0
cloudinit2.2.0
tls4.0.4

Modules

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

Resources

NameType
acme_certificate.certificateresource
acme_registration.regresource
aws_cloudwatch_metric_alarm.high_bandwidthresource
aws_cloudwatch_metric_alarm.high_cpuresource
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_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
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
domain_nameDomain name to use for the instancestringn/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
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
rfc2136_nameservern/astringn/ayes
rfc2136_tsig_keyn/astringn/ayes
rfc2136_tsig_secretn/astringn/ayes
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.

Makefile Targets

Available targets:

  help                                Help screen
  help/all                            Display help for all targets
  help/short                          This help short screen
  lint                                Lint terraform code

Help

Got a question? We got answers.

File a GitLab issue, send us an email or join our Matrix Community.

README Commercial Support

Matrix Community

Matrix badge

Join our Open Source Community on Matrix. It’s FREE for everyone! This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build on our open source code.

Contributing

Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

Developing

If you are interested in being a contributor and want to get involved in developing this project or help out with our other projects, we would love to hear from you! Shoot us an email.

In general, PRs are welcome. We follow the typical “fork-and-pull” Git workflow.

  1. Fork the repo on GitLab
  2. Clone the project to your own machine
  3. Commit changes to your own branch
  4. Push your work back up to your fork
  5. Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from “upstream” before making a pull request!

Copyright © 2021-2022 SR2 Communications Limited

License

License: BSD 2-clause

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
   disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
   disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Trademarks

All other trademarks referenced herein are the property of their respective owners.

About

This project is maintained by SR2 Communications Limited.

SR2 Communications Limited

We’re a DevOps Professional Services company based in Aberdeen, Scotland. We ❤️ open source software and specialise in digital human rights and humanitarian projects.

We offer paid support on all of our projects.

Check out our other projects, or hire us to get support with using our projects.

Contributors

irl
irl
aws terraform ec2 bypass-censorship web-mirrors