Last active
December 12, 2018 19:52
-
-
Save bernadinm/e9d666ad1ff95735baf29fbbc6fae953 to your computer and use it in GitHub Desktop.
dcos-terraform: Provisioner Variable Descriptions for major convenience wrappers
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Variables | Description | AWS Appendix | GCP Appendix | Azure Appendix | |
|---|---|---|---|---|---|
| additional_listener | List of additional listeners | ||||
| additional_rules | List of additional rules | ||||
| admin | Firewall rules for debuging access | ||||
| admin_ips | List of CIDR admin IPs | ||||
| admin_username | SSH User | ||||
| agent_cidr_range | Agent CIDR Range | ||||
| agent_subnetwork_name | Agent Subnetwork Name | ||||
| allow_ports | ports to allow | ||||
| allow_stopping_for_update | If true, allows Terraform to stop the instance to update its properties | ||||
| ami | AMI that will be used for the instance | ||||
| arg1 | Description of the arg1 variable | ||||
| associate_public_ip_address | Associate a public IP address with the instances | ||||
| auto_accept | Auto accept peering connections | ||||
| availability_zones | Availability zones to be used | ||||
| aws_agent_profile | Name of the agent profile | ||||
| aws_ami | AMI that will be used for the instances instead of Mesosphere provided AMIs | ||||
| aws_associate_public_ip_address | Associate a public IP address with the instances | ||||
| aws_default_os_user | Map OS name to default login user (e.g. centos -> centos, coreos -> coreos) | ||||
| aws_iam_instance_profile | Instance profile to be used for these instances | ||||
| aws_instance_type | Instance type | ||||
| aws_key_name | Specify the aws ssh key to use. We assume its already loaded in your SSH agent. Set ssh_public_key_file to empty string | ||||
| aws_main_route_table_id | AWS main route table id | ||||
| aws_master_profile | Name of the masters profile | ||||
| aws_root_volume_size | Root volume size in GB | ||||
| aws_root_volume_type | Root volume type | ||||
| aws_security_group_ids | Firewall IDs to use for these instances | ||||
| aws_subnet_ids | Subnets to spawn the instances in. The module tries to distribute the instances | ||||
| azure_location | Azure location to be used | ||||
| azure_offer | Azure Offer | ||||
| azure_os_image_version | Azure Images | ||||
| azure_publisher | Azure Publisher | ||||
| azure_sku | Azure SKU | ||||
| azure_version | Azure Version | ||||
| backend_address_pool | backend address pool | ||||
| backend_address_pool | backend address pool | ||||
| backend_address_pool | backend address pool | ||||
| backend_address_pool | backend address pool | ||||
| bootstrap_admin_username | Bootstrap node SSH User | ||||
| bootstrap_associate_public_ip_address | [BOOTSTRAP] Associate a public ip address with there instances | ||||
| bootstrap_aws_ami | [BOOTSTRAP] AMI to be used | ||||
| bootstrap_dcos_instance_os | Bootstrap node tested OSes image | ||||
| bootstrap_disk_size | Bootstrap node disk size (gb) | ||||
| bootstrap_disk_type | Bootstrap node disk type. | ||||
| bootstrap_gcp_image | [BOOTSTRAP] Image to be used | ||||
| bootstrap_image | [BOOTSTRAP] Image to be used | ||||
| bootstrap_instance_type | [BOOTSTRAP] Instance type | ||||
| bootstrap_ip | The bootstrap IP to SSH to | ||||
| bootstrap_machine_type | [BOOTSTRAP] Machine type | ||||
| bootstrap_os | [BOOTSTRAP] Operating system to use. Instead of using your own AMI you could use a provided OS. | ||||
| bootstrap_os_user | The OS user to be used with ssh exec (only for bootstrap) | ||||
| bootstrap_port | TCP port bootstrap nginx is listening on. Used to build the bootstrap URL. | ||||
| bootstrap_prereq-id | Workaround making the bootstrap install depending on an external resource (e.g. nullresource.id) | ||||
| bootstrap_private_ip | Private IP bootstrap nginx is listening on. Used to build the bootstrap URL. | ||||
| bootstrap_public_ssh_key_path | Bootstrap Node Public SSH Key | ||||
| bootstrap_root_volume_size | [BOOTSTRAP] Root volume size in GB | ||||
| bootstrap_root_volume_type | [BOOTSTRAP] Root volume type | ||||
| bootstrap_ssh_user | Bootstrap node SSH User | ||||
| bootstrap_subnetwork_name | Instance Subnetwork Name | ||||
| bootstrap.admin_username | Bootstrap node SSH User | ||||
| bootstrap.dcos_instance_os | Bootstrap node tested OSes image | ||||
| bootstrap.disk_size | Bootstrap node disk size (gb) | ||||
| bootstrap.disk_type | Bootstrap node disk type. | ||||
| bootstrap.image | Bootstrap node OS image | ||||
| bootstrap.instance | Bootstrap instance ID | ||||
| bootstrap.instance_type | Bootstrap node machine type | ||||
| bootstrap.machine_type | Bootstrap node machine type | ||||
| bootstrap.nsg_id | nsg id | ||||
| bootstrap.nsg_name | nsg name | ||||
| bootstrap.os_user | Bootstrap instance OS default user | ||||
| bootstrap.prereq_id | Returns the ID of the prereq script (if image are not used) | ||||
| bootstrap.prereq-id | Returns the ID of the prereq script for bootstrap (if user_data or ami are not used) | ||||
| bootstrap.private_ip | Private IP of the bootstrap instance | ||||
| bootstrap.public_ip | Public IP of the bootstrap instance | ||||
| bootstrap.ssh_user | Bootstrap node SSH User | ||||
| cluster_name | Name of the DC/OS cluster | ||||
| connection_draining | Enable connection draining | ||||
| cross_zone_load_balancing | Enable cross-zone load balancing | ||||
| custom_dcos_download_path | insert location of dcos installer script (optional) | ||||
| dcos_adminrouter_tls_1_0_enabled | Indicates whether to enable TLSv1 support in Admin Router. (optional) | ||||
| dcos_adminrouter_tls_1_1_enabled | Indicates whether to enable TLSv1.1 support in Admin Router. (optional) | ||||
| dcos_adminrouter_tls_1_2_enabled | Indicates whether to enable TLSv1.2 support in Admin Router. (optional) | ||||
| dcos_adminrouter_tls_cipher_suite | [Enterprise DC/OS] Indicates whether to allow web browsers to send the DC/OS authentication cookie through a non-HTTPS connection. (optional) | ||||
| dcos_agent_list | used to list the agents in the config.yaml (optional) | ||||
| dcos_audit_logging | [Enterprise DC/OS] enable security decisions are logged for Mesos, Marathon, and Jobs. (optional) | ||||
| dcos_auth_cookie_secure_flag | [Enterprise DC/OS] allow web browsers to send the DC/OS authentication cookie through a non-HTTPS connection. (optional) | ||||
| dcos_aws_access_key_id | AWS key ID for exhibitor storage (optional but required with dcos_exhibitor_address) | ||||
| dcos_aws_region | AWS region for exhibitor storage (optional but required with dcos_exhibitor_address) | ||||
| dcos_aws_secret_access_key | AWS secret key for exhibitor storage (optional but required with dcos_exhibitor_address) | ||||
| dcos_aws_template_storage_access_key_id | AWS key ID for CloudFormation template storage (optional) | ||||
| dcos_aws_template_storage_bucket | AWS CloudFormation bucket name (optional) | ||||
| dcos_aws_template_storage_bucket_path | AWS CloudFormation bucket path (optional) | ||||
| dcos_aws_template_storage_region_name | AWS CloudFormation region name (optional) | ||||
| dcos_aws_template_storage_secret_access_key | AWS secret key for the CloudFormation template (optional) | ||||
| dcos_aws_template_upload | To automatically upload the customized advanced templates to your S3 bucket. (optional) | ||||
| dcos_bootstrap_port | Port of the bootstrap URL | ||||
| dcos_bouncer_expiration_auth_token_days | [Enterprise DC/OS] Sets the auth token time-to-live (TTL) for Identity and Access Management. (optional) | ||||
| dcos_ca_certificate_chain_path | [Enterprise DC/OS] Path (relative to the $DCOS_INSTALL_DIR) to a file containing the complete CA certification chain required for end-entity certificate verification, in the OpenSSL PEM format. (optional) | ||||
| dcos_ca_certificate_key_path | [Enterprise DC/OS] Path (relative to the $DCOS_INSTALL_DIR) to a file containing a single X.509 certificate private key in the OpenSSL PEM format. (optional) | ||||
| dcos_ca_certificate_key_path | UNDEFINED | ||||
| dcos_ca_certificate_path | [Enterprise DC/OS] Path (relative to the $DCOS_INSTALL_DIR) to a file containing a single X.509 CA certificate in the OpenSSL PEM format. (optional) | ||||
| dcos_check_time | Check if Network Time Protocol (NTP) is enabled during DC/OS startup. (optional) | ||||
| dcos_cluster_docker_credentials | Dictionary of Docker credentials to pass. (optional) | ||||
| dcos_cluster_docker_credentials_dcos_owned | Indicates whether to store the credentials file in /opt/mesosphere or /etc/mesosphere/docker_credentials. A sysadmin cannot edit /opt/mesosphere directly (optional) | ||||
| dcos_cluster_docker_credentials_enabled | Indicates whether to pass the Mesos --docker_config option to Mesos. (optional) | ||||
| dcos_cluster_docker_credentials_write_to_etc | Indicates whether to write a cluster credentials file. (optional) | ||||
| dcos_cluster_docker_registry_enabled | DC/OS cluster docker registry enabled | ||||
| dcos_cluster_docker_registry_url | The custom URL that Mesos uses to pull Docker images from. If set, it will configure the Mesos --docker_registry flag to the specified URL. (optional) | ||||
| dcos_cluster_name | sets the DC/OS cluster name | ||||
| dcos_config | used to add any extra arguments in the config.yaml that are not specified here. (optional) | ||||
| dcos_custom_checks | Custom installation checks that are added to the default check configuration process. (optional) | ||||
| dcos_customer_key | [Enterprise DC/OS] sets the customer key (optional) | ||||
| dcos_dns_bind_ip_blacklist | A list of IP addresses that DC/OS DNS resolvers cannot bind to. (optional) | ||||
| dcos_dns_forward_zones | Allow to forward DNS to certain domain requests to specific server. The following syntax must be used in combination with Terraform string heredoc. (optional) (:warning: DC/OS 1.10+) | ||||
| dcos_dns_search | A space-separated list of domains that are tried when an unqualified domain is entered. (optional) | ||||
| dcos_docker_remove_delay | The amount of time to wait before removing stale Docker images stored on the agent nodes and the Docker image generated by the installer. (optional) | ||||
| dcos_enable_docker_gc | Indicates whether to run the docker-gc script, a simple Docker container and image garbage collection script, once every hour to clean up stray Docker containers. (optional) | ||||
| dcos_enable_gpu_isolation | Indicates whether to enable GPU support in DC/OS. (optional) | ||||
| dcos_exhibitor_address | The address of the load balancer in front of the masters (recommended) | ||||
| dcos_exhibitor_azure_account_key | the azure account key for exhibitor storage (optional but required with dcos_exhibitor_address) | ||||
| dcos_exhibitor_azure_account_name | the azure account name for exhibitor storage (optional but required with dcos_exhibitor_address) | ||||
| dcos_exhibitor_azure_prefix | the azure account name for exhibitor storage (optional but required with dcos_exhibitor_address) | ||||
| dcos_exhibitor_explicit_keys | set whether you are using AWS API keys to grant Exhibitor access to S3. (optional) | ||||
| dcos_exhibitor_storage_backend | options are aws_s3, azure, or zookeeper (recommended) | ||||
| dcos_exhibitor_zk_hosts | a comma-separated list of one or more ZooKeeper node IP and port addresses to use for configuring the internal Exhibitor instances. (not recommended but required with exhibitor_storage_backend set to ZooKeeper. Use aws_s3 or azure instead. Assumes external ZooKeeper is already online.) | ||||
| dcos_exhibitor_zk_path | the filepath that Exhibitor uses to store data (not recommended but required with exhibitor_storage_backend set to zookeeper. Use aws_s3 or azureinstead. Assumes external ZooKeeper is already online.) | ||||
| dcos_fault_domain_detect_contents | [Enterprise DC/OS] fault domain script contents. Optional but required if no fault-domain-detect script present. | ||||
| dcos_fault_domain_enabled | [Enterprise DC/OS] used to control if fault domain is enabled | ||||
| dcos_gc_delay | The maximum amount of time to wait before cleaning up the executor directories (optional) | ||||
| dcos_gpus_are_scarce | Indicates whether to treat GPUs as a scarce resource in the cluster. (optional) | ||||
| dcos_http_proxy | http proxy (optional) | ||||
| dcos_https_proxy | https proxy (optional) | ||||
| dcos_install_mode | Type of command to execute. Options: install or upgrade | ||||
| dcos_instance_os | Operating system to use. Instead of using your own AMI you could use a provided OS. | ||||
| dcos_ip_detect_contents | Allows DC/OS to detect your private address. Use this to pass this as an input to the module rather than a file in side your bootstrap node. (recommended) | ||||
| dcos_ip_detect_public_contents | Allows DC/OS to be aware of your publicly routeable address for ease of use (recommended) | ||||
| dcos_ip_detect_public_filename | statically set your detect-ip-public path | ||||
| dcos_l4lb_enable_ipv6 | A boolean that indicates if layer 4 load balancing is available for IPv6 networks. (optional) | ||||
| dcos_license_key_contents | [Enterprise DC/OS] used to privide the license key of DC/OS for Enterprise Edition. Optional if license.txt is present on bootstrap node. | ||||
| dcos_log_directory | The path to the installer host logs from the SSH processes. (optional) | ||||
| dcos_master_discovery | The Mesos master discovery method. The available options are static or master_http_loadbalancer. (recommend the use of master_http_loadbalancer) | ||||
| dcos_master_dns_bindall | Indicates whether the master DNS port is open. (optional) | ||||
| dcos_master_external_loadbalancer | Allows DC/OS to configure certs around the External Load Balancer name. If not used SSL verfication issues will arrise. EE only. (recommended) | ||||
| dcos_master_list | statically set your master nodes (not recommended but required with exhibitor_storage_backend set to static. Use aws_s3 or azure instead, that way you can replace masters in the cloud.) | ||||
| dcos_mesos_container_log_sink | The log manager for containers (tasks). The options are to send logs to: 'journald', 'logrotate', 'journald+logrotate'. (optional) | ||||
| dcos_mesos_dns_set_truncate_bit | Indicates whether to set the truncate bit if the response is too large to fit in a single packet. (optional) | ||||
| dcos_mesos_max_completed_tasks_per_framework | The number of completed tasks for each framework that the Mesos master will retain in memory. (optional) | ||||
| dcos_no_proxy | A YAML nested list (-) of addresses to exclude from the proxy. (optional) | ||||
| dcos_num_masters | set the num of master nodes (required with exhibitor_storage_backend set to aws_s3, azure, ZooKeeper) | ||||
| dcos_oauth_enabled | [Open DC/OS Only] Indicates whether to enable authentication for your cluster. (optional) | ||||
| dcos_overlay_config_attempts | Specifies how many failed configuration attempts are allowed before the overlay configuration modules stop trying to configure an virtual network. (optional) | ||||
| dcos_overlay_enable | Enable to disable overlay (optional) | ||||
| dcos_overlay_mtu | The maximum transmission unit (MTU) of the Virtual Ethernet (vEth) on the containers that are launched on the overlay. (optional) | ||||
| dcos_overlay_network | This group of parameters define an virtual network for DC/OS. (optional) | ||||
| dcos_package_storage_uri | Where to permanently store DC/OS packages. The value must be a file URL. (optional) | ||||
| dcos_previous_version | DC/OS 1.9+ requires users to set this value to ensure users know the version. Terraform helps populate this value, but users can override it here. (recommended) | ||||
| dcos_previous_version_master_index | Used to track the index of master for quering the previous DC/OS version during upgrading. (optional) applicable: 1.9+ | ||||
| dcos_process_timeout | The allowable amount of time, in seconds, for an action to begin after the process forks. (optional) | ||||
| dcos_public_agent_list | statically set your public agents (not recommended) | ||||
| dcos_resolvers | A YAML nested list (-) of DNS resolvers for your DC/OS cluster nodes. (recommended) | ||||
| dcos_rexray_config | The REX-Ray configuration method for enabling external persistent volumes in Marathon. (optional) | ||||
| dcos_rexray_config_filename | The REX-Ray configuration filename for enabling external persistent volumes in Marathon. (optional) | ||||
| dcos_rexray_config_method | The REX-Ray configuration method for enabling external persistent volumes in Marathon. (optional) | ||||
| dcos_role | DCOS Role | ||||
| dcos_s3_bucket | name of the s3 bucket for the exhibitor backend (recommended but required with dcos_exhibitor_address) | ||||
| dcos_s3_prefix | name of the s3 prefix for the exhibitor backend (recommended but required with dcos_exhibitor_address) | ||||
| dcos_security | [Enterprise DC/OS] set the security level of DC/OS, either 'strict' or 'permissive'. Default is 'permissive'. (recommended) | ||||
| dcos_skip_checks | Upgrade option: Used to skip all dcos checks that may block an upgrade if any DC/OS component is unhealthly. (optional) applicable: 1.10+ | ||||
| dcos_staged_package_storage_uri | Where to temporarily store DC/OS packages while they are being added. (optional) | ||||
| dcos_superuser_password_hash | [Enterprise DC/OS] set the superuser password hash (recommended) | ||||
| dcos_superuser_username | [Enterprise DC/OS] set the superuser username (recommended) | ||||
| dcos_telemetry_enabled | Change the telemetry option (optional) | ||||
| dcos_ucr_default_bridge_subnet | IPv4 subnet allocated to the mesos-bridge CNI network for UCR bridge-mode networking. (optional) | ||||
| dcos_use_proxy | To enable use of proxy for internal routing (optional) | ||||
| dcos_variant | Main Variables | ||||
| dcos_version | Specifies which DC/OS version instruction to use. Options: 1.9.0, 1.8.8, etc. See dcos_download_path or dcos_version tree for a full list. | ||||
| dcos_zk_agent_credentials | [Enterprise DC/OS] set the ZooKeeper agent credentials (recommended) | ||||
| dcos_zk_master_credentials | [Enterprise DC/OS] set the ZooKeeper master credentials (recommended) | ||||
| dcos_zk_super_credentials | [Enterprise DC/OS] set the zk super credentials (recommended) | ||||
| dcos-infrastructure.bootstrap.admin_username | UNDEFINED | ||||
| dcos-infrastructure.bootstrap.dcos_instance_os | UNDEFINED | ||||
| dcos-infrastructure.bootstrap.disk_size | UNDEFINED | ||||
| dcos-infrastructure.bootstrap.disk_type | UNDEFINED | ||||
| dcos-infrastructure.bootstrap.image | UNDEFINED | ||||
| dcos-infrastructure.bootstrap.instance_type | UNDEFINED | ||||
| dcos-infrastructure.bootstrap.private_ip | UNDEFINED | ||||
| dcos-infrastructure.bootstrap.public_ip | UNDEFINED | ||||
| dcos-infrastructure.dcos_version | UNDEFINED | ||||
| dcos-infrastructure.location | UNDEFINED | ||||
| dcos-infrastructure.masters.admin_username | UNDEFINED | ||||
| dcos-infrastructure.masters.dcos_instance_os | UNDEFINED | ||||
| dcos-infrastructure.masters.disk_size | UNDEFINED | ||||
| dcos-infrastructure.masters.disk_type | UNDEFINED | ||||
| dcos-infrastructure.masters.image | UNDEFINED | ||||
| dcos-infrastructure.masters.instance_type | UNDEFINED | ||||
| dcos-infrastructure.masters.lb.fqdn | UNDEFINED | ||||
| dcos-infrastructure.masters.private_ips | UNDEFINED | ||||
| dcos-infrastructure.masters.public_ips | UNDEFINED | ||||
| dcos-infrastructure.name_prefix | UNDEFINED | ||||
| dcos-infrastructure.num_masters | UNDEFINED | ||||
| dcos-infrastructure.num_private_agents | UNDEFINED | ||||
| dcos-infrastructure.num_public_agents | UNDEFINED | ||||
| dcos-infrastructure.private_agents.admin_username | Private Agents node SSH User | ||||
| dcos-infrastructure.private_agents.dcos_instance_os | UNDEFINED | ||||
| dcos-infrastructure.private_agents.disk_size | UNDEFINED | ||||
| dcos-infrastructure.private_agents.disk_type | UNDEFINED | ||||
| dcos-infrastructure.private_agents.image | UNDEFINED | ||||
| dcos-infrastructure.private_agents.instance_type | UNDEFINED | ||||
| dcos-infrastructure.private_agents.private_ips | UNDEFINED | ||||
| dcos-infrastructure.private_agents.public_ips | UNDEFINED | ||||
| dcos-infrastructure.public_agents.admin_username | UNDEFINED | ||||
| dcos-infrastructure.public_agents.dcos_instance_os | UNDEFINED | ||||
| dcos-infrastructure.public_agents.disk_size | UNDEFINED | ||||
| dcos-infrastructure.public_agents.disk_type | UNDEFINED | ||||
| dcos-infrastructure.public_agents.image | UNDEFINED | ||||
| dcos-infrastructure.public_agents.instance_type | UNDEFINED | ||||
| dcos-infrastructure.public_agents.lb.fqdn | UNDEFINED | ||||
| dcos-infrastructure.public_agents.private_ips | UNDEFINED | ||||
| dcos-infrastructure.public_agents.public_ips | UNDEFINED | ||||
| depends | Modules are missing the depends_on feature. Faking this feature with input and output variables | ||||
| depends_on | Modules are missing the depends_on feature. Faking this feature with input and output variables | ||||
| disk_size | Disk Size in GB | ||||
| disk_type | Disk Type to Leverage | The GCE disk type. Can be either 'pd-ssd', 'local-ssd', or 'pd-standard'. (optional) | |||
| dns_name | DNS Name of the master load balancer | ||||
| elb_address | UNDEFINED | ||||
| elb_name_format | Printf style format for naming the ELB. Gets truncated to 32 characters. (input cluster_name) | ||||
| elb.masters_dns_name | This is the load balancer to access the DC/OS UI | ||||
| elb.masters_internal_dns_name | This is the load balancer to access the masters internally in the cluster | ||||
| elb.public_agents_dns_name | This is the load balancer to reach the public agents | ||||
| enabled | Enable module | ||||
| forwarding_rules.masters | Master Forwarding Rules | ||||
| forwarding_rules.public_agents | Public Agent Forwarding Rules | ||||
| health_check | Health check definition. | Setting partial keys is allowed. E.g. only setting `port` or `request_path` | |||
| hostname_format | Format the hostname inputs are index+1, region, cluster_name | ||||
| https_acm_cert_arn | ACM certifacte to be used. | ||||
| iam_instance_profile | The instance profile to be used for these instances | ||||
| idle_timeout | Time in seconds the connection is allowed to be idle | ||||
| image | Source image to boot from | ||||
| image_family | GCP Image Family Name | ||||
| image_name | GCP Image Name | ||||
| infra_admin_username | Global Infra SSH User | ||||
| infra_dcos_instance_os | Global Infra Tested OSes Image | ||||
| infra_disk_size | Global Infra Disk Size | ||||
| infra_disk_type | Global Infra Disk Type | ||||
| infra_instance_type | Global Infra Machine Type | ||||
| infra_machine_type | Global Infra Machine Type | ||||
| infra_public_ssh_key_path | Global Infra Public SSH Key | ||||
| infra_ssh_user | Global Infra SSH User | ||||
| instance | List of instances IDs created by this module | ||||
| instance_subnetwork_name | Instance Subnetwork Name | ||||
| instance_type | Specify the instance type | ||||
| instance_type | Instance Type | ||||
| instances | List of instance IDs | ||||
| instances_self_link | List of instance self links | ||||
| internal | Firewall rules for all private interfaces | ||||
| internal | Internal Facing Scheme for elb | ||||
| internal | This ELB is internal only | ||||
| internal_subnets | List of internal subnets to allow traffic between them | ||||
| ip_address | Load balancer ip address | ||||
| key_name | The SSH key to use for these instances. | ||||
| labels | Add custom labels to all resources | ||||
| lb_address | lb address | ||||
| lb_address | lb address | ||||
| lb_address | lb address | ||||
| lb_address | lb address | ||||
| lb_name_format | Printf style format for naming the LB. (input cluster_name) | ||||
| lb.fqdn | UNDEFINED | ||||
| lb.masters | lb address | ||||
| lb.masters-internal | lb address | ||||
| lb.public-agents | lb address | ||||
| listener | List of listeners. By default HTTP and HTTPS are set. If set it overrides the default listeners. | ||||
| location | Azure Region | ||||
| machine_type | Instance Type | ||||
| main_region | The Main Region where the Masters run (ex: us-west-2, us-east-1) | ||||
| main_route_table_id | ID of the Route Table for the Main Region | ||||
| main_subnet | The subnet range of the Main Region | ||||
| main_vpc_id | The VPC ID of the Main Region | ||||
| master_admin_username | Master node SSH User | ||||
| master_cidr_range | Master CIDR Range | ||||
| master_dcos_instance_os | Master node tested OSes image | ||||
| master_disk_size | Master node disk size (gb) | ||||
| master_disk_type | Master node disk type. | ||||
| master_image | Master node OS image | ||||
| master_instance_type | Master node machine type | ||||
| master_instances | List of master instance IDs | ||||
| master_ips | list of master ips | ||||
| master_ips | list of master private ips | ||||
| master_ips | List of masterips to SSH to | ||||
| master_lb | Firewall rules for master load balancer | ||||
| master_machine_type | Master node machine type | ||||
| master_private_ips | list of master private ips | ||||
| master_public_ssh_key_path | Master node Public SSH Key | ||||
| master_ssh_user | Master node SSH User | ||||
| master_subnetwork_name | Master Subnetwork Name | ||||
| masters_acm_cert_arn | ACM certifacte to be used for the masters load balancer | ||||
| masters_additional_rules | Additional list of rules for masters. These Rules are an additon to the default rules. | ||||
| masters_associate_public_ip_address | [MASTERS] Associate a public ip address with there instances | ||||
| masters_aws_ami | [MASTERS] AMI to be used | ||||
| masters_dns_name | DNS Name of the master load balancer | ||||
| masters_gcp_image | [MASTERS] Image to be used | ||||
| masters_instance_type | [MASTERS] Instance type | ||||
| masters_internal_acm_cert_arn | ACM certifacte to be used for the internal masters load balancer | ||||
| masters_internal_dns_name | DNS Name of the master load balancer | ||||
| masters_ip_address | IP Address of master load balancer | ||||
| masters_machine_type | [MASTERS] Machine type | ||||
| masters_os | [MASTERS] Operating system to use. Instead of using your own AMI you could use a provided OS. | ||||
| masters_os_user | The OS user to be used with ssh exec ( only for masters ) | ||||
| masters_prereq-id | Workaround making the masters install depending on an external resource (e.g. nullresource.id) | ||||
| masters_root_volume_size | [MASTERS] Root volume size in GB | ||||
| masters_self_link | List of master instances self links | ||||
| masters-internal.backend_address_pool | backend address pool | ||||
| masters-internal.lb_address | lb address | ||||
| masters-ips | Master IP addresses | ||||
| masters-loadbalancer | This is the load balancer address to access the DC/OS UI | ||||
| masters.admin_username | Masters node SSH User | ||||
| masters.backend_address_pool | backend address pool | ||||
| masters.dcos_instance_os | UNDEFINED | ||||
| masters.disk_size | UNDEFINED | ||||
| masters.disk_type | UNDEFINED | ||||
| masters.image | UNDEFINED | ||||
| masters.instance_type | UNDEFINED | ||||
| masters.instances | Master instances IDs | ||||
| masters.lb_address | lb address | ||||
| masters.lb.fqdn | UNDEFINED | ||||
| masters.machine_type | UNDEFINED | ||||
| masters.nsg_id | nsg id | ||||
| masters.nsg_name | nsg name | ||||
| masters.os_user | Master instances private OS default user | ||||
| masters.prereq_id | Returns the ID of the prereq script for masters (if user_data or ami are not used) | ||||
| masters.prereq-id | Returns the ID of the prereq script for masters (if user_data or ami are not used) | ||||
| masters.private_ips | Master instances private IPs | ||||
| masters.public_ips | Master instances public IPs | ||||
| masters.ssh_user | Deployed masters agent SSH user | ||||
| name | UNDEFINED | ||||
| name_format | printf style format for naming the ELB. Gets truncated to 32 characters. (input cluster_name) | ||||
| name_prefix | Cluster Name | ||||
| network | Network Name | ||||
| network_name | Name of the network created by this module | ||||
| network_security_group_id | Security Group Id | ||||
| nsg_id | UNDEFINED | ||||
| nsg_name | UNDEFINED | ||||
| num | How many instances should be created | ||||
| num_bootstrap | Number of Instance | ||||
| num_instances | How many instances should be created | ||||
| num_masters | Specify the amount of masters. For redundancy you should have at least 3 | ||||
| num_of_private_agents | Specify the amount of private agents. These agents will provide your main resources | ||||
| num_of_private_agents | UNDEFINED | ||||
| num_of_public_agents | Specify the amount of public agents. These agents will host marathon-lb and edgelb | ||||
| num_of_public_agents | UNDEFINED | ||||
| num_private_agents | Specify the amount of private agents. These agents will provide your main resources | ||||
| num_public_agents | Specify the amount of public agents. These agents will host marathon-lb and edgelb | ||||
| os | Operating system to use | ||||
| os_image_version | GCP Images | ||||
| os_user | The OS user to be used | ||||
| os-setup | os-setup | ||||
| prereq_id | Prereq id used for dependency | ||||
| prereq-id | Returns the ID of the prereq script (if user_data or ami are not used) | ||||
| private_agent_admin_username | Private Agent ndoe SSH User | ||||
| private_agent_dcos_instance_os | Private agent node tested OSes image | ||||
| private_agent_disk_size | Private agent node disk size (gb) | ||||
| private_agent_disk_type | Private agent node disk type. | ||||
| private_agents_disk_size | Private agent node disk size (gb) | ||||
| private_agents_disk_type | Private agent node disk type. | ||||
| private_agent_image | Private agent node OS image | ||||
| private_agent_instance_type | Private agent node machine type | ||||
| private_agent_ips | List of private agent IPs to SSH to | ||||
| private_agent_machine_type | Private agent node machine type | ||||
| private_agent_public_ssh_key_path | Private Agent node Public SSH Key | ||||
| private_agent_ssh_user | Private Agent node SSH User | ||||
| private_agent_subnetwork_name | Instance Subnetwork Name | ||||
| private_agents_associate_public_ip_address | [PRIVATE AGENTS] Associate a public ip address with there instances | ||||
| private_agents_aws_ami | [PRIVATE AGENTS] AMI to be used | ||||
| private_agents_gcp_image | [PRIVATE AGENTS] Image to be used | ||||
| private_agents_instance_type | [PRIVATE AGENTS] Instance type | ||||
| private_agents_machine_type | [PRIVATE AGENTS] Machine type | ||||
| private_agents_os | [PRIVATE AGENTS] Operating system to use. Instead of using your own AMI you could use a provided OS. | ||||
| private_agents_os_user | The OS user to be used with ssh exec ( only for private agents ) | ||||
| private_agents_prereq-id | Workaround making the private agent install depending on an external resource (e.g. nullresource.id) | ||||
| private_agents_root_volume_size | [PRIVATE AGENTS] Root volume size in GB | ||||
| private_agents_root_volume_type | [PRIVATE AGENTS] Root volume type | ||||
| private_agents.admin_username | Private Agents node SSH User | ||||
| private_agents.dcos_instance_os | UNDEFINED | ||||
| private_agents.disk_size | UNDEFINED | ||||
| private_agents.disk_type | UNDEFINED | ||||
| private_agents.image | UNDEFINED | ||||
| private_agents.instance_type | UNDEFINED | ||||
| private_agents.instances | Private Agent instances IDs | ||||
| private_agents.machine_type | UNDEFINED | ||||
| private_agents.nsg_id | nsg id | ||||
| private_agents.nsg_name | nsg name | ||||
| private_agents.os_user | Private Agent instances private OS default user | ||||
| private_agents.prereq_id | Returns the ID of the prereq script for private agents (if image are not used) | ||||
| private_agents.prereq-id | Returns the ID of the prereq script for private agents (if user_data or ami are not used) | ||||
| private_agents.private_ips | Private Agent instances private IPs | ||||
| private_agents.public_ips | Private Agent public IPs | ||||
| private_agents.ssh_user | Deployed private agent SSH user | ||||
| private_backend_address_pool | Private backend address pool | ||||
| private_cidr | UNDEFINED | ||||
| private_ip | List of private ip addresses created by this module | ||||
| private_ips | List of private ip addresses created by this module | ||||
| private_subnet_id | UNDEFINED | ||||
| private_subnet_name | UNDEFINED | ||||
| probe | Main probe to check for node health | ||||
| project_id | project id | ||||
| provider | Provider to use | ||||
| provider | Provider to use | ||||
| public_agent_admin_username | Public Agent node SSH User | ||||
| public_agent_dcos_instance_os | Public Agent node tested OSes image | ||||
| public_agent_disk_size | Public agent disk size (gb) | ||||
| public_agent_disk_type | Public agent node disk type. | ||||
| public_agent_image | Public agent node OS image | A storage_image_reference reference. | |||
| public_agent_instance_type | Public agent machine type | ||||
| public_agent_instances | List of public agent instance IDs | ||||
| public_agent_ips | list of master private ips | ||||
| public_agent_ips | List of public agent IPs to SSH to | ||||
| public_agent_machine_type | Public agent machine type | ||||
| public_agent_public_ssh_key_path | Public Agent node Public SSH Key | ||||
| public_agent_ssh_user | Public Agent node SSH User | ||||
| public_agent_subnetwork_name | Instance Subnetwork Name | ||||
| public_agents | Firewall rules for public agents load balancer | ||||
| public_agents_acm_cert_arn | ACM certifacte to be used for the public agents load balancer | ||||
| public_agents_additional_rules | Additional list of rules for public agents. These Rules are an additon to the default rules. | ||||
| public_agents_additional_listeners | Additional list of listeners for public agents. These listeners are an additon to the default listeners. | ||||
| public_agents_associate_public_ip_address | [PUBLIC AGENTS] Associate a public ip address with there instances | ||||
| public_agents_aws_ami | [PUBLIC AGENTS] AMI to be used | ||||
| public_agents_dns_name | DNS Name of the public agent load balancer | ||||
| public_agents_gcp_image | [PUBLIC AGENTS] Image to be used | ||||
| public_agents_instance_type | [PUBLIC AGENTS] Instance type | ||||
| public_agents_ip_address | IP Address of public agents load balancer | ||||
| public_agents_ips | List of ips allowed access to public agents. admin_ips are joined to this list | ||||
| public_agents_machine_type | [PUBLIC AGENTS] Machine type | ||||
| public_agents_os | [PUBLIC AGENTS] Operating system to use. Instead of using your own AMI you could use a provided OS. | ||||
| public_agents_os_user | The OS user to be used with ssh exec (only for public agents) | ||||
| public_agents_prereq-id | Workaround making the public agent install depending on an external resource (e.g. nullresource.id) | ||||
| public_agents_root_volume_size | [PUBLIC AGENTS] Root volume size | ||||
| public_agents_root_volume_type | [PUBLIC AGENTS] Specify the root volume type. | ||||
| public_agents_self_link | List of public agent instances self links | ||||
| public_agents.admin_username | Public Agents node SSH User | ||||
| public_agents.dcos_instance_os | UNDEFINED | ||||
| public_agents.disk_size | UNDEFINED | ||||
| public_agents.disk_type | UNDEFINED | ||||
| public_agents.image | UNDEFINED | ||||
| public_agents.instance_type | UNDEFINED | ||||
| public_agents.instances | Public Agent instances IDs | ||||
| public_agents.lb.fqdn | UNDEFINED | ||||
| public_agents.machine_type | UNDEFINED | ||||
| public_agents.nsg_id | nsg id | ||||
| public_agents.nsg_name | nsg name | ||||
| public_agents.os_user | Private Agent instances private OS default user | ||||
| public_agents.prereq_id | Returns the ID of the prereq script for public agents (if image are not used) | ||||
| public_agents.prereq-id | Returns the ID of the prereq script for public agents (if user_data or ami are not used) | ||||
| public_agents.private_ips | Public Agent instances private IPs | ||||
| public_agents.public_ips | Public Agent public IPs | ||||
| public_agents.ssh_user | Deployed public agent SSH user | ||||
| public_backend_address_pool | Public backend address pool | ||||
| public_cidr | UNDEFINED | ||||
| public_ip | List of public ip addresses created by this module | ||||
| public_ips | List of public ip addresses created by this module | ||||
| public_ssh_key | SSH Public Key | ||||
| public_subnet_id | UNDEFINED | ||||
| public_subnet_name | UNDEFINED | ||||
| public-agents-loadbalancer | This is the load balancer address to access the DC/OS public agents | ||||
| public-agents.backend_address_pool | backend address pool | ||||
| public-agents.lb_address | lb address | ||||
| region | Region to use. If not specify AWS current region is used. | ||||
| region | Specify the region to be used | ||||
| region | region | ||||
| remote_region | The AWS Remote Region (ex: us-west-2, us-east-1) | ||||
| remote_route_table_id | ID of the Route Table for the Remote Region | ||||
| remote_vpc_id | The VPC ID of the Remote VPC | ||||
| resource_group_name | Name of the azure resource group | ||||
| role | specifies which dcos role of commands to run. Options: `dcos-bootstrap`, `dcos-mesos-agent-public`, `dcos-mesos-agent` and `dcos-mesos-master` | ||||
| root_volume_size | Specify the root volume size | ||||
| root_volume_type | Specify the root volume type. Masters MUST have at least gp2 | ||||
| rules | List of rules. By default HTTP and HTTPS are set. If set it overrides the default rules. | ||||
| scheduling_preemptible | Deploy instance with preemptible scheduling. (bool) | ||||
| script | The battle-tested provisioner contents of the output by DC/OS role to perform requried admin actions in behalf of the user as documented in http://mesosphere.com and http://dcos.io | ||||
| security_group_ids | Firewall IDs to use for these instances | ||||
| security_groups | Security Group IDs to use | ||||
| security_groups_masters | Security Group IDs to use for external masters load balancer | ||||
| security_groups_masters_internal | Security Group IDs to use for internal communication to masters | ||||
| security_groups_public_agents | Security Group IDs to use for external public agents load balancer | ||||
| self_link | Self link of the network created by this module | ||||
| ssh_private_key_filename | Path to the SSH private key | ||||
| ssh_public_key | SSH public key in authorized keys format (e.g. 'ssh-rsa ..') to be used with the instances. Make sure you added this key to your ssh-agent. | ||||
| ssh_public_key_file | Path to SSH public key. This is mandatory but can be set to an empty string if you want to use ssh_public_key with the key as string. | ||||
| ssh_user | SSH User | ||||
| subnet_id | Subnet ID | ||||
| subnet_ids | List of subnet IDs created in this network | ||||
| subnet_name | public subnet name | ||||
| subnet_range | Private IP space to be used in CIDR format | ||||
| subnets | List of subnet IDs created in this Network | ||||
| tags | Add custom tags to all resources | ||||
| target_pool | Target Pool | ||||
| traditional_default_os_user | Standard Default OS Users | ||||
| trigger | Triggers for null resource | ||||
| user | User | ||||
| user_data | User data to be used on these instances (cloud-init) | ||||
| vnet_cidr | UNDEFINED | ||||
| vpc_id | AWS VPC ID | ||||
| zone_list | Element by zone list | ||||
| cluster_name_random_string | Add a random string to the cluster name | ||||
| custom_data | User data to be used on these instances (cloud-init) | ||||
| public_agents_additional_ports | List of additional ports allowed for public access on public agents (80 and 443 open by default) | ||||
| dcos_ca_certificate_key_path | DC/OS CA certificate key path | ||||
| vm_size | Azure virtual machine size | ||||
| prereq_id | Prereq id used for dependency | ||||
| bootstrap_vm_size | [BOOTSTRAP] Azure virtual machine size | ||||
| masters_image | [MASTERS] Image to be used | ||||
| masters_vm_size | [MASTERS] Azure virtual machine size | ||||
| private_agents_image | [PRIVATE AGENTS] Image to be used | ||||
| private_agents_vm_size | [PRIVATE AGENTS] Azure virtual machine size | ||||
| public_agents_image | [PUBLIC AGENTS] Image to be used | ||||
| public_agents_vm_size | [PUBLIC AGENTS] Azure virtual machine size | ||||
| masters_disk_size | Masters node disk size (gb) | ||||
| masters_disk_type | Masters node disk type. | ||||
| public_agents_disk_size | Public agent disk size (gb) | ||||
| public_agents_disk_type | Public agent node disk type. | ||||
| masters_admin_username | Master node SSH User | ||||
| public_agents_admin_username | Public Agent node SSH User | ||||
| private_agents_admin_username | Private Agent ndoe SSH User | ||||
| infra_vm_size | Global Infra Machine Type | ||||
| masters_dcos_instance_os | Master node tested OSes image | ||||
| public_agents_dcos_instance_os | Public Agent node tested OSes image | ||||
| private_agents_dcos_instance_os | Private agent node tested OSes image | ||||
| load_balancer_type | Load Balancer type. Allowed values network, application | ||||
| bootstrap_iam_instance_profile | [BOOTSTRAP] Instance profile to be used for these instances | ||||
| masters_iam_instance_profile | [MASTERS] Instance profile to be used for these instances | ||||
| private_agents_iam_instance_profile | [PRIVATE AGENTS] Instance profile to be used for these instances | ||||
| public_agents_iam_instance_profile | [PUBLIC AGENTS] Instance profile to be used for these instances | ||||
| vpc.id | This is the id of the VPC the cluster is in |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment