docs: improve README, update host/group vars, and prerequisites #437
+135
−129
Conversation
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
| **env.file_server.iso_os_variant** | The os variant for the bastion kvm to be created | rhel8.8 | ||
| **env.file_server.iso_mount_dir** | Directory path relative to the HTTP/FTP accessible directory where RHEL ISO is mounted. For example, if the FTP root is at /home/user1 and the ISO is mounted at /home/user1/RHEL/8.7 then this variable would be RHEL/8.7 - no slash before or after. | RHEL/8.7 | ||
| **env.file_server.cfgs_dir** | Directory path relative to to the HTTP/FTP accessible directory where configuration files can be stored. For example, if FTP root is /home/user1 and you would like to store the configs at /home/user1/ocpz-config then this variable would be ocpz-config. No slash before or after. | ocpz-config | ||
| **env.file_server.ip** | IPv4 address for the file server that will be used to pass config files and iso to KVM host LPAR(s) and bastion VM during their first boot. | `'172.23.10.1'` |
Collaborator
There was a problem hiding this comment.
@ayanarukasar
Why are we changing the IP here ?
Please revert back this updating IP as we are exposing the IP here.
| **env.bastion.options.loadbalancer.public_ip** | (Only required if env.bastion.options.loadbalancer.on_bastion is True). The public IPv4 address for your environment's loadbalancer. api, apps, *.apps must use this. | 192.168.10.50 | ||
| **env.bastion.options.loadbalancer.private_ip** | (Only required if env.bastion.options.loadbalancer.on_bastion is True). The private IPv4 address for your environment's loadbalancer. api-int must use this. | 10.24.17.12 | ||
| **env.bastion.create** | True or False. Would you like to create a bastion KVM guest to host essential infrastructure services like DNS, load balancer, firewall, etc? Can de-select certain services with the env.bastion.options variables below. | `True` | ||
| **env.bastion.vm_name** | Name of the bastion VM. Arbitrary value. | `'bastion'` |
Collaborator
There was a problem hiding this comment.
any specific reason to mention everything in single quotes ?
| **env.bastion.networking.ip** | IPv4 address for the bastion. | `192.168.122.20` | ||
| **env.bastion.networking.internal_ip** | <b>(Optional)</b> Private IPv4 address for bastion required when installing LPAR cluster with HiperSocket. Currently supports only when bastion is on LPAR or on zVM host. Incase of zVM bastion enable the HiperSocket prior to the playbook run with vmcp commands on the bastion. Alternative Option would be setting up the bridge port on OSA or RoCE. | `10.42.16.1` | ||
| **env.bastion.networking.ipv6** | IPv6 address for the bastion if use_ipv6 variable is 'True'. Keep empty `''` to use default ipv6 | `'fd00::3'` | ||
| **env.bastion.networking.mac** | MAC address for the bastion if use_dhcp variable is 'True'. (Generate using: `printf 'fa:1d:67:%02d:%02d:%02d\n' $((RANDOM%100)) $((RANDOM%100)) $((RANDOM%100))`) | `'fa:1d:67:35:13:20'` |
Collaborator
There was a problem hiding this comment.
Any reason to give random mac address generation here, as we are talking bout DHCP , do we need a random generated mac ?
| **env.bastion.resources.swap** | How much swap storage would you like to allocate the bastion (in megabytes)? Recommended 4096 or more. | `4096` | ||
| **env.bastion.resources.vcpu** | How many virtual CPUs would you like to allocate to the bastion? Recommended 4 or more. | `4` | ||
| **env.bastion.resources.vcpu_model_option** | Configure the CPU model and CPU features exposed to the guest | `"--cpu host"` | ||
| **env.bastion.networking.ip** | IPv4 address for the bastion. | `192.168.122.20` |
Collaborator
There was a problem hiding this comment.
Any specific reason here to change the IP ?
veera-damisetti
added
the
documentation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updated docs/set-variables-host-vars.md
Updated docs/set-variables-group-vars.md
Updated docs/prerequisites.md
Improvements made to the README and variable documentation for clarity.