Skip to content

Commit

Permalink
update the doc
Browse files Browse the repository at this point in the history
  • Loading branch information
liyihuang committed Jul 28, 2024
1 parent 811d2ff commit 64ac376
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ In the private virtual network, the router works as the ipv4/ipv6 L3 gateway/DHC

We require you to input the mac address prefix,hostname prefix and nodes counts for k8s nodes info in this module because we will populate the staitc DHCP mappingg, the FQDN name and HA proxy config for the k8s nodes in the DHCP/DNS server and HA proxy. When you deploy your k8s nodes, you can just use the MAC address from the output from this module so you can have the relaible IP address from the DHCP server.

## Requirements
* You need to install xsltproc and mkisofs package for the VM deployment
* You need to have on your local machine to run the module where I dont quite understand(https://github.com/dmacvicar/terraform-provider-libvirt/issues/1089)

## Notes
* the router will source NAT the virtual network traffic to its public IP address to help the virtual private network VM to access the Internet.
* the router will forward the 6443/443/80 traffic from the its public/private interfaces to the k8s masters(6443)/workers(443/80) nodes.
Expand Down Expand Up @@ -107,4 +111,4 @@ No modules.
| <a name="output_ssh_private_key_file_path"></a> [ssh\_private\_key\_file\_path](#output\_ssh\_private\_key\_file\_path) | private key file path for this project |
| <a name="output_ssh_public_key_file_path"></a> [ssh\_public\_key\_file\_path](#output\_ssh\_public\_key\_file\_path) | public key file path for this project |
| <a name="output_testbox-public-ip-address"></a> [testbox-public-ip-address](#output\_testbox-public-ip-address) | the public IP address of the testbox |
<!-- END_TF_DOCS -->
<!-- END_TF_DOCS -->

0 comments on commit 64ac376

Please sign in to comment.