Terraform
The following is automatically generated reference documentation for Terraform by terraform-docs.
It can be generated via
$ terraform-docs -c docs/.terraform-docs.yaml terraform
Requirements
Name |
Version |
|---|---|
terraform |
>= 0.14 |
local |
>= 2.4.0 |
openstack |
~> 1.54.0 |
template |
>= 2.2.0 |
Providers
Name |
Version |
|---|---|
local |
>= 2.4.0 |
openstack |
~> 1.54.0 |
template |
>= 2.2.0 |
Modules
No modules.
Resources
Name |
Type |
|---|---|
resource |
|
resource |
|
resource |
|
resource |
|
resource |
|
resource |
|
resource |
|
resource |
|
resource |
|
resource |
|
resource |
|
resource |
|
resource |
|
resource |
|
resource |
|
resource |
|
resource |
|
resource |
|
resource |
|
openstack_networking_router_interface_v2.cluster_router_iface |
resource |
openstack_networking_router_interface_v2.cluster_router_iface_v6 |
resource |
resource |
|
resource |
|
resource |
|
resource |
|
data source |
|
data source |
|
data source |
|
data source |
|
data source |
|
data source |
|
data source |
|
data source |
Inputs
Name |
Description |
Type |
Default |
Required |
|---|---|---|---|---|
azs |
If ‘enable_az_management=true’ defines which availability zones of your cloud to use to distribute the spawned server for better HA. Additionally the count of the array will define how many gateway server will be spawned. The naming of the elements doesn’t matter if ‘enable_az_management=false’. It is also used for unique naming of gateways. |
|
[ |
no |
cluster_name |
n/a |
|
|
no |
create_root_disk_on_volume |
n/a |
|
|
no |
default_master_flavor |
n/a |
|
|
no |
default_master_image_name |
n/a |
|
|
no |
default_master_root_disk_size |
If ‘create_root_disk_on_volume=true’, the master flavor does not specify a disk size and no specific value has been given, the root disk volume will have this size. |
|
|
no |
default_worker_flavor |
n/a |
|
|
no |
default_worker_image_name |
n/a |
|
|
no |
default_worker_root_disk_size |
If ‘create_root_disk_on_volume=true’, the worker flavor does not specify a disk size and no specific value has been given, the root disk volume will have this size. |
|
|
no |
dns_nameservers_v4 |
A list of IPv4 addresses which will be configured as DNS nameservers of the IPv4 subnet. |
|
|
no |
dualstack_support |
If set to true, dualstack support related resources will be (re-)created |
|
n/a |
yes |
enable_az_management |
If set to false, the availability zone of instances will not be managed. This is useful in CI environments if the Cloud Is Full. |
|
|
no |
gateway_flavor |
n/a |
|
|
no |
gateway_image_name |
n/a |
|
|
no |
gateway_root_disk_volume_size |
If ‘create_root_disk_on_volume=true’ and the gateway flavor does not specify a disk size, the root disk volume will have this size. |
|
|
no |
gateway_root_disk_volume_type |
If ‘create_root_disk_on_volume=true’, set the volume type of the root disk volume for Gateways. Can’t be configured separately for each instance. If left empty, the volume type specified in ‘root_disk_volume_type’ will be used. |
|
|
no |
gitlab_backend |
If set to true, GitLab will be used as Terraform HTTP backend. |
|
|
no |
gitlab_base_url |
Base URL of GitLab for Terraform HTTP backend if ‘gitlab_backend=true’. |
|
|
no |
gitlab_project_id |
If ‘gitlab_backend=true’, the Terraform state will be stored in the GitLab repo with this ID. |
|
|
no |
gitlab_state_name |
If ‘gitlab_backend=true’, the terraform state file will have this name. |
|
|
no |
keypair |
n/a |
|
n/a |
yes |
master_azs |
n/a |
|
|
no |
master_flavors |
n/a |
|
|
no |
master_images |
n/a |
|
|
no |
master_names |
It can be used to uniquely identify masters |
|
|
no |
master_root_disk_sizes |
If ‘create_root_disk_on_volume=true’ and the master flavor does not specify a disk size, the root disk volume of this particular instance will have this size. |
|
|
no |
master_root_disk_volume_types |
If ‘create_root_disk_on_volume=true’, volume type for root disk of this particular control plane node. If left empty, the volume type specified in ‘root_disk_volume_type’ will be used. |
|
|
no |
masters |
n/a |
|
|
no |
monitoring_manage_thanos_bucket |
Create an object storage container for thanos. |
|
|
no |
network_mtu |
MTU for the network used for the cluster. |
|
|
no |
public_network |
n/a |
|
|
no |
root_disk_volume_type |
If ‘create_root_disk_on_volume=true’, the volume type to be used as default for all instances. If left empty, default of IaaS environment is used. |
|
|
no |
subnet_cidr |
n/a |
|
|
no |
subnet_v6_cidr |
n/a |
|
|
no |
thanos_delete_container |
n/a |
|
|
no |
timeout_time |
n/a |
|
|
no |
worker_anti_affinity_group_name |
n/a |
|
|
no |
worker_azs |
n/a |
|
|
no |
worker_flavors |
n/a |
|
|
no |
worker_images |
n/a |
|
|
no |
worker_join_anti_affinity_group |
n/a |
|
|
no |
worker_names |
It can be used to uniquely identify workers |
|
|
no |
worker_root_disk_sizes |
If ‘create_root_disk_on_volume=true’, size of the root disk of this particular worker node. If left empty, the root disk size specified in ‘default_worker_root_disk_size’ is used. |
|
|
no |
worker_root_disk_volume_types |
If ‘create_root_disk_on_volume=true’, volume types for the root disk of this particular worker node. If left empty, the volume type specified in ‘root_disk_volume_type’ will be used. |
|
|
no |
workers |
n/a |
|
|
no |
Outputs
No outputs.