diff --git a/README.md b/README.md index af396ad..044d9c7 100644 --- a/README.md +++ b/README.md @@ -90,10 +90,20 @@ No modules. | Name | Description | |------|-------------| +| [dns\_base\_domain](#output\_dns\_base\_domain) | base domain for the LAN network so the k8s nodes can get unique the FQDN name and resolved by the router | | [host-public-ip-address](#output\_host-public-ip-address) | the public IP address of the equinix host | -| [k8s\_master\_ip\_mac\_hostname\_maps](#output\_k8s\_master\_ip\_mac\_hostname\_maps) | k8s masters maps including ipv4/mac/hostname/ipv6 | -| [k8s\_worker\_ip\_mac\_hostname\_maps](#output\_k8s\_worker\_ip\_mac\_hostname\_maps) | k8s workers maps including ipv4/mac/hostname/ipv6 | +| [k8s\_cluster\_name](#output\_k8s\_cluster\_name) | this will be used to create the FQDN name in the DNS record to follow the OCP guide(https://docs.openshift.com/container-platform/4.11/installing/installing_bare_metal/installing-bare-metal.html#installation-dns-user-infra-example_installing-bare-metal) | +| [k8s\_master\_count](#output\_k8s\_master\_count) | number of master nodes, and we only support numbers 1 or 3 for now | +| [k8s\_master\_ip\_mac\_hostname\_map](#output\_k8s\_master\_ip\_mac\_hostname\_map) | k8s masters maps including ipv4/mac/hostname/ipv6 | +| [k8s\_worker\_count](#output\_k8s\_worker\_count) | number of worker nodes, and we only support numbers less than 9 for now | +| [k8s\_worker\_ip\_mac\_hostname\_map](#output\_k8s\_worker\_ip\_mac\_hostname\_map) | k8s workers maps including ipv4/mac/hostname/ipv6 | +| [libvirt\_pool\_main\_id](#output\_libvirt\_pool\_main\_id) | libvirt\_pool\_main\_id | +| [libvirt\_private\_network\_id](#output\_libvirt\_private\_network\_id) | libvirt private network id | +| [libvirt\_public\_network\_id](#output\_libvirt\_public\_network\_id) | libvirt public network id | +| [private\_network\_ipv4\_cidr](#output\_private\_network\_ipv4\_cidr) | the private network IPv4 cidr block for VMs, only /24 is supported for now | +| [private\_network\_ipv6\_cidr](#output\_private\_network\_ipv6\_cidr) | the private network IPv6 cidr block for VMs, and only /112 is supported for now | | [router-public-ip-address](#output\_router-public-ip-address) | the public IP address of the router | +| [router\_password](#output\_router\_password) | The login password for vyos. | | [ssh\_private\_key\_file\_path](#output\_ssh\_private\_key\_file\_path) | private key file path for this project | | [ssh\_public\_key\_file\_path](#output\_ssh\_public\_key\_file\_path) | public key file path for this project | | [testbox-public-ip-address](#output\_testbox-public-ip-address) | the public IP address of the testbox |