Files
terraform-modules/kubernetes/flannel/README.md

143 lines
3.8 KiB
Markdown

## Requirements
The following requirements are needed by this module:
- <a name="requirement_kubernetes"></a> [kubernetes](#requirement\_kubernetes) (~> 2.11)
## Providers
The following providers are used by this module:
- <a name="provider_kubernetes"></a> [kubernetes](#provider\_kubernetes) (~> 2.11)
## Modules
No modules.
## Resources
The following resources are used by this module:
- [kubernetes_cluster_role.this](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/cluster_role) (resource)
- [kubernetes_cluster_role_binding.this](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/cluster_role_binding) (resource)
- [kubernetes_config_map.this](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/config_map) (resource)
- [kubernetes_daemonset.this](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/daemonset) (resource)
- [kubernetes_pod_security_policy.this](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/pod_security_policy) (resource)
- [kubernetes_service_account.this](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/service_account) (resource)
## Required Inputs
The following input variables are required:
### <a name="input_cluster_cidr"></a> [cluster\_cidr](#input\_cluster\_cidr)
Description: ClusterCIDR
Type: `string`
### <a name="input_vxlan_id"></a> [vxlan\_id](#input\_vxlan\_id)
Description: VXLAN ID (VNI)
Type: `number`
### <a name="input_vxlan_port"></a> [vxlan\_port](#input\_vxlan\_port)
Description: UDP port to use for sending encapsulated packets
Type: `number`
## Optional Inputs
The following input variables are optional (have default values):
### <a name="input_cluster_role_name"></a> [cluster\_role\_name](#input\_cluster\_role\_name)
Description: Name of the cluster role flannel will use
Type: `string`
Default: `"flannel"`
### <a name="input_create_cluster_role"></a> [create\_cluster\_role](#input\_create\_cluster\_role)
Description: Weather or not to create a suitable cluster role or use an already exisiting specified by cluster\_role\_name variable
Type: `bool`
Default: `true`
### <a name="input_daemonset_name"></a> [daemonset\_name](#input\_daemonset\_name)
Description: Name of the daeomonset
Type: `string`
Default: `"flannel"`
### <a name="input_flannel_cni_plugin_image"></a> [flannel\_cni\_plugin\_image](#input\_flannel\_cni\_plugin\_image)
Description: n/a
Type: `string`
Default: `"rancher/mirrored-flannelcni-flannel-cni-plugin:v1.0.1"`
### <a name="input_flannel_image"></a> [flannel\_image](#input\_flannel\_image)
Description: n/a
Type: `string`
Default: `"rancher/mirrored-flannelcni-flannel:v0.17.0"`
### <a name="input_namespace"></a> [namespace](#input\_namespace)
Description: namespace for resources
Type: `string`
Default: `"kube-system"`
### <a name="input_node_selector_os"></a> [node\_selector\_os](#input\_node\_selector\_os)
Description: Which kubernetes.io/os node-label to match for execution
Type: `list(string)`
Default:
```json
[
"linux"
]
```
## Outputs
The following outputs are exported:
### <a name="output_cluster_role"></a> [cluster\_role](#output\_cluster\_role)
Description: n/a
### <a name="output_cluster_role_binding"></a> [cluster\_role\_binding](#output\_cluster\_role\_binding)
Description: n/a
### <a name="output_configmap"></a> [configmap](#output\_configmap)
Description: n/a
### <a name="output_daemonset"></a> [daemonset](#output\_daemonset)
Description: n/a
### <a name="output_pod_security_policy"></a> [pod\_security\_policy](#output\_pod\_security\_policy)
Description: n/a
### <a name="output_service_account"></a> [service\_account](#output\_service\_account)
Description: n/a