Component: zscaler
This component is responsible for provisioning ZScaler Private Access Connector instances on Amazon Linux 2 AMIs.
Prior to provisioning this component, it is required that a SecureString SSM Parameter containing the ZScaler App Connector Provisioning Key is populated in each account corresponding to the regional stack the component is deployed to, with the name of the SSM Parameter matching the value of var.zscaler_key
.
This parameter should be populated using chamber
, which is included in the geodesic image:
chamber write zscaler key <value>
Where <value>
is the ZScaler App Connector Provisioning Key. For more information on how to generate this key, see: ZScaler documentation on Configuring App Connectors.
Usage
Stack Level: Regional
The typical stack configuration for this component is as follows:
components:
terraform:
zscaler:
vars:
zscaler_count: 2
Preferably, regional stack configurations can be kept DRY by importing catalog/zscaler
via the imports
list at the top of the configuration.
import:
...
- catalog/zscaler
Requirements
Name | Version |
---|---|
terraform | >= 0.13.0 |
aws | >= 3.0 |
null | >= 3.0 |
random | >= 3.0 |
template | >= 2.2 |
utils | >= 1.10.0 |
Providers
Name | Version |
---|---|
aws | >= 3.0 |
template | >= 2.2 |
Modules
Name | Source | Version |
---|---|---|
ec2_zscaler | cloudposse/ec2-instance/aws | 0.32.2 |
iam_roles | ../account-map/modules/iam-roles | n/a |
this | cloudposse/label/null | 0.24.1 |
Resources
Name | Type |
---|---|
aws_iam_role_policy_attachment.ssm_core | resource |
aws_ami.amazon_linux_2 | data source |
aws_ssm_parameter.zscaler_key | data source |
template_file.userdata | data source |
Inputs
Name | Description | Type | Default | Required |
---|---|---|---|---|
additional_tag_map | Additional tags for appending to tags_as_list_of_maps. Not added to tags . | map(string) | {} | no |
ami_owner | The owner of the AMI used for the ZScaler EC2 instances. | string | "amazon" | no |
ami_regex | The regex used to match the latest AMI to be used for the ZScaler EC2 instances. | string | "^amzn2-ami-hvm.*" | no |
attributes | Additional attributes (e.g. 1 ) | list(string) | [] | no |
aws_ssm_enabled | Set true to install the AWS SSM agent on each EC2 instances. | bool | true | no |
context | Single 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 |
| no |
delimiter | Delimiter to be used between namespace , environment , stage , name and attributes .Defaults to - (hyphen). Set to "" to use no delimiter at all. | string | null | no |
enabled | Set to false to prevent the module from creating any resources | bool | null | no |
environment | Environment, e.g. 'uw2', 'us-west-2', OR 'prod', 'staging', 'dev', 'UAT' | string | null | no |
id_length_limit | Limit id to this many characters (minimum 6).Set to 0 for unlimited length.Set to null for default, which is 0 .Does not affect id_full . | number | null | no |
instance_type | The instance family to use for the ZScaler EC2 instances. | string | "m5n.large" | no |
label_key_case | The letter case of label keys (tag names) (i.e. name , namespace , environment , stage , attributes ) to use in tags .Possible values: lower , title , upper .Default value: title . | string | null | no |
label_order | The naming order of the id output and Name tag. Defaults to ["namespace", "environment", "stage", "name", "attributes"]. You can omit any of the 5 elements, but at least one must be present. | list(string) | null | no |
label_value_case | The letter case of output label values (also used in tags and id ).Possible values: lower , title , upper and none (no transformation).Default value: lower . | string | null | no |
name | Solution name, e.g. 'app' or 'jenkins' | string | null | no |
namespace | Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp' | string | null | no |
regex_replace_chars | Regex to replace chars with empty string in namespace , environment , stage and name .If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits. | string | null | no |
region | AWS region | string | n/a | yes |
secrets_store_type | Secret store type for Zscaler provisioning keys. Valid values: SSM , ASM (but ASM not currently supported) | string | "SSM" | no |
security_group_rules | A list of maps of Security Group rules. The values of map is fully complated with aws_security_group_rule resource.To get more info see security_group_rule. | list(any) |
| no |
stage | Stage, e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release' | string | null | no |
tags | Additional tags (e.g. map('BusinessUnit','XYZ') | map(string) | {} | no |
zscaler_count | The number of Zscaler instances. | number | 1 | no |
zscaler_key | SSM key (without leading / ) for the Zscaler provisioning key secret. | string | "zscaler/key" | no |
Outputs
Name | Description |
---|---|
instance_id | Instance ID |
private_ip | Private IP of the instance |
References
- cloudposse/terraform-aws-components - Cloud Posse's upstream component