红帽全球峰会此内容没有您所选择的语言版本。
Appendix B. Understanding the example configuration files
B.1. Understanding the luks_tang_inventory.yml file
B.1.1. Configuration parameters for disk encryption
- hc_nodes (required)
A list of hyperconverged hosts that uses the back-end FQDN of the host, and the configuration details of those hosts. Configuration that is specific to a host is defined under that host’s back-end FQDN. Configuration that is common to all hosts is defined in the vars: section.
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - blacklist_mpath_devices (optional)
By default, Red Hat Virtualization Host enables multipath configuration, which provides unique multipath names and worldwide identifiers for all disks, even when disks do not have underlying multipath configuration. Include this section if you do not have multipath configuration so that the multipath device names are not used for listed devices. Disks that are not listed here are assumed to have multipath configuration available, and require the path format
/dev/mapper/<WWID>instead of/dev/sdxwhen defined in subsequent sections of the inventory file.On a server with four devices (sda, sdb, sdc and sdd), the following configuration blacklists only two devices. The path format /dev/mapper/<WWID> is expected for devices not in this list.
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - gluster_infra_luks_devices (required)
A list of devices to encrypt and the encryption passphrase to use for each device.
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - devicename
-
The name of the device in the format
/dev/sdx. - passphrase
- The password to use for this device when configuring encryption. After disk encryption with Network-Bound Disk Encryption (NBDE) is configured, a new random key is generated, providing greater security.
- rootpassphrase (required)
The password that you used when you selected Encrypt my data during operating system installation on this host.
hc_nodes: hosts: host1backend.example.com: rootpassphrase: h1-Str0ngPa55#hc_nodes: hosts: host1backend.example.com: rootpassphrase: h1-Str0ngPa55#Copy to Clipboard Copied! Toggle word wrap Toggle overflow - rootdevice (required)
The root device that was encrypted when you selected Encrypt my data during operating system installation on this host.
hc_nodes: hosts: host1backend.example.com: rootdevice: /dev/sda2hc_nodes: hosts: host1backend.example.com: rootdevice: /dev/sda2Copy to Clipboard Copied! Toggle word wrap Toggle overflow - networkinterface (required)
The network interface this host uses to reach the NBDE key server.
hc_nodes: hosts: host1backend.example.com: networkinterface: ens3s0f0hc_nodes: hosts: host1backend.example.com: networkinterface: ens3s0f0Copy to Clipboard Copied! Toggle word wrap Toggle overflow - ip_version (required)
Whether to use IPv4 or IPv6 networking. Valid values are
IPv4andIPv6. There is no default value. Mixed networks are not supported.hc_nodes: vars: ip_version: IPv4hc_nodes: vars: ip_version: IPv4Copy to Clipboard Copied! Toggle word wrap Toggle overflow - ip_config_method (required)
Whether to use DHCP or static networking. Valid values are
dhcpandstatic. There is no default value.hc_nodes: vars: ip_config_method: dhcphc_nodes: vars: ip_config_method: dhcpCopy to Clipboard Copied! Toggle word wrap Toggle overflow The other valid value for this option is
static, which requires the following additional parameters and is defined individually for each host:Copy to Clipboard Copied! Toggle word wrap Toggle overflow - gluster_infra_tangservers
The address of your NBDE key server or servers, including
http://. If your servers use a port other than the default (80), specify a port by appending:_port_to the end of the URL.hc_nodes: vars: gluster_infra_tangservers: - url: http://key-server1.example.com - url: http://key-server2.example.com:80hc_nodes: vars: gluster_infra_tangservers: - url: http://key-server1.example.com - url: http://key-server2.example.com:80Copy to Clipboard Copied! Toggle word wrap Toggle overflow
B.1.2. Example luks_tang_inventory.yml
Dynamically allocated IP addresses
Static IP addresses
B.2. Understanding the gluster_inventory.yml file
The gluster_inventory.yml file is an example Ansible inventory file that you can use to automate the deployment of Red Hat Hyperconverged Infrastructure for Virtualization using Ansible.
The single_node_gluster_inventory.yml is the same as the gluster_inventory.yml file. The only change is in the hosts section as there is only 1 host for a single node deployment.
You can find this file at /etc/ansible/roles/gluster.ansible/playbooks/hc-ansible-deployment/gluster_inventory.yml on any hyperconverged host.
B.2.1. Default host groups
The gluster_inventory.yml example file defines two host groups and their configuration in the YAML format. You can use these host groups directly if you want all nodes to host all storage domains.
- hc_nodes
A list of hyperconverged hosts that uses the back-end FQDN of the host, and the configuration details of those hosts. Configuration that is specific to a host is defined under that host’s back-end FQDN. Configuration that is common to all hosts is defined in the
vars:section.Copy to Clipboard Copied! Toggle word wrap Toggle overflow - gluster
A list of hosts that uses the front-end FQDN of the host. These hosts serve as additional storage domain access points, so this list of nodes does not include the first host.
If you want all nodes to host all storage domains, place
storage_domains:and all storage domain definitions under thevars:section.Copy to Clipboard Copied! Toggle word wrap Toggle overflow
B.2.2. Configuration parameters for hyperconverged nodes
B.2.2.1. Multipath devices
blacklist_mpath_devices(optional)By default, Red Hat Virtualization Host enables multipath configuration, which provides unique multipath names and worldwide identifiers for all disks, even when disks do not have underlying multipath configuration. Include this section if you do not have multipath configuration so that the multipath device names are not used for listed devices. Disks that are not listed here are assumed to have multipath configuration available, and require the path format
/dev/mapper/<WWID>instead of/dev/sdxwhen defined in subsequent sections of the inventory file.On a server with four devices (
sda,sdb,sdcandsdd), the following configuration blacklists only two devices. The path format/dev/mapper/<WWID>is expected for devices not in this list.Copy to Clipboard Copied! Toggle word wrap Toggle overflow ImportantDo not list encrypted devices (
luks_*devices) inblacklist_mpath_devices, as they require multipath configuration to work.
B.2.2.2. Deduplication and compression
gluster_infra_vdo(optional)Include this section to define a list of devices to use deduplication and compression. These devices require the
/dev/mapper/<name>path format when you define them as volume groups ingluster_infra_volume_groups. Each device listed must have the following information:name-
A short name for the VDO device, for example
vdo_sdc. device-
The device to use, for example,
/dev/sdc. logicalsize-
The logical size of the VDO volume. Set this to ten times the size of the physical disk, for example, if you have a 500 GB disk, set
logicalsize: '5000G'. emulate512-
If you use devices with a 4 KB block size, set this to
on. slabsize-
If the logical size of the volume is 1000 GB or larger, set this to
32G. If the logical size is smaller than 1000 GB, set this to2G. blockmapcachesize-
Set this to
128M. writepolicy-
Set this to
auto.
For example:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
B.2.2.3. Cluster definition
cluster_nodes(required)Defines the list of nodes that are part of the cluster, using the back-end FQDN for each node and creates the cluster.
Copy to Clipboard Copied! Toggle word wrap Toggle overflow gluster_features_hci_cluster(required)Identifies
cluster_nodesas part of a hyperconverged cluster.hc_nodes: vars: gluster_features_hci_cluster: "{{ cluster_nodes }}"hc_nodes: vars: gluster_features_hci_cluster: "{{ cluster_nodes }}"Copy to Clipboard Copied! Toggle word wrap Toggle overflow gluster_features_hci_volumes(required)Defines the layout of the Gluster volumes across the hyperconverged nodes.
volname- The name of the Gluster volume to create.
brick- The location at which to create the brick.
arbiter-
Set to
1for arbitrated volumes and0for a fully replicated volume. serversThe list of back-end FQDN addresses for the hosts on which to create bricks for this volume.
There are two format options for this parameter. Only one of these formats is supported per deployment.
Format 1: Creates bricks for the specified volumes across all hosts
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Format 2: Creates bricks for the specified volumes on specified hosts
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
B.2.2.4. Storage infrastructure
gluster_infra_volume_groups(required)This section creates the volume groups that contain the logical volumes.
Copy to Clipboard Copied! Toggle word wrap Toggle overflow gluster_infra_mount_devices(required)This section creates the logical volumes that form Gluster bricks.
Copy to Clipboard Copied! Toggle word wrap Toggle overflow gluster_infra_thinpools(optional)This section defines logical thin pools for use by thinly provisioned volumes. Thin pools are not suitable for the
enginevolume, but can be used for thevmstoreanddatavolume bricks.vgname- The name of the volume group that contains this thin pool.
thinpoolname-
A name for the thin pool, for example,
gluster_thinpool_sdc. thinpoolsize- The sum of the sizes of all logical volumes to be created in this volume group.
poolmetadatasize-
Set to
16G; this is the recommended size for supported deployments.
Copy to Clipboard Copied! Toggle word wrap Toggle overflow gluster_infra_cache_vars(optional)This section defines cache logical volumes to improve performance for slow devices. A fast cache device is attached to a thin pool, and requires
gluster_infra_thinpoolto be defined.vgname- The name of a volume group with a slow device that requires a fast external cache.
cachedisk-
The paths of the slow and fast devices, separated with a comma, for example, to use a cache device
sdewith the slow devicesdb, specify/dev/sdb,/dev/sde. cachelvname- A name for this cache logical volume.
cachethinpoolname- The thin pool to which the fast cache volume is attached.
cachelvsize- The size of the cache logical volume. Around 0.01% of this size is used for cache metadata.
cachemode-
The cache mode. Valid values are
writethroughandwriteback.
Copy to Clipboard Copied! Toggle word wrap Toggle overflow gluster_infra_thick_lvs(required)The thickly provisioned logical volumes that are used to create bricks. Bricks for the
enginevolume must be thickly provisioned.vgname- The name of the volume group that contains the logical volume.
lvname- The name of the logical volume.
size-
The size of the logical volume. The
enginelogical volume requires100G.
Copy to Clipboard Copied! Toggle word wrap Toggle overflow gluster_infra_lv_logicalvols(required)The thinly provisioned logical volumes that are used to create bricks.
vgname- The name of the volume group that contains the logical volume.
thinpool- The thin pool that contains the logical volume, if this volume is thinly provisioned.
lvname- The name of the logical volume.
size-
The size of the logical volume. The
enginelogical volume requires100G.
Copy to Clipboard Copied! Toggle word wrap Toggle overflow gluster_infra_disktype(required)Specifies the underlying hardware configuration of the disks. Set this to the value that matches your hardware:
RAID6,RAID5, orJBOD.hc_nodes: vars: gluster_infra_disktype: RAID6hc_nodes: vars: gluster_infra_disktype: RAID6Copy to Clipboard Copied! Toggle word wrap Toggle overflow gluster_infra_diskcount(required)Specifies the number of data disks in the RAID set. For a
JBODdisk type, set this to1.hc_nodes: vars: gluster_infra_diskcount: 10hc_nodes: vars: gluster_infra_diskcount: 10Copy to Clipboard Copied! Toggle word wrap Toggle overflow gluster_infra_stripe_unit_size(required)The stripe size of the RAID set in megabytes.
hc_nodes: vars: gluster_infra_stripe_unit_size: 256hc_nodes: vars: gluster_infra_stripe_unit_size: 256Copy to Clipboard Copied! Toggle word wrap Toggle overflow gluster_features_force_varlogsizecheck(required)Set this to
trueif you want to verify that your/var/logpartition has sufficient free space during the deployment process. It is important to have sufficient space for logs, but it is not required to verify space requirements at deployment time if you plan to monitor space requirements carefully.hc_nodes: vars: gluster_features_force_varlogsizecheck: falsehc_nodes: vars: gluster_features_force_varlogsizecheck: falseCopy to Clipboard Copied! Toggle word wrap Toggle overflow gluster_set_selinux_labels(required)Ensures that volumes can be accessed when SELinux is enabled. Set this to
trueif SELinux is enabled on this host.hc_nodes: vars: gluster_set_selinux_labels: truehc_nodes: vars: gluster_set_selinux_labels: trueCopy to Clipboard Copied! Toggle word wrap Toggle overflow Recommendation for LV sizeLogical volume for engine brick must be a thick LV of size 100GB, other bricks created as thin LV reserving 16GB for thinpool metadata and 16GB reserved for spare metadata.
Example:
If the host has a disk of size 1TB, then engine brick size= 100GB ( thick LV ) Pool metadata size= 16GB Spare metadata size= 16GB Available space for thinpool= 1TB - ( 100GB + 16GB + 16GB ) = 868 GB
If the host has a disk of size 1TB, then engine brick size= 100GB ( thick LV ) Pool metadata size= 16GB Spare metadata size= 16GB Available space for thinpool= 1TB - ( 100GB + 16GB + 16GB ) = 868 GBCopy to Clipboard Copied! Toggle word wrap Toggle overflow
Other bricks for volumes can be created with the available thinpool storage space of 868GB, for example, vmstore brick with 200GB and data brick with 668GB.
B.2.2.5. Firewall and network infrastructure
gluster_infra_fw_ports(required)A list of ports to open between all nodes, in the format
<port>/<protocol>.Copy to Clipboard Copied! Toggle word wrap Toggle overflow gluster_infra_fw_permanent(required)Ensures the ports listed in
gluster_infra_fw_portsare open after nodes are rebooted. Set this totruefor production use cases.hc_nodes: vars: gluster_infra_fw_permanent: true
hc_nodes: vars: gluster_infra_fw_permanent: trueCopy to Clipboard Copied! Toggle word wrap Toggle overflow gluster_infra_fw_state(required)Enables the firewall. Set this to
enabledfor production use cases.hc_nodes: vars: gluster_infra_fw_state: enabledhc_nodes: vars: gluster_infra_fw_state: enabledCopy to Clipboard Copied! Toggle word wrap Toggle overflow gluster_infra_fw_zone(required)Specifies the firewall zone to which these
gluster_infra_fw_\*parameters are applied.hc_nodes: vars: gluster_infra_fw_zone: publichc_nodes: vars: gluster_infra_fw_zone: publicCopy to Clipboard Copied! Toggle word wrap Toggle overflow gluster_infra_fw_services(required)A list of services to allow through the firewall. Ensure
glusterfsis defined here.hc_nodes: vars: gluster_infra_fw_services: - glusterfshc_nodes: vars: gluster_infra_fw_services: - glusterfsCopy to Clipboard Copied! Toggle word wrap Toggle overflow
B.2.2.6. Storage domains
storage_domains(required)Creates the specified storage domains.
name- The name of the storage domain to create.
host- The front-end FQDN of the first host. Do not use the IP address.
address- The back-end FQDN address of the first host. Do not use the IP address.
path- The path of the Gluster volume that provides the storage domain.
function-
Set this to
data; this is the only supported type of storage domain. mount_options-
Specifies additional mount options. The
backup-volfile-serversoption is required to specify the other hosts that provide the volume. Thexlator-option='transport.address-family=inet6'option is required for IPv6 configurations.
IPv4 configuration
gluster: vars: storage_domains: - {"name":"data","host":"host1-frontend-network-FQDN","address":"host1-backend-network-FQDN","path":"/data","function":"data","mount_options":"backup-volfile-servers=host2-backend-network-FQDN:host3-backend-network-FQDN"} - {"name":"vmstore","host":"host1-frontend-network-FQDN","address":"host1-backend-network-FQDN","path":"/vmstore","function":"data","mount_options":"backup-volfile-servers=host2-backend-network-FQDN:host3-backend-network-FQDN"}gluster: vars: storage_domains: - {"name":"data","host":"host1-frontend-network-FQDN","address":"host1-backend-network-FQDN","path":"/data","function":"data","mount_options":"backup-volfile-servers=host2-backend-network-FQDN:host3-backend-network-FQDN"} - {"name":"vmstore","host":"host1-frontend-network-FQDN","address":"host1-backend-network-FQDN","path":"/vmstore","function":"data","mount_options":"backup-volfile-servers=host2-backend-network-FQDN:host3-backend-network-FQDN"}Copy to Clipboard Copied! Toggle word wrap Toggle overflow IPv6 configuration
gluster: vars: storage_domains: - {"name":"data","host":"host1-frontend-network-FQDN","address":"host1-backend-network-FQDN","path":"/data","function":"data","mount_options":"backup-volfile-servers=host2-backend-network-FQDN:host3-backend-network-FQDN,xlator-option='transport.address-family=inet6'"} - {"name":"vmstore","host":"host1-frontend-network-FQDN","address":"host1-backend-network-FQDN","path":"/vmstore","function":"data","mount_options":"backup-volfile-servers=host2-backend-network-FQDN:host3-backend-network-FQDN,xlator-option='transport.address-family=inet6'"}gluster: vars: storage_domains: - {"name":"data","host":"host1-frontend-network-FQDN","address":"host1-backend-network-FQDN","path":"/data","function":"data","mount_options":"backup-volfile-servers=host2-backend-network-FQDN:host3-backend-network-FQDN,xlator-option='transport.address-family=inet6'"} - {"name":"vmstore","host":"host1-frontend-network-FQDN","address":"host1-backend-network-FQDN","path":"/vmstore","function":"data","mount_options":"backup-volfile-servers=host2-backend-network-FQDN:host3-backend-network-FQDN,xlator-option='transport.address-family=inet6'"}Copy to Clipboard Copied! Toggle word wrap Toggle overflow
B.2.3. Example gluster_inventory.yml file
B.3. Understanding the he_gluster_vars.json file
The he_gluster_vars.json file is an example Ansible variable file. The variables in this file need to be defined in order to deploy Red Hat Hyperconverged Infrastructure for Virtualization.
You can find an example file at /etc/ansible/roles/gluster.ansible/playbooks/hc-ansible-deployment/he_gluster_vars.json on any hyperconverged host.
Example he_gluster_vars.json file
Red Hat recommends encrypting this file. See Working with files encrypted using Ansible Vault for more information.
B.3.1. Required variables
he_appliance_password- The password for the hosted engine. For a production cluster, use an encrypted value created with Ansible Vault.
he_admin_password-
The password for the
adminaccount of the hosted engine. For a production cluster, use an encrypted value created with Ansible Vault. he_domain_type-
The type of storage domain. Set to
glusterfs. he_fqdn- The FQDN for the hosted engine virtual machine.
he_vm_mac_addr- The MAC address for the appropriate network device of the hosted engine virtual machine. You can skip this option for hosted deployment with static IP configuration as in such cases the MAC address for Hosted Engine is automatically generated.
he_default_gateway- The FQDN of the gateway to be used.
he_mgmt_network-
The name of the management network. Set to
ovirtmgmt. he_storage_domain_name-
The name of the storage domain to create for the hosted engine. Set to
HostedEngine. he_storage_domain_path-
The path of the Gluster volume that provides the storage domain. Set to
/engine. he_storage_domain_addr-
The back-end FQDN of the first host providing the
enginedomain. he_mount_optionsSpecifies additional mount options.
For a three node deployment with IPv4 configurations, set:
For a three node deployment with IPv4 configurations, set:Copy to Clipboard Copied! Toggle word wrap Toggle overflow "he_mount_options":"backup-volfile-servers=host2-backend-network-FQDN:host3-backend-network-FQDN"
"he_mount_options":"backup-volfile-servers=host2-backend-network-FQDN:host3-backend-network-FQDN"Copy to Clipboard Copied! Toggle word wrap Toggle overflow The
he_mount_optionis not required for IPv4 based single node deployment of Red Hat Hyperconverged Infrastructure for Virtualization.For a three node deployment with IPv6 configurations, set:
"he_mount_options":"backup-volfile-servers=host2-backend-network-FQDN:host3-backend-network-FQDN",xlator-option='transport.address-family=inet6'"
"he_mount_options":"backup-volfile-servers=host2-backend-network-FQDN:host3-backend-network-FQDN",xlator-option='transport.address-family=inet6'"Copy to Clipboard Copied! Toggle word wrap Toggle overflow For a single node deployment with IPv6 configurations, set:
"he_mount_options":"xlator-option='transport.address-family=inet6'"
"he_mount_options":"xlator-option='transport.address-family=inet6'"Copy to Clipboard Copied! Toggle word wrap Toggle overflow he_bridge_if- The name of the interface to use for bridge creation.
he_enable_hc_gluster_service-
Enables Gluster services. Set to
true. he_mem_size_MB- The amount of memory allocated to the hosted engine virtual machine in megabytes.
he_cluster- The name of the cluster in which the hyperconverged hosts are placed.
he_vcpus- The amount of CPUs used on the engine VM. By default 4 VCPUs are allocated for Hosted Engine Virtual Machine.
DHCP configuration is used on the Hosted Engine VM by default. However, if you want to use static IP or FQDN, define the following variables:
he_vm_ip_addr- Static IP address for Hosted Engine VM (IPv4 or IPv6).
he_vm_ip_prefix- IP prefix for Hosted Engine VM (IPv4 or IPv6).
he_dns_addr- DNS server for Hosted Engine VM (IPv4 or IPv6).
he_default_gateway- Default gateway for Hosted Engine VM (IPv4 or IPv6).
he_vm_etc_hosts-
Specifies Hosted Engine VM IP address and FQDN to
/etc/hostson the host, boolean value.
Example he_gluster_vars.json file with static Hosted Engine configuration
If DNS is not available, use ping for he_network_test instead of dns.
Example: "he_network_test": "ping"
Example: "he_network_test": "ping"
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}